You are reading the documentation for version 2.2. Magento 2.3 is the latest version available. Ensure you are reading the documentation for your version of Magento.

Search component

The Search component allows searching through the grid records. It is a generic tool for filtering content that aggregates all other filter elements.

Configuration options

Option Description Type Default Value
label The search field label. String 'Keyword'
placeholder Value displayed when the search field is empty. String 'Search by keyword'
statefull Defines a list of component properties whose values are automatically saved in the configured storage if they change. key is the property's name and the value defines whether its saved. {
[name: string]: boolean
{value: true}
template Path to the component’s .html template. String ui/grid/search/search

Source files

Extends UiElement: