@github/auto-complete-element

中文文档
3.8.0发布于 2025/03/12MITTypeScriptES Module近 30 天下载 17.2万

服务器结果自动完成输入值

中文使用文档
文档目录16 节
  1. 安装
  2. 使用量
  3. 脚本
  4. 标记
  5. 清除按钮上的注释
  6. 属性
  7. 属性
  8. 活动
  9. 网络请求生命周期事件
  10. 自动完成事件
  11. CSP 信任类型
  12. 浏览器支持
  13. 发展
  14. 无障碍测试
  15. 校验工程中的用途
  16. 许可证

< 自动完成 > 元素

从服务器搜索结果自动完成输入值 .

安装

$ npm install --save @github/auto-complete-element

使用量

脚本

导入为 ES 模块 :

import '@github/auto-complete-element'

带有脚本标签 :

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

标记

<auto-complete src="/users/search" for="users-popup">
  <input type="text" name="users">
  <!--
    Optional clear button:
    - id must match the id of the input or the name of the input plus "-clear"
    - recommended to be *before* UL elements to avoid conflicting with their blur logic

    Please see Note below on this button for more details
  -->
  <button id="users-clear">X</button>
  <ul id="users-popup"></ul>
  <!--
    Optional div for screen reader feedback. Note the ID matches the ul, but with -feedback appended.
    Recommended: Use a "Screen Reader Only" class to position the element off the visual boundary of the page.
  -->
  <div id="users-popup-feedback" class="sr-only"></div>
</auto-complete>

如果您要启用自动选择( 按 Enter 在输入中将选择第一个选项) , 请使用上述示例 :

<auto-complete data-autoselect="true" src="/users/search" for="users-popup">
...
</auto-complete>

服务器响应应当包括匹配搜索查询的项目.

<li role="option">Hubot</li>
<li role="option">Bender</li>
<li role="option">BB-8</li>
<li role="option" aria-disabled="true">R2-D2 (powered down)</li>

这个 data-autocomplete-value 属性可用于定义一个 显示文本需要不同的项目:

<li role="option" data-autocomplete-value="bb8">BB-8 (astromech)</li>

使用 data-no-result-found="true" 在自动完成弹出器内显示无结果信息。 确定要添加 role="presentation" 至此元素, 这样屏幕阅读器不会将它误认为是自动完成选项 。 自动完成组件在功能中构建 处理 aria- live 宣布搜索结果的数量, 因此这应该是纯装饰性的 .

<li role="presentation" aria-hidden="true" data-no-result-found="true">No results found!</li>

清除按钮上的注释

虽然 input type="search" 带着一个 x 因此我们选择启用一个自定义的清晰按钮,以便键盘用户能够与之互动.

例如:

在克罗姆语中,这个"x"不是一个按钮而是一个带有伪="-webkit-search-cancel-按钮"的div. 它没有标签索引或者没有鼠标的导航方法. 此外,这个控制只在鼠标徘徊时可见.

属性

  • open 当自动完整结果列表可见时为真
  • value 清除时是列表中选定的值或空字符串

属性

  • fetchResult 您可以通过压倒此属性来推翻用于查询结果的默认方法 : document.querySelector('auto-complete').fetchResult = async (url) => (await fetch(url)).text()

活动

网络请求生命周期事件

请求的生命周期活动于 <auto-complete> 键。 这些事件不会发泡.

  • loadstart - 服务器抓取开始 .
  • load - 网络请求成功完成.
  • error - 网络请求失败 .
  • loadend - 网络请求已完成.

网络事件对显示飞行中请求时的进展状态很有用.

const completer = document.querySelector('auto-complete')
const container = completer.parentElement
completer.addEventListener('loadstart', () => container.classList.add('is-loading'))
completer.addEventListener('loadend', () => container.classList.remove('is-loading'))
completer.addEventListener('load', () => container.classList.add('is-success'))
completer.addEventListener('error', () => container.classList.add('is-error'))

自动完成事件

auto-complete-change 在选定一个值后发送。 单位 event 您可以找到:

  • relatedTarget: HTML 输入元素控制自动完整结果列表.
completer.addEventListener('auto-complete-change', function(event) {
  console.log('Auto-completed value chosen or cleared', completer.value)
  console.log('Related input element', event.relatedTarget)
})

