Pro installation quickstart 🚀

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

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

  • 具有 valuelabel 键的对象数组(参见上面的例子)
  • 字符串数组 ['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对象来完成。在这个对象中,我们可以使用pagehasNextPage属性。page属性是当前的页码,hasNextPage属性是一个在有更多页面需要加载时被调用的函数:

加载实时示例

加载样式

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

选项加载器

重新注入值

FormKit的taglist输入还提供了一个optionLoader属性,允许你重新注入不在选项列表中的值。在这个例子中,我们将为taglist提供一个初始值(一个电影ID),并将optionLoader分配给一个将向API发出请求获取电影的函数:

加载实时示例

注意在上面的例子中,optionLoader函数传递了两个参数:选定选项的value(在这种情况下,是电影ID)和cachedOption。cachedOption用于防止不必要的查找。如果cachedOption不是null,那么意味着已经加载了选定的选项,你可以直接返回cachedOption。

加载样式

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

创建时加载

如果你更愿意在创建taglist时加载选项,你可以将load-on-created属性设置为true,我们的函数loadCurrentlyPopularMovies将在用户无需展开列表框的情况下被调用:

加载实时示例

标签外观

就像taglist输入自动完成输入,taglist输入允许你利用插槽来自定义选项列表和选定选项的外观和感觉,通过利用无渲染组件模式

在这个例子中,我们将使用tag插槽来自定义标签的外观:

加载实时示例

行为属性

空消息

默认情况下,当过滤时没有找到搜索结果时,标签列表输入框不会展开列表框。您可以通过为 empty-message 属性分配一个消息来改变这种行为,当没有找到结果时显示该消息:

加载实时示例

最大值

max 属性允许您限制可以选择的选项数量。当达到 max 限制时,标签列表输入框将禁用列表框:

加载实时示例

选择后关闭

如果您希望标签列表的列表框在选择之间保持打开状态,将 close-on-select 属性设置为 false

加载实时示例

提交后重新加载

如果您希望用户提交选择后重新加载选项(对于静态选项,这将使用空字符串的值过滤选项,对于动态选项,这将使用空字符串的值向选项加载器发出请求),请使用 reload-on-commit 属性:

加载实时示例

点击打开

要启用点击其搜索输入时打开标签列表的列表框,将 open-on-click 属性设置为 true

加载实时示例

聚焦打开

如果您希望在其搜索输入被聚焦时打开标签列表的列表框,将 open-on-focus 属性设置为 true

加载实时示例
聚焦打开 vs 点击打开

聚焦打开包含点击打开。

移除后打开

如果您希望在选择被移除时展开列表框,使用 open-on-remove 属性:

加载实时示例

完整示例

现在让我们通过利用 tag 插槽进行自定义标记,并将 options 属性设置为一个将从 API 返回电影页面的函数,来结合我们到目前为止学到的内容:

加载实时示例

Props & Attributes

PropType默认描述
debouncenumber200对选项函数调用进行防抖的毫秒数。
optionsany[]用户可以从中选择的选项列表。
load-on-scrollbooleanfalse当设置为`true`时,taglist将尝试根据最终用户的滚动位置加载更多选项
open-on-clickbooleanfalse输入焦点时自动展开自动完成,而不是等待输入搜索值后再展开。
filterfunctionnull用于为静态选项应用自定义过滤函数。
option-loaderfunctionnull用于填充初始值,或执行额外的请求以加载所选选项的更多信息。
allow-new-valuesbooleanfalse允许最终用户输入在选项列表中不存在的新值。
disable-drag-and-dropbooleantrue禁止最终用户通过拖放对标签进行排序。
empty-messagestringundefined当没有选项可显示时,渲染一条消息。
maxnumberundefined限制可以选择的选项数量。
close-on-selectbooleantrue选择选项时关闭列表框。
open-on-removebooleanfalse当`selection-removable`属性设置为`true`时,删除选定值后,taglist不会打开。您可以通过将`open-on-remove`属性设置为`true`来改变这种行为。
open-on-focusbooleanfalse
options-appearancestringundefined对于多选taglist,此属性允许您自定义所选选项的外观和感觉。可能的值是`default`(默认)或`checkbox`。
always-load-on-openbooleanfalse当设置为`true`时,taglist将在打开列表框时始终加载选项。
load-on-createdbooleanfalse当设置为`true`时,taglist将在节点创建时加载选项。
显示 通用 props
configObject{}提供给 input 的节点和此输入的任何后代节点的配置选项。
delayNumber20在调度 commit hook 前,输入值的去抖动毫秒数。
dirtyBehaviorstringtouched确定此输入的“dirty”标志设置方式。可以设置为 touchedcompare — 默认为 touched,性能更好,但无法检测表单是否再次匹配其初始状态。
errorsArray[]要在此字段上显示的错误消息的字符串数组。
helpString''帮助文本与输入关联的文本。
idStringinput_{n}输入的唯一标识符。提供一个 id 还可以全局访问输入的节点。
ignoreBooleanfalse防止将输入包含在任何父级(组、列表、表单等)中。在仅用于 UI 而不是实际值的情况下非常有用。
indexNumberundefined如果父级是列表,允许在给定索引处插入输入。如果输入的值未定义,它将继承该索引位置的值。如果它有一个值,它将在给定索引处将其插入到列表的值中。
labelString''与输入关联的 label 元素的文本。
nameStringinput_{n}输入的名称,在数据对象中唯一标识。在一组字段中应该是唯一的。
parentFormKitNodecontextual默认情况下,父级是包装组、列表或表单,但此属性允许显式分配父级节点。
prefix-iconString''指定放置在 prefixIcon 部分的 图标
preservebooleanfalse在输入卸载时,在父组、列表或表单上保留输入的值。
preserve-errorsbooleanfalse默认情况下,使用 setErrors 在输入上设置的错误会在输入时自动清除,将此属性设置为 true 可以保留错误,直到明确清除为止。
sections-schemaObject{}一个包含部分键和模式部分值的对象,其中每个模式部分应用于相应的部分。
suffix-iconString''指定放置在 suffixIcon 部分的 图标
typeStringtext要从库中渲染的输入类型。
validationString, Array[]要应用于输入的 验证 规则。
validation-visibilityStringblur确定何时显示输入的验证失败规则。有效值为 blurdirtylive
validation-labelString{label prop}确定在验证错误消息中使用的标签,默认情况下,如果可用,则使用 label 属性,否则使用 name 属性。
validation-rulesObject{}附加的自定义验证规则,可用于验证 prop。
valueAnyundefined为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。
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包含消息的元素(或多个元素) - 最常见的是验证和错误消息。