DxSearchPanel Plugin Reference

A plugin that renders the Search Panel.

Import

Use the following statement to import a plugin with embedded theme components:

import { DxSearchPanel } from '@devexpress/dx-vue-grid-bootstrap4';

If you want to use custom components, you can import the themeless plugin:

import { DxSearchPanel } from '@devexpress/dx-vue-grid';

Name	Type	Default	Description
inputComponent	DxSearchPanel.DxInput		A component that renders the Search Panel input element.
messages?	DxSearchPanel.LocalizationMessages		An object that specifies localization messages.

Field	Type	Description
value	string	Specifies the search value.
getMessage	(messageKey: string) => string	Returns a specified localization message.

Field	Type	Description
valueChange	(value: string) => void	Handles the search value changes.

Field	Type	Default	Description
searchPlaceholder?	string	‘Search…’	The search editor placeholder text.

Name	Type	Description
DxSearchPanel.components.DxInput	DxSearchPanel.DxInput	A component that renders the Search Panel input element.

Name	Plugin	Type	Description
searchValue	Getter	string	The applied search value.
changeSearchValue	Action	(value:string) => void	Fires the `update:value` event with the corresponding value and changes the search value state.

none