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
要输出多个切换按钮，请使用 options 属性。选项可以通过以下3种方式指定：
label 和 value 属性的对象数组（与 select 和 radio 输入相同）。
disabled、help、onLabel 和/或 offLabel。默认情况下，togglebuttons 输入只允许选择一个选项。您可以通过设置 multiple 属性来改变这种行为，这将允许选择多个选项：
默认情况下，togglebuttons 允许您选择和取消选择，允许有一个关闭状态。启用 enforced 属性后，一旦用户与输入互动，就会始终设置一个值，就像单选输入一样。
假设您使用的是默认的 FormKit 样式，vertical 属性应用数据集属性和样式，以垂直方向堆叠切换按钮。
更多属性示例和组合：
togglebuttons 输入提供一个或多个值之间的选择；当您希望用户切换功能的开/关、在选项之间选择或允许多个选择时，这是一个很好的选项。
如果未与之互动，切换按钮的值为 undefined，如果选中，则为 true，如果未选中，则为 false。您可以通过传递 onValue 和 offValue 属性来更改这些值。在此示例中，我们将 onValue 设置为字符串 'active'，将 offValue 设置为字符串 'inactive'：
此外，您可以通过设置 on-label 和 off-label 属性来指定次要标签。这些值会根据开关的开/关状态有条件地显示。值标签会渲染在开关输入的右侧。当使用值标签时，"主标签" 将移动到开关上方的输入标签位置：
对于多个选项，您可以使用 default 插槽来设置切换的内容。
对于单个切换，您可以使用默认插槽来设置切换内容。还有 on 和 off 插槽可用于根据切换是否激活来更改内容。
| Prop | Type | 默认 | 描述 |
|---|---|---|---|
| off-value | any | false | 当切换未选中时的值。 仅用于独立切换按钮。 |
| on-value | any | true | 当切换选中时的值。 仅用于独立切换按钮。 |
| off-label | String | undefined | 当切换未选中时按钮标签的文本。 仅用于独立切换按钮。 |
| on-label | String | undefined | 当切换选中时按钮标签的文本。 仅用于独立切换按钮。 |
| options | Array/Object | [] | 一个值/标签对的对象，或一个字符串数组，或一个必须包含标签和值属性的对象数组。其他属性包括：disabled、help、onLabel 和 offLabel |
| multiple | Boolean | false | 允许选择多个选项。 仅用于多个切换按钮。 |
| enforced | Boolean | false | 确保一旦字段激活，至少有一个选择保持选中状态。 仅用于多个切换按钮。 |
| vertical | Boolean | 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 | 描述 |
|---|---|
| singleToggle | 单个切换按钮的按钮包装器 |
| multiToggle | 存在多个切换按钮时，切换按钮的按钮包装器 |
| inputInner | 切换按钮的按钮内部文本 |
| option | 负责选项中每个项目的包装器。 |
| options | 负责所有选项项目周围的包装元素。 |
| 显示 通用 section keys | |
| outer | 最外层的包装元素。 |
| wrapper | 标签和输入周围的包装器。 |
| label | 输入的标签。 |
| prefix | 默认情况下没有输出，但允许直接在输入元素之前放置内容。 |
| prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
| inner | 实际输入元素周围的包装器。 |
| suffix | 默认情况下没有输出，但允许直接在输入元素之后放置内容。 |
| suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
| input | 输入元素本身。 |
| help | 包含帮助文本的元素。 |
| messages | 包装所有消息的容器。 |
| message | 包含消息的元素（或多个元素） - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是考虑到以下无障碍性因素而设计的。通过在此处提交无障碍性问题来帮助我们不断改进所有人的无障碍性：
| 部分键 | 属性 | 默认 | 描述 |
|---|---|---|---|
| singleToggle | aria-label | 提供一个可访问的名称。 | |
| aria-pressed | 指示切换按钮的按下状态。 | ||
| role | checkbox | 向辅助技术表明此元素的功能类似于复选框。 | |
| 显示 通用 部分键 | |||
| label | label | for | 将其与输入元素关联，提高可访问性和用户体验 |
| input | input | disabled | 禁用 HTML 元素，阻止用户交互并指示非交互状态 |
| aria-describedby | 通过将元素与描述关联，增强可访问性，帮助屏幕阅读器 | ||
| aria-required | 当需要验证时，添加所需的状态 | ||
| icon | icon | for | 每当将图标定义为标签时，将其与输入元素关联，增强可访问性和用户体验 |
| 部分键 | 属性 | 默认 | 描述 |
|---|---|---|---|
| multiToggle | aria-label | 提供一个可访问的名称。 | |
| aria-pressed | 指示切换按钮的按下状态。 | ||
| role | checkbox or radio | 向辅助技术表明此元素的功能类似于复选框（如果有选项）或单选按钮（如果没有）。 | |
| options | role | group | 向辅助技术表明此元素的功能类似于一组。 |
| aria-labelledby | 将此元素作为输入的标签关联起来。 | ||
| option | role | listitem | 向辅助技术表明此元素的功能类似于列表项。 |
| 显示 通用 部分键 | |||
| label | label | for | 将其与输入元素关联，提高可访问性和用户体验 |
| input | input | disabled | 禁用 HTML 元素，阻止用户交互并指示非交互状态 |
| aria-describedby | 通过将元素与描述关联，增强可访问性，帮助屏幕阅读器 | ||
| aria-required | 当需要验证时，添加所需的状态 | ||
| icon | icon | for | 每当将图标定义为标签时，将其与输入元素关联，增强可访问性和用户体验 |
| 键盘事件 | 描述 |
|---|---|
| Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
| Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |