@github/details-menu-element

中文文档
1.0.13发布于 2022/10/26MITTypeScriptES Module零依赖近 30 天下载 18.3万

A menu opened with a

button.

原始使用文档
文档目录9 节
  1. Installation
  2. Usage
  3. Script
  4. Markup
  5. Events
  6. Deferred loading
  7. Browser support
  8. Development
  9. License

<details-menu> element

A menu that's opened with a <details> button.

Installation

$ npm install @github/details-menu-element

Usage

Script

Import as a module:

import '@github/details-menu-element'

With a script tag:

<script type="module" src="./node_modules/@github/details-menu-element/dist/index.js">

Markup

<details>
  <summary>Robots</summary>
  <details-menu role="menu">
    <button type="button" role="menuitem">Hubot</button>
    <button type="button" role="menuitem">Bender</button>
    <button type="button" role="menuitem">BB-8</button>
  </details-menu>
</details>

Use data-menu-button and data-menu-button-text to update the button's text on menu item activation.

<details>
  <summary>Preferred robot: <span data-menu-button>None</span></summary>
  <details-menu role="menu">
    <button type="button" role="menuitem" data-menu-button-text>Hubot</button>
    <button type="button" role="menuitem" data-menu-button-text>Bender</button>
    <button type="button" role="menuitem" data-menu-button-text>BB-8</button>
  </details-menu>
</details>

Use data-menu-button and data-menu-button-contents to update the button's HTML content on menu item activation.

<details>
  <summary>Preferred robot: <span data-menu-button>None</span></summary>
  <details-menu role="menu">
    <button type="button" role="menuitem" data-menu-button-contents><img src="hubot.png"> Hubot</button>
    <button type="button" role="menuitem" data-menu-button-contents><img src="bender.png"> Bender</button>
    <button type="button" role="menuitem" data-menu-button-contents><img src="bb8.png"> BB-8</button>
  </details-menu>
</details>

Use label[tabindex="0"][role=menuitemradio/menuitemcheckbox] when dealing with radio and checkbox inputs menu items. Check states of the input element and the label will be synchronized.

<details>
  <summary>Preferred robot</summary>
  <details-menu role="menu">
    <label tabindex="0" role="menuitemradio">
      <input type="radio" name="robot" value="Hubot"> Hubot
    </label>
    <label tabindex="0" role="menuitemradio">
      <input type="radio" name="robot" value="Bender"> Bender
    </label>
    <label tabindex="0" role="menuitemradio">
      <input type="radio" name="robot" value="BB-8"> BB-8
    </label>
  </details-menu>
</details>

Events

  • details-menu-select (cancelable) - fired on <details-menu> with event.detail.relatedTarget being the item to be selected.
  • details-menu-selected - fired on <details-menu> with event.detail.relatedTarget being the item selected, after label is updated and menu is closed.

Deferred loading

Menu content can be loaded from a server by embedding an <include-fragment> element.

<details>
  <summary>Robots</summary>
  <details-menu src="/robots" preload>
    <include-fragment>Loading…</include-fragment>
  </details-menu>
</details>

The src attribute value is copied to the <include-fragment> the first time the <details> button is toggled open, which starts the server fetch.

If the preload attribute is present, the server fetch will begin on mouse hover over the <details> button, so the content may be loaded by the time the menu is opened.

Browser support

Browsers without native custom element support require a polyfill.

  • Chrome
  • Firefox
  • Safari
  • Microsoft Edge

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

版本与发布记录

@github/details-menu-element 共发布 33 个版本,首次发布于 2018/06/29;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.13latest2022/10/264 年前
1.0.122021/08/235 年前
1.0.112021/08/125 年前
1.0.102021/07/215 年前
1.0.92020/06/046 年前
1.0.82020/01/306 年前

关于 @github/details-menu-element 的常见问题

@github/details-menu-element 是什么?

A menu opened with a button.

如何安装 @github/details-menu-element?

在项目目录运行 npm install @github/details-menu-element,或使用 pnpm add / yarn add / bun add。

@github/details-menu-element 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@github/details-menu-element 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@github/details-menu-element 可以商用吗?

@github/details-menu-element 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@github/details-menu-element 的下载量有多少?

根据 npm 官方下载统计,@github/details-menu-element 在 2026/10/17 – 2026/11/15 这 30 天内被下载 183,129 次,日均约 6,104 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@github/details-menu-element 还在维护吗?

最新版本 1.0.13 发布于 2022/10/26(4 年前);至今共发布 33 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/06/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。