Introducing KickStart — AI generated FormKit forms in seconds. Generate from a screenshot, edit with drag-and-drop or conversational AI, copy & paste as components or schema!
Try for free

Taglist

View pricing →

专业安装快速启动 :rocket:

taglist 输入允许用户搜索选项列表并应用任意数量的标签。用户还可以拖放标签以重新排序：

options 属性可以接受三种不同格式的值：

一个包含 value 和 label 键的对象数组（见上面的示例）
一个字符串数组 ['A', 'B', 'C']
一个键值对的对象字面量 { a: 'A', b: 'B', c: 'C' }
一个返回上述任何一种的函数

空选项

如果你将选项指定为一个空数组，输入将以禁用状态呈现。

基本示例

taglist 输入允许用户搜索选项列表并应用任意数量的标签。用户还可以拖放标签以重新排序：

加载实时示例

过滤

标签列表输入将使用其内部搜索功能过滤选项。你可以通过提供自己的 filter 属性函数来替换这个搜索功能。你的函数将接收两个参数，正在迭代的 option 和当前的 search 值：

加载实时示例

允许新值

与下拉菜单或自动完成输入不同，标签列表输入允许你输入任意值（不在选项列表中的值）。这对于即时创建新标签非常有用。要启用此功能，请将 allow-new-values 属性设置为 true。

加载实时示例

动态选项

你可以将 options 属性指定为一个函数，而不是传递一个静态列表。当你需要从API或其他来源加载选项时，这样做非常有用。

搜索参数

在这个示例中，我们将 options 属性指定为 searchMovies 函数。这样做，searchMovies 将接收 context 对象作为参数。在这个 context 对象中有一个 search 属性，它是当前的搜索值。为了执行我们的搜索，我们将使用 search 值作为我们API请求的查询参数：

加载实时示例

页面和 hasNextPage 参数

你可能会遇到的一个常见场景是需要搜索分页的 API。这可以通过引用前面提到的相同的 context 对象来完成。在这个对象中，我们可以使用 page 和 hasNextPage 属性。page 属性是当前的页码，而 hasNextPage 属性是一个在有更多页面需要加载时调用的函数：

加载实时示例

加载样式

你可以设置 loadOnScroll 属性为 true，这样就不需要用户点击 加载更多 按钮来加载额外的选项，而是在滚动到选项列表底部时自动分页加载选项。

选项加载器

重新填充值

FormKit 的标签列表输入框还提供了一个 optionLoader 属性，允许你重新填充不在选项列表中的值。在这个例子中，我们将为标签列表提供一个初始值（一个电影 ID），并将 optionLoader 指定为一个函数，该函数将向 API 发出请求以获取电影：

加载实时示例

请注意，在上面的例子中，optionLoader 函数传递了两个参数：所选选项的 value（在这种情况下是电影 ID）和 cachedOption。cachedOption 用于防止不必要的查找。如果 cachedOption 不是 null，这意味着所选选项已经被加载过了，你可以直接返回 cachedOption。

加载实时示例

聚焦时打开 vs 点击时打开

聚焦时打开包含了点击时打开。

Prop	Type	默认	描述
debounce	number	200	延迟调用选项函数的毫秒数。
options	any	[]	用户可以从中选择的选项列表。
load-on-scroll	boolean	false	设置为 `true` 时，taglist 将尝试根据最终用户的滚动位置加载更多选项。
open-on-click	boolean	false	自动完成在输入焦点时展开，而不是等到输入搜索值后才展开。
filter	function	null	用于对静态选项应用自定义过滤函数。
option-loader	function	null	用于初始化值的水合作用，或执行额外的请求以加载所选选项的更多信息。
allow-new-values	boolean	false	允许最终用户输入一个在选项列表中不存在的新值。
disable-drag-and-drop	boolean	true	禁止最终用户通过拖放来排序标签。
empty-message	string	undefined	当没有选项可显示时，渲染一条消息。
max	number	undefined	限制可以选择的选项数量。
close-on-select	boolean	true	选择一个选项时关闭列表框。
open-on-remove	boolean	false	当 `selection-removable` 属性设置为 `true` 时，移除所选值后 taglist 不会打开。您可以通过将 `open-on-remove` 属性设置为 `true` 来改变这种行为。
open-on-focus	boolean	false
options-appearance	string	undefined	对于多选 taglist，此属性允许您自定义所选选项的外观和感觉。可能的值有 `default`（默认值）或 `checkbox`。
always-load-on-open	boolean	true	确定 taglist 在打开时是否应始终加载其选项，或者是否应参考之前打开时找到的选项。
load-on-created	boolean	false	设置为 `true` 时，taglist 将在节点创建时加载选项。
popover	boolean	false	使用浏览器 Popover API 渲染输入的列表框。
显示通用 props
config	Object	{}	提供给 input 的节点和此输入的任何后代节点的配置选项。
delay	Number	20	在调度 `commit` hook 前，输入值的去抖动毫秒数。
dirtyBehavior	string	touched	确定此输入的“dirty”标志设置方式。可以设置为 `touched` 或 `compare` — 默认为 `touched`，性能更好，但无法检测表单是否再次匹配其初始状态。
errors	Array	[]	要在此字段上显示的错误消息的字符串数组。
help	String	''	帮助文本与输入关联的文本。
id	String	input_{n}	输入的唯一标识符。提供一个 id 还可以全局访问输入的节点。
ignore	Boolean	false	防止将输入包含在任何父级（组、列表、表单等）中。在仅用于 UI 而不是实际值的情况下非常有用。
index	Number	undefined	如果父级是列表，允许在给定索引处插入输入。如果输入的值未定义，它将继承该索引位置的值。如果它有一个值，它将在给定索引处将其插入到列表的值中。
label	String	''	与输入关联的 `label` 元素的文本。
name	String	input_{n}	输入的名称，在数据对象中唯一标识。在一组字段中应该是唯一的。
parent	FormKitNode	contextual	默认情况下，父级是包装组、列表或表单，但此属性允许显式分配父级节点。
prefix-icon	String	''	指定放置在 `prefixIcon` 部分的图标。
preserve	boolean	false	在输入卸载时，在父组、列表或表单上保留输入的值。
preserve-errors	boolean	false	默认情况下，使用 `setErrors` 在输入上设置的错误会在输入时自动清除，将此属性设置为 true 可以保留错误，直到明确清除为止。
sections-schema	Object	{}	一个包含部分键和模式部分值的对象，其中每个模式部分应用于相应的部分。
suffix-icon	String	''	指定放置在 `suffixIcon` 部分的图标。
type	String	text	要从库中渲染的输入类型。
validation	String, Array	[]	要应用于输入的验证规则。
validation-visibility	String	blur	确定何时显示输入的验证失败规则。有效值为 `blur`、`dirty` 和 `live`。
validation-label	String	{label prop}	确定在验证错误消息中使用的标签，默认情况下，如果可用，则使用 `label` 属性，否则使用 `name` 属性。
validation-rules	Object	{}	附加的自定义验证规则，可用于验证 prop。
value	Any	undefined	为输入和/或其子元素提供初始值。不是响应式的。可以种子整个组（表单）和列表。

Section-key	描述
selector	选择器部分是一个按钮元素，用于打开 taglist 选项列表。
selections	包含单独的选择部分。
selection	包含所选选项。
listitem	包含选项部分的列表项元素。
option	包含选项内容的 div。
listbox	列表框部分是一个 ul 元素，包含选项列表。
taglistWrapper	包裹列表框部分。一个处理列表框滚动的 div。
optionLoading	在选项加载时，条件性渲染在所选选项内的 span 元素。
loaderIcon	在加载发生时，用于在选择器元素中输出图标的元素。
selectIcon	在 taglist 关闭时，用于在选择器元素中输出图标的元素。
loadMore	当有更多页面需要加载时，条件性渲染在选项列表底部的列表项元素。
loadMoreInner	在 loadMore 部分内作为 loaderIcon 包裹的 span 元素。
removeSelection	用于移除特定选择的按钮元素。
closeIcon	在 removeSelection 按钮内输出图标的元素。
listboxButton	用于打开 taglist 的按钮元素。
emptyMessage	当没有选项可显示时，条件性渲染的列表项元素。
emptyMessageInner	作为 emptyMessage 部分包裹的 span 元素。
显示通用 section keys
outer	最外层的包装元素。
wrapper	标签和输入周围的包装器。
label	输入的标签。
prefix	默认情况下没有输出，但允许直接在输入元素之前放置内容。
prefixIcon	输出在前缀部分之前放置一个图标的元素。
inner	实际输入元素周围的包装器。
suffix	默认情况下没有输出，但允许直接在输入元素之后放置内容。
suffixIcon	输出在后缀部分之后放置一个图标的元素。
input	输入元素本身。
help	包含帮助文本的元素。
messages	包装所有消息的容器。
message	包含消息的元素（或多个元素） - 最常见的是验证和错误消息。

无障碍性

所有 FormKit 输入都是考虑到以下无障碍性因素而设计的。通过在此处提交无障碍性问题，帮助我们不断改进所有人的无障碍性：

语义标记Aria 属性可通过键盘访问焦点指示器与提供的主题的颜色对比可访问标签、帮助文本和错误

部分键	属性	默认	描述
input	tabindex	0	通过将其设置为0来优先考虑键盘焦点顺序。
	role	combobox	向辅助技术表明此元素的功能为组合框。
	readonly		限制用户编辑，确保数据完整性和受控的、信息性的用户体验。
	aria-autocomplete	list	指导输入建议，呈现一系列可能完成用户输入的值。
	aria-expanded		在元素聚焦时传达可展开状态。
	aria-controls		将列表框元素与此元素关联。
	aria-describedby		将元素与描述关联，帮助屏幕阅读器。
	aria-activedescendant		管理焦点到当前活动的后代元素。
listboxButton	tabindex	-1	通过将其设置为-1来优先考虑键盘焦点顺序。
	aria-haspopup	true	表示一个元素触发弹出窗口或菜单
	aria-expanded		在元素聚焦时传达可展开状态。
	aria-controls		将列表框元素与此元素关联。
tagWrapper	tabindex	-1	通过将其设置为-1来优先考虑键盘焦点顺序。
tag	role	button	向辅助技术表明此元素的功能为按钮。
tags	aria-live	polite	当选择在屏幕上时，传达动态内容变化。
removeSelection	tabindex	-1	移除此元素上键盘焦点的优先级。
	aria-controls		将输入元素与此元素关联。
显示通用部分键
label	label	for	将其与输入元素关联，提高可访问性和用户体验
input	input	disabled	禁用 HTML 元素，阻止用户交互并指示非交互状态
		aria-describedby	通过将元素与描述关联，增强可访问性，帮助屏幕阅读器
		aria-required	当需要验证时，添加所需的状态
icon	icon	for	每当将图标定义为标签时，将其与输入元素关联，增强可访问性和用户体验

键盘交互

键盘事件	描述
`Tab`	将焦点移动到页面上的下一个可聚焦输入。
`Shift` + `Tab`	将焦点移动到页面上的上一个可聚焦输入。

文档

入门指南

基本要素

输入框

插件

指南

API 参考文档

工具

关于

赞助商

入门指南

基本要素

输入框

插件

指南

Taglist

专业安装快速启动 :rocket:

文档

工具

关于

注册获取最新消息