Pro installation quickstart 🚀

基本示例

dropdown 输入允许用户从可自定义的选项列表中选择一个值:

加载实时示例

定义选项

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

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

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

空消息

如果没有传递选项,默认情况下,下拉输入将以禁用状态呈现。或者,您可以传递 empty-message prop 一个消息,以在没有可用选项时显示:

加载实时示例

插槽

与原生选择元素不同,dropdown 输入允许您使用标记自定义选项列表。

选项插槽

dropdown 输入允许您使用 option 插槽自定义每个选项的外观和感觉。在此示例中,我们使用 option 插槽显示每个选项的资产;徽标和名称:

加载实时示例

选择插槽

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

加载实时示例

加载选项

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

单个请求

假设我们有一个 API 端点,它返回了给定 dropdown 输入所需的所有选项。以下是我们如何编写 dropdown 输入以从单个请求加载选项的示例:

加载实时示例

在上面的示例中,我们将 options prop 分配给 loadHorrorMovies 函数。请求后,我们遍历结果以确保返回具有显式 valuelabel 属性的对象数组。

多个页面

如何从需要进行多次请求以执行分页的 API 中加载选项?当将函数设置为 options prop 时,它将作为参数传递给 FormKit 节点的 context 对象。在此 context 对象中有 pagehasNextPage 属性。page 属性是当前页码,hasNextPage 属性是在有更多页面要加载时要调用的函数:

加载实时示例

在上面的示例中,我们在确定有更多页面要加载时调用 hasNextPage。完成后,FormKit 在渲染的选项列表末尾附加一个 Load more 选项,并自动递增其 page 属性。当用户选择 Load more 选项时,将再次调用分配给 options prop 的函数,过程重复。

选项加载器

重新注入值

FormKit 的下拉输入还提供了一个 optionLoader prop,允许您重新注入不在选项列表中的值。在此示例中,我们将为自动完成提供一个初始值(电影 ID),并将 optionLoader 分配给一个将向 API 发出请求以获取电影的函数:

加载实时示例

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

获取其他数据

您可以使用 optionLoader 执行查找以获取其他数据,而不是使用 optionLoader prop 重新注入不在选项列表中的值。在此示例中,在选择一个选项后,我们将执行查找以加载所选选项的电影评论:

加载实时示例

滚动加载

如果您希望用户在不必单击选项列表底部的 Load more 选项的情况下加载更多选项,您可以将 load-on-scroll prop 设置为 true,然后我们的函数 loadCurrentlyPopularMovies 将再次被调用:

加载实时示例

完整示例

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

加载实时示例

超滚动

在使用具有静态选项的下拉菜单时,FormKit 的下拉菜单还具有一个名为 overscroll 的独特功能。在这个例子中,我们将看到将 overscroll 设置为 true 时的行为:

加载实时示例

属性和属性

PropType默认描述
optionsany[]用户可以从中选择的选项列表。
load-on-scrollbooleanfalse当设置为 `true` 时,下拉菜单将尝试根据最终用户的滚动位置加载更多选项
option-loaderfunctionnull用于为初始值进行水合,或执行额外的请求以加载所选选项的更多信息。
empty-messagestringundefined当没有选项可显示时,呈现一条消息。
显示 通用 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)或内容(通过插槽)。了解更多关于部分的信息,请点击这里

外部结构

View on a larger screen to see this section diagram.

选择 T 恤颜色
灰色
蓝色 灰色 棕色
打开和关闭音效。
发生了一些错误。

内部列表框结构

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

View on a larger screen to see this section diagram.

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