Pro installation quickstart 🚀

基本示例

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

加载实时示例

定义选项

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

  • 具有 valuelabel 键的对象数组(参见上面的示例)
  • 一个字符串数组 'A', 'B', 'C'
  • 一个具有键值对的对象字面量 { a: 'A', b: 'B', c: 'C' }
  • 返回上述任何内容的函数
空选项

如果将选项分配为空数组,则输入将以禁用状态呈现。

筛选

标签列表输入将使用其自己的内部搜索功能筛选选项。您可以通过为 filter prop 提供一个自己的函数来替换此搜索功能。您的函数将接收两个参数,正在迭代的 option 和当前的 search 值:

加载实时示例

空消息

默认情况下,当在筛选过程中找不到搜索结果时,标签列表输入将关闭列表框。您可以通过为 empty-message prop 分配一个消息来更改此行为,以在找不到结果时显示:

加载实时示例

允许新值

与下拉或自动完成输入不同,标签列表输入允许您输入任意值(不在选项列表中的值)。这对于即时创建新标签很有用。要启用此功能,请将 allow-new-values prop 设置为 true

加载实时示例

最大值

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

加载实时示例

选择后关闭

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

加载实时示例

插槽

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

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

加载实时示例

加载选项

您可以将options属性分配给一个函数,而不是将静态选项列表传递给options属性。这样做在需要从API或其他来源加载选项时非常有用。

搜索参数

在这个例子中,我们将把options属性分配给searchMovies函数。这样做的话,searchMovies将接收context对象作为参数。在这个context对象中有一个search属性,它是当前的搜索值。为了执行我们的搜索,我们将使用search值作为API请求的查询参数:

加载实时示例

页面和hasNextPage参数

您可能会遇到的一个场景是需要通过分页API进行搜索。这可以通过引用与之前相同的context对象来完成。在这个对象中,我们可以使用pagehasNextPage属性。page属性是当前的页码,hasNextPage属性是在有更多页面需要加载时要调用的函数:

加载实时示例

加载样式

您可以将loadOnScroll属性设置为true,而不是要求用户单击加载更多按钮来加载其他选项,这样将在您滚动到选项列表底部时分页选项。

选项加载器

重新水合值

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

加载实时示例

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

获取额外数据

除了使用 optionLoader prop 重新生成不在选项列表中的值之外,您还可以使用 optionLoader 执行查找以获取额外数据,甚至只是修改选项的当前标签。在此示例中,我们将使用 optionLoader 获取电影的海报图像:

加载实时示例

完整示例

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

加载实时示例

Props & Attributes

PropType默认描述
debouncenumber200对选项函数调用进行去抖动的毫秒数。
optionsany[]用户可以从中选择的选项列表。
load-on-scrollbooleanfalse当设置为 `true` 时,下拉菜单将尝试根据最终用户的滚动位置加载更多选项
open-on-clickbooleanfalse在输入框聚焦时展开自动完成,而不是等待输入搜索值后展开。
filterfunctionnull用于为静态选项应用自定义过滤函数。
option-loaderfunctionnull用于为初始值进行水合,或执行额外请求以加载所选选项的更多信息。
allow-new-valuesbooleanfalse允许最终用户输入不存在于选项列表中的新值。
disable-drag-and-dropbooleantrue禁止最终用户通过拖放对标签进行排序。
empty-messagestringundefined当没有选项可显示时呈现一条消息。
maxnumberundefined限制可以选择的选项数量。
close-on-selectbooleantrue选择选项时关闭列表框。
显示 通用 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选择器部分是一个打开下拉选项列表的按钮元素。
selections包含单个选择部分。
selection包含所选选项。
listitem包含选项部分的列表项元素。
option包含选项内容的 div。
listbox列表框部分是一个包含选项列表的 ul 元素。
dropdownWrapper包装列表框部分。处理列表框滚动的 div。
optionLoading当加载发生时,在所选选项中有条件地呈现的 span 元素。
loaderIcon当加载发生时,在选择器元素中输出图标的元素。
selectIcon当下拉菜单关闭时,在选择器元素中输出图标的元素。
loadMore当有更多页面可加载时,在选项列表底部有条件地呈现的列表项元素。
loadMoreInner在 loadMore 部分内充当 loaderIcon 的包装器的 span 元素。
removeSelection用于删除特定选择的按钮元素。
closeIcon在 removeSelection 按钮内输出图标的元素。
listboxButton用于打开下拉菜单的按钮元素。
emptyMessage当没有选项可显示时有条件地呈现的列表项元素。
emptyMessageInner充当 emptyMessage 部分的包装器的 span 元素。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。