CSP 信任类型

你可以打电话 setCSPTrustedTypesPolicy(policy: TrustedTypePolicy | Promise<TrustedTypePolicy> | null) 从 Java 脚本设置 CSP 信任的类型政策,可以执行 (同步)过滤或拒绝 fetch 在答复之前 插入到页面中 :

import AutoCompleteElement from 'auto-complete-element'
import DOMPurify from 'dompurify' // Using https://github.com/cure53/DOMPurify

// This policy removes all HTML markup except links.
const policy = trustedTypes.createPolicy('links-only', {
  createHTML: (htmlText: string) => {
    return DOMPurify.sanitize(htmlText, {
      ALLOWED_TAGS: ['a'],
      ALLOWED_ATTR: ['href'],
      RETURN_TRUSTED_TYPE: true
    })
  }
})
AutoCompleteElement.setCSPTrustedTypesPolicy(policy)

该政策可进入 fetch 响应对象。 由于平台 限制,只有来自响应的同步信息(除 HTML 文本正文)可以在策略中被使用:

import AutoCompleteElement from 'auto-complete-element'

const policy = trustedTypes.createPolicy('require-server-header', {
  createHTML: (htmlText: string, response: Response) => {
    if (response.headers.get('X-Server-Sanitized') !== 'sanitized=true') {
      // Note: this will reject the contents, but the error may be caught before it shows in the JS console.
      throw new Error('Rejecting HTML that was not marked by the server as sanitized.')
    }
    return htmlText
  }
})
AutoCompleteElement.setCSPTrustedTypesPolicy(policy)

注意:

  • 只有单一的政策可以制定,由所有人共享 AutoCompleteElement 获取.
  • 你应该打电话 setCSPTrustedTypesPolicy() 在任何其他负载之前 auto-complete 代码中的元素.
    • 如果您的政策本身需要同步工作来构建, 您也可以 通过一个 Promise<TrustedTypePolicy>。 。 。 .
    • 过 null 以删除保险单.
  • 不是所有的浏览器 支持 JavaScript 中信任的 API 类型。 。 。 . 你也许想用 建议的微量填充 改为 构建一个不在其他浏览器中引起问题的策略.

浏览器支持

浏览器, 不本地 自定义元素支持 需要一个 多边填充。 。 。 .

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

发展

npm install
npm test

要查看本地更改, 运行 npm run examples。 。 。 .

单位 examples/index.html,无注释 <!--<script type="module" src="./dist/bundle.js"></script>--> 并评论脚本参考 unpkg 版本。 这允许您使用 src 密码在这个repo。 否则, 您将绘制最新发布的代码, 它不会反映您正在做的本地更改 .

无障碍测试

我们列入了一些习惯规则,帮助提供护栏,确认这一构成部分正在被无障碍地使用.

如果你正在使用 axe-core 图书馆在您的项目中,

import axe from 'axe-core'
import autoCompleteRulesBuilder from '@github/auto-complete-element/validator'

const autoCompleteRules = autoCompleteRulesBuilder() // optionally, pass in your app's custom rules object, it will build and return the full object

axe.configure(autoCompleteRules)
axe.run(document)

校验工程中的用途

为了确认你的用法符合设计,

import {validate} from '@github/auto-complete-element/validator' 

validate(document)

出入证和故障可按 passes 财务报告和审定财务报表 violations 返回对象上的数组 :

{
  passes: [],
  violations: []
}

许可证

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

版本与发布记录

@github/auto-complete-element 共发布 37 个版本,首次发布于 2018/04/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.8.0latest2025/03/121.7 年前
3.7.12025/02/141.8 年前
3.6.22024/03/062 年前
3.6.12024/02/232 年前
3.6.02023/11/133 年前
3.5.12023/07/043 年前

关于 @github/auto-complete-element 的常见问题

@github/auto-complete-element 是什么?

服务器结果自动完成输入值

如何安装 @github/auto-complete-element?

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

@github/auto-complete-element 支持 TypeScript 吗?

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

@github/auto-complete-element 支持 ESM 还是 CommonJS?

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

@github/auto-complete-element 可以商用吗?

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

@github/auto-complete-element 的下载量有多少?

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

@github/auto-complete-element 还在维护吗?

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