list
输入允许你将子输入的数据结构化为数组。列表本身默认不输出任何标记,并且可以与任何其他类型的输入一起使用 - 包括嵌套的组和列表。
列表输入的值是一个数组,其中每个项都是该索引处的输入值。子输入不需要是相同的类型。除了结构化数据外,列表还可以确定验证状态,提供初始值,并向其所有子项提供插件和配置。
Vue的方便的v-model
在FormKit中得到了全面支持,即使在列表和组上也可以进行双向数据流。然而,如果你的表单需要极高的性能,考虑使用核心节点进行读/写,而不是v-model。
有两种类型的列表:
静态列表是创建的最简单的列表类型。将任何输入包装在<FormKit type="list">
中,这些输入将自动被设置为数组的值。列表的直接子项没有名称(即使指定了),而是总是由它们的索引来识别。在静态列表中,这个索引是稳定的,基于输入的顺序。
静态列表不应用于迭代它们自己的值。虽然迭代其他任意数据是安全的,但迭代列表本身的值会导致递归渲染和无限循环。相反,使用动态列表。
动态列表允许你迭代列表的值来创建和填充列表内的输入。动态列表对于创建动态数组结构(如重复器)非常有用。
你可以通过从值数组中添加和删除项来改变你的动态列表的结构。FormKit将自动更新底层的表单结构以匹配新的值。
为了让动态列表保持你的数据同步,你必须使用默认插槽中的items
来创建你的v-for
,并且你还必须将v-for
的index
作为每个列表项的index
属性传递。
要使用预构建的重复器,请查看免费的FormKit Pro repeater input。
列表(和组)总是知道其子元素(包括嵌套子元素)的验证状态。您可以在输入的上下文对象(context.state.valid
)中访问这些数据。
尽管list
可以有验证规则和输入错误,但默认情况下,它不包含显示验证消息和错误的任何功能。列表完全不包含HTML。如果您想显示这些错误 - 您可以将<FormKitMessages />
添加为list
的子元素。
关于FormKitMessages
组件的更多文档可以在表单文档页面上找到。
Prop | Type | 默认 | 描述 |
---|---|---|---|
disabled | Boolean | false | 禁用列表中的所有输入。 |
dynamic | Boolean | false | 为列表启用动态模式,并在默认插槽中提供items ,创建一个迭代器(v-for )。 |
显示 通用 props | |||
config | Object | {} | 提供给 input 的节点和此输入的任何后代节点的配置选项。 |
delay | Number | 20 | 在调度 commit hook 前,输入值的去抖动毫秒数。 |
dirtyBehavior | string | touched | 确定此输入的“dirty”标志设置方式。可以设置为 touched 或 compare — 默认为 touched ,性能更好,但无法检测表单是否再次匹配其初始状态。 |
errors | Array | [] | 要在此字段上显示的错误消息的字符串数组。 |
help | String | '' | 帮助文本与输入关联的文本。 |
id | String | input_{n} | 输入的唯一标识符。提供一个 id 还可以全局访问输入的节点。 |
ignore | Boolean | false | 防止将输入包含在任何父级(组、列表、表单等)中。在仅用于 UI 而不是实际值的情况下非常有用。 |
index | Number | undefined | 如果父级是列表,允许在给定索引处插入输入。如果输入的值未定义,它将继承该索引位置的值。如果它有一个值,它将在给定索引处将其插入到列表的值中。 |
label | String | '' | 与输入关联的 label 元素的文本。 |
name | String | input_{n} | 输入的名称,在数据对象中唯一标识。在一组字段中应该是唯一的。 |
parent | FormKitNode | contextual | 默认情况下,父级是包装组、列表或表单,但此属性允许显式分配父级节点。 |
prefix-icon | String | '' | 指定放置在 prefixIcon 部分的 图标。 |
preserve | boolean | false | 在输入卸载时,在父组、列表或表单上保留输入的值。 |
preserve-errors | boolean | false | 默认情况下,使用 setErrors 在输入上设置的错误会在输入时自动清除,将此属性设置为 true 可以保留错误,直到明确清除为止。 |
sections-schema | Object | {} | 一个包含部分键和模式部分值的对象,其中每个模式部分应用于相应的部分。 |
suffix-icon | String | '' | 指定放置在 suffixIcon 部分的 图标。 |
type | String | text | 要从库中渲染的输入类型。 |
validation | String, Array | [] | 要应用于输入的 验证 规则。 |
validation-visibility | String | blur | 确定何时显示输入的验证失败规则。有效值为 blur 、dirty 和 live 。 |
validation-label | String | {label prop} | 确定在验证错误消息中使用的标签,默认情况下,如果可用,则使用 label 属性,否则使用 name 属性。 |
validation-rules | Object | {} | 附加的自定义验证规则,可用于验证 prop。 |
value | Any | undefined | 为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。 |
Section-key | 描述 |
---|---|
outer | 最外层的包装元素。 |
wrapper | 标签和输入周围的包装器。 |
label | 输入的标签。 |
prefix | 默认情况下没有输出,但允许直接在输入元素之前放置内容。 |
prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
inner | 实际输入元素周围的包装器。 |
suffix | 默认情况下没有输出,但允许直接在输入元素之后放置内容。 |
suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
input | 输入元素本身。 |
help | 包含帮助文本的元素。 |
messages | 包装所有消息的容器。 |
message | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |