checkbox
输入使用HTML的原生复选框输入。它可以向用户显示一个或多个选项,是允许用户从列表中选择多个项目的好方法。FormKit支持单个和多个复选框输入。
默认情况下,复选框类型将渲染一个单个复选框并使用boolean
值。为了让单个复选框被选中 - 输入的当前值必须匹配该输入的on-value
(默认情况下,单个复选框使用true
作为on-value
)。
为了提高所有FormKit输入的API一致性 - FormKit使用value
作为输入的初始状态。不应直接使用checked
prop/attribute。
要使用单个输入输出多个复选框,使用options
prop。选项可以以3种方式指定:
具有多个options
的复选框输入的值是选定值的数组。
提供选项的最简单方法是字符串数组。提供的字符串将用于选项的标签和值。
您也可以提供options
prop,其中键是值,每个属性的值是标签。
定义选项的最灵活的方式是提供一个对象数组。对象 必须 包括value
和label
属性 - 但也可以包括一个help
属性以及一个attrs
对象,用于应用于每个复选框输入标签的附加属性。
Prop | Type | 默认 | 描述 |
---|---|---|---|
decorator-icon | String | ’’ | 指定在decoratorIcon 部分放置的图标。当复选框被选中时显示。默认为checkboxDecorator 图标。 |
options | Array/Object | [] | 一个值/标签对的对象,或者一个字符串数组,或者一个对象数组,这些对象必须包含标签和值属性。 |
on-value | any | true | 复选框被选中时的值(仅限单个复选框)。 |
off-value | any | false | 复选框未被选中时的值(仅限单个复选框)。 |
显示 通用 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 | 描述 |
---|---|
decorator | 负责紧跟在输入元素后面的元素——通常用于自定义复选框的样式。 |
decoratorIcon | 包含装饰图标的元素。 |
legend | 负责fieldset的legend元素。 |
fieldset | 当有多个选项可用时,负责fieldset。 |
option | 负责选项中每个项目的包装器。 |
options | 负责所有选项项目的包装元素。 |
显示 通用 section keys | |
outer | 最外层的包装元素。 |
wrapper | 标签和输入周围的包装器。 |
label | 输入的标签。 |
prefix | 默认情况下没有输出,但允许直接在输入元素之前放置内容。 |
prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
inner | 实际输入元素周围的包装器。 |
suffix | 默认情况下没有输出,但允许直接在输入元素之后放置内容。 |
suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
input | 输入元素本身。 |
help | 包含帮助文本的元素。 |
messages | 包装所有消息的容器。 |
message | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |