@capillarytech/blaze-ui 1.0.2 → 1.0.3-alpha.10

package/CapUnifiedSelect/CapUnifiedSelect.d.ts

@@ -0,0 +1,153 @@
+import type { TreeSelectProps } from 'antd-v5';
+import React from 'react';
+import { type SelectType } from './constants';
+interface OptionData {
+    label?: React.ReactNode;
+    value?: string | number;
+    key?: string | number;
+    title?: React.ReactNode;
+    children?: OptionData[];
+    optionSuffix?: React.ReactNode;
+    optionSuffixInfo?: React.ReactNode;
+    optionTooltipInfo?: React.ReactNode;
+    disabled?: boolean;
+    [key: string]: unknown;
+}
+export interface CapUnifiedSelectProps extends Omit<TreeSelectProps, 'treeData' | 'value' | 'onChange'> {
+    type?: SelectType;
+    options?: OptionData[];
+    value?: string | number | (string | number)[] | undefined;
+    onChange?: (value: string | number | (string | number)[] | undefined) => void;
+    placeholder?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+    isError?: boolean;
+    errorMessage?: string;
+    containerClassName?: string;
+    popoverClassName?: string;
+    allowClear?: boolean;
+    headerLabel?: string;
+    onUpload?: () => void;
+    /**
+     * Label text for the upload button
+     * @default "Upload"
+     */
+    uploadLabel?: string;
+    tooltip?: React.ReactNode;
+    bylineText?: string;
+    disabled?: boolean;
+    showUpload?: boolean;
+    customPopupRender?: boolean;
+    showSearch?: boolean;
+    searchBasedOn?: 'label' | 'value' | 'key';
+    /**
+     * Search callback function that triggers when user types in search input.
+     * When staticValue is false, this enables API-based search with debouncing.
+     * @param query - The search query string entered by user
+     * @example
+     * onSearch={(query) => {
+     *   actions.searchDependentEnumsRequest({ searchQuery: query });
+     * }}
+     */
+    onSearch?: (query: string) => void;
+    /**
+     * Debounce timeout for search input in milliseconds.
+     * Controls when and how often the search callback is triggered.
+     * @default 300
+     * @example
+     * searchDebounce={500}
+     */
+    searchDebounce?: number;
+    onConfirm?: (value: string | number | (string | number)[] | undefined) => void;
+    clearText?: string;
+    noResultCustomText?: string;
+    noResultCustomIcon?: string;
+    readOnly?: boolean;
+    /**
+     * Controls whether data is static (local) or dynamic (API-based).
+     * When true: Shows "Select All" checkbox, search is local (filters existing options).
+     * When false: Hides "Select All" checkbox, search triggers onSearch callback for API calls.
+     * @default true - Static data with local search by default
+     * @remarks Only applicable when type is 'multiSelect' or 'multiTreeSelect'
+     * @example
+     * // For static data (all data available at once, local search)
+     * staticValue={true}
+     *
+     * // For API-based data (search triggers onSearch callback)
+     * staticValue={false}
+     */
+    staticValue?: boolean;
+    /**
+     * Callback function triggered when the footer download CTA is clicked
+     * @param values - The current selected values
+     */
+    onFooterDownloadChange?: (values: (string | number)[]) => void;
+    /**
+     * Callback function triggered when user scrolls in the dropdown popup.
+     * The component automatically checks if scroll is near bottom before calling this callback.
+     * The developer should handle hasMore and isLoading conditions inside the callback.
+     * @param event - The scroll event object containing scroll position information
+     * @example
+     * onPopupScroll={(event) => {
+     *   if (enumData?.hasMore && !isLoading) {
+     *     // Load more data - component already checked scroll position
+     *     loadMoreData();
+     *   }
+     * }}
+     */
+    onPopupScroll?: () => void;
+    /**
+     * Indicates whether there are more items available to load via pagination.
+     * When false, the component will not show loading state or trigger onPopupScroll when scrolling to bottom.
+     * This prevents infinite loading when all items have been exhausted.
+     * @default true - Assumes more items are available if not specified
+     * @example
+     * hasMore={enumData?.hasMore ?? false}
+     */
+    hasMore?: boolean;
+    /**
+     * Enable controlled virtualization for large lists.
+     * When true, disables Ant Design's built-in virtualization (virtual prop).
+     * For flat lists, Ant Design's built-in virtualization (when enableVirtualization is false) provides good performance.
+     * @default false
+     */
+    enableVirtualization?: boolean;
+    /**
+     * Height of each virtualized row in pixels.
+     * Used by Ant Design's built-in virtualization when enableVirtualization is false.
+     * @default 32
+     */
+    virtualRowHeight?: number;
+    /**
+     * Whether to reset search text when confirm button is clicked or dropdown closes.
+     * When true, search text is cleared on both confirm and close actions.
+     * @default true - Search text is cleared by default
+     */
+    resetSearch?: boolean;
+    /**
+     * Callback function triggered to reset/load initial data.
+     * Called when dropdown closes, confirm button is clicked, or clear button is clicked.
+     * This allows the developer to trigger an API call to reload initial data.
+     * @example
+     * resetData={() => {
+     *   actions.loadInitialDataRequest();
+     * }}
+     */
+    resetData?: () => void;
+    /**
+     * Callback function triggered when selected values are not present in the current options.
+     * This is useful for API-based pagination where selected items might be from different pages.
+     * The component automatically detects missing selected values and calls this function with an array of missing values.
+     * Only called when there are actually missing values to prevent unnecessary API calls.
+     * @param missingValues - Array of selected values that are not present in the current options
+     * @example
+     * fetchMissingOptions={(missingValues) => {
+     *   // Fetch the missing options from API
+     *   actions.fetchOptionsByIds({ ids: missingValues });
+     * }}
+     */
+    fetchMissingOptions?: (missingValues: (string | number)[]) => void;
+}
+declare const CapUnifiedSelect: React.FC<CapUnifiedSelectProps>;
+export default CapUnifiedSelect;
+//# sourceMappingURL=CapUnifiedSelect.d.ts.map

