@e-burgos/tucu-ui 2.4.1 → 2.6.0

package/datatable/components/Assets/ArrowLongIndicator.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+/**
+ * ArrowLongIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+interface ArrowLongIndicatorProps {
+    size?: number;
+    color?: string;
+    direction: 'up' | 'down' | 'left' | 'right';
+}
+/**
+ * ArrowLongIndicator
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+export declare const ArrowLongIndicator: React.FC<ArrowLongIndicatorProps>;
+export default ArrowLongIndicator;

package/datatable/components/Assets/ArrowPaginationIndicator.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+/**
+ * ArrowPaginationIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+interface ArrowPaginationIndicatorProps {
+    size?: number;
+    color?: string;
+    direction: 'first' | 'last';
+}
+/**
+ * ArrowPaginationIndicator
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+export declare const ArrowPaginationIndicator: React.FC<ArrowPaginationIndicatorProps>;
+export default ArrowPaginationIndicator;

package/datatable/components/Assets/AssetButton.d.ts

@@ -0,0 +1,32 @@
+import { default as React } from 'react';
+/**
+ * AssetButtonProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param children - The children
+ * @param disabled - The disabled
+ * @param active - The active
+ * @param sx - The sx
+ * @param className - The className
+ * @param onHover - The onHover
+ * @param onClick - The onClick
+ */
+export interface AssetButtonProps {
+    children: React.ReactNode;
+    disabled?: boolean;
+    /**
+     * @deprecated unused
+     */
+    active?: boolean;
+    sx?: React.CSSProperties;
+    className?: string;
+    /**
+     * @deprecated unused
+     */
+    bgColor?: 'row' | 'header' | 'actionHover' | 'paper' | 'actionBg';
+    onHover?: React.MouseEventHandler<HTMLButtonElement>;
+    onClick?: React.MouseEventHandler<HTMLButtonElement>;
+}
+export declare const AssetButton: React.FC<AssetButtonProps>;
+export default AssetButton;

package/datatable/components/Assets/ColumnIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * ColumnIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface ColumnIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const ColumnIndicator: React.FC<ColumnIndicatorProps>;
+export default ColumnIndicator;

package/datatable/components/Assets/DeleteIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * DeleteIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface DeleteIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const DeleteIndicator: React.FC<DeleteIndicatorProps>;
+export default DeleteIndicator;

package/datatable/components/Assets/DownloadIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * DownloadIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface DownloadIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const DownloadIndicator: React.FC<DownloadIndicatorProps>;
+export default DownloadIndicator;

package/datatable/components/Assets/DragIndicator.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+/**
+ * DragIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+interface DragIndicatorProps {
+    size?: number;
+    color?: string;
+    direction: 'vertical' | 'horizontal';
+}
+export declare const DragIndicator: React.FC<DragIndicatorProps>;
+export default DragIndicator;

package/datatable/components/Assets/EditIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * EditIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface EditIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const EditIndicator: React.FC<EditIndicatorProps>;
+export default EditIndicator;

package/datatable/components/Assets/FilterIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * FilterIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface FilterIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const FilterIndicator: React.FC<FilterIndicatorProps>;
+export default FilterIndicator;

package/datatable/components/Assets/MoreIndicator.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+/**
+ * MoreIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+interface MoreIndicatorProps {
+    size?: number;
+    color?: string;
+    direction: 'vertical' | 'horizontal';
+}
+export declare const MoreIndicator: React.FC<MoreIndicatorProps>;
+export default MoreIndicator;

package/datatable/components/Assets/OpenNewTab.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * ArrowDoubleIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface ArrowDoubleIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const OpenNewTab: React.FC<ArrowDoubleIndicatorProps>;
+export default OpenNewTab;

package/datatable/components/Assets/PinIndicator.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+/**
+ * PinIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param direction - The direction
+ */
+interface PinIndicatorProps {
+    size?: number;
+    color?: string;
+    direction: 'up' | 'down' | 'left' | 'right';
+}
+export declare const PinIndicator: React.FC<PinIndicatorProps>;
+export default PinIndicator;

package/datatable/components/Assets/RowIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * RowIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface RowIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const RowIndicator: React.FC<RowIndicatorProps>;
+export default RowIndicator;

package/datatable/components/Assets/ViewDetailsIndicator.d.ts

@@ -0,0 +1,16 @@
+import { default as React } from 'react';
+/**
+ * ViewDetailsIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param visibility - The visibility
+ */
+interface ViewDetailsIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const ViewDetailsIndicator: React.FC<ViewDetailsIndicatorProps>;
+export default ViewDetailsIndicator;

