New to Kendo UI for Angular? Start a free 30-day trial

SmartBoxToolbarToolComponent

Component

Represents the toolbar tool for showing a smart bar. Use this component inside a ToolbarComponent in the Grid.

Definition

Package:@progress/kendo-angular-grid

Selector:kendo-grid-smartbox-tool

Syntax:

html

<kendo-grid>
     <kendo-toolbar>
        <kendo-grid-smartbox-tool></kendo-grid-smartbox-tool>
     </kendo-toolbar>
</kendo-grid>

Inputs

activeMode

GridSmartBoxMode

Sets the initially active mode of the tool.

Default:

'search'

aiAssistantMode

boolean | GridSmartBoxAIAssistantSettings

Controls the visibility and settings of the AI Assistant mode. By default, the mode is disabled.

Default:

false

history

boolean | GridSmartBoxHistorySettings

Controls the visibility and settings of the history for each mode.

placeholder

string

Sets the placeholder of the input element in the SmartBox and applies to all modes.

searchMode

boolean | GridSmartBoxSearchSettings

Controls the visibility and settings of the Search mode. By default, the mode is enabled.

Default:

true

semanticSearchMode

boolean | GridSmartBoxSemanticSearchSettings

Controls the visibility and settings of the Semantic Search mode. By default, the mode is disabled.

Default:

false

size

GridSmartBoxSize

Specifies the padding of the input.

Default:

'medium'

Fields

loading

boolean

Indicates whether the SmartBox tool is in a loading state. Use this to show a loading indicator in the UI.

Default:

false

Events

aiAssistantCancelRequest

EventEmitter<undefined>

Emits when the user clicks the Cancel button.

aiAssistantPromptRequest

EventEmitter<GridSmartBoxRequestEvent>

Emits before the SmartBox tool sends the AI request.

When you provide a requestUrl, you can handle the event to modify the request options.
When you do not provide a requestUrl, you can handle the event to perform an entirely custom request.

aiAssistantResponseError

EventEmitter<GridSmartBoxResponseErrorEvent>

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

EventEmitter<GridSmartBoxResponseSuccessEvent>

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

EventEmitter<any>

Emits when the SmartBox tool closes.

inputBlur

EventEmitter<any>

Emits when the SmartBox tool input is blurred.

inputFocus

EventEmitter<any>

Emits when the SmartBox tool input is focused.

modeChange

EventEmitter<GridSmartBoxMode>

Emits when the mode of the SmartBox tool changes. The event contains the new mode.

open

EventEmitter<any>

Emits when the SmartBox tool opens.

search

EventEmitter<GridSmartBoxSearchEvent>

Emits when the user types in Search mode. The event contains the search query and the filter descriptors created based on the query.

semanticSearch

EventEmitter<GridSmartBoxSemanticSearchEvent>

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 true if the tool participates in keyboard navigation.

Returns:

boolean

true if the tool is focusable.

focus

Called when the tool receives focus. Accepts the original browser event, which can be a KeyboardEvent, MouseEvent, or FocusEvent.

Parameters:_ev?Event

The event that triggers focus for the tool.

handleKey

Called when the tool is focused and an arrow key is pressed. Returns a boolean value that determines if the ToolBarComponent moves focus to the next or previous tool (see example).

Parameters:_evKeyboardEvent

The last pressed arrow key.

Returns:

boolean

true if focus moves to another tool.