colorpicker 输入允许进行高级颜色选择——包括支持 alpha 通道。它支持 HexHSLARGBA 格式的颜色,并且可以配置为提供预设颜色列表。

最重要的是,与原生的 color 输入不同,colorpicker 提供了跨浏览器和操作系统一致、可预测和可访问的用户体验。

colorpicker 输入完全支持键盘导航,并附带可访问性标记。

基本示例

加载实时示例

颜色格式

支持的格式

colorpicker 支持 HexHSLARGBA 格式。您可以使用 format 属性设置所需的格式,从 colorpicker 返回的颜色值将以该格式返回。您选择的格式也将成为 colorpicker 面板中显示的输入字段的默认设置。

加载实时示例

值格式

有时您可能希望向用户显示一种默认格式,但返回不同的格式。您可以使用 value-format 属性指定与 format 属性无关的返回值格式。

加载实时示例

色板

使用 options 属性提供色板,并使用与 FormKit 中的 selectdropdownautocompletetaglist 输入相同的 options API。

简单色板

这是使用 options 属性并提供一组平面颜色值数组的简单色板示例。您提供的值可以是任何支持的颜色格式(HexHSLARGBA),并将自动转换为 colorpicker 指定的默认 format,默认为 Hex

加载实时示例

分组色板

colorpicker 还支持分组的 options。这允许您在颜色选择器中创建一组共同标题下的色板集。

加载实时示例

仅色板

您可以通过使用 panel-controlspanel-format 属性并将它们设置为 false 来创建一个“仅色板”的 color-picker

在仅显示色板的弹出模式(默认)中,添加 close-on-select 属性将在选择色板时关闭弹出窗口。

加载实时示例

通过色板名称输入

如果你通过 options 属性提供的色板有 label,那么你可以使用色板名称调用 node.input(),相应的颜色将为你设置。

加载实时示例

吸管工具

colorpicker 输入支持浏览器原生的 EyeDropper API。如果你的浏览器支持 EyeDropper 并且你没有通过将 eye-dropper 属性设置为 false 来禁用 EyeDropper,那么你将在色调和透明度滑块的右侧看到一个吸管按钮。

加载实时示例

粘贴值

默认情况下,colorpicker 输入将允许在输入的任何位置粘贴任何有效的颜色值。值将立即转换为你所需的 format

你可以通过将 allow-paste 属性设置为 false 来禁用粘贴值的功能。

加载实时示例

属性 & 特性

PropType默认描述
formatstringhex应该在输入预览中显示的 `colorpicker` 输入的格式,并且是拾色器面板输入的默认设置。可以设置为 `hex`、`hsla` 或 `rgba`。
value-formatstringundefined无论显示格式如何,都应该从 `colorpicker` 输入返回的格式。如果未指定,则将使用 `format` 属性的值。
panel-controlsbooleantrue用于控制亮度/饱和度渐变以及色调和透明度滑块的显示。
panel-formatbooleantrue用于控制颜色输入字段和格式切换按钮的显示。
eye-dropperbooleantrue用于控制吸管控件的显示。需要支持 EyeDropper API 的浏览器。如果在不支持的浏览器中启用,控件将表现得好像设置为 `false`。
inlinebooleanfalse当设置为 `true` 时,`colorpicker` 将其面板作为内联元素而不是作为弹出窗口渲染。
optionsArray/Object[]值/标签对的对象,或字符串数组,或必须包含 `label` 和 `value` 属性的对象数组。通过包含 `group` 和 `options` 键的对象数组支持分组选项,其中 `options` 是嵌套的 `options` 定义。分组仅支持一级深度。
show-valuebooleantrue用于控制在输入预览中显示当前颜色值。使用 `format` 属性来确定显示哪个值。
close-on-selectbooleanfalse当设置为 `true` 时,选择预设色板选项后 `colorpicker` 面板将关闭。
allow-pastebooleantrue允许将任何有效的 `Hex`、`HSLA` 或 `RGBA` 格式的颜色字符串粘贴到包含用户焦点的 `colorpicker` 中。粘贴的字符串将立即设置为 `colorpicker` 的值并转换为所需格式。
popoverbooleanfalse使用浏览器 Popover API 渲染输入的 UI 面板。
显示 通用 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)或内容(通过插槽))。了解更多关于部分的信息,请点击这里

当存在 inline 属性时,colorpicker 输入的结构会发生变化:

弹出式结构(默认)

输入预览

View on a larger screen to see this section diagram.

选择颜色
⬛️
#000000
选择你最喜欢的颜色。
颜色是必需的

弹出面板

View on a larger screen to see this section diagram.

(panelClose 仅在弹出模式下的小触摸屏上显示)
🖼️
⬛️
🌈
👻
👁️
#️⃣
0️⃣
0️⃣
0️⃣
0️⃣
0️⃣
0️⃣
1️⃣
🟦
🟥
🟨

内联结构

View on a larger screen to see this section diagram.

选择颜色
选择你最喜欢的颜色。
🖼️
⬛️
🌈
👻
👁️
#️⃣
0️⃣
0️⃣
0️⃣
0️⃣
0️⃣
0️⃣
1️⃣
🟦
🟥
🟨
颜色是必需的
Section-key描述
swatchPreview围绕色块预览画布元素和显示的颜色值字符串的包裹 div
canvasSwatchPreview一个渲染当前颜色选择的 canvas 元素。
valueString一个包含当前颜色值字符串的 span 元素,格式通过 format 属性设置。
panel所有颜色选择器控件的包裹元素
panelClose面板的前缀部分,包含关闭按钮。仅在应用了 '固定位置' 处理的小型触摸屏设备上显示。
iconClose在 panelClose 部分输出图标的元素。
controlGroup面板内所有颜色控制元素的包裹元素
preview当前颜色预览的包裹元素。
canvasPreview一个渲染当前颜色选择的 canvas 元素。
LS亮度/饱和度控件的包裹元素
canvasLS一个渲染当前给定 hue 的可用颜色的 canvas 元素。
controlLS作为 LS 画布控制的样式元素。
hue色调控件的包裹元素
canvasHue一个渲染所有可用 hue(50% 亮度)的 canvas 元素。
controlHue作为色调画布控制的样式元素。
alpha透明度控件的包裹元素
canvasAlpha一个从 0% 到 100% 不透明度渲染当前选定颜色的 canvas 元素。
controlAlpha作为透明度画布控制的样式元素。
eyeDropper作为启用浏览器 EyeDropper API 的触发器的元素。仅在支持的浏览器中显示。
iconEyeDropper在 eyeDropper 部分输出图标的元素。
formatField包含所有颜色格式输入字段和格式切换控制的包裹元素。仅显示与当前选定面板格式相关的字段。
colorInputGroup包裹一个或多个与给定颜色格式相关的输入字段的包裹元素。
hexField十六进制颜色格式的输入。支持 #RRGGBBAA 格式,尽管不要求 alpha 十六进制值。
rFieldRGBA 颜色格式的 R 值输入。
gFieldRGBA 颜色格式的 G 值输入。
bFieldRGBA 颜色格式的 B 值输入。
hFieldHSLA 颜色格式的 H 值输入。
sFieldHSLA 颜色格式的 S 值输入。
lFieldHSLA 颜色格式的 L 值输入。
aFieldRGBA 或 HSLA 颜色格式的 A 值输入。
formatSwitcher作为在颜色选择器面板中更改当前显示颜色格式的触发器的元素。不影响输入的 formatvalue-format 设置。
iconSwitch在 formatSwitcher 部分输出图标的元素。
swatches包含通过 options 属性提供的所有可用色块的包裹元素。
swatch处理渲染由 options 属性提供的每个选项(或选项组)的元素。
显示 通用 section keys
outer最外层的包装元素。
wrapper标签和输入周围的包装器。
label输入的标签。
prefix默认情况下没有输出,但允许直接在输入元素之前放置内容。
prefixIcon输出在前缀部分之前放置一个图标的元素。
inner实际输入元素周围的包装器。
suffix默认情况下没有输出,但允许直接在输入元素之后放置内容。
suffixIcon输出在后缀部分之后放置一个图标的元素。
input输入元素本身。
help包含帮助文本的元素。
messages包装所有消息的容器。
message包含消息的元素(或多个元素) - 最常见的是验证和错误消息。

可访问性

所有 FormKit 输入都是考虑到以下可访问性因素而设计的。通过在此处提交可访问性问题,帮助我们不断改进所有人的可访问性:

语义标记Aria 属性可通过键盘访问焦点指示器与提供的主题的颜色对比可访问标签、帮助文本和错误
部分键属性默认描述
swatchPreviewtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
rolebutton向辅助技术表明此元素的功能类似于按钮。
aria-valuetext定义值的人类可读文本。
panelaria-roledialog当布局设置为弹出窗口时添加此属性。
aria-modaltrue当布局设置为弹出窗口时添加此属性。
aria-label提供一个可访问的名称。
panelClosetabindex-1 or 0通过设置为 -1(面板关闭时)和 0(打开时)来优先考虑键盘焦点顺序。
aria-label提供一个可访问的名称。
controlGrouprolegroup向辅助技术表明此元素的功能类似于一组。
canvasLSaria-hiddentrue使此元素不暴露给可访问性 API。
controlLStabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
roleslider向辅助技术表明此元素的功能类似于滑块。
aria-valuemin定义允许的最小值。
aria-valuemax定义允许的最大值。
aria-valuetext定义值的人类可读文本。
canvasHuearia-hiddentrue使此元素不暴露给可访问性 API。
controlHuetabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
roleslider向辅助技术表明此元素的功能类似于滑块。
aria-valuemin定义允许的最小值。
aria-valuemax定义允许的最大值。
aria-valuenow定义值的人类可读文本。
canvasAlphaaria-hiddentrue使此元素不暴露给可访问性 API。
controlAlphatabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
roleslider向辅助技术表明此元素的功能类似于滑块。
aria-valuemin定义允许的最小值。
aria-valuemax定义允许的最大值。
aria-valuenow定义值的人类可读文本。
canvasPreviewaria-hiddentrue使此元素不暴露给可访问性 API。
canvasSwatchPreviewaria-hiddentrue使此元素不暴露给可访问性 API。
eyeDroppertabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
rolebutton向辅助技术表明此元素的功能类似于按钮。
colorInputGrouparia-rolegroup向辅助技术表明此元素的功能类似于一组。
hexFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
rFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
gFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
bFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
aFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
hFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
sFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
lFieldtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
for将标签与输入元素关联。用户可以点击标签来聚焦输入或切换状态。
formatSwitchertabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
rolebutton向辅助技术表明此元素的功能类似于按钮。
aria-label提供一个可访问的名称。
swatchtabindex-1 or 0通过设置为 -1(禁用时)和 0(启用时)来优先考虑键盘焦点顺序。
rolebutton向辅助技术表明此元素的功能类似于按钮。
aria-label提供一个可访问的名称。
显示 通用 部分键
labellabelfor将其与输入元素关联,提高可访问性和用户体验
inputinputdisabled禁用 HTML 元素,阻止用户交互并指示非交互状态
aria-describedby通过将元素与描述关联,增强可访问性,帮助屏幕阅读器
aria-required当需要验证时,添加所需的状态
iconiconfor每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验

键盘交互

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