Search

Search lets users explore a website or application by typing keywords or phrases that find the most relevant content for them.

Read more about this component in the Aksel documentation.

Properties

PropertyDescriptionDefault
Control
Properties
label
required

Search label.

string
-
clearButton

If false, removes clear-button option from input.

boolean
true
clearButtonLabel

aria-label on clear button.

string
"Clear"
description

Adds a description to extend labling of a field.

string
""
disabled

Disables element

boolean
false
hideLabel

Shows label and description for screen readers only.

boolean
true
loading

Loading state.

boolean
false
searchIconText

Aria label on search icon.

string
"Search"
size

Size of input.

"medium" "small"
"medium"
value
bindable

Value of input.

string
""
variant

Changes button-variant, "simple" removes button

"primary" "secondary" "simple"
"primary"
Snippets
button

Custom button

 -
Events
onclear

Event when the input is cleared

 -

Properties included from: Omit<HTMLInputAttributes, "size" | "value" | "type" | "role" | "onclick">, HTMLButtonAttributes