@progress/kendo-react-grid
Version:
React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package
94 lines (93 loc) • 2.57 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { SVGIcon } from '@progress/kendo-svg-icons';
import { SmartBoxMode } from '../interfaces/index.js';
/**
* Represents a minimal mode configuration for labels.
*
* @hidden
*/
export interface SmartBoxLabelsModeConfig {
/**
* Specifies whether the mode is enabled.
*/
enabled?: boolean;
/**
* The placeholder text for the mode.
*/
placeholder?: string;
}
/**
* Represents the props for the useSmartBoxLabels hook.
*
* @hidden
*/
export interface UseSmartBoxLabelsProps {
/**
* The currently selected view mode.
*/
selectedView: SmartBoxMode | null;
/**
* The search mode configuration.
*/
searchMode: SmartBoxLabelsModeConfig | null;
/**
* The semantic search mode configuration.
*/
semanticSearchMode: SmartBoxLabelsModeConfig | null;
/**
* The AI assistant mode configuration.
*/
aiAssistantMode: SmartBoxLabelsModeConfig | null;
/**
* The shared placeholder text that overrides mode-specific placeholders.
*/
sharedPlaceholder?: string;
}
/**
* Represents a prefix icon configuration.
*
* @hidden
*/
export interface SmartBoxPrefixIcon {
/**
* The icon name.
*/
name: string;
/**
* The SVG icon.
*/
svgIcon: SVGIcon;
}
/**
* Represents the return value of the useSmartBoxLabels hook.
*
* @hidden
*/
export interface UseSmartBoxLabelsResult {
/**
* The placeholder text for the input based on the selected mode.
*/
inputPlaceholder: string;
/**
* The prefix icon configuration based on the selected mode.
*/
prefixIcon: SmartBoxPrefixIcon;
}
/**
* Hook to compute SmartBox labels and icons based on the selected mode.
*
* This hook determines the appropriate placeholder text and prefix icon
* based on the currently selected mode, using localized strings.
*
* @param props - The hook properties.
* @returns An object containing the input placeholder and prefix icon.
*
* @hidden
*/
export declare function useSmartBoxLabels({ selectedView, searchMode, semanticSearchMode, aiAssistantMode, sharedPlaceholder }: UseSmartBoxLabelsProps): UseSmartBoxLabelsResult;