< filter- input > 元素 
在匹配过滤器输入文本的子树上显示元素 .
安装
$ npm install @github/filter-input-element
使用量
<filter-input aria-owns="robots">
<label>
Filter robots
<input type="text" autofocus autocomplete="off">
</label>
</filter-input>
<div id="robots">
<ul data-filter-list>
<li>Bender</li>
<li>Hubot</li>
<li>Wall-E</li>
<li>BB-8</li>
<li>R2-D2</li>
</ul>
<p data-filter-empty-state hidden>0 robots found.</p>
</div>
要素和属性
需求
filter-input[aria-owns]应该指向包罗全部的容器ID<filter-input>相关要素.filter-input应该有一个input用于过滤的儿童元素.[id]应设置在包含或有下列内容的容器上:[data-filter-list]属性.[data-filter-list]应设定为: 直接儿童因素 将被过滤.
可选
指定过滤文本
使用 [data-filter-item-text] 以指定一个其文本应用于过滤的元素。 在以下例子中,案文 (current) 将不匹配.
<div data-filter-list>
<a href="/bender">Bender</a>
<a href="/hubot">
<span data-filter-item-text>Hubot</span>
(current)
</a>
</div>
空盘
使用 [data-filter-empty-state] 以指定未找到结果时要显示的元素。 此元素必须在容器内 aria-owns 指点.
<div id="filter-list">
<div data-filter-list>
<a href="/bender">Bender</a>
<a href="/hubot">Hubot</a>
</div>
<div data-filter-empty-state hidden>No results found.</div>
</div>
创建新项目
使用 [data-filter-new-item] 以包含一个项目,在找不到精确匹配时创建新实例。 元素为 [data-filter-new-text]文本内容将设定为输入值。 您还可以使用 [data-filter-new-value] 为查询参数设置输入值.
<div id="filter-list">
<div data-filter-list>
<a href="/bender">Bender</a>
<a href="/hubot">Hubot</a>
</div>
<form action="/new" data-filter-new-item hidden>
<button name="robot" data-filter-new-item-value>
Create robot "<span data-filter-new-item-text></span>"
</button>
</form>
</div>
方法
filterInputElement.filter 可选择设置以提供替代过滤逻辑。 默认为下弦 .
const fuzzyFilterInput = document.querySelector('.js-fuzzy-filter-input')
fuzzyFilterInput.filter = (element, elementText, query) => {
// fuzzy filtering logic
return {match: boolean, hideNew: boolean}
}
match(所需)表示是否应当显示该项目. hideNew (可选)将确定是否应当隐藏“创建新项目”元素。 例如,当找到精确匹配时,"创建新项目"选项应该被隐藏.
活动
filter-input-start(泡泡) - 开火<filter-input>当过滤动作即将启动时.filter-input-updated(泡泡) - 开火<filter-input>当过滤器完成时.event.detail.count找到匹配次数,以及event.detail.total是元素的总数.
为确保客户端更新以辅助技术传播, filter-input-updated 事件可以用来更新过滤结果来筛选阅读器。 例如:
const ariaLiveContainer = document.querySelector('[aria-live="assertive"]')
document.addEventListener('filter-input-updated', event => {
ariaLiveContainer.textContent = `${event.detail.count} results found.`
})
有关此技术的详情,请查看 改善GOV.UK搜索的无障碍环境。 。 。 .
浏览器支持
浏览器, 不本地 自定义元素支持 需要一个 多边填充。 。 。 .
- 颜色
- 火花
- 萨法里
- 微软边缘
发展
npm install
npm test
许可证
以麻省理工学院许可证分发。 详情见LICENSE.