package/datatable/components/Assets/VisibilityIndicator.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+/**
+ * VisibilityIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ * @param visibility - The visibility
+ */
+interface VisibilityIndicatorProps {
+    size?: number;
+    color?: string;
+    visibility: 'on' | 'off';
+}
+export declare const VisibilityIndicator: React.FC<VisibilityIndicatorProps>;
+export default VisibilityIndicator;

package/datatable/components/Assets/VoidIndicator.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+/**
+ * VoidIndicatorProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param color - The color
+ */
+interface VoidIndicatorProps {
+    size?: number;
+    color?: string;
+}
+export declare const VoidIndicator: React.FC<VoidIndicatorProps>;
+export default VoidIndicator;

package/datatable/components/Assets/index.d.ts

@@ -0,0 +1,18 @@
+export * from './ArrowDoubleIndicator';
+export * from './ArrowIndicator';
+export * from './ArrowLongIndicator';
+export * from './ArrowPaginationIndicator';
+export * from './AssetButton';
+export * from './ColumnIndicator';
+export * from './DeleteIndicator';
+export * from './DownloadIndicator';
+export * from './DragIndicator';
+export * from './EditIndicator';
+export * from './FilterIndicator';
+export * from './MoreIndicator';
+export * from './OpenNewTab';
+export * from './PinIndicator';
+export * from './RowIndicator';
+export * from './VisibilityIndicator';
+export * from './VoidIndicator';
+export * from './ViewDetailsIndicator';

package/datatable/components/Common/IconButton/index.d.ts

@@ -0,0 +1,18 @@
+import { ButtonHTMLAttributes, ReactElement, RefObject } from 'react';
+/**
+ * IconButtonProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param size - The size
+ * @param icon - The icon
+ * @param isPinned - The isPinned
+ */
+type IconButtonProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'> & {
+    ref?: RefObject<any>;
+    icon: ReactElement;
+    isPinned?: boolean;
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+};
+export declare const IconButton: import('react').ForwardRefExoticComponent<Omit<IconButtonProps, "ref"> & import('react').RefAttributes<HTMLButtonElement>>;
+export default IconButton;

package/datatable/components/Common/Spinner.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+declare const colors: {
+    primary: string;
+    gray: string;
+    success: string;
+    danger: string;
+    info: string;
+    warning: string;
+};
+interface SpinnerProps {
+    size?: 'sm' | 'md' | 'lg';
+    color?: keyof typeof colors;
+}
+export declare const Spinner: React.FC<SpinnerProps>;
+export default Spinner;

package/datatable/components/Common/Tooltip.d.ts

@@ -0,0 +1,37 @@
+import { CSSProperties, ReactNode } from 'react';
+/**
+ * Tooltip position options
+ * @category libs/datatable
+ * @subcategory Components
+ */
+type TooltipPosition = 'top' | 'bottom' | 'left' | 'right' | 'auto';
+/**
+ * TooltipProps
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {ReactNode} children - The trigger element that will show the tooltip on hover
+ * @property {string} text - The text content to display in the tooltip
+ * @property {CSSProperties} [style] - Optional custom styles for the trigger wrapper
+ * @property {TooltipPosition} [position] - Preferred position of the tooltip (default: 'auto')
+ * @property {number} [delay] - Delay in milliseconds before showing the tooltip (default: 0)
+ */
+interface TooltipProps {
+    children: ReactNode;
+    text: string;
+    style?: CSSProperties;
+    position?: TooltipPosition;
+    delay?: number;
+}
+/**
+ * Tooltip component that displays a text tooltip on hover.
+ * Supports automatic positioning to avoid viewport overflow and uses CSS variables for theming.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @param {TooltipProps} props - The component props
+ * @returns {JSX.Element} The tooltip component
+ */
+export declare function Tooltip({ children, text, style, position, delay, }: TooltipProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/datatable/components/DataTable/ColumnsVisibilityManager.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+export declare const ColumnsVisibilityManager: React.FC;
+export default ColumnsVisibilityManager;

package/datatable/components/DataTable/DataTable.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+import { DataTableProps } from '../../context/index';
+/**
+ * DataTable component for rendering a data table with customizable columns, sorting, and other features. This component is a wrapper around the DataTableComponent, which is the actual table implementation.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @component
+ * @template TData - The type of data used in the table.
+ * @extends IOptionalDataTableProps<TData> - Extends the optional properties for the data table.
+ * @param {DataTableProps<TData>} props The properties passed to the component.
+ *
+ * Parameters for useDataTable hook.
+ * @param {string} props.tableId Table ID.
+ * @param {Array<ColumnDef<TData, TData>>} props.columns Array of column definitions.
+ * @param {Array<TData>} props.data Array of data to display.
+ * @param {function(SortingState): void} props.onSortModelChange Function to handle sort model changes.
+ * @param {boolean} props.enableMultiSort Whether multi-sorting is enabled.
+ * @param {string} props.title Title of the data table.
+ *
+ * @returns {ReactElement} Returns the data table UI.
+ */
+declare function DataTable<TData>(props: DataTableProps<TData>): React.JSX.Element;
+declare const _default: typeof DataTable;
+export default _default;

package/datatable/components/DataTable/DataTableComponent/index.d.ts

@@ -0,0 +1,70 @@
+import { default as React, Dispatch, RefObject } from 'react';
+import { ColumnOrderState, Table, VisibilityState } from '@tanstack/react-table';
+import { IOptionalDataTableProps, ManualPaginationState, TData } from '../../../common/types';
+import { IScrollProps } from '../../../context/index';
+/**
+ * Props for the DataTableComponent.
+ *
+ * @category libs/datatable
+ * @subcategory Props
+ *
+ * @template TData - The type of data used in the table.
+ * @extends IOptionalDataTableProps<TData> - Extends the optional properties for the data table.
+ *
+ * @property {string} tableId - Unique identifier for the table.
+ * @property {Table<TData>} table - The table instance.
+ * @property {Array<TData>} data - The data to be displayed in the table.
+ * @property {boolean} [showHeader] - Whether to show the table header.
+ * @property {ColumnOrderState} columnOrder - The order of columns in the table.
+ * @property {VisibilityState} columnVisibility - The visibility state of columns.
+ * @property {Dispatch<SetStateAction<ColumnOrderState>>} setColumnOrder - Function to set the order of columns.
+ * @property {Dispatch<SetStateAction<VisibilityState>>} setColumnVisibility - Function to set the visibility of columns.
+ * @property {Dispatch<SetStateAction<ManualPaginationState>>} setManualPagination - Function to manage manual pagination state.
+ * @property {RefObject<HTMLDivElement>} [tableContainerRef] - Reference to the table container element.
+ * @property {IScrollProps} [scrollProps] - Scroll-related properties for the table.
+ */
+export interface DataTableComponentProps<TData> extends IOptionalDataTableProps<TData> {
+    tableId: string;
+    table: Table<TData>;
+    data: Array<TData>;
+    showHeader?: boolean;
+    setColumnOrder: Dispatch<ColumnOrderState>;
+    setColumnVisibility: Dispatch<VisibilityState>;
+    setManualPagination: Dispatch<ManualPaginationState>;
+    tableContainerRef?: RefObject<HTMLDivElement>;
+    scrollProps?: IScrollProps;
+}
+/**
+ * DataTableComponent is a React component that displays a data table with sorting, pagination,
+ * and optional subComponents, is a versatile and customizable table component designed to handle various data display needs.
+ * It supports features like pagination, row selection, column visibility, and sub-components rendering.
+ * This component is parameterized by a table of type `Table<TData>`
+ * provided by TanStack Table. Without this implementation, it cannot function.
+ * For more information, see the [React Table documentation](https://tanstack.com/react-table/).
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @component
+ * @extends IOptionalDataTableProps<TData> - The data table properties.
+ * @template TData - The type of data being displayed in the table.
+ *
+ * @param {DataTableComponentProps<TData>} props - The properties object.
+ * @param {string} props.tableId - The unique identifier for the table.
+ * @param {Table<TData>} props.table - The table instance.
+ * @param {Array<TData>} props.data - The data to be displayed in the table.
+ * @param {ColumnOrderState} props.columnOrder - The state of the column order.
+ * @param {VisibilityState} props.columnVisibility - The state of the column visibility.
+ * @param {Dispatch<SetStateAction<ColumnOrderState>>} props.setColumnOrder - Function to set the column order state.
+ * @param {Dispatch<SetStateAction<VisibilityState>>} props.setColumnVisibility - Function to set the column visibility state.
+ * @param {Dispatch<SetStateAction<ManualPaginationState>>} props.setManualPagination - Function to set the manual pagination state.
+ * @param {RefObject<HTMLDivElement>} [props.tableContainerRef] - Optional reference to the table container element.
+ * @param {IScrollProps} [props.scrollProps] - Optional scroll properties for the table.
+ *
+ * @returns {JSX.Element} The rendered DataTableComponent or null if the table instance is not provided.
+ */
+declare function DataTableComponent<T extends TData = TData>({ data, }: {
+    data: T[];
+}): React.JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof DataTableComponent>;
+export default _default;

package/datatable/components/DataTable/StateTableHandler/index.d.ts

@@ -0,0 +1,23 @@
+import { default as React } from 'react';
+import { IDataTableStateMessage } from '../../../common/types';
+/**
+ * Props for the StateTableHandler component.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {number} containerWith - The width of the container.
+ * @property {boolean} isLoading - Whether the data is loading.
+ * @property {boolean} isEmpty - Whether the data is empty.
+ * @property {boolean} isError - Whether the data is in an error state.
+ * @property {IDataTableStateMessage} stateMessage - The state message to display.
+ */
+interface StateTableHandlerProps {
+    containerWith: number;
+    isLoading: boolean;
+    isEmpty: boolean;
+    isError: boolean;
+    stateMessage?: IDataTableStateMessage;
+}
+declare const StateTableHandler: React.FC<StateTableHandlerProps>;
+export default StateTableHandler;

package/datatable/components/DataTable/SubComponentDataTable/index.d.ts

@@ -0,0 +1,18 @@
+import { default as React } from 'react';
+import { IOptionalDataTableProps, SubComponentDataTableProps, TData } from '../../../common/types';
+/**
+ * Props for the SubComponentDataTable component.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {TData} row - The row data.
+ * @property {string} tableId - The id of the table.
+ * @property {React.ReactNode} renderSubDataTable - The sub-table to render.
+ * @property {IOptionalDataTableProps<TData>} props - The props for the DataTable component.
+ *
+ * @template TData - The type of the data in the table.
+ */
+type IDataTableProps = SubComponentDataTableProps & IOptionalDataTableProps<TData>;
+declare const SubComponentDataTable: React.FC<IDataTableProps>;
+export default SubComponentDataTable;

package/datatable/components/DataTable/TableCell/ExpandedRowCell/index.d.ts

@@ -0,0 +1,19 @@
+import { Row } from '@tanstack/react-table';
+import { HoverType, TData } from '../../../../common/types';
+/**
+ * Props for the ExpandedRowCell component.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {Row<TData>} row - The row data.
+ * @property {HoverType} hoverRow - The hover row data.
+ *
+ * @template TData - The type of the data in the table.
+ */
+interface ExpandedRowCellProps {
+    row: Row<TData>;
+    hoverRow: HoverType;
+}
+declare const ExpandedRowCell: React.FC<ExpandedRowCellProps>;
+export default ExpandedRowCell;

package/datatable/components/DataTable/TableCell/RowActionsCell/index.d.ts

@@ -0,0 +1,29 @@
+import { Row } from '@tanstack/react-table';
+import { HoverType, IRowActions, TData } from '../../../../common/types';
+/**
+ * Props for the RowActionsCell component.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {string} tableId - The id of the table.
+ * @property {Row<TData>} row - The row data.
+ * @property {HoverType} hoverRow - The hover row data.
+ * @property {Array<IRowActions<TData>>} rowActions - The row actions.
+ * @property {function(HoverType): void} setHoverRow - The function to set the hover row.
+ * @property {function(boolean): void} setOpenActions - The function to set the open actions.
+ * @property {boolean} forceShowMenuActions - Whether to force show the menu actions.
+ *
+ * @template TData - The type of the data in the table.
+ */
+export interface RowActionsCellProps {
+    tableId: string;
+    row: Row<TData>;
+    hoverRow: HoverType;
+    rowActions?: IRowActions<TData>[];
+    setHoverRow: (value: HoverType) => void;
+    setOpenActions: (value: boolean) => void;
+    forceShowMenuActions?: boolean;
+}
+declare const RowActionsCell: React.FC<RowActionsCellProps>;
+export default RowActionsCell;

package/datatable/components/DataTable/TableCell/RowSelectionCell/index.d.ts

@@ -0,0 +1,21 @@
+import { Row, Table } from '@tanstack/react-table';
+import { IRowSelection, TData } from '../../../../common/types';
+/**
+ * Props for the RowSelectionCell component.
+ *
+ * @category libs/datatable
+ * @subcategory Components
+ *
+ * @property {Row<TData>} row - The row data.
+ * @property {IRowSelection<TData>} rowSelection - The row selection data.
+ * @property {Table<TData>} table - The table data.
+ *
+ * @template TData - The type of the data in the table.
+ */
+interface RowSelectionCellProps {
+    row: Row<TData>;
+    rowSelection: IRowSelection<TData>;
+    table: Table<TData>;
+}
+declare const RowSelectionCell: React.FC<RowSelectionCellProps>;
+export default RowSelectionCell;