Select

选择输入使用HTML的本地选择输入。选择输入可以是单值选择,也可以通过使用multiple属性进行多值选择。有4种方法可以为选择输入提供选项:

  • 字符串数组
  • 值/标签对的对象
  • 具有labelvalue属性的对象数组(与复选框单选按钮输入相同)
  • 直接在default插槽内使用<option>标签。
Pro Alternative

需要比本地HTML select输入提供更多灵活性?查看FormKit Pro中提供的dropdown输入

单选

选择列表通常用于从选项列表中选择单个项目。

字符串数组

提供选项的最简单方法是字符串数组。提供的字符串将用于选项的标签和值。

加载实时示例

值/标签对象

您还可以提供options属性,其中键是值,每个属性的值是标签。

加载实时示例

对象数组

定义选项的最灵活方法是提供对象数组。对象 必须 包括valuelabel属性 - 但也可以包括help属性以及要应用于每个选择输入标签的附加属性的attrs对象。

加载实时示例
Option attributes

要将其他属性传递给每个<option>元素,您的对象还可以包含一个attrs属性。

{ label: 'My Label', value: 'a-value', attrs: { disabled: true } }

默认插槽

有时可能希望手动输出选择列表的内容以创建专门的结构。这可以通过使用default插槽来明确输出选项来完成。

加载实时示例
warning

当使用默认插槽输出选项时,您不应使用placeholderoptions属性。

多选

select 输入还支持一个 multiple 属性,允许多选。与 FormKit 一起使用时,此选项会生成一个值数组。

加载实时示例
Alternatives

带有 multiple 属性的选择输入对某些用户来说可能具有挑战性,因为它们需要按住 control 或 command 键进行多选。根据您的受众,您可能需要考虑使用带有 options复选框输入 代替。

Multiple with default slot

在使用默认插槽与 multiple 属性结合时,您必须为每个选项显式分配 selected 属性。

Props & Attributes

PropType默认描述
optionsArray/Object[]值/标签对的对象或字符串数组,或者一个包含标签和值属性的对象数组。
placeholderStringnone当定义时,FormKit 将一个不可选择的隐藏 option 标签作为列表的第一个值,用作占位符。
select-iconString’’指定要放在 selectIcon 部分的 图标。默认为 select 图标。
显示 通用 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为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。

Sections

您可以通过使用该部分的"key"来定位输入的特定部分,从而可以修改该部分的类、HTML(通过:sections-schema)或内容(通过插槽))。了解更多关于部分的信息,请点击这里

Smoothie size
👩🏼‍🦱
Medium
Choose a smoothie size.
You must make a selection.
Section-key描述
option负责渲染每个选项。上下文包括正在渲染的选项的 option 属性。此对象包括 labelvalue 属性。
selectIcon用于输出打开选择列表的图标的元素。通常是一个向下箭头。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。