GridSearchBoxProps

Updated on Dec 23, 2025

Represents the props of the GridSearchBox component.

Name	Type	Default	Description
ariaLabel?	string		Defines the built-in aria-label property of the input element inside the TextBox.
defaultValue?	string | number | string[]
dir?	string
disabled?	boolean
fillMode?	string	solid	Configures the fillMode of the TextBox. The available options are: solid outline flat null—Does not set a fillMode class.
iconName?	string		Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons. Check the Icons article for more information about how the Font Icon can be loaded to your project.
id?	string		Renders a floating label for the TextBox component.
inputAttributes?	Object		Sets the built-in HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
inputClass?	string		Defines additional class to the input element.
inputPrefix?	string | boolean | Object | Function
inputSuffix?	string | boolean | Object | Function
label?	string
maxlength?	string		Defines the built-in maxlength property of the text inputs. As the property is directly passed to the internal input element, when defining it, it should be written as it is - maxlength. Camel-case and kebap-case won't work in this scenario.
minlength?	string		Defines the built-in minlength property of the text inputs. As the property is directly passed to the internal input element, when defining it, it should be written as it is - minlength. Camel-case and kebap-case won't work in this scenario.
modelValue?	string | number
name?	string		Specifies the name property of the input DOM element.
onBlur?	(event: any) => void		Fires when the input is blurred.
onChange?	(event: GridSearchBoxChangeEvent) => void		Fires when the value of the search box is changed.
onFocus?	(event: any) => void		Fires when the input is focused.
onKeydown?	(event: any) => void		Fires when the 'keydown' input event is triggered.
onKeypress?	(event: any) => void		Fires when the 'keypress' input event is triggered.
onKeyup?	(event: any) => void		Fires when the 'keyup' input event is triggered.
onTextBox?	(event: any) => void		Fires when the input event of the input is triggered.
placeholder?	string		Specifies the placeholder of an input element. Used to define if the input is empty.
prefix?	string | boolean | Object | Function		Defines if the inputPrefix will be shown. Accepts a slot name, a render function, or a Vue component.
required?	boolean		Specifies if null is a valid value for the component.
role?	string		Defines the role of the input element inside the TextBox.
rounded?	string	medium	Configures the roundness of the TextBox. The available options are: small medium large full null—Does not set a rounded class.
showClearButton?	boolean		Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
showLoadingIcon?	boolean		Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
showValidationIcon?	boolean		Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
size?	string	medium	Configures the size of the TextBox. The available options are: small medium large null—Does not set a size class.
suffix?	string | boolean | Object | Function		Defines if the inputSuffix will be shown. Accepts a slot name, a render function, or a Vue component.
tabIndex?	number		Defines the built-in tabindex property of the input element inside the TextBox.
title?	string		Defines the built-in title property of the input element inside the TextBox.
valid?	boolean		Overrides the validity state of the component. If valid is set, the required property will be ignored.
validate?	boolean
validationMessage?	string		Controls the form error message of the component. If set to an empty string, no error will be thrown.
validityStyles?	boolean		If set to false, no visual representation of the invalid state of the component will be applied.
value?	string | number | string[]
wrapperClass?	string		Defines additional class to the wrapper element.