# @github/text-expander-element 中文文档

规范地址：https://npmcn.com/package/%40github/text-expander-element/

版本：2\.9\.4
npm 元数据更新时间：2026-10-15T16:21:05.131Z
中文译文更新时间：2026-11-16T11:00:20.941Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40github/text-expander-element
原文对照：https://npmcn.com/package/%40github/text-expander-element/?lang=original
项目主页：https://github.com/github/text-expander-element#readme
源码仓库：https://github.com/github/text-expander-element

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：79.3 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2019-06-12T22:21:58.926Z
- 最新版本发布：2026-01-15T17:37:30.541Z
- 近 30 天下载量：49858（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 1 个）

## 中文简介

激活一个建议菜单,以扩展您输入的文本片段.

## 安装

```sh
npm install @github/text-expander-element
```

也可以使用：`pnpm add @github/text-expander-element`、`yarn add @github/text-expander-element`、`bun add @github/text-expander-element`

## README

# < text-expander > 元素

激活一个建议菜单,以扩展您输入的文本片段.

## 安装

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

## 使用量

### 脚本

导入为 ES 模块 :

```js
import '@github/text-expander-element'
```

带有脚本标签 :

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

### 标记

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

## 属性

-   `keys` 是菜单激活密钥的空格分隔列表
-   `multiword` 定义扩展是否应使用几个词
    -   您可以提供一个空格分隔的激活键列表,该列表应支持多字匹配
-   `suffix` 是一个在扩展时附加到值的字符串,默认是一个单空字符

## 活动

**`text-expander-change`** 匹配密钥时,会开火。 单位 `event.detail` 您可以找到:

-   `key`: 匹配的密钥;例如: `:`。 。 。 .
-   `text`: 匹配文本;例如: `cat`,用于 `:cat`。 。 。 .
    -   如果 `key` 指定于 `multiword` 属性然后匹配的文本可以包含多个字;例如 `cat and dog` 页:1 `:cat and dog`。 。 。 .
-   `provide`: 获得菜单结果时要调用的函数。 需要一个 `Promise` 与 `{matched: boolean, fragment: HTMLElement}` 地点 `matched` 说明是否有建议,以及 `fragment` 是要在页面上显示的菜单内容.

```js
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}))
})
```

退回的碎片应当由过滤器组成 `[role=option]` 待选项目。 例如:

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

**`text-expander-value`** 当选定某一项时,会开火。 单位 `event.detail` 您可以找到:

-   `key`: 匹配的密钥;例如: `:`。 。 。 .
-   `item`: 所选项目。 这将是其中之一 `[role=option]`。用这个解决 `value`。 。 。 .
-   `value`: 用于替换查询的无效值占位符。 要替换文本查询,只需重新指定此值.
-   `continue`: 插入一个值后指定是否继续自动补全的布尔值。 默认为 `false`如果设置为 `true`,不会在插入值后添加空格,并且会继续开火 `text-expander-change` 活动.

```js
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`** 在下面之后发射 `input` 在 DOM 中更新了值。 单位 `event.detail` 您可以找到:

-   `input`编号: `HTMLInputElement` 或者说 `HTMLTextAreaElement` 刚刚有 `value` 对DOM的承诺.

```js
const expander = document.querySelector('text-expander')

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

**`text-expander-activate`** 在菜单被指定并附在DOM之后即被发射,就在它即将被定位到文本以扩展之前。 用于指定类或调用显示菜单的必备方法, 例如 `.showPopover()`。 。 。 .

**`text-expander-deactivate`** 在菜单未分配和从DOM中取出之前就被解雇了 这对删除类或运行清除如从缓存中去除是有用的.

## 浏览器支持

浏览器, 不本地 [自定义元素支持](https://caniuse.com/#feat=custom-elementsv1) 需要一个 [多边填充](https://github.com/webcomponents/custom-elements)。 。 。 .

-   颜色
-   火花
-   萨法里
-   微软边缘

## 发展

```
npm install
npm test
```

## 许可证

以麻省理工学院许可证分发。 详情见LICENSE.

## 常见问题

### @github/text-expander-element 是什么？

激活一个建议菜单,以扩展您输入的文本片段\.

### 如何安装 @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 和提交记录判断。

