Skip to main content

The Year component for Retool Apps

A dropdown menu and input field to select or enter a year.

Year is a preset version of Select. It has been preconfigured with a list of values.

Demo

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.

allowCustomValue​

Whether to allow values that do not exist in values.

Type boolean
Format True/False
Configurability Inspector
Defaultfalse
Examples
falsetrue

allowDeselect​

Whether to allow deselection of an item.

Type boolean
Format True/False
Configurability Inspector
Defaultfalse
Examples
falsetrue

clearInputValueOnChange​

Whether to clear the input value when the selection changes.

Type boolean
Configurability Inspector
Defaultnull

deprecatedLabels​

A list of labels (deprecated).

Type array
Array values string
Configurability Read-only
Defaultnull

disabled​

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

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

disabledValues​

A list of values not available for selection.

Type array
Array values boolean
Configurability Read-only
Defaultnull

emptyMessage​

The message to display if no value is set.

Type string
Configurability Inspector > Appearance > Empty state
Defaultnull

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

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
Defaultyear1
Examples
falsequery1
falsebutton1

inputValue​

The default or most recently entered value.

Type string
Configurability Read-only
Defaultnull

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
falsetrue

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
falsetrue

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
falsetop

loading​

Whether to display a loading indicator.

Type boolean
Format True/False
Configurability Inspector > Interaction > Loading
Defaultfalse
Examples
falsetrue

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
falsetrue

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
false4px 8px

overlayMaxHeight​

The maximum height of the options list, in pixels.

Type number
Format Integer
Configurability Inspector > Appearance > Advanced > Max list height
Defaultnull
Examples
false200

overlayMinWidth​

The minimum width of the options list, in pixels.

Type number
Format Integer
Configurability Inspector > Appearance > Advanced > Min list width
Defaultnull
Examples
false200

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
falseEnter a value

readOnly​

Whether user input is read-only.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Read only
Defaultfalse
Examples
falsetrue

required​

Whether a value is required to be selected.

Type boolean
Format True/False
Configurability Inspector > Interaction > Validation rules > Required
Defaultfalse
Examples
falsetrue

searchMode​

The type of search to perform.

Type string
Configurability Inspector
Allowed Values
ValueDescription
fuzzy

Searches using fuzzy logic.

caseInsensitive

Ignores the case used in search terms.

caseSensitive

Matches the case used in search terms.

Defaultnull

selectedIndex​

The selected values, by index.

Type number
Format Integer
Configurability Read-only
Default[]
Examples
false["Value 1", "Value 2"]

selectedItem​

The selected item.

Type string | number | boolean | object | array
Format Custom data
Configurability Read-only
Defaultnull
Examples
false{"id": "1", "name": "Item 1"}

selectedLabel​

The label of the selected value, by index.

Type string
Formatstring
Configurability Read-only
Defaultnull
Examples
falseValue 1

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
falsetrue

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
falsetrue

showSelectionIndicator​

Whether to display an icon next to a selected item.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show selection indicator
Defaulttrue
Examples
falsetrue

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

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
falseSubmit

value​

The current value.

Type string | number | boolean | object | array
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.

year.blur()​

The input field is deselected.

Definition
year.blur()
Examples

Remove focus from year.

year.blur();

year.clearValidation()​

Clear the validation message from the input field.

Definition
year.clearValidation()
Examples

Clear the validation message from year.

year.clearValidation();

year.clearValue()​

Clear the current values.

Definition
year.clearValue()
Examples

Clear the current value of year.

year.clearValue();

year.focus()​

Set focus on the component.

Definition
year.focus()
Examples

Set focus on year.

year.focus();

year.resetValue()​

Reset the current value to the default value.

Definition
year.resetValue()
Examples

Reset the current value of year.

year.resetValue();

year.scrollIntoView()​

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition
year.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 year into view.

year.scrollIntoView({behavior: 'auto', block: 'nearest'});

year.setDisabled()​

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition
year.setDisabled(disabled)
Parameters

disabled​

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

Type boolean
Format True/False
Default
false
Examples
true
Examples

Disable year.

year.setDisabled(true);

Enable year.

year.setDisabled(false);

year.setHidden()​

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition
year.setHidden(hidden)
Parameters

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true
Examples

Hide year.

year.setHidden(true);

Unhide year.

year.setHidden(false);

year.setValue()​

Set the current value.

Definition
year.setValue(key, value)
Parameters

key​

The key.

Type string

value​

The value.

Type string | number | boolean | object | array
Examples

Set the current value of year to userValue.

year.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.
Input Value ChangeThe input value is changed.