< 自动完成 > 元素
从服务器搜索结果自动完成输入值 .
安装
$ 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.