Pro installation quickstart 🚀

基本示例

repeater 输入用于重复输入组。你可以在一个重复器中使用任意数量的FormKit输入,而且重复器本身可以无限嵌套。

默认情况下,重复器输入具有移动、添加和删除项目的能力:

加载实时示例

与大多数其他FormKit输入类型不同,重复器输入是list类型。你可以看到上面的users属性(我们的重复器的值)是一个数组。

Schema 示例

像所有其他FormKit输入一样,Repeater可以在用FormKit schema编写的表单中使用。

加载实时示例

添加按钮属性

在前面的示例中,'Add Users'按钮是默认提供的,按钮标签是从重复器的label派生的。我们可以通过使用add-button属性并将其设置为string来自定义标签,或者通过将其设置为false来完全删除它。或者,类似于FormKit的表单上的submit-attrs属性,我们可以提供一个属性对象,通过add-attrs应用到按钮上。在这个示例中,我们使用add-label属性将重复器的标签从Add Users更改为My custom label

加载实时示例

最小/最大

像许多其他FormKit输入一样,重复器带有minmax属性。你可以使用这些属性来限制要添加或删除的项目数量。

加载实时示例

空状态

当一个重复器被允许为空,通过将其min属性设置为0并且没有值,你可以使用empty插槽控制在空状态下渲染的内容。

加载实时示例

控制

默认情况下,重复器输入带有一组控件,允许你移动、添加和删除项目。你可以通过将upControldownControlinsertControlremoveControl属性设置为truefalse来控制这些控件的可见性。

加载实时示例

自定义控件

使用FormKit的重复器,您不受我们默认控件的限制。您可以以任何您想要的方式操作重复器:

加载实时示例

设置错误

您可以使用点表示法在重复器或任何可重复项上设置错误。这里我们使用 setErrors 助手,但也有其他方法:

// setErrors的第二个参数是输入级错误
formNode.setErrors( null, // 没有表单错误,
  {
    // 重复器字段上的错误:
    'teamMembers': ['您的1个团队成员出现问题。']

    // 特定重复器项上的错误:
    'teamMembers.1.email': ['emily@formkit.com已经在一个团队中。'],
  }
)

请记住,您的提交处理程序会传递表单的核心node,并且可以用来方便地设置深度错误。阅读更多关于错误处理的信息 这里。这是一个假后端返回重复器和一个子项的错误的例子:

加载实时示例

Props & Attributes

PropType默认描述
add-labelstringnull用于更改添加按钮的标签。
add-attrsobject[object Object]用于将属性应用于添加按钮元素。
add-buttonbooleantrue是否显示添加按钮的条件。
up-controlbooleantrue是否显示向上控制的条件。
down-controlbooleantrue是否显示向下控制的条件。
insert-controlbooleanfalse是否显示插入控制的条件。
remove-controlbooleantrue是否显示删除控制的条件。
minNumber1子项的最小数量。
maxNumbernull子项的最大数量。
显示 通用 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.

客人
请注明您将带到赛道的客人。
此处重复字段。
🗑
添加客人
对不起,您不能添加超过3位客人。
Section-key描述
fieldset作为重复器包装器的fieldset元素。
legend渲染标签的legend元素。
items包装重复器项目的ul元素。
item为每个重复器项目渲染的li元素。
content组部分的容器。
group不渲染元素。它将默认插槽结构化为对象数据结构。
controls包装重复器控件的ul元素。
controlLabel渲染给定控件标签的span元素。
up渲染上控件的li元素。
upControl渲染上控件的button元素。
moveUpIcon渲染upControl的图标的span元素。
down渲染下控件的li元素。
downControl渲染下控件的button元素。
moveDownIcon渲染downControl的图标的span元素。
insert渲染插入控件的li元素。
insertControl渲染插入控件的button元素。
insertIcon渲染insertControl的图标的span元素。
remove渲染删除控件的li元素。
removeControl渲染删除控件的button元素。
removeIcon渲染removeControl的图标的span元素。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。