Color Picker
Ant Design
The Color Picker component lets users pick a color from a palette or by its code, such as a label color or a brand color.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the field, or beside it when Layout is horizontal. | Text. Default: Color |
| Extra | Help text shown under the field. A validation message replaces it while the value is invalid. | Text |
| Tooltip | Text shown when the user hovers over an info icon after the label. | Text |
| Layout | vertical puts the label above the field; horizontal puts it at the left. | vertical, horizontal. Default: vertical |
| Value | Color selected when the app loads, such as #1677ff or rgb(22, 119, 255). Text that isn't a color is cleared. Reset field returns to this value. | Text |
| Format | How the selected color is written: hex, such as #1677ff, or rgb, such as rgb(22, 119, 255). | hex, rgb. Default: hex |
| Show text | Shows the color's code next to the swatch. | On or off. Default: On |
| Allow clear | Lets the user clear the color from the picker. | On or off. Default: Off |
| Disable alpha | Hides the transparency slider, so the user picks only solid colors. | On or off. Default: On |
| Presets | Groups of ready-made colors shown under the picker, as a list of {label, colors}, such as [{ label: 'Brand', colors: ['#1677ff'] }]. | Array |
| Size | Size of the color swatch. | small, middle, large. Default: middle |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets the component grow with its content in the running app instead of keeping a fixed height. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows the component in the mobile layout. | On or off. Default: Off |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On change | Triggers when the color changes, including while the user drags in the picker. |
| On change complete | Triggers when the user finishes picking a color, such as when they release the pointer. |
Component Specific Actions (CSA)​
Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.
Action | Description | How To Access |
|---|---|---|
| Set field value | Changes the color to the given Value and fires On change. Text that isn't a color is ignored. | components.colorpicker1.setFieldValue("") |
| Reset field | Returns the color to the Value property's value. | components.colorpicker1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.colorpicker1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.colorpicker1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.colorpicker1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the field, or beside it when Layout is horizontal. | {{components.colorpicker1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is invalid. | {{components.colorpicker1.extra}} |
tooltip | Text shown when the user hovers over an info icon after the label. | {{components.colorpicker1.tooltip}} |
layout | vertical puts the label above the field; horizontal puts it at the left. | {{components.colorpicker1.layout}} |
value | Color selected when the app loads, such as #1677ff or rgb(22, 119, 255). Text that isn't a color is cleared. Reset field returns to this value. | {{components.colorpicker1.value}} |
format | How the selected color is written: hex, such as #1677ff, or rgb, such as rgb(22, 119, 255). | {{components.colorpicker1.format}} |
showText | Shows the color's code next to the swatch. | {{components.colorpicker1.showText}} |
allowClear | Lets the user clear the color from the picker. | {{components.colorpicker1.allowClear}} |
disabledAlpha | Hides the transparency slider, so the user picks only solid colors. | {{components.colorpicker1.disabledAlpha}} |
presets | Groups of ready-made colors shown under the picker, as a list of {label, colors}, such as [{ label: 'Brand', colors: ['#1677ff'] }]. | {{components.colorpicker1.presets}} |
size | Size of the color swatch. | {{components.colorpicker1.size}} |
isVisible | Whether the component is visible. | {{components.colorpicker1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.colorpicker1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.colorpicker1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 0px 0px 0px #00000040 |
A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.