Pro installation quickstart 🚀

基本示例

toggle 输入 — 有时被称为 "switch" — 提供了两个值之间的选择;当你希望用户切换功能的开启或关闭时,它是一个很好的选择:

加载实时示例

如果未进行交互,切换的值为 undefined,如果选中,则为 true,如果未选中,则为 false。你可以通过传递 onValueoffValue 属性来更改这些值。在这个例子中,我们将 onValue 设置为字符串 'active'offValue 设置为字符串 'inactive'

加载实时示例

标签

主标签

默认情况下,切换输入支持像其他 FormKit 输入一样的主标签,如 label 属性。主标签显示在切换的右侧,除非你使用 Value label,这将把它移动到切换的上方:

加载实时示例

Alt 标签位置

如果你希望标签显示在切换的上方,你可以使用 alt-label-position 属性:

加载实时示例

Value 标签

此外,你可以通过设置 on-value-labeloff-value-label 属性来指定次要标签。这些值根据切换的开/关状态有条件地显示。值标签渲染到切换输入的右侧。当使用值标签时,"主标签" 将被移动到切换上方的替代标签位置:

加载实时示例

内部值标签

此外,你可以将 value-label-display 属性设置为 inner,以在切换内部渲染值标签。主标签 将返回到切换的右侧显示:

加载实时示例

图标

thumb-icon 属性允许你在 toggle 输入的 thumb 部分插入一个图标。此属性接受一个字符串,该字符串被传递给 FormKit 的 icon plugin

加载实时示例

颜色

切换输入支持其各个部分的颜色属性,以便于样式设计。每个属性包含开启和关闭状态,这些状态会根据切换是否开启而应用。以下示例使用了一些这些颜色属性。请参阅下面的 Props & Attributes 部分,以获取这些属性的完整列表:

加载实时示例

可访问性

toggle 输入基于 HTML 的原生复选框输入构建。

Props & Attributes

PropType默认描述
alt-label-positionBooleanundefined将标签移动到切换的上方。
off-valueanyfalse切换未选中时的值。
on-valueanytrue切换选中时的值。
off-value-labelStringundefined切换未选中时的值标签文本。
on-value-labelStringundefined切换选中时的值标签文本。
value-label-displayStringundefined`on` 和 `off` 值标签默认始终显示在切换的外部和右侧。其他接受的值包括 `inner`,用于将值标签设置在切换的内部,以及 `hidden`,用于隐藏值标签。
value-label-color-offStringundefined用于设置切换未选中时值标签的颜色。
value-label-color-onStringundefined用于设置切换选中时值标签的颜色。
thumb-iconStringundefined此属性用于设置将放置在拇指部分内的图标。
thumb-color-offStringundefined设置切换未选中时拇指部分的背景颜色。
thumb-color-onStringundefined设置切换选中时拇指部分的背景颜色。
icon-color-offStringundefined当设置了 `toggle-icon` 属性且切换未选中时,应设置图标的颜色。
icon-color-onStringundefined当设置了 `toggle-icon` 属性且切换选中时,应设置图标的颜色。
track-color-offStringundefined设置切换未选中时 `track` 部分的背景颜色。
track-color-onStringundefined设置切换选中时 `track` 部分的背景颜色。
显示 通用 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为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组(表单)和列表。

部分

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

⚫️
声音效果
打开和关闭声音效果。
发生了一些错误。
Section-key描述
track轨道部分是切换的背景(滑块滑动的区域)。
thumb滑块部分是在轨道上滑动的元素。
thumbIcon滑块图标部分是在滑块部分内渲染的图标(当设置了滑块图标属性时)。
valueLabel一个额外的标签元素,当使用值标签属性时渲染。显示在切换的右侧。
altLabel标签的标签元素。当使用值标签属性时,此标签被渲染。
innerLabel当提供值标签属性并将值标签显示设置为内部时使用的标签元素。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。