The Color Input component for Retool Apps
An input field to select a color.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
allowAlpha
Whether to allow opacity adjustments.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector |
| Default | false |
Examples
true
colorFormat
Whether to allow opacity adjustments.
| Type | string | ||||||
| Configurability | Inspector | ||||||
| Allowed Values |
| ||||||
| Default | null |
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
true
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
formattedValue
The selected value in the specified format.
| Type | string |
| Configurability | Read-only |
| Default | null |
iconAfter
The suffix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Suffix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Prefix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
| Type | string |
| Format | Plain Text |
| Configurability | Inspector |
| Default | colorInput1 |
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on desktop |
| Default | false |
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on mobile |
| Default | true |
Examples
true
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Content > Add-ons > Label > Position | |||||||||
| Allowed Values |
| |||||||||
| Default | left |
Examples
top
loading
Whether to display a loading indicator.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Loading |
| Default | false |
Examples
true
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
| Default | false |
Examples
true
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Spacing > Margin | |||||||||
| Allowed Values |
| |||||||||
| Default | 4px 8px |
Examples
4px 8px
placeholder
The text to display within the input field when there is no value.
| Type | string |
| Format | string |
| Configurability | Inspector > Content > Placeholder |
| Default | Enter a value |
Examples
Enter a value
readOnly
Whether user input is read-only.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Advanced > Read only |
| Default | false |
Examples
true
required
Whether a value is required to be selected.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Validation rules > Required |
| Default | false |
Examples
true
showClear
Whether to display a button to clear the value of the input field.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Show clear button |
| Default | false |
Examples
true
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
| Default | false |
Examples
true
textAfter
The suffix text to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Suffix text |
| Default | null |
Examples
USD
px
@example.com
textAlign
The alignment of the text within the input field.
| Type | string | ||||||||
| Configurability | Read-only | ||||||||
| Allowed Values |
| ||||||||
| Default | null |
textBefore
The prefix text to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Prefix text |
| Default | null |
Examples
$
Email address
SKU
tooltipText
The tooltip text to display next to the label on hover.
| Type | string |
| Format | Markdown |
| Configurability | Inspector > Content > Add-ons > Helper text |
| Default | null |
Examples
Submit
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
colorInput.clearValidation()
Clear the validation message from the input field.
colorInput.clearValidation()
Examples
Clear the validation message from colorInput.
colorInput.clearValidation();
colorInput.clearValue()
Clear the current values.
colorInput.clearValue()
Examples
Clear the current value of colorInput.
colorInput.clearValue();
colorInput.focus()
Set focus on the input field.
colorInput.focus()
Examples
Set focus on colorInput.
colorInput.focus();
colorInput.resetValue()
Reset the current value to the default value.
colorInput.resetValue()
Examples
Reset the current value of colorInput.
colorInput.resetValue();
colorInput.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
colorInput.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring colorInput into view.
colorInput.scrollIntoView({behavior: 'auto', block: 'nearest'});
colorInput.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
colorInput.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable colorInput.
colorInput.setDisabled(true);
Enable colorInput.
colorInput.setDisabled(false);
colorInput.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
colorInput.setHidden(hidden)
Parameters
Examples
true
Examples
Hide colorInput.
colorInput.setHidden(true);
Unhide colorInput.
colorInput.setHidden(false);
colorInput.setValue()
Set the current value.
colorInput.setValue(key, value)
Examples
Set the current value of colorInput to userValue.
colorInput.setValue(userValue);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Blur | The input field is deselected. |
| Change | The value is changed. |
| Focus | The input field is selected. |
| Submit | The value is submitted. |