SmartBoxToolbarToolComponent
Represents the toolbar tool for showing a smart bar. Use this component inside a ToolbarComponent in the Grid.
<kendo-grid>
<kendo-toolbar>
<kendo-grid-smartbox-tool></kendo-grid-smartbox-tool>
</kendo-toolbar>
</kendo-grid>
Selector
kendo-grid-smartbox-tool
Inputs
| Name | Type | Default | Description |
|---|---|---|---|
activeMode |
|
|
Sets the initially active mode of the tool. |
aiAssistantMode |
|
|
Controls the visibility and settings of the AI Assistant mode. By default, the mode is disabled. |
history |
|
Controls the visibility and settings of the history for each mode. | |
placeholder |
|
Sets the placeholder of the input element in the SmartBox and applies to all modes. | |
searchMode |
|
|
Controls the visibility and settings of the Search mode. By default, the mode is enabled. |
semanticSearchMode |
|
|
Controls the visibility and settings of the Semantic Search mode. By default, the mode is disabled. |
size |
|
|
Specifies the padding of the input. |
Fields
| Name | Type | Default | Description |
|---|---|---|---|
loading |
|
Indicates whether the SmartBox tool is in a loading state. Use this to show a loading indicator in the UI. |
Events
| Name | Type | Description |
|---|---|---|
aiAssistantCancelRequest |
|
Emits when the user clicks the Cancel button. |
aiAssistantPromptRequest |
|
Emits before the SmartBox tool sends the AI request.
|
aiAssistantResponseError |
|
Emits when the SmartBox tool completes the AI request with an error. The event contains the error response from the AI service and is preventable to allow stopping the default error handling. |
aiAssistantResponseSuccess |
|
Emits when the SmartBox tool completes the AI request successfully. The event contains the response from the AI service and is preventable to allow stopping the default response handling. |
close |
|
Emits when the SmartBox tool closes. |
inputBlur |
|
Emits when the SmartBox tool input is blurred. |
inputFocus |
|
Emits when the SmartBox tool input is focused. |
modeChange |
|
Emits when the mode of the SmartBox tool changes. The event contains the new mode. |
open |
|
Emits when the SmartBox tool opens. |
search |
|
Emits when the user types in Search mode. The event contains the search query and the filter descriptors created based on the query. |
semanticSearch |
|
Emits when the user types in Semantic Search mode. The event contains the search query and the filter descriptors created based on the query. |
Methods
canFocus | ||||
|---|---|---|---|---|
|
Determines if the tool can receive focus.
Returns | ||||
|
focus | ||||||
|---|---|---|---|---|---|---|
|
Called when the tool receives focus.
Accepts the original browser event, which can be a | ||||||
|
handleKey | ||||||
|---|---|---|---|---|---|---|
|
Called when the tool is focused and an arrow key is pressed.
Returns a boolean value that determines if the | ||||||
| ||||||
|