package/CapUnifiedSelect/CapUnifiedSelect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CapUnifiedSelect.d.ts","sourceRoot":"","sources":["../../components/CapUnifiedSelect/CapUnifiedSelect.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAuB,MAAM,SAAS,CAAC;AAEpE,OAAO,KAA4D,MAAM,OAAO,CAAC;AAUjF,OAAO,EAAoC,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAGhF,UAAU,UAAU;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC/B,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACnC,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AA0KD,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,GAAG,OAAO,GAAG,UAAU,CAAC;IAChE,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,KAAK,IAAI,CAAC;IAC9E,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;IAC1C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,KAAK,IAAI,CAAC;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;IAC/D;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;CACpE;AAED,QAAA,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CA8pDrD,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/CapUnifiedSelect/constants.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Select type constants for CapUnifiedSelect component
+ */
+export declare const SELECT_TYPES: {
+    readonly SELECT: "select";
+    readonly MULTI_SELECT: "multiSelect";
+    readonly TREE_SELECT: "treeSelect";
+    readonly MULTI_TREE_SELECT: "multiTreeSelect";
+};
+export type SelectType = (typeof SELECT_TYPES)[keyof typeof SELECT_TYPES];
+/**
+ * Timeout constants (in milliseconds)
+ */
+export declare const TIMEOUTS: {
+    /** Default search debounce timeout */
+    readonly DEFAULT_SEARCH_DEBOUNCE: 300;
+    /** Delay for state updates after search */
+    readonly SEARCH_STATE_UPDATE_DELAY: 100;
+    /** Minimum time since search was cleared to consider data ready */
+    readonly SEARCH_CLEARED_TIMEOUT: 200;
+    /** Buffer time added to debounce for cleared search */
+    readonly SEARCH_CLEARED_BUFFER: 300;
+    /** Buffer time added to debounce for regular search */
+    readonly SEARCH_REGULAR_BUFFER: 500;
+    /** Brief delay to show loading indicator for static search */
+    readonly STATIC_SEARCH_DELAY: 150;
+    /** Timeout for resetData fallback (1 second) */
+    readonly RESET_DATA_TIMEOUT: 1000;
+    /** Minimum time since resetData was called to consider data ready */
+    readonly RESET_DATA_MIN_TIME: 300;
+    /** Maximum time since resetData was called to consider data ready */
+    readonly RESET_DATA_MAX_TIME: 2000;
+    /** Fallback timeout for scroll loading (10 seconds) */
+    readonly SCROLL_LOADING_TIMEOUT: 10000;
+    /** Delay before setting up scroll container listener */
+    readonly SCROLL_CONTAINER_DELAY: 100;
+};
+/**
+ * Default values for component props
+ */
+export declare const DEFAULTS: {
+    /** Default placeholder text */
+    readonly PLACEHOLDER: "Select an option";
+    /** Default upload button label */
+    readonly UPLOAD_LABEL: "Upload";
+    /** Default clear button text */
+    readonly CLEAR_TEXT: "Clear";
+    /** Default no results message */
+    readonly NO_RESULT_TEXT: "No results found";
+    /** Default no results icon */
+    readonly NO_RESULT_ICON: "warning";
+    /** Default virtual row height in pixels */
+    readonly VIRTUAL_ROW_HEIGHT: 32;
+    /** Default list height in pixels */
+    readonly LIST_HEIGHT: 256;
+};
+//# sourceMappingURL=constants.d.ts.map

package/CapUnifiedSelect/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../components/CapUnifiedSelect/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;CAKf,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB,sCAAsC;;IAEtC,2CAA2C;;IAE3C,mEAAmE;;IAEnE,uDAAuD;;IAEvD,uDAAuD;;IAEvD,8DAA8D;;IAE9D,gDAAgD;;IAEhD,qEAAqE;;IAErE,qEAAqE;;IAErE,uDAAuD;;IAEvD,wDAAwD;;CAEhD,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB,+BAA+B;;IAE/B,kCAAkC;;IAElC,gCAAgC;;IAEhC,iCAAiC;;IAEjC,8BAA8B;;IAE9B,2CAA2C;;IAE3C,oCAAoC;;CAE5B,CAAC"}