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
repeater
输入用于重复一组输入。你可以在 repeater 中使用任意数量的 FormKit 输入,且 repeater 本身可以无限嵌套。
默认情况下,repeater 输入具有移动、添加和移除项目的能力:
与大多数其他 FormKit 输入类型不同,repeater 输入的类型是 list。你可以看到上面的 users
属性(我们 repeater 的值)是一个数组。
像所有其他 FormKit 输入一样,Repeater 能够在 FormKit schema 编写的表单中使用。
在前面的示例中,默认提供了“添加用户”按钮,按钮标签来自 repeater 的 label
。我们可以通过使用 add-button
属性并将其设置为 string
来自定义标签,或者通过将其设置为 false
来完全移除它。或者,类似于 FormKit 表单 上的 submit-attrs
属性,我们可以提供一个属性对象应用于按钮,使用 add-attrs
。在这个示例中,我们使用 add-label
属性将 repeater 的标签从 Add Users
更改为 My custom label
:
像许多其他 FormKit 输入一样,repeater 附带有 min
和 max
属性。你可以使用这些属性来限制添加或移除的项目数量。
当 repeater 允许为空,通过将其 min
属性设置为 0
并且没有值时,你可以使用 empty
插槽控制在空状态下渲染的内容。
repeater 输入默认带有一组控件,允许你移动、添加和移除项目。你可以通过将 upControl
、downControl
、insertControl
和 removeControl
属性设置为 true
或 false
来控制这些控件的可见性。
使用 FormKit 的重复器,你不受限于我们的默认控件。你可以以任何你想要的方式操作重复器:
你可以使用点表示法在重复器或任何可重复项上设置错误。这里我们使用的是
setErrors
辅助函数,但还有其他方法:
// setErrors 的第二个参数是输入级别的错误
formNode.setErrors( null, // 没有表单错误,
{
// 重复器字段上的错误:
'teamMembers': ['你的一个团队成员出现问题。']
// 特定重复器项上的错误:
'teamMembers.1.email': ['emily@formkit.com 已经在一个团队中。'],
}
)
记住,你的提交处理函数会传递表单的核心 node
,可以方便地在深度上设置错误。阅读更多关于错误处理的信息
这里。这是一个假后端返回重复器和一个子项错误的示例:
Prop | Type | 默认 | 描述 |
---|---|---|---|
add-label | string | null | 用于更改添加按钮的标签。 |
add-attrs | object | [object Object] | 用于对添加按钮元素应用属性。 |
add-button | boolean | true | 是否显示添加按钮的条件。 |
up-control | boolean | true | 是否显示上移控件的条件。 |
down-control | boolean | true | 是否显示下移控件的条件。 |
insert-control | boolean | false | 是否显示插入控件的条件。 |
remove-control | boolean | true | 是否显示移除控件的条件。 |
min | Number | 1 | 子项的最小数量。 |
max | Number | null | 子项的最大数量。 |
显示 通用 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 | 为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。 |
您可以通过使用该部分的"key"来定位输入的特定部分,从而可以修改该部分的类、HTML(通过:sections-schema
)或内容(通过插槽))。了解更多关于部分的信息,请点击这里。
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 | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是考虑到以下无障碍性因素而设计的。通过在此处提交无障碍性问题,帮助我们不断提高所有人的无障碍性:
部分键 | 属性 | 默认 | 描述 |
---|---|---|---|
items | role | list | 向辅助技术表明此元素的功能为列表。 |
item | role | listitem | 向辅助技术表明此元素的功能为列表项。 |
显示 通用 部分键 | |||
label | label | for | 将其与输入元素关联,提高可访问性和用户体验 |
input | input | disabled | 禁用 HTML 元素,阻止用户交互并指示非交互状态 |
aria-describedby | 通过将元素与描述关联,增强可访问性,帮助屏幕阅读器 | ||
aria-required | 当需要验证时,添加所需的状态 | ||
icon | icon | for | 每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验 |
键盘事件 | 描述 |
---|---|
Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |