@progress/kendo-angular-grid
Version:
Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.
121 lines (120 loc) • 6.07 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { EventEmitter } from '@angular/core';
import { ToolBarToolComponent } from '@progress/kendo-angular-toolbar';
import { GridSmartBoxAIAssistantSettings, GridSmartBoxHistorySettings, GridSmartBoxMode, GridSmartBoxRequestEvent, GridSmartBoxResponseErrorEvent, GridSmartBoxResponseSuccessEvent, GridSmartBoxSearchEvent, GridSmartBoxSearchSettings, GridSmartBoxSemanticSearchEvent, GridSmartBoxSemanticSearchSettings, GridSmartBoxSize } from './models';
import { GridSmartBoxPromptSuggestionTemplateDirective } from './smartbox-suggestion.template';
import { GridSmartBoxHistoryItemTemplateDirective } from './smartbox-history-item.template';
import * as i0 from "@angular/core";
/**
* Represents the toolbar tool for showing a smart bar.
* Use this component inside a ToolbarComponent in the Grid.
*
* @example
* ```html
* <kendo-grid>
* <kendo-toolbar>
* <kendo-grid-smartbox-tool></kendo-grid-smartbox-tool>
* </kendo-toolbar>
* </kendo-grid>
* ```
*/
export declare class SmartBoxToolbarToolComponent extends ToolBarToolComponent {
promptSuggestionTemplate: GridSmartBoxPromptSuggestionTemplateDirective;
historyItemTemplate: GridSmartBoxHistoryItemTemplateDirective;
/**
* Controls the visibility and settings of the Search mode. By default, the mode is enabled.
*
* @default true
*/
searchMode: boolean | GridSmartBoxSearchSettings;
/**
* Controls the visibility and settings of the Semantic Search mode. By default, the mode is disabled.
*
* @default false
*/
semanticSearchMode: boolean | GridSmartBoxSemanticSearchSettings;
/**
* Controls the visibility and settings of the AI Assistant mode. By default, the mode is disabled.
*
* @default false
*/
aiAssistantMode: boolean | GridSmartBoxAIAssistantSettings;
/**
* Sets the initially active mode of the tool.
*
* @default 'search'
*/
activeMode: GridSmartBoxMode;
/**
* Controls the visibility and settings of the history for each mode.
*/
history: boolean | GridSmartBoxHistorySettings;
/**
* Sets the placeholder of the input element in the SmartBox and applies to all modes.
*/
placeholder: string;
/**
* Specifies the padding of the input.
*
* @default 'medium'
*/
size: GridSmartBoxSize;
/**
* Emits when the SmartBox tool opens.
*/
open: EventEmitter<any>;
/**
* Emits when the SmartBox tool closes.
*/
close: EventEmitter<any>;
/**
* Emits when the SmartBox tool input is focused.
*/
inputFocus: EventEmitter<any>;
/**
* Emits when the SmartBox tool input is blurred.
*/
inputBlur: EventEmitter<any>;
/**
* 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.
*/
aiAssistantPromptRequest: EventEmitter<GridSmartBoxRequestEvent>;
/**
* 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.
*/
aiAssistantResponseSuccess: EventEmitter<GridSmartBoxResponseSuccessEvent>;
/**
* 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.
*/
aiAssistantResponseError: EventEmitter<GridSmartBoxResponseErrorEvent>;
/**
* Emits when the user clicks the Cancel button.
*/
aiAssistantCancelRequest: EventEmitter<undefined>;
/**
* Emits when the user types in Search mode. The event contains the search query and the filter descriptors created based on the query.
*/
search: EventEmitter<GridSmartBoxSearchEvent>;
/**
* Emits when the user types in Semantic Search mode. The event contains the search query and the filter descriptors created based on the query.
*/
semanticSearch: EventEmitter<GridSmartBoxSemanticSearchEvent>;
/**
* Emits when the mode of the SmartBox tool changes. The event contains the new mode.
*/
modeChange: EventEmitter<GridSmartBoxMode>;
/**
* Indicates whether the SmartBox tool is in a loading state. Use this to show a loading indicator in the UI.
*/
loading: boolean;
constructor();
static ɵfac: i0.ɵɵFactoryDeclaration<SmartBoxToolbarToolComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SmartBoxToolbarToolComponent, "kendo-grid-smartbox-tool", never, { "searchMode": { "alias": "searchMode"; "required": false; }; "semanticSearchMode": { "alias": "semanticSearchMode"; "required": false; }; "aiAssistantMode": { "alias": "aiAssistantMode"; "required": false; }; "activeMode": { "alias": "activeMode"; "required": false; }; "history": { "alias": "history"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "size": { "alias": "size"; "required": false; }; }, { "open": "open"; "close": "close"; "inputFocus": "inputFocus"; "inputBlur": "inputBlur"; "aiAssistantPromptRequest": "aiAssistantPromptRequest"; "aiAssistantResponseSuccess": "aiAssistantResponseSuccess"; "aiAssistantResponseError": "aiAssistantResponseError"; "aiAssistantCancelRequest": "aiAssistantCancelRequest"; "search": "search"; "semanticSearch": "semanticSearch"; "modeChange": "modeChange"; }, ["promptSuggestionTemplate", "historyItemTemplate"], never, true, never>;
}