Chip 纸片

纸片组件用于辅助用户输入信息、进行选择、筛选内容或执行相关操作。

使用方法

按需导入组件：

import 'mdui/components/chip.js';

按需导入组件的 TypeScript 类型：

import type { Chip } from 'mdui/components/chip.js';

使用示例：

Chip

<mdui-chip>Chip</mdui-chip>

示例

形状

使用 variant 属性设置纸片的形状。纸片有 4 种形状，可以根据用途选择：

assist：用于显示与当前上下文相关的辅助操作。例如，在点餐页面，提供分享，收藏等功能。
filter：用于对内容进行筛选。例如，在搜索结果页，对搜索结果进行过滤。
input：用于表示用户输入的信息片段。例如，在 Gmail 中的“收件人”字段中的联系人。
suggestion：用于提供动态生成的推荐信息，以简化用户操作。例如，在聊天应用中猜测用户可能想发送的信息，供用户选择。

Assist

Filter

Input

Suggestion

<mdui-chip variant="assist">Assist</mdui-chip>
<mdui-chip variant="filter">Filter</mdui-chip>
<mdui-chip variant="input">Input</mdui-chip>
<mdui-chip variant="suggestion">Suggestion</mdui-chip>

源码

阴影

添加 elevated 属性可以使纸片拥有阴影。

Chip

<mdui-chip elevated>Chip</mdui-chip>

源码

图标

添加 icon、end-icon 属性，可以分别在纸片左侧、右侧添加 Material Icons 图标。也可以通过 icon、end-icon slot 在纸片左侧、右侧添加元素。

Icon

End Icon

Slot

<mdui-chip icon="search">Icon</mdui-chip>
<mdui-chip end-icon="arrow_forward">End Icon</mdui-chip>
<mdui-chip>
  Slot
  <mdui-icon slot="icon" name="downloading"></mdui-icon>
  <mdui-icon slot="end-icon" name="attach_file"></mdui-icon>
</mdui-chip>

源码

链接

添加 href 属性，可以使纸片变为链接，此时还可以使用这些和链接相关的属性：download、target、rel。

Link

<mdui-chip href="https://www.mdui.org" target="_blank">Link</mdui-chip>

源码

禁用及加载中状态

添加 disabled 属性可以禁用纸片；添加 loading 属性可以为纸片添加加载中状态。

Disabled

Loading & Disabled

<mdui-chip disabled>Disabled</mdui-chip>
<mdui-chip loading>Loading</mdui-chip>
<mdui-chip loading disabled>Loading & Disabled</mdui-chip>

源码

可选中

添加 selectable 属性可以使纸片可被选中。

Chip

<mdui-chip selectable>Chip</mdui-chip>

源码

使用 selected-icon 属性可以指定选中状态的 Material Icons 图标名称。也可以通过 selected-icon slot 指定选中状态的图标元素。

Chip

<mdui-chip selectable selected-icon="favorite">Chip</mdui-chip>
<mdui-chip selectable>
  Chip
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-chip>

源码

纸片被选中后，selected 属性变为 true。也可以通过添加 selected 属性，使纸片默认处于选中状态。

Chip

<mdui-chip selectable selected>Chip</mdui-chip>

源码

可删除

添加 deletable 属性后，纸片右侧会出现一个删除图标。点击该图标会触发 delete 事件。您可以通过 delete-icon 属性指定删除图标的 Material Icons 图标名，或者通过 delete-icon slot 指定删除图标的元素。

Chip

<mdui-chip deletable>Chip</mdui-chip>
<mdui-chip deletable delete-icon="backspace">Chip</mdui-chip>
<mdui-chip deletable>
  Chip
  <mdui-icon slot="delete-icon" name="backspace"></mdui-icon>
</mdui-chip>

源码

API

属性

