Search component

Overview

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

Constructor: app/code/Magento/Ui/view/base/web/js/grid/search/search.js

Configuration options

Extends all UiElement configuration.

Search-specific configuration:

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