@anypoint-web-components/anypoint-autocomplete

中文文档
0.2.13发布于 2021/10/16Apache-2.0ESM + CJS近 30 天下载 3283

用于输入的任意点样式自动完成 .

中文使用文档
文档目录12 节
  1. 使用量
  2. 安装
  3. 在 HTML 文档中
  4. 同步建议
  5. 在一个LitElement中
  6. 建议模式
  7. 无障碍
  8. 你的密码
  9. 初始化后
  10. 发展
  11. 本地运行演示
  12. 运行测试

折旧

此组件已移至 anypoint-web-components/awc。 。 。 .


本构成部分以材料设计清单为基础.

任意点网络组件是允许在开源项目中构建任意点启用的UI的组件集.

该要素使输入字段的建议清单易于查阅.

Build Status

tests

使用量

安装

npm install --save @anypoint-web-components/anypoint-autocomplete

在 HTML 文档中

<html>
  <head>
    <script type="module">
      import '@anypoint-web-components/anypoint-autocomplete/anypoint-autocomplete.js';
      import '@anypoint-web-components/anypoint-input/anypoint-input.js';
    </script>
  </head>
  <body>
    <div class="parent">
      <anypoint-input id="targetInput"></anypoint-input>
      <anypoint-autocomplete target="targetInput"></anypoint-autocomplete>
    </div>

    <script>
    {
      document.querySelector('anypoint-autocomplete').source = [
        'a',
        'b',
        'c',
        'd'
      ];
    }
    </script>
  </body>
</html>

同步建议

当输入值改变自动完成调度时 query 活动。 您的应用程序应该处理此事件, 为用户生成建议, 并设置 source 属性.

向用户显示您可以设置的建议同步 loader 属性。 它使一个进步栏,直到源财产改变.

<div class="parent">
  <anypoint-input id="targetInput"></anypoint-input>
  <anypoint-autocomplete target="targetInput"></anypoint-autocomplete>
</div>
<script>
{
  document.querySelector('anypoint-autocomplete').onquery = (e) => {
    const { value } = e.detail;
    const suggestions = await getAsyncSuggestions(value);
    e.target.source = suggestions;
  };
}
</script>

在一个LitElement中

import { LitElement, html } from 'lit-element';
import '@anypoint-web-components/anypoint-autocomplete/anypoint-autocomplete.js';
import '@anypoint-web-components/anypoint-input/anypoint-input.js';

class SimpleElement extends ControlStateMixin(ButtonStateMixin(LitElement)) {
  render() {
    return html`
    <div class="parent">
      <anypoint-input id="targetInput"></anypoint-input>
      <anypoint-autocomplete
        target="targetInput"
        loader
        .source="${this.suggestions}"
        @query="${this._handleQuery}"></anypoint-autocomplete>
    </div>
    `;
  }

  async _handleQuery(e) {
    const { value } = e.detail;
    this.suggestions = await getAsyncSuggestions(value);
  }
}
window.customElements.define('simple-element', SimpleElement);

建议模式

{
  "value": "Required, string. The value to insert into the input field",
  "label": "Optional, string. When set this will be used as the drop down list label",
  "description": "Optional, string. When set it renders a second line for the suggestion with help message. Keep it short!"
}

无障碍

自动完成元素遵循 W3C 准则 ARIA 1. 1 有 Listbox 弹出式组合框。该元素可以支持屏幕阅读器.

由于屏幕阅读器如何剖析页面内容和关联角色,元素将建议作为自定义元素的儿童元素. 这意味着您可能会不慎给您主 CSS 文件列表项样式 .

因为自動完成元素和文本输入需要具有特定角色的母元素,所以将两个元素都放入单子母体内. 该元素注意在所有元素上设定角色和aria属性.

你的密码

<div class="parent">
  <anypoint-input id="targetInput"></anypoint-input>
  <anypoint-autocomplete target="targetInput"></anypoint-autocomplete>
</div>

初始化后

<div
  class="parent"
  role="combobox"
  aria-label="Text input with list suggestions"
  aria-expanded="true"
  aria-owns="paperAutocompleteInput7302"
  aria-haspopup="listbox">
  <anypoint-input
    id="targetInput"
    aria-autocomplete="list"
    autocomplete="off"
    aria-haspopup="true"
    aria-controls="paperAutocompleteInput63418"></anypoint-input>
  <anypoint-autocomplete
    target="targetInput"
    id="paperAutocompleteInput7302"
    aria-controls="paperAutocompleteInput63418"
    >
    <anypoint-dropdown>
      <anypoint-listbox
        aria-label="Use arrows and enter to select list item. Escape to close the list."
        role="listbox"
        aria-activedescendant=""
        id="paperAutocompleteInput63418"></anypoint-listbox>
    </anypoint-dropdown>
  </anypoint-autocomplete>
</div>

你可以设置 aria-label 以覆盖默认信件。 然而,其他属性总是被改变以符合无障碍要求.

发展

git clone https://github.com/anypoint-web-components/anypoint-autocomplete
cd anypoint-autocomplete
npm install

本地运行演示

npm start

运行测试

npm test

版本与发布记录

@anypoint-web-components/anypoint-autocomplete 共发布 19 个版本,首次发布于 2019/08/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.13latest2021/10/165 年前
0.2.122021/08/185 年前
0.2.102021/06/015 年前
0.2.92021/03/225 年前
0.2.82020/12/235 年前
0.2.72020/10/046 年前

关于 @anypoint-web-components/anypoint-autocomplete 的常见问题

@anypoint-web-components/anypoint-autocomplete 是什么?

用于输入的任意点样式自动完成 .

如何安装 @anypoint-web-components/anypoint-autocomplete?

在项目目录运行 npm install @anypoint-web-components/anypoint-autocomplete,或使用 pnpm add / yarn add / bun add。

@anypoint-web-components/anypoint-autocomplete 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/anypoint-web-components__anypoint-autocomplete 是否存在。

@anypoint-web-components/anypoint-autocomplete 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@anypoint-web-components/anypoint-autocomplete 可以商用吗?

@anypoint-web-components/anypoint-autocomplete 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@anypoint-web-components/anypoint-autocomplete 的下载量有多少?

根据 npm 官方下载统计,@anypoint-web-components/anypoint-autocomplete 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,283 次,日均约 109 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@anypoint-web-components/anypoint-autocomplete 还在维护吗?

最新版本 0.2.13 发布于 2021/10/16(5 年前);至今共发布 19 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/08/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。