slider
输入是原生 HTML range
输入的高级且高度可配置版本。与标准的 range
输入相比,一些值得注意的补充功能包括:
如果您熟悉使用原生 HTML range
输入,您会发现许多您熟悉的现有属性在 slider
输入中按预期工作。
即使在最简单的形式中,slider
输入也有一些技巧。就像原生的 range
输入一样,当输入框处于焦点状态时,您可以使用箭头键调整输入值 — 但是在 slider
输入中,您可以按住 shift
键以 10 倍递增,并使用系统的修饰键(command
或 ctrl
)跳至最小/最大值。
每当您将手柄聚焦在 slider
输入上时,您可以在键盘上输入一个值,稍作停顿后,您的 slider
手柄将设置为您提供的值 — 或最接近的可用匹配项。
要在 slider
输入上渲染两个值手柄,请将数组作为输入的值。控制手柄可以通过彼此拖动,您的结果数组值将始终按从小到大的顺序返回排序。
默认情况下,slider
工具提示在悬停和拖动选择手柄时显示。您可以通过使用 tooltip
属性并提供布尔值将工具提示强制设置为开启或关闭状态。
通过为 tooltip-format
属性提供一个函数,您可以自定义 slider
工具提示的值。您的 tooltip-format
函数将提供两个参数:
value
:默认情况下在工具提示中显示的当前值。
handle
:受函数影响的当前手柄。最小值或最大值。
通过使用 tooltip-format
属性,您可以为您的 slider
输入引入多样性 — 尤其是与 FormKit 的部分键类属性系统结合使用时。
有时,如果用户能够在链接字段中直接输入数字值,范围式输入对用户来说更有用。通过将 show-input
prop 设置为 true
,您可以显示绑定到 slider
范围手柄值的 number
输入。
链接的 number
输入是 FormKit 输入。您可以使用提供的 props 向它们应用属性:
input-attrs
:将您提供的对象绑定到 min
和 max
输入。min-input-attrs
:绑定到链接的 min
输入的对象。max-input-attrs
:绑定到链接的 max
输入的对象。slider
输入支持在输入轨道上渲染标记。通过将 marks
属性设置为 true
,标记将在每个 steps
间隔处渲染。
您可以通过将 mark-labels
prop 设置为 true
为标记启用标签。
通过向 marks
prop 提供对象数组而不是布尔值,您可以在滑块的轨道上放置任意标记。标记对象应具有以下属性:
at
:标记应渲染的轨道上的位置(值)。label
:如果启用了 mark-labels
prop,则为标记渲染的标签。在提供自定义标记时,您可能希望强制选择跳至提供的标记。这可以通过 snap-to-marks
prop 实现。当 snap-to-marks
为 true
时,键盘事件将跳至最接近的标记,通过键盘或链接输入输入的值将跳至最近的可用标记。
您可以通过向 chart
prop 提供数组,在滑块上方渲染具有任意值的条形图。chart
数组的结构类似于 marks
数组。每个嵌套对象应包含:
at
:条形图应渲染的轨道上的位置(值)。value
:将用于计算条形图中条的相对高度的数值。slider
输入将遍历您的 chart
数组并确定数组中包含的最大 value
,然后将所有其他值除以该最大值以确定渲染图表条的相对高度。
通过组合提供的 slider
组件属性,您可以创建一个强大的输入来覆盖各种用例。这是一个价格范围滑块的示例。
Prop | Type | 默认 | 描述 |
---|---|---|---|
chart | array | none | 包含 at 和 value 键的对象数组。在滑块轨道上方渲染相对高度的条形图。 |
input-attrs | object | {} | 将自定义属性应用于嵌套的链接 FormKit 输入,用于最小和最大值。 |
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 | 始终出现在输入开头的字符。 |
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 | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |