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
选择输入使用HTML的原生选择输入。选择输入可以是单值选择,也可以通过使用multiple
属性来进行多值选择。有4种方法可以向选择输入提供选项:
需要比原生HTML select
输入更多的灵活性吗?查看FormKit Pro中提供的dropdown
输入。
选择列表最常用于从选项列表中选择单个项目。
提供选项的最简单方法是字符串数组。提供的字符串将用于选项的标签和值。
您也可以提供options
属性,其中键是值,每个属性的值是标签。
定义选项最灵活的方式是提供一个对象数组。对象_必须_包括value
和label
属性——但也可以包括一个help
属性以及一个attrs
对象,用于应用于每个选择输入标签的附加属性。
要将额外的属性传递给每个<option>
元素,您的对象也可以包含一个attrs
属性。
[
{
label: '我的标签',
value: 'a-value',
attrs: {
disabled: true
}
}
]
optgroup
)使用对象数组语法,您还可以创建选项组(HTML中的<optgroup>
)。为此,请提供一个group
选项:
有时可能需要手动输出选择列表的内容,以便创建特殊结构。这可以通过使用 default
插槽来明确输出你的选项来完成。
使用默认插槽输出选项时,你不应使用 placeholder
或 options
属性。
select
输入也支持 multiple
属性,允许多选。在 FormKit 中使用时,此选项会产生一个值数组。
具有 multiple
属性的选择输入对某些用户来说可能具有挑战性,因为它们需要按住控制键或命令键来进行多选。根据你的受众,你可能会考虑使用 带有 options
的复选框输入代替。
当使用默认插槽结合 multiple
属性时,你必须明确地为每个选项指定 selected
属性。
Prop | Type | 默认 | 描述 |
---|---|---|---|
options | Array/Object | [] | 一个值/标签对的对象,或一个字符串数组,或一个必须包含标签和值属性的对象数组。 |
placeholder | String | none | 定义时,FormKit 会注入一个不可选择的隐藏 option 标签作为列表的第一个值,用作占位符。 |
select-icon | String | ’’ | 指定 一个图标 放在 selectIcon 部分。默认为 select 图标。 |
显示 通用 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 | 描述 |
---|---|
option | 负责渲染每个选项。上下文包括一个 option 属性,其中包含正在渲染的选项。这个对象包括 label 和 value 属性。 |
selectIcon | 用于输出打开选择列表的图标的元素。通常是一个向下的箭头。 |
显示 通用 section keys | |
outer | 最外层的包装元素。 |
wrapper | 标签和输入周围的包装器。 |
label | 输入的标签。 |
prefix | 默认情况下没有输出,但允许直接在输入元素之前放置内容。 |
prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
inner | 实际输入元素周围的包装器。 |
suffix | 默认情况下没有输出,但允许直接在输入元素之后放置内容。 |
suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
input | 输入元素本身。 |
help | 包含帮助文本的元素。 |
messages | 包装所有消息的容器。 |
message | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是基于以下无障碍性考虑而设计的。通过在此处提交无障碍性问题,帮助我们不断提高所有人的无障碍性:
部分键 | 属性 | 默认 | 描述 |
---|---|---|---|
label | label | for | 将其与输入元素关联,提高可访问性和用户体验 |
input | input | disabled | 禁用 HTML 元素,阻止用户交互并指示非交互状态 |
aria-describedby | 通过将元素与描述关联,增强可访问性,帮助屏幕阅读器 | ||
aria-required | 当需要验证时,添加所需的状态 | ||
icon | icon | for | 每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验 |
键盘事件 | 描述 |
---|---|
Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |