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
toggle 输入 — 有时被称为“开关” — 提供两个值之间的选择；当你希望用户切换某个功能的开启或关闭时，它是一个很好的选项：
切换的值如果未进行交互则为 undefined，选中时为 true，未选中时为 false。你可以通过传递 onValue 和 offValue 属性来更改这些值。在这个示例中，我们将 onValue 设置为字符串 'active'，将 offValue 设置为字符串 'inactive'：
默认情况下，切换输入支持像任何其他 FormKit 输入的 label 属性一样的主标签。除非你使用了 Value label，否则主标签会显示在切换的右侧，这将使其移动到切换的上方：
如果你希望标签显示在切换的上方，你可以使用 alt-label-position 属性：
此外，你可以通过设置 on-value-label 和 off-value-label 属性来指定次级标签。这些值会根据切换的开/关状态有条件地显示。值标签会渲染在切换输入的右侧。当使用值标签时，“主标签”将移动到切换上方的替代标签位置：
此外，你可以将 value-label-display 属性设置为 inner，以在切换内部渲染值标签。主标签 将返回到切换的右侧显示：
thumb-icon 属性允许你将图标插入到 toggle 输入的 thumb 部分。这个属性接受一个字符串，传递给 FormKit 的图标插件：
切换输入支持其各个部分的颜色属性，以便于样式设置。每个属性包含开启和关闭状态，这些状态会根据切换是否开启而应用。以下示例使用了一些这些颜色属性。请参阅下面的属性 & 特性部分，以获取这些属性的完整列表：
toggle 输入是建立在HTML的原生复选框输入之上的。
| Prop | Type | 默认 | 描述 |
|---|---|---|---|
| alt-label-position | Boolean | undefined | 将标签移至切换开关的上方。 |
| off-value | any | false | 切换未选中时的值。 |
| on-value | any | true | 切换选中时的值。 |
| off-value-label | String | undefined | 切换未选中时的值标签文本。 |
| on-value-label | String | undefined | 切换选中时的值标签文本。 |
| value-label-display | String | undefined | 开启和关闭的值标签默认情况下会显示在切换开关的外部和右侧。其他接受的值包括`inner`，将值标签设置在切换开关的内部，以及`hidden`，隐藏值标签。 |
| value-label-color-off | String | undefined | 用于设置切换未选中时值标签的颜色。 |
| value-label-color-on | String | undefined | 用于设置切换选中时值标签的颜色。 |
| thumb-icon | String | undefined | 此属性用于设置将放置在拇指部分内的图标。 |
| thumb-color-off | String | undefined | 设置切换未选中时拇指部分的背景颜色。 |
| thumb-color-on | String | undefined | 设置切换选中时拇指部分的背景颜色。 |
| icon-color-off | String | undefined | 当设置了`toggle-icon`属性且切换未选中时，图标应设置的颜色。 |
| icon-color-on | String | undefined | 当设置了`toggle-icon`属性且切换选中时，图标应设置的颜色。 |
| track-color-off | String | undefined | 设置切换未选中时`轨道`部分的背景颜色。 |
| track-color-on | String | undefined | 设置切换选中时`轨道`部分的背景颜色。 |
| 显示 通用 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 | 描述 |
|---|---|
| track | 轨道部分是开关的背景（滑块滑动的区域）。 |
| thumb | 滑块部分是在轨道上滑动的元素。 |
| thumbIcon | 滑块图标部分是在滑块部分内渲染的图标（当设置了 thumb-icon 属性时）。 |
| valueLabel | 一个额外的标签元素，当使用 value-label 属性时渲染。显示在开关的右侧。 |
| altLabel | 标签的一个标签元素。当使用 value-label 属性时，这个标签会被渲染。 |
| innerLabel | 一个标签元素，当提供了 value-label 属性并且 value-label-display 设置为内部时使用。 |
| 显示 通用 section keys | |
| outer | 最外层的包装元素。 |
| wrapper | 标签和输入周围的包装器。 |
| label | 输入的标签。 |
| prefix | 默认情况下没有输出，但允许直接在输入元素之前放置内容。 |
| prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
| inner | 实际输入元素周围的包装器。 |
| suffix | 默认情况下没有输出，但允许直接在输入元素之后放置内容。 |
| suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
| input | 输入元素本身。 |
| help | 包含帮助文本的元素。 |
| messages | 包装所有消息的容器。 |
| message | 包含消息的元素（或多个元素） - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是考虑到以下无障碍性因素而设计的。通过在此处提交无障碍性问题，帮助我们不断改进所有人的无障碍性：
| 部分键 | 属性 | 默认 | 描述 |
|---|---|---|---|
| altLabel | for | 将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。 | |
| valueLabel | for | 将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。 | |
| inner | for | 将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。 | |
| 显示 通用 部分键 | |||
| label | label | for | 将其与输入元素关联，提高可访问性和用户体验 |
| input | input | disabled | 禁用 HTML 元素，阻止用户交互并指示非交互状态 |
| aria-describedby | 通过将元素与描述关联，增强可访问性，帮助屏幕阅读器 | ||
| aria-required | 当需要验证时，添加所需的状态 | ||
| icon | icon | for | 每当将图标定义为标签时，将其与输入元素关联，增强可访问性和用户体验 |
| 键盘事件 | 描述 |
|---|---|
| Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
| Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |