Skip to main content

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
Defaultfalse
Examples
true

colorFormat

Whether to allow opacity adjustments.

Type string
Configurability Inspector
Allowed Values
ValueDescription
hex

Displays colors in HEX format.

rgb

Displays colors in RGB format.

Defaultnull

disabled

Whether input, interaction, selection, or triggering is disabled.

Type boolean
Format True/False
Configurability Inspector > Interaction > Disabled
Defaultfalse
Examples
true

events

A list of configured event handlers that trigger actions or queries.

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
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
Defaultnull

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
Defaultnull

type

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

Defaultnull


formattedValue

The selected value in the specified format.

Type string
Configurability Read-only
Defaultnull

Examples
/icon:bold/shopping-gift

Examples
/icon:bold/shopping-gift

id

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
DefaultcolorInput1
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
Defaultfalse
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
Defaulttrue
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
ValueUI OptionDescription
topTop

Above the input field or value.

leftLeft

Left of the input field or value.

Defaultleft
Examples
top

loading

Whether to display a loading indicator.

Type boolean
Format True/False
Configurability Inspector > Interaction > Loading
Defaultfalse
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
Defaultfalse
Examples
true

margin

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
4px 8px

placeholder

The text to display within the input field when there is no value.

Type string
Formatstring
Configurability Inspector > Content > Placeholder
DefaultEnter a value
Examples
Enter a value

Examples
true

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
Defaultfalse
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
Defaultfalse
Examples
true

style

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

Examples
USD
px
@example.com

textAlign

The alignment of the text within the input field.

Type string
Configurability Read-only
Allowed Values
ValueDescription
left

Left-aligned text.

center
right

Right-aligned text.

Defaultnull

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
Defaultnull
Examples
Submit

value

The value for Color Input.

Type string
Configurability Read-only
Defaultnull

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.

Definition
colorInput.clearValidation()
Examples

Clear the validation message from colorInput.

colorInput.clearValidation();

colorInput.clearValue()

Clear the current values.

Definition
colorInput.clearValue()
Examples

Clear the current value of colorInput.

colorInput.clearValue();

colorInput.focus()

Set focus on the input field.

Definition
colorInput.focus()
Examples

Set focus on colorInput.

colorInput.focus();

colorInput.resetValue()

Reset the current value to the default value.

Definition
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.

Definition
colorInput.scrollIntoView(options)
Parameters

options

The scroll options.

Type object
Object Properties

behavior

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
nearest

Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.

start

Scrolls to position the component at the top of the visible area.

center

Scrolls to position the component in the middle of the visible area.

end

Scrolls to position the component at the bottom of the visible area.



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.

Definition
colorInput.setDisabled(disabled)
Parameters

disabled

Whether input, interaction, selection, or triggering is disabled.

Type boolean
Format True/False
Default
false
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.

Definition
colorInput.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide colorInput.

colorInput.setHidden(true);

Unhide colorInput.

colorInput.setHidden(false);

colorInput.setValue()

Set the current value.

Definition
colorInput.setValue(key, value)
Parameters

key

The key.

Type string

value

The value.

Type string | number | boolean | object | array

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.

EventDescription
BlurThe input field is deselected.
ChangeThe value is changed.
FocusThe input field is selected.
SubmitThe value is submitted.