Autocomplete

View pricing →

Pro installation quickstart 🚀

基本示例

自动完成输入框允许您在选项列表中进行搜索。在这个第一个示例中,让我们为 options 属性提供一个国家列表:

加载实时示例

定义选项

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

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

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

筛选

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

加载实时示例

空消息

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

加载实时示例

选择外观

自动完成输入框具有一个 selectionAppearance 属性,用于确定所选选项的显示方式。

文本输入

自动完成输入框将默认为 text-input 选择外观。当选择一个选项时,文本输入框将显示所选选项的标签:

加载实时示例

选项

或者,您可以将自动完成的选择外观设置为 option。在这种模式下,当进行选择时,文本输入框将被包含所选选项标签的 div 替换。此外,option 选择外观将呈现一个 removeSelection 按钮,单击该按钮将清除选择:

加载实时示例

插槽

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

选项插槽

在这个例子中,我们将使用选项插槽来显示汽车品牌及其徽标:

加载实时示例

选择插槽

如果您只想自定义所选选项的显示,请使用selection插槽:

加载实时示例

多选

自动完成支持多选,适用于text-inputoption选择外观。要启用多选,只需设置multiple属性。

使用 multiple 属性

设置multiple属性时,自动完成的值必须始终为数组。

文本输入多选

对于text-input选择外观,所选选项显示为逗号分隔的列表:

加载实时示例

选项多选

对于option选择外观,所选选项显示为一组divs,它们在文本输入框下方呈现:

加载实时示例

最大值

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

加载实时示例

选择后关闭

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

加载实时示例

加载选项

您可以将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 执行查找以获取其他数据,而不是使用 optionLoader 属性重新生成不在选项列表中的值。在此示例中,在选择一个选项后,我们将执行一个查找以加载所选选项的电影评论:

加载实时示例

完整示例

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

加载实时示例

属性 & 属性

PropType默认描述
debouncenumber200对选项函数调用进行去抖动的毫秒数。
optionsany[]用户可以从中选择的选项列表。
load-on-scrollbooleanfalse当设置为 `true` 时,下拉菜单将尝试根据最终用户的滚动位置加载更多选项
selection-appearancestringtext-input更改选项标签的显示方式。
multiplebooleanfalse允许多个选择。
open-on-clickbooleanfalse在输入框聚焦时展开自动完成,而不是等到输入搜索值时才展开。
filterfunctionnull用于为静态选项应用您自己的自定义过滤函数。
option-loaderfunctionnull用于为初始值进行水合,或执行额外的请求以加载所选选项的更多信息。
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为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。

部分

您可以通过使用该部分的"key"来定位输入的特定部分,从而可以修改该部分的类、HTML(通过:sections-schema)或内容(通过插槽)。了解更多关于部分的信息,请点击这里

自动完成的结构根据以下几种不同的情况而变化:

  • selection-appearance 是否设置为 text-input(默认值)或 option
  • 是否通过 multiple 属性启用多个选择。

选择外观 text-input

View on a larger screen to see this section diagram.

您最喜欢的运动员
Serena, Pelé
Tiger Pelé
搜索您最喜欢的运动员。
抱歉,找不到该运动员。

选择外观 option,单选

View on a larger screen to see this section diagram.

您最喜欢的运动员
Pelé
X
Tiger Pelé
搜索您最喜欢的运动员。
抱歉,找不到该运动员。

选择外观 option,多选

View on a larger screen to see this section diagram.

您最喜欢的运动员
Tiger Pelé
Pelé
X
搜索您最喜欢的运动员。
抱歉,找不到该运动员。

内部列表框结构

以下是上述图表中的内部选项列表(listbox)结构:

View on a larger screen to see this section diagram.

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包含消息的元素(或多个元素) - 最常见的是验证和错误消息。