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
slider
输入是原生 HTML range
输入的高级且高度可配置的版本。与标准的 range
输入相比,一些值得注意的新增功能包括:
如果您熟悉使用原生 HTML range
输入,您会发现许多您熟悉的现有属性在 slider
输入中按预期工作。
即使是在其最简单的形式中,slider
输入也有一些小技巧。就像原生的 range
输入一样,当它被聚焦时,您可以使用箭头键来调整输入值 — 但是使用 slider
输入时,您可以按住 shift
键以 10 倍的增量调整,以及使用系统的修饰键(command
或 ctrl
)跳转到最小值/最大值。
每当您在 slider
输入上聚焦一个句柄时,您可以在键盘上输入一个值,经过短暂的防抖后,您的 slider
句柄将被设置为您提供的值 — 或最接近的可用匹配值。
要在 slider
输入上渲染两个值句柄,请为输入的值提供一个数组。控制句柄可以互相拖动,您的结果数组值将始终按从最小到最大的顺序返回排序。
使用 maxHandleInner
(默认)和 minHandleInner
插槽,您可以自定义 slider
句柄的外观。maxHandleInner
插槽用于单值 slider
输入。
默认情况下,当选择句柄被拖动时,slider
工具提示在悬停时显示。您可以通过使用 tooltip
属性并提供一个布尔值,强制工具提示进入开启或关闭状态。
通过向 tooltip-format
属性提供一个函数,你可以自定义 slider
工具提示的值。你的 tooltip-format
函数将提供两个参数:
value
:默认情况下将在工具提示中显示的当前值。
handle
:受函数影响的当前句柄。可以是 min
或 max
。
通过使用 tooltip-format
属性,你可以为你的 slider
输入引入多样性 — 尤其是当与 FormKit 的 section-key 类属性系统 结合使用时。
有时,如果用户还能够在关联字段中直接输入数字值,范围式输入对用户来说更有用。你可以通过将 show-input
属性设置为 true
来显示绑定到 slider
范围句柄值的 number
输入。
关联的 number
输入是 FormKit 输入。你可以使用提供的属性对它们应用属性:
input-attrs
:将你提供的对象绑定到 min
和 max
输入上。min-input-attrs
:对象绑定到关联的 min
输入上。max-input-attrs
:对象绑定到关联的 max
输入上。slider
输入支持在输入轨道上渲染刻度。通过将 marks
属性设置为 true
,刻度将在每个 steps
间隔处渲染。
你可以通过将 mark-labels
属性设置为 true
来为你的刻度启用标签。
通过向 marks
属性提供一个对象数组而不是布尔值,你可以在滑块的轨道上放置任意刻度。刻度对象应具有以下属性:
at
:刻度应渲染的轨道上的位置(值)。label
:如果启用了 mark-labels
属性,则为刻度渲染的标签。class
:应用于刻度元素的一串类。labelClasses
:应用于刻度标签元素的一串类。当提供自定义标记时,您可能希望选择自动对准所提供的标记。这可以通过 snap-to-marks
属性来实现。当 snap-to-marks
为 true
时,键盘事件将跳转到最近的标记,通过键盘或关联输入输入的值将对准最近的可用标记。
您可以通过在标记对象上使用 class
和 labelClasses
属性,为您的标记和标记标签应用自定义类。
默认情况下,slider
输入在其整个范围内线性缩放值。然而,您可以使用提供的 scaling-function
或 intervals
属性来改变这种行为。
scaling-function
属性接受 3 个值:
linear
— 这是默认行为log
将应用对数缩放函数到您的 slider
forward
和 reverse
的函数的对象,将应用您自己的缩放逻辑。intervals
属性接受一个对象数组,每个对象定义了 slider
上的一个区间范围。每个对象包含:
value
:区间开始的 slider
上的点step
:区间内应使用的步长大小您的最后一个区间将覆盖从您指定的 value
到 slider
的 max
属性值的范围。如果您的最低区间不是从 slider
的最小可能值开始,则将为您创建一个区间,覆盖从 slider
的 min
属性到您的第一个区间的范围。其 step
值将是您的 slider
输入上的 step
属性值。
重要的是要注意,在 slider
轨道上区间的视觉表示是基于给定区间内可能步数的总数,而不是区间的原始数值。
您可以通过向 chart
属性提供一个数组,在滑块上方渲染一个条形图,该数组具有任意值。chart
数组的结构类似于 marks
数组。每个嵌套对象应包含:
at
:轨道上应渲染图表条形的位置(值)。value
:一个数值,将用于计算图表中条形的相对高度。slider
输入将遍历您的 chart
数组,并确定数组中包含的最大 value
,然后将所有其他值除以该最大值,以确定渲染图表条形的相对高度。
通过组合 slider
组件提供的属性,您可以创建一个强大的输入工具,以覆盖多种用例。这里是一个价格范围滑块的示例。
Prop | Type | 默认 | 描述 |
---|---|---|---|
chart | array | none | 一个包含 at 和 value 键的对象数组。在滑块轨道上方渲染一个相对高度的条形图。 |
input-attrs | object | {} | 将自定义属性应用于嵌套的链接 FormKit 输入,用于最小和最大值。 |
intervals | array | none | 一个区间值数组,由 value 和 step 组成,用于定义滑块轨道不同部分的不同缩放。 |
marks | boolean || array | false | 当为 true 时,在每个 step 值处在轨道上渲染标记。当为一个包含 at 和 label 键的对象数组时,在每个对象的 at 值处在轨道上渲染一个标记。 |
mark-labels | boolean | false | 启用在轨道上的标记下方渲染标签 |
max | number | 100 | 滑块范围的最大可能值。 |
max-input-attrs | object | {} | 将自定义属性应用于嵌套的链接 FormKit 输入,用于最大值。 |
min | number | 0 | 滑块范围的最小可能值。 |
min-input-attrs | object | {} | 将自定义属性应用于嵌套的链接 FormKit 输入,用于最小值。 |
prefix | string | none | 将始终出现在输入开头的字符。 |
scaling-function | string || object | linear | 使用预设值字符串或一组自定义函数,定义滑块轨道上值的缩放行为。 |
show-input | boolean | false | 渲染与滑块的值相关联的 FormKit type="number" 输入。 |
snap-to-marks | boolean | false | 启用时,强制用户选择对准标记 |
step | number | 1 | 滑块值可以增加/减少的最小值。 |
suffix | string | none | 将始终出现在输入末尾的字符。 |
tooltip | boolean | none | 当设置为布尔值时,强制显示滑块手柄的工具提示。 |
tooltip-format | function | none | 提供给每个滑块手柄的 value 和 handle 的函数,应返回一个 string 。 |
显示 通用 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 | 描述 |
---|---|
chart | 图表条元素的容器。 |
chartBar | 图表元素的单个条形。 |
fill | 滑块输入选定范围的填充。 |
handleMax | 最大值选择手柄。这是单值滑块输入的默认手柄。 |
handleMin | 最小值选择手柄。 |
handles | 轨道选择手柄的容器。 |
linkedValues | 滑块最小值和最大值输入的链接包装器。 |
mark | 轨道上的单个标记。 |
markLabel | 轨道上单个标记的标签。 |
marks | 轨道上所有标记的容器。 |
maxValue | 滑块最大值的链接FormKit数字输入。如果滑块只有一个值,这将作为sliderInner部分的直接子代渲染。 |
minValue | 滑块最小值的链接FormKit数字输入。 |
sliderInner | 包含滑块输入内容的内部div。 |
track | 包含滑块输入轨道标记的包装器。 |
trackInner | 为了样式目的包含所有轨道标记(不包括图表)的内部包装器。 |
trackWrapper | 包含所有轨道标记(不包括图表)的包装器。 |
tooltipMin | 最小值选择手柄的工具提示。 |
tooltipMax | 最大值选择手柄的工具提示。 |
显示 通用 section keys | |
outer | 最外层的包装元素。 |
wrapper | 标签和输入周围的包装器。 |
label | 输入的标签。 |
prefix | 默认情况下没有输出,但允许直接在输入元素之前放置内容。 |
prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
inner | 实际输入元素周围的包装器。 |
suffix | 默认情况下没有输出,但允许直接在输入元素之后放置内容。 |
suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
input | 输入元素本身。 |
help | 包含帮助文本的元素。 |
messages | 包装所有消息的容器。 |
message | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是考虑到以下无障碍性因素而设计的。通过在此处提交无障碍性问题,帮助我们不断改进所有人的无障碍性:
部分键 | 属性 | 默认 | 描述 |
---|---|---|---|
maxValue | tabindex | -1 | 当输入被禁用时,通过将其设置为-1来优先考虑键盘焦点顺序。 |
minValue | tabindex | -1 | 当输入被禁用时,通过将其设置为-1来优先考虑键盘焦点顺序。 |
handleMax | tabindex | -1 or 0 | 当输入被禁用时,通过将其设置为-1来优先考虑键盘焦点顺序,当输入未被禁用时设置为0。 |
handleMin | tabindex | -1 or 0 | 当输入被禁用时,通过将其设置为-1来优先考虑键盘焦点顺序,当输入未被禁用时设置为0。 |
显示 通用 部分键 | |||
label | label | for | 将其与输入元素关联,提高可访问性和用户体验 |
input | input | disabled | 禁用 HTML 元素,阻止用户交互并指示非交互状态 |
aria-describedby | 通过将元素与描述关联,增强可访问性,帮助屏幕阅读器 | ||
aria-required | 当需要验证时,添加所需的状态 | ||
icon | icon | for | 每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验 |
键盘事件 | 描述 |
---|---|
Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |