专业安装快速启动 :rocket:

基本示例

rating 输入允许用户基于由图标/图片表示的数字刻度提供反馈:

加载实时示例

最小/最大值

minmax 属性定义了终端用户可以选择的最小和最大值。max 决定了要渲染的图标数量:

加载实时示例

步长

默认情况下,rating 输入将以 1 为增量。step 属性允许您设置每个值之间的步长大小。例如,如果您设置 step="0.5",终端用户可以选择任何是 0.5 的倍数的值。步长必须是 0.011 之间的值:

加载实时示例

图标

默认情况下,rating 输入使用 FormKit 自己的星星图标。您可以通过设置 rating-icon 属性来更改正在使用的图标。此属性接受一个字符串,将使用 FormKit 的图标插件

加载实时示例

图标的插槽

默认插槽

您可以使用 default 插槽传递原始 SVG,而不是通过 FormKit 图标插件指定图标:

加载实时示例

命名插槽

最后,您可以使用 offItemonItem 插槽传递任何您想要的资源。在这个示例中,我们将使用不同的图片来表示 offon 状态:

加载实时示例

颜色

除了提供图标,您还可以通过属性指定颜色。设置 off-color 属性将改变未选中时图标的颜色。on-color 属性将改变选中时图标的颜色:

加载实时示例

属性 & 属性

PropType默认描述
minNumber0可以选择的最小图标数量。
maxNumber5要渲染的最大图标数量。
stepNumber1应用于 `rating` 图标的步长或增量。接受的值在 `0.01` 到 `1` 之间。
hover-highlightBooleantrue确定是否在鼠标悬停时显示图标/图片的选中状态。
off-colorStringundefined设置未选中时应用于给定图标的颜色。
on-colorStringundefined设置选中时应用于给定图标的颜色。
显示 通用 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)或内容(通过插槽))。了解更多关于部分的信息,请点击这里

View on a larger screen to see this section diagram.

请为我们的剧院体验打分
⭐️
如果您给我们5星评价,我们将送您一张礼品卡。
您必须提供一个评分。
Section-key描述
itemsWrapper所有评分项(包括亮起和未亮起的)的外包装。
offItems所有未亮起评分项的容器。
offItemWrapper每个未亮起评分项的直接父容器。
onItems所有亮起评分项的容器。
onItemWrapper每个亮起评分项的直接父容器。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。

无障碍性

所有 FormKit 输入都是在考虑以下无障碍性因素的前提下设计的。通过在此处提交无障碍性问题来帮助我们不断提高所有人的无障碍性:

语义标记Aria 属性可通过键盘访问焦点指示器与提供的主题的颜色对比可访问标签、帮助文本和错误
部分键属性默认描述
labellabelfor将其与输入元素关联,提高可访问性和用户体验
inputinputdisabled禁用 HTML 元素,阻止用户交互并指示非交互状态
aria-describedby通过将元素与描述关联,增强可访问性,帮助屏幕阅读器
aria-required当需要验证时,添加所需的状态
iconiconfor每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验

键盘交互

键盘事件描述
Tab将焦点移动到页面上的下一个可聚焦输入。
Shift + Tab将焦点移动到页面上的上一个可聚焦输入。