HTML 属性	JavaScript 属性	类型	默认值
`variant`	`variant`	`'assist' \| 'filter' \| 'input' \| 'suggestion'`	`'assist'`
纸片的形状。可选值包括： `assist`：用于显示与当前上下文相关的辅助操作，如在点餐页面提供分享、收藏等功能 `filter`：用于对内容进行筛选，如在搜索结果页过滤搜索结果 `input`：用于表示用户输入的信息片段，如在 Gmail 的“收件人”字段中的联系人 `suggestion`：用于提供动态生成的推荐信息，以简化用户操作，如在聊天应用中预测用户可能想发送的信息
`elevated`	`elevated`	`boolean`	`false`
是否显示阴影
`selectable`	`selectable`	`boolean`	`false`
是否可选中
`selected`	`selected`	`boolean`	`false`
是否已选中
`deletable`	`deletable`	`boolean`	`false`
是否可删除。为 `true` 时，纸片右侧会显示删除图标
`icon`	`icon`	`string`	-
左侧的 Material Icons 图标名。也可以通过 `slot="icon"` 设置
`selected-icon`	`selectedIcon`	`string`	-
选中状态下左侧的 Material Icons 图标名。也可以通过 `slot="selected-icon"` 设置
`end-icon`	`endIcon`	`string`	-
右侧的 Material Icons 图标名。也可以通过 `slot="end-icon"` 设置
`delete-icon`	`deleteIcon`	`string`	-
可删除时，右侧删除图标的 Material Icons 图标名。也可以通过 `slot="delete-icon"` 设置
`href`	`href`	`string`	-
链接的目标 URL。如果设置了此属性，组件内部将渲染为 `<a>` 元素，并可以使用链接相关的属性。
`download`	`download`	`string`	-
下载链接的目标。 Note：仅在设置了 `href` 属性时，此属性才有效。
`target`	`target`	`'_blank' \| '_parent' \| '_self' \| '_top'`	-
链接的打开方式。可选值包括： `_blank`：在新窗口中打开链接 `_parent`：在父框架中打开链接 `_self`：默认。在当前框架中打开链接 `_top`：在整个窗口中打开链接 Note：仅在设置了 `href` 属性时，此属性才有效。
`rel`	`rel`	`'alternate' \| 'author' \| 'bookmark' \| 'external' \| 'help' \| 'license' \| 'me' \| 'next' \| 'nofollow' \| 'noreferrer' \| 'opener' \| 'prev' \| 'search' \| 'tag'`	-
当前文档与被链接文档之间的关系。可选值包括： `alternate`：当前文档的替代版本 `author`：当前文档或文章的作者 `bookmark`：永久链接到最近的祖先章节 `external`：引用的文档与当前文档不在同一站点 `help`：链接到相关的帮助文档 `license`：当前文档的主要内容由被引用文件的版权许可覆盖 `me`：当前文档代表链接内容的所有者 `next`：当前文档是系列中的一部分，被引用的文档是系列的下一个文档 `nofollow`：当前文档的作者或发布者不认可被引用的文件 `noreferrer`：不包含 `Referer` 头。类似于 `noopener` 的效果 `opener`：如果超链接会创建一个顶级浏览上下文（即 `target` 属性值为 `_blank`），则创建一个辅助浏览上下文 `prev`：当前文档是系列的一部分，被引用的文档是系列的上一个文档 `search`：提供一个资源链接，可用于搜索当前文件及其相关页面 `tag`：提供一个适用于当前文档的标签（由给定地址识别） Note：仅在指定了 `href` 属性时可用。
`autofocus`	`autofocus`	`boolean`	`false`
是否在页面加载完成后自动获取焦点
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 键切换焦点时的顺序
`disabled`	`disabled`	`boolean`	`false`
是否禁用
`loading`	`loading`	`boolean`	`false`
是否处于加载中状态
`name`	`name`	`string`	`''`
按钮的名称，将与表单数据一起提交。 Note：仅在未设置 `href` 属性时，此属性才有效。
`value`	`value`	`string`	`''`
按钮的初始值，将与表单数据一起提交。 Note：仅在未设置 `href` 属性时，此属性才有效。
`type`	`type`	`'submit' \| 'reset' \| 'button'`	`'button'`
按钮的类型。默认类型为 `button`。可选类型包括： `submit`：点击按钮会提交表单数据到服务器 `reset`：点击按钮会将表单中的所有字段重置为初始值 `button`：此类型的按钮没有默认行为 Note：仅在未指定 `href` 属性时，此属性才有效。
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。 Note：仅在未指定 `href` 属性时，此属性才有效。
`formaction`	`formAction`	`string`	-
指定提交表单的 URL。如果指定了此属性，将覆盖 `<form>` 元素的 `action` 属性。 Note：仅在未指定 `href` 属性且 `type="submit"` 时，此属性才有效。
`formenctype`	`formEnctype`	`'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`	-
指定提交表单到服务器的内容类型。可选值包括： `application/x-www-form-urlencoded`：未指定该属性时的默认值 `multipart/form-data`：当表单包含 `<input type="file">` 元素时使用 `text/plain`：HTML5 新增，用于调试如果指定了此属性，将覆盖 `<form>` 元素的 `enctype` 属性。 Note：仅在未指定 `href` 属性且 `type="submit"` 时，此属性才有效。
`formmethod`	`formMethod`	`'post' \| 'get'`	-
指定提交表单时使用的 HTTP 方法。可选值包括： `post`：表单数据包含在表单内容中，发送到服务器 `get`：表单数据以 `?` 作为分隔符附加到表单的 URI 属性中，生成的 URI 发送到服务器。当表单没有副作用，并且仅包含 ASCII 字符时，使用此方法如果设置了此属性，将覆盖 `<form>` 元素的 `method` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
`formnovalidate`	`formNoValidate`	`boolean`	`false`
如果设置了此属性，表单提交时将不执行表单验证。如果设置了此属性，将覆盖 `<form>` 元素的 `novalidate` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
`formtarget`	`formTarget`	`'_self' \| '_blank' \| '_parent' \| '_top'`	-
提交表单后接收到的响应应显示在何处。可选值包括： `_self`：默认选项，在当前框架中打开 `_blank`：在新窗口中打开 `_parent`：在父框架中打开 `_top`：在整个窗口中打开如果设置了此属性，将覆盖 `<form>` 元素的 `target` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`string`	-
如果表单验证未通过，此属性将包含提示信息。如果验证通过，此属性将为空字符串

