@progress/kendo-react-grid 14.0.0-develop.1 → 14.0.0-develop.3

package/toolbar-tools/smartbox/hooks/useSmartBoxSearch.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridSmartBoxSearchProps, GridSmartBoxSearchEvent, SmartBoxMode } from '../interfaces/index.js';
+import { GridSmartBoxHistoryProps } from '../interfaces/utilTypes.js';
+/**
+ * Represents the props for the useSmartBoxSearch hook.
+ *
+ * @hidden
+ */
+export interface UseSmartBoxSearchProps {
+    /**
+     * The currently selected view mode.
+     */
+    selectedView: SmartBoxMode | null;
+    /**
+     * The search mode configuration.
+     */
+    searchMode: GridSmartBoxSearchProps | null;
+    /**
+     * The grid columns used for filtering.
+     */
+    columns: Array<{
+        field: string;
+    }>;
+    /**
+     * The grid context providing access to grid operations.
+     */
+    gridContext: any;
+    /**
+     * The history settings for search mode.
+     */
+    searchHistorySettings: GridSmartBoxHistoryProps | null;
+    /**
+     * The history settings for semantic search mode.
+     */
+    semanticSearchHistorySettings: GridSmartBoxHistoryProps | null;
+    /**
+     * Function to add a new item to the history.
+     */
+    addToHistory: (mode: SmartBoxMode, value: string, historySettings: GridSmartBoxHistoryProps | null) => void;
+    /**
+     * Callback function fired when a search is performed.
+     */
+    onSearch?: (event: GridSmartBoxSearchEvent) => void;
+    /**
+     * Callback function fired when a semantic search is performed.
+     */
+    onSemanticSearch?: (event: GridSmartBoxSearchEvent) => void;
+}
+/**
+ * Represents the return value of the useSmartBoxSearch hook.
+ *
+ * @hidden
+ */
+export interface UseSmartBoxSearchReturn {
+    /**
+     * Function to emit a search event with the given value.
+     * Creates filter descriptors and triggers the appropriate callback
+     * based on the selected view mode.
+     *
+     * @param value - The search value to emit.
+     */
+    emitSearchEvent: (value: string) => void;
+}
+/**
+ * Hook to handle search event emission for SmartBox.
+ *
+ * This hook creates filter descriptors based on the search value and configured fields,
+ * emits the appropriate search event (search or semantic search), and optionally
+ * applies the filter to the grid if the default action is not prevented.
+ *
+ * @param props - The hook properties.
+ * @returns An object containing the emitSearchEvent function.
+ *
+ * @hidden
+ */
+export declare function useSmartBoxSearch({ selectedView, searchMode, columns, gridContext, searchHistorySettings, semanticSearchHistorySettings, addToHistory, onSearch, onSemanticSearch }: UseSmartBoxSearchProps): UseSmartBoxSearchReturn;

package/toolbar-tools/smartbox/hooks/useSmartBoxSearch.js

@@ -0,0 +1,9 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("react");function j(t){const e=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(t){for(const l in t)if(l!=="default"){const f=Object.getOwnPropertyDescriptor(t,l);Object.defineProperty(e,l,f.get?f:{enumerable:!0,get:()=>t[l]})}}return e.default=t,Object.freeze(e)}const o=j(g);function v({selectedView:t,searchMode:e,columns:l,gridContext:f,searchHistorySettings:p,semanticSearchHistorySettings:c,addToHistory:i,onSearch:n,onSemanticSearch:s}){return{emitSearchEvent:o.useCallback(r=>{var O;if(!t||t==="aiAssistant")return;const b=((O=e==null?void 0:e.fields)!=null&&O.length?e.fields:l.map(u=>u.field)).map(u=>({field:u,operator:"contains",value:r,ignoreCase:!0}));let a=!1;const m={searchValue:r,filters:b,logic:"or",isDefaultPrevented:()=>a,preventDefault:()=>{a=!0}};if(t==="search"){if(n==null||n(m),!a&&(f!=null&&f.filterChange)){const u=r.trim()?{filters:b,logic:"or"}:null;f.filterChange(u,{})}i("search",r,p)}else t==="semanticSearch"&&(s==null||s(m),i("semanticSearch",r,c))},[t,e,l,f,n,s,i,p,c])}}exports.useSmartBoxSearch=v;

package/toolbar-tools/smartbox/hooks/useSmartBoxSearch.mjs

