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

Autocomplete

View pricing →

专业安装快速启动 :rocket:

autocomplete 输入框允许你从选项列表中搜索。

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

  • 一个包含 valuelabel 键的对象数组(见上面的例子)
  • 一个字符串数组 ['A', 'B', 'C']
  • 一个键值对的对象字面量 { a: 'A', b: 'B', c: 'C' }
  • 一个返回以上任何一种的函数
空选项

如果你将选项设置为一个空数组,输入框将以禁用状态呈现。

基本示例

单选

默认情况下,自动完成输入框将以单选模式呈现:

加载实时示例

多选

通过设置 multiple 属性,自动完成输入框将以多选模式呈现:

加载实时示例
多选输入框的值

请注意,在上面的示例中,因为设置了 multiple 属性,value 属性必须是一个数组。

过滤

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

加载实时示例

动态选项

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

搜索参数

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

加载实时示例

页面和 hasNextPage 参数

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

加载实时示例

选项加载器

重新填充值

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

加载实时示例

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

加载样式

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

创建时加载

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

加载实时示例

选项外观

选项插槽

自动完成输入框允许你使用选项插槽来自定义每个选项的外观和感觉。在这个例子中,我们使用选项插槽来显示每个选项的资产;标志和名称:

加载实时示例

选择外观

自动完成输入框允许你自定义所选选项的外观和感觉。

选择外观属性

自动完成输入框允许您使用 selection-appearance 属性自定义所选选项的外观。无论是单选还是多选自动完成,您都可以将 selection-appearance 属性设置为 text-input(默认)或 option

加载实时示例

选择插槽

如果您只想自定义所选选项的显示,将选择外观设置为 option

加载实时示例

行为属性

空消息

默认情况下,当过滤时没有搜索结果时,自动完成输入框不会展开列表框。您可以通过为 empty-message 属性分配消息来更改此行为,以在找不到结果时显示:

加载实时示例

选择后关闭

如果您希望在选择值后列表框保持展开状态,可以将 close-on-select 设置为 false

加载实时示例

提交后重新加载

如果您希望用户提交选择时重新加载选项,请使用 reload-on-commit 属性:

加载实时示例

点击时打开

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

加载实时示例

聚焦时打开

如果您希望每次点击输入框时都打开自动完成的列表框,请将 open-on-focus 属性设置为 true

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

如果使用了 open-on-focus,则会隐式设置 open-on-click

打开时清除搜索

仅适用于单选自动完成,如果您希望在打开列表框时清除搜索输入,请设置 clear-search-on-open 属性:

加载实时示例

可移除选择

对于单选自动完成,您可以设置 selection-removable 属性。当设置为 true 时,选中选项旁边将显示一个移除按钮。对于选择外观为 option 的自动完成,默认情况下此属性设置为 true

仅限单选

selection-removable 属性不能用于多选。

加载实时示例

移除时打开

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

加载实时示例

最大值

如果您希望限制可以选择的选项数量,您可以使用 max 属性:

加载实时示例

完整示例

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

加载实时示例

属性 & 属性

PropType默认描述
debouncenumber200对选项函数调用进行去抖动的毫秒数。
optionsany[]用户可以从中选择的选项列表。
load-on-scrollbooleanfalse当设置为 `true` 时,自动完成将尝试根据最终用户的滚动位置加载更多选项
selection-appearancestringtext-input更改选项标签的显示方式。
multiplebooleanfalse允许多选。
open-on-clickbooleanfalse自动完成在输入焦点时展开,而不是等待输入搜索值后再展开。
filterfunctionnull用于对静态选项应用您自己的自定义过滤函数。
option-loaderfunctionnull用于初始化值的水合作用,或执行额外的请求以加载选中选项的更多信息。
empty-messagestringundefined当没有选项可显示时,渲染一条消息。
maxnumberundefined限制可以选择的选项数量。
open-on-removebooleanfalse当 `selection-removable` 属性设置为 `true` 时,移除选中值后自动完成不会打开。您可以通过将 `open-on-remove` 属性设置为 `true` 来改变这种行为。
open-on-focusbooleanfalse
options-appearancestringundefined对于多选自动完成,此属性允许您自定义选中选项的外观和感觉。可能的值有 `default`(默认值)或 `checkbox`。
always-load-on-openbooleantrue确定自动完成在打开时是否总是加载其选项,或者是否应该参考之前找到的选项。
load-on-createdbooleanfalse当设置为 `true` 时,自动完成将在节点创建时加载选项。
clear-search-on-openbooleanfalse当设置为 `true` 时,打开列表框时将清除搜索输入。
maxnumber | stringundefined如果您希望限制可以选择的选项数量,您可以使用 `max` 属性(仅适用于多选)。
popoverbooleanfalse使用浏览器 Popover API 渲染输入的列表框。
显示 通用 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包含消息的元素(或多个元素) - 最常见的是验证和错误消息。

无障碍性

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

语义标记Aria 属性可通过键盘访问焦点指示器与提供的主题的颜色对比可访问标签、帮助文本和错误
部分键属性默认描述
inputtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时),优先考虑键盘焦点顺序。
rolecombobox向辅助技术表明此元素的功能为组合框。
readonly限制用户编辑,确保数据完整性和受控的、信息性的用户体验。
aria-autocompletelist指导输入建议,呈现一系列可能完成用户输入的值。
aria-activedescendant管理焦点至当前活跃的后代元素。
aria-expanded在元素聚焦时传达可展开状态。
aria-controls将列表框元素与此元素关联。
listboxButtontabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时),优先考虑键盘焦点顺序。
rolebutton向辅助技术表明此元素的功能为按钮。
aria-haspopuptrue表示一个元素触发弹出窗口或菜单
aria-expanded在元素聚焦时传达可展开状态。
aria-controls将列表框元素与此元素关联。
aria-disabled在输入被禁用时传达禁用状态。
selectionWrappertabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时),优先考虑键盘焦点顺序。
selectionsaria-livepolite当选择项出现在屏幕上时,传达动态内容变化。
removeSelectiontabindex-1移除此元素的键盘焦点优先权。
aria-controls将输入元素与此元素关联。
显示 通用 部分键
labellabelfor将其与输入元素关联,提高可访问性和用户体验
inputinputdisabled禁用 HTML 元素,阻止用户交互并指示非交互状态
aria-describedby通过将元素与描述关联,增强可访问性,帮助屏幕阅读器
aria-required当需要验证时,添加所需的状态
iconiconfor每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验

键盘交互

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