方法

名称	参数	返回值
`click`		`void`
模拟鼠标点击元素
`focus`	`options: FocusOptions` (可选)	`void`
将焦点设置到当前元素。可以传入一个对象作为参数，该对象的属性包括： `preventScroll`：默认情况下，元素获取焦点后，页面会滚动以将该元素滚动到视图中。如果不希望页面滚动，可以将此属性设置为 `true`。
`blur`		`void`
移除当前元素的焦点
`checkValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`
`reportValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`。如果验证未通过，还会在组件上显示验证失败的提示。
`setCustomValidity`	`message: string`	`void`
设置自定义的错误提示文本。只要这个文本不为空，就表示字段未通过验证

事件

名称
`focus`
获得焦点时触发
`blur`
失去焦点时触发
`invalid`
表单字段验证未通过时触发
`change`
选中状态变更时触发
`delete`
点击删除图标时触发

Slots

名称
默认
纸片文本
`icon`
左侧元素
`end-icon`
右侧元素
`selected-icon`
选中状态下的左侧元素
`delete-icon`
可删除时的右侧删除元素

CSS Parts

名称
`button`
内部的 `<button>` 或 `<a>` 元素
`label`
纸片文本
`icon`
左侧图标
`end-icon`
右侧图标
`selected-icon`
选中状态下的左侧图标
`delete-icon`
可删除时的右侧删除图标
`loading`
加载中状态的 `<mdui-circular-progress>` 元素

CSS 自定义属性

名称
`--shape-corner`
组件的圆角大小。可以指定一个具体的像素值；但更推荐引用设计令牌

Checkbox 复选框

CircularProgress 圆形进度指示器