@@ -0,0 +1,67 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import * as B from "react";
+function j({
+  selectedView: f,
+  searchMode: l,
+  columns: v,
+  gridContext: p,
+  searchHistorySettings: D,
+  semanticSearchHistorySettings: E,
+  addToHistory: m,
+  onSearch: u,
+  onSemanticSearch: i
+}) {
+  return {
+    emitSearchEvent: B.useCallback(
+      (s) => {
+        var A;
+        if (!f || f === "aiAssistant")
+          return;
+        const b = ((A = l == null ? void 0 : l.fields) != null && A.length ? l.fields : v.map((t) => t.field)).map((t) => ({
+          field: t,
+          operator: "contains",
+          value: s,
+          ignoreCase: !0
+        }));
+        let r = !1;
+        const k = {
+          searchValue: s,
+          filters: b,
+          logic: "or",
+          isDefaultPrevented: () => r,
+          preventDefault: () => {
+            r = !0;
+          }
+        };
+        if (f === "search") {
+          if (u == null || u(k), !r && (p != null && p.filterChange)) {
+            const t = s.trim() ? { filters: b, logic: "or" } : null;
+            p.filterChange(t, {});
+          }
+          m("search", s, D);
+        } else f === "semanticSearch" && (i == null || i(k), m("semanticSearch", s, E));
+      },
+      [
+        f,
+        l,
+        v,
+        p,
+        u,
+        i,
+        m,
+        D,
+        E
+      ]
+    )
+  };
+}
+export {
+  j as useSmartBoxSearch
+};

package/toolbar-tools/smartbox/hooks/useSmartBoxSegmentedControl.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { SmartBoxMode, SegmentedButtonProps } from '../interfaces/index.js';
+import * as React from 'react';
+/**
+ * Represents a minimal mode configuration for the segmented control.
+ *
+ * @hidden
+ */
+export interface SmartBoxModeConfig {
+    /**
+     * Specifies whether the mode is enabled.
+     */
+    enabled?: boolean;
+}
+/**
+ * Represents the props for the useSmartBoxSegmentedControl hook.
+ *
+ * @hidden
+ */
+export interface UseSmartBoxSegmentedControlProps {
+    /**
+     * The search mode configuration.
+     */
+    searchMode: SmartBoxModeConfig | null;
+    /**
+     * The semantic search mode configuration.
+     */
+    semanticSearchMode: SmartBoxModeConfig | null;
+    /**
+     * The AI assistant mode configuration.
+     */
+    aiAssistantMode: SmartBoxModeConfig | null;
+    /**
+     * The currently selected view mode.
+     */
+    selectedView: SmartBoxMode | null;
+    /**
+     * The last selected search mode (either 'search' or 'semanticSearch').
+     * Used to restore the previous search mode when switching back from AI Assistant.
+     */
+    lastSearchMode: SmartBoxMode | null;
+    /**
+     * Callback function to update the selected view state.
+     */
+    setSelectedViewState: (view: SmartBoxMode) => void;
+    /**
+     * Callback function to update the input value.
+     */
+    setInputValue: React.Dispatch<React.SetStateAction<string>>;
+}
+/**
+ * Hook to generate segmented control buttons for switching between SmartBox modes.
+ *
+ * This hook creates the button configuration for the segmented control that allows
+ * users to switch between Search and AI Assistant modes. When both search modes
+ * (standard and semantic) are available, the Search button dynamically shows the
+ * appropriate icon based on the last selected search mode.
+ *
+ * @param props - The hook properties.
+ * @returns An array of segmented button props for the mode switcher.
+ *
+ * @hidden
+ */
+export declare function useSmartBoxSegmentedControl({ searchMode, semanticSearchMode, aiAssistantMode, selectedView, lastSearchMode, setSelectedViewState, setInputValue }: UseSmartBoxSegmentedControlProps): SegmentedButtonProps[];

package/toolbar-tools/smartbox/hooks/useSmartBoxSegmentedControl.js

@@ -0,0 +1,9 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const v=require("react"),I=require("@progress/kendo-svg-icons");function y(n){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(n){for(const u in n)if(u!=="default"){const b=Object.getOwnPropertyDescriptor(n,u);Object.defineProperty(t,u,b.get?b:{enumerable:!0,get:()=>n[u]})}}return t.default=n,Object.freeze(t)}const x=y(v);function C({searchMode:n,semanticSearchMode:t,aiAssistantMode:u,selectedView:b,lastSearchMode:l,setSelectedViewState:f,setInputValue:r}){return x.useMemo(()=>{const g=[],p=(n==null?void 0:n.enabled)||(t==null?void 0:t.enabled),k=u==null?void 0:u.enabled;if(p&&k){const O=b==="search"||b==="semanticSearch",c=l||(n!=null&&n.enabled?"search":"semanticSearch"),o=b==="semanticSearch"||b==="aiAssistant"&&c==="semanticSearch",j=o?I.zoomSparkleIcon:I.searchIcon;g.push({buttonId:1,text:"Search",svgIcon:j,selected:O,accentIcon:o,onClick:()=>{l&&(l==="search"?n!=null&&n.enabled:t!=null&&t.enabled)?f(l):n!=null&&n.enabled?f("search"):t!=null&&t.enabled&&f("semanticSearch"),r("")}}),g.push({buttonId:2,text:"AI Assistant",svgIcon:I.sparklesIcon,selected:b==="aiAssistant",accentIcon:!0,onClick:()=>{f("aiAssistant"),r("")}})}return g},[n,t,u,b,l,f,r])}exports.useSmartBoxSegmentedControl=C;

