The Search Bar component for Retool Mobile
An input field to enter a single line of text.
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.
autoCapitalize
The type of automatic capitalization that the browser can automatically perform when using virtual or on-screen keyboards.
Type | string | ||||||||||
Format | Plain Text | ||||||||||
Mutability |
| ||||||||||
Allowed Values |
| ||||||||||
Default |
|
Examples
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
hidden
Whether this object is hidden from view.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
iconAfter
The suffix icon to display.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
iconBefore
The prefix icon to display.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
label
The text label to display.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
labelCaption
The additional text to display with the label.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
|
maxLength
The maximum number of characters to allow.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
minLength
The minimum number of characters to allow.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
pattern
A regular expression (regex), without forward slashes around the pattern, to validate input if patternType
is regex
.
Type | string | ||||
Format | Regular Expression | ||||
Mutability |
| ||||
Default |
|
Examples
patternType
The pattern with which to validate the input.
Type | string | ||||||||
Format | Plain Text | ||||||||
Mutability |
| ||||||||
Allowed Values |
| ||||||||
Default |
|
placeholder
The text to display within the input field when there is no value.
Type | string | ||||
Format | string | ||||
Mutability |
| ||||
Default |
|
Examples
showCharacterCount
Whether to display a character count with the input field.
Type | boolean | ||||
Mutability |
|
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
searchBar.clearValidation()
Examples
searchBar.resetValue()
Examples
searchBar.setDisabled()
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
searchBar.setDisabled(disabled)
Parameters
Examples
searchBar.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
searchBar.setHidden(hidden)
Parameters
Examples
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. |
Suffix Icon Press | A suffix icon is pressed. |