Skip to content

Search Field

The search field is a one-line text field for entering a search string. Clicking the search icon in the component or pressing the Enter key activates the action.

Property

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-generatedidstringAuto-generatedThe [id] property cannot be set by actions.
2Label LStringSearch FieldlabelstringSearch FieldComponent label
3WidthString222widthstring222Component width
4HeightString55heightstring55Component height
5XStringxstringX coordinate position
6YStringystringY coordinate position
7LockBooleanOFFlockbooleanfalseWhen ON, the component stays fixed even when the screen is scrolled.
When OFF, the component moves along with the screen scroll.
Added in v4.1.0.
8SizeSelection
1. Small
2. Medium
3. None
NonesizestringnoneWhen a value other than None is selected, Height is disabled.
When Legacy Design is ON, Size is disabled.
Added in v4.2.0.
9VariantSelection
1. Outlined
2. Filled
3. Standard
OutlinedvariantstringoutlinedComponent style
10Legacy DesignBooleanOFFThis is only effective when the Variant is set to Standard.
When ON, the component is displayed with the legacy design.
When OFF, the component is displayed with the new design.
Added in v4.1.0
11ColorString
Color Picker
colorstringComponent color
12Background ColorString
Color Picker
backgroundColorstringBackground color
13Label ColorString
Color Picker
labelColorstringLabel color
14Input ColorString
Color Picker
inputColorstringInput text color
15DisabledBooleanOFFdisabledbooleanfalseDisabled state
16Read OnlyBooleanOFFreadOnlybooleanfalseRead-only state
17VisibilityBooleanONvisibilitybooleantrueComponent show/hide
18PlaceholderStringplaceholderstringPlaceholder text
19Helper TextStringhelperTextstringHelper text
20Click EventSelection
1. None
2. UI Script
3. Action
4. Detached Action
ActionEvent on click
Detached Action became selectable in v4.1.0.
UI Script became selectable in v4.2.0.
21ValueStringvaluestringSearch field value
22ErrorerrorbooleanfalseError state
23Detached ActionSelection
1. [Detached Action ID]
detachedActionstringSet a detached action
Added in v4.1.0.
24Tab FocusSelection
1.[Component ID]
tabFocusstringNext focus component specification
Added in v3.3.0

Event

Event nameDescription
onclickOccurs when clicking the search icon or pressing the Enter key.