@github/text-expander-element

中文文档
2.9.4发布于 2026/01/16MITTypeScriptES Module构建来源已验证近 30 天下载 5万

Activates a suggestion menu to expand text snippets as you type.

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

<text-expander> element

Activates a suggestion menu to expand text snippets as you type.

Installation

$ npm install --save @github/text-expander-element

Usage

Script

Import as ES modules:

import '@github/text-expander-element'

With a script tag:

<script type="module" src="./node_modules/@github/text-expander-element/dist/bundle.js">

Markup

<text-expander keys=": @ #" multiword="#">
  <textarea></textarea>
</text-expander>

Attributes

  • keys is a space separated list of menu activation keys
  • multiword defines whether the expansion should use several words or not
    • you can provide a space separated list of activation keys that should support multi-word matching
  • suffix is a string that is appended to the value during expansion, default is a single space character

Events

text-expander-change is fired when a key is matched. In event.detail you can find:

  • key: The matched key; for example: :.
  • text: The matched text; for example: cat, for :cat.
    • If the key is specified in the multiword attribute then the matched text can contain multiple words; for example cat and dog for :cat and dog.
  • provide: A function to be called when you have the menu results. Takes a Promise with {matched: boolean, fragment: HTMLElement} where matched tells the element whether a suggestion is available, and fragment is the menu content to be displayed on the page.
const expander = document.querySelector('text-expander')

expander.addEventListener('text-expander-change', function(event) {
  const {key, provide, text} = event.detail
  if (key !== ':') return

  const suggestions = document.querySelector('.emoji-suggestions').cloneNode(true)
  suggestions.hidden = false
  for (const suggestion of suggestions.children) {
    if (!suggestion.textContent.match(text)) {
      suggestion.remove()
    }
  }
  provide(Promise.resolve({matched: suggestions.childElementCount > 0, fragment: suggestions}))
})

The returned fragment should be consisted of filtered [role=option] items to be selected. For example:

<ul class="emoji-suggestions" hidden>
  <li role="option" data-value="🐈">🐈 :cat2:</li>
  <li role="option" data-value="🐕">🐕 :dog:</li>
</ul>

text-expander-value is fired when an item is selected. In event.detail you can find:

  • key: The matched key; for example: :.
  • item: The selected item. This would be one of the [role=option]. Use this to work out the value.
  • value: A null value placeholder to replace the query. To replace the text query, simply re-assign this value.
  • continue: A boolean value to specify whether to continue autocompletion after inserting a value. Defaults to false. If set to true, will not add a space after inserted value and will keep firing the text-expander-change event.
const expander = document.querySelector('text-expander')

expander.addEventListener('text-expander-value', function(event) {
  const {key, item}  = event.detail
  if (key === ':') {
    event.detail.value = item.getAttribute('data-value')
  }
})

text-expander-committed is fired after the underlying input value has been updated in the DOM. In event.detail you can find:

  • input: The HTMLInputElement or HTMLTextAreaElement that just had value changes committed to the DOM.
const expander = document.querySelector('text-expander')

expander.addEventListener('text-expander-committed', function(event) {
  const {input}  = event.detail
})

text-expander-activate is fired just after the menu has been assigned and appended to the DOM, and just before it is about to be positioned near the text to expand. This is useful for assigning classes or calling imperative methods to show the menu, such as .showPopover().

text-expander-deactivate is fired just before the menu is going to be unassigned and removed from the DOM. This is useful for removing classes or running cleanup like removing from caches.

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/text-expander-element 共发布 31 个版本,首次发布于 2019/06/13;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.9.4latest2026/01/169 个月前
2.9.22025/05/221.5 年前
2.9.12025/01/311.8 年前
2.9.02025/01/301.8 年前
2.8.02024/10/102 年前
2.7.22024/09/252 年前

关于 @github/text-expander-element 的常见问题

@github/text-expander-element 是什么?

Activates a suggestion menu to expand text snippets as you type.

如何安装 @github/text-expander-element?

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

@github/text-expander-element 支持 TypeScript 吗?

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

@github/text-expander-element 支持 ESM 还是 CommonJS?

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

@github/text-expander-element 可以商用吗?

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

@github/text-expander-element 的下载量有多少?

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

@github/text-expander-element 还在维护吗?

最新版本 2.9.4 发布于 2026/01/16(9 个月前);至今共发布 31 个版本,其中过去 12 个月发布了 1 个;首次发布于 2019/06/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。