List

list 输入允许你将子输入的数据结构化为数组。列表本身默认不输出任何标记,并且可以与任何其他类型的输入一起使用 - 包括嵌套的和列表。

列表输入的值是一个数组,其中每个项都是该索引处的输入值。子输入不需要是相同的类型。除了结构化数据外,列表还可以确定验证状态,提供初始值,并向其所有子项提供插件和配置。

基本示例

加载实时示例
性能

Vue的方便的v-model在FormKit中得到了全面支持,即使在列表和组上也可以进行双向数据流。然而,如果你的表单需要极高的性能,考虑使用核心节点进行读/写,而不是v-model。

列表类型

有两种类型的列表:

  • 静态列表(默认)有预定的子项。它们不应用于迭代值或添加/删除项。
  • 动态列表允许迭代列表的值来创建其子项。它们对于创建动态长度的列表(如重复器)非常有用。

静态列表

静态列表是创建的最简单的列表类型。将任何输入包装在<FormKit type="list">中,这些输入将自动被设置为数组的值。列表的直接子项没有名称(即使指定了),而是总是由它们的索引来识别。在静态列表中,这个索引是稳定的,基于输入的顺序。

加载实时示例
迭代列表值

静态列表不应用于迭代它们自己的值。虽然迭代其他任意数据是安全的,但迭代列表本身的值会导致递归渲染和无限循环。相反,使用动态列表。

动态列表

动态列表允许你迭代列表的值来创建和填充列表内的输入。动态列表对于创建动态数组结构(如重复器)非常有用。

你可以通过从值数组中添加和删除项来改变你的动态列表的结构。FormKit将自动更新底层的表单结构以匹配新的值。

为了让动态列表保持你的数据同步,你必须使用默认插槽中的items来创建你的v-for,并且你还必须将v-forindex作为每个列表项的index属性传递。

FormKit Pro Repeater

要使用预构建的重复器,请查看免费的FormKit Pro repeater input

动态列表示例

加载实时示例

使用 v-model 的动态列表

加载实时示例

schema 中的动态列表

加载实时示例

子元素的有效性

列表(和)总是知道其子元素(包括嵌套子元素)的验证状态。您可以在输入的上下文对象(context.state.valid)中访问这些数据。

加载实时示例

显示错误和验证消息

尽管list可以有验证规则和输入错误,但默认情况下,它不包含显示验证消息和错误的任何功能。列表完全不包含HTML。如果您想显示这些错误 - 您可以将<FormKitMessages />添加为list的子元素。

配置

关于FormKitMessages组件的更多文档可以在表单文档页面上找到。

Props & Attributes

PropType默认描述
disabledBooleanfalse禁用列表中的所有输入。
dynamicBooleanfalse为列表启用动态模式,并在默认插槽中提供items,创建一个迭代器(v-for)。
显示 通用 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为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。

Sections

Section-key描述
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。