package/toolbar-tools/smartbox/hooks/useSmartBoxSegmentedControl.mjs

@@ -0,0 +1,57 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import * as A from "react";
+import { zoomSparkleIcon as R, searchIcon as j, sparklesIcon as q } from "@progress/kendo-svg-icons";
+function D({
+  searchMode: n,
+  semanticSearchMode: b,
+  aiAssistantMode: p,
+  selectedView: u,
+  lastSearchMode: I,
+  setSelectedViewState: f,
+  setInputValue: k
+}) {
+  return A.useMemo(() => {
+    const l = [], g = (n == null ? void 0 : n.enabled) || (b == null ? void 0 : b.enabled), C = p == null ? void 0 : p.enabled;
+    if (g && C) {
+      const v = u === "search" || u === "semanticSearch", B = I || (n != null && n.enabled ? "search" : "semanticSearch"), x = u === "semanticSearch" || u === "aiAssistant" && B === "semanticSearch", z = x ? R : j;
+      l.push({
+        buttonId: 1,
+        text: "Search",
+        svgIcon: z,
+        selected: v,
+        accentIcon: x,
+        onClick: () => {
+          I && (I === "search" ? n != null && n.enabled : b != null && b.enabled) ? f(I) : n != null && n.enabled ? f("search") : b != null && b.enabled && f("semanticSearch"), k("");
+        }
+      }), l.push({
+        buttonId: 2,
+        text: "AI Assistant",
+        svgIcon: q,
+        selected: u === "aiAssistant",
+        accentIcon: !0,
+        onClick: () => {
+          f("aiAssistant"), k("");
+        }
+      });
+    }
+    return l;
+  }, [
+    n,
+    b,
+    p,
+    u,
+    I,
+    f,
+    k
+  ]);
+}
+export {
+  D as useSmartBoxSegmentedControl
+};

package/toolbar-tools/smartbox/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+export * from './interfaces/index.js';
+export * from './SmartBox.js';
+export * from './SegmentedControl.js';

package/toolbar-tools/smartbox/interfaces/SearchTypes.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridSmartBoxHistoryProps } from './utilTypes.js';
+export interface GridSmartBoxAIAssistantSearchProps {
+    /**
+     * Sets the settings for the history queries of all modes.
+     * When set to `true`, enables history with default settings for all modes.
+     * When set to `false`, disables history for all modes.
+     * When set to an object, configures the history settings for all modes.
+     * This shared setting overrides individual mode history settings (e.g., `searchConfig.history`).
+     *
+     * @example
+     * ```tsx
+     * // Enable history with default settings for all modes
+     * <SmartBox history={true} />
+     *
+     * // Disable history for all modes
+     * <SmartBox history={false} />
+     *
+     * // Configure history settings for all modes (overrides individual mode settings)
+     * <SmartBox history={{ size: 10, timestampFormat: 'HH:mm' }} />
+     * ```
+     */
+    history?: boolean | GridSmartBoxHistoryProps;
+    /**
+     * Sets the placeholder text for the SmartBox input.
+     */
+    placeholder?: string;
+    /**
+     * Specifies whether the mode is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * Sets the delay in milliseconds before triggering search.
+     */
+    delay?: number;
+}
+export interface GridSmartBoxSearchProps extends GridSmartBoxAIAssistantSearchProps {
+    fields?: Array<string>;
+}

package/toolbar-tools/smartbox/interfaces/SegmentedControlTypes.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ButtonProps } from '@progress/kendo-react-buttons';
+import { SVGIcon } from '@progress/kendo-svg-icons';
+/**
+ * @hidden
+ *
+ * Defines the props for a Button inside the SegmentedControlComponent.
+ */
+export interface SegmentedButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    /**
+     * The unique identifier for the SegmentedButton.
+     */
+    buttonId: number;
+    /**
+     * Sets an SVG icon to display inside the Button.
+     */
+    svgIcon?: SVGIcon;
+    /**
+     * Specifies the text content of the Button.
+     */
+    text?: string;
+    /**
+     * Specifies whether the button is selected.
+     */
+    selected?: boolean;
+    /**
+     * Specifies whether the icon should use the accent color when the button is selected.
+     *
+     * @default false
+     */
+    accentIcon?: boolean;
+}
+/**
+ * @hidden
+ */
+export interface SegmentedControlHandle {
+    /**
+     * The root DOM element of the SegmentedControl.
+     */
+    element: HTMLDivElement | null;
+}
+/**
+ * @hidden
+ */
+export interface SegmentedControlProps {
+    /**
+     * Specifies the collection of buttons that will be rendered inside the SegmentedControl.
+     */
+    buttons?: Array<SegmentedButtonProps>;
+    /**
+     * Sets the padding of the control.
+     *
+     *
+     */
+    size?: ButtonProps['size'];
+    /**
+     * Specifies whether the SegmentedControl should stretch to fill the available horizontal space.
+     */
+    stretched?: boolean;
+}