@caffeinebounce/ui 0.62.2 → 0.63.0

package/dist/data-grid.d.ts

@@ -0,0 +1,241 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React$1 from 'react';
+import { RowData, Cell, TableMeta, TableOptions, ColumnDef, Column } from '@tanstack/react-table';
+import * as _tanstack_virtual_core from '@tanstack/virtual-core';
+import * as _tanstack_table_core from '@tanstack/table-core';
+
+type Direction = "ltr" | "rtl";
+type RowHeightValue = "short" | "medium" | "tall" | "extra-tall";
+interface CellSelectOption {
+    label: string;
+    value: string;
+    icon?: React.ComponentType<React.ComponentProps<"svg">>;
+    count?: number;
+}
+type CellOpts = {
+    variant: "short-text";
+} | {
+    variant: "long-text";
+} | {
+    variant: "number";
+    min?: number;
+    max?: number;
+    step?: number;
+} | {
+    variant: "select";
+    options: CellSelectOption[];
+} | {
+    variant: "multi-select";
+    options: CellSelectOption[];
+} | {
+    variant: "checkbox";
+} | {
+    variant: "date";
+} | {
+    variant: "url";
+} | {
+    variant: "file";
+    maxFileSize?: number;
+    maxFiles?: number;
+    accept?: string;
+    multiple?: boolean;
+};
+interface CellUpdate {
+    rowIndex: number;
+    columnId: string;
+    value: unknown;
+}
+declare module "@tanstack/react-table" {
+    interface ColumnMeta<TData extends RowData, TValue> {
+        label?: string;
+        cell?: CellOpts;
+    }
+    interface TableMeta<TData extends RowData> {
+        dataGridRef?: React.RefObject<HTMLElement | null>;
+        cellMapRef?: React.RefObject<Map<string, HTMLDivElement>>;
+        focusedCell?: CellPosition | null;
+        editingCell?: CellPosition | null;
+        selectionState?: SelectionState;
+        searchOpen?: boolean;
+        getIsCellSelected?: (rowIndex: number, columnId: string) => boolean;
+        getIsSearchMatch?: (rowIndex: number, columnId: string) => boolean;
+        getIsActiveSearchMatch?: (rowIndex: number, columnId: string) => boolean;
+        getVisualRowIndex?: (rowId: string) => number | undefined;
+        scrollToCell?: (rowIndex: number, columnId: string, align?: "auto" | "start" | "center" | "end") => void;
+        rowHeight?: RowHeightValue;
+        onRowHeightChange?: (value: RowHeightValue) => void;
+        onRowSelect?: (rowId: string, checked: boolean, shiftKey: boolean) => void;
+        onDataUpdate?: (params: CellUpdate | Array<CellUpdate>) => void;
+        onRowsDelete?: (rowIndices: number[]) => void | Promise<void>;
+        onColumnClick?: (columnId: string) => void;
+        onCellClick?: (rowIndex: number, columnId: string, event?: React.MouseEvent) => void;
+        onCellDoubleClick?: (rowIndex: number, columnId: string) => void;
+        onCellMouseDown?: (rowIndex: number, columnId: string, event: React.MouseEvent) => void;
+        onCellMouseEnter?: (rowIndex: number, columnId: string) => void;
+        onCellMouseUp?: () => void;
+        onCellContextMenu?: (rowIndex: number, columnId: string, event: React.MouseEvent) => void;
+        onCellEditingStart?: (rowIndex: number, columnId: string) => void;
+        onCellEditingStop?: (opts?: {
+            direction?: NavigationDirection;
+            moveToNextRow?: boolean;
+        }) => void;
+        onCellsCopy?: () => void;
+        onCellsCut?: () => void;
+        onCellsPaste?: (expand?: boolean) => void;
+        onSelectionClear?: () => void;
+        onFilesUpload?: (params: {
+            files: File[];
+            rowIndex: number;
+            columnId: string;
+        }) => Promise<FileCellData[]>;
+        onFilesDelete?: (params: {
+            fileIds: string[];
+            rowIndex: number;
+            columnId: string;
+        }) => void | Promise<void>;
+        contextMenu?: ContextMenuState;
+        onContextMenuOpenChange?: (open: boolean) => void;
+        pasteDialog?: PasteDialogState;
+        onPasteDialogOpenChange?: (open: boolean) => void;
+        readOnly?: boolean;
+    }
+}
+interface CellPosition {
+    rowIndex: number;
+    columnId: string;
+}
+interface CellRange {
+    start: CellPosition;
+    end: CellPosition;
+}
+interface SelectionState {
+    selectedCells: Set<string>;
+    selectionRange: CellRange | null;
+    isSelecting: boolean;
+}
+interface ContextMenuState {
+    open: boolean;
+    x: number;
+    y: number;
+}
+interface PasteDialogState {
+    open: boolean;
+    rowsNeeded: number;
+    clipboardText: string;
+}
+type NavigationDirection = "up" | "down" | "left" | "right" | "home" | "end" | "ctrl+up" | "ctrl+down" | "ctrl+home" | "ctrl+end" | "pageup" | "pagedown" | "pageleft" | "pageright";
+interface SearchState {
+    searchMatches: CellPosition[];
+    matchIndex: number;
+    searchOpen: boolean;
+    onSearchOpenChange: (open: boolean) => void;
+    searchQuery: string;
+    onSearchQueryChange: (query: string) => void;
+    onSearch: (query: string) => void;
+    onNavigateToNextMatch: () => void;
+    onNavigateToPrevMatch: () => void;
+}
+interface DataGridCellProps<TData> {
+    cell: Cell<TData, unknown>;
+    tableMeta: TableMeta<TData>;
+    rowIndex: number;
+    columnId: string;
+    rowHeight: RowHeightValue;
+    isEditing: boolean;
+    isFocused: boolean;
+    isSelected: boolean;
+    isSearchMatch: boolean;
+    isActiveSearchMatch: boolean;
+    readOnly: boolean;
+}
+interface FileCellData {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    url?: string;
+}
+type TextFilterOperator = "contains" | "notContains" | "equals" | "notEquals" | "startsWith" | "endsWith" | "isEmpty" | "isNotEmpty";
+type NumberFilterOperator = "equals" | "notEquals" | "lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "isBetween" | "isEmpty" | "isNotEmpty";
+type DateFilterOperator = "equals" | "notEquals" | "before" | "after" | "onOrBefore" | "onOrAfter" | "isBetween" | "isEmpty" | "isNotEmpty";
+type SelectFilterOperator = "is" | "isNot" | "isAnyOf" | "isNoneOf" | "isEmpty" | "isNotEmpty";
+type BooleanFilterOperator = "isTrue" | "isFalse";
+type FilterOperator = TextFilterOperator | NumberFilterOperator | DateFilterOperator | SelectFilterOperator | BooleanFilterOperator;
+interface FilterValue {
+    operator: FilterOperator;
+    value?: string | number | string[];
+    endValue?: string | number;
+}
+
+interface UseDataGridProps<TData> extends Omit<TableOptions<TData>, "pageCount" | "getCoreRowModel"> {
+    onDataChange?: (data: TData[]) => void;
+    onRowAdd?: (event?: React$1.MouseEvent<HTMLDivElement>) => Partial<CellPosition> | Promise<Partial<CellPosition> | null> | null;
+    onRowsAdd?: (count: number) => void | Promise<void>;
+    onRowsDelete?: (rows: TData[], rowIndices: number[]) => void | Promise<void>;
+    onPaste?: (updates: Array<CellUpdate>) => void | Promise<void>;
+    onFilesUpload?: (params: {
+        files: File[];
+        rowIndex: number;
+        columnId: string;
+    }) => Promise<FileCellData[]>;
+    onFilesDelete?: (params: {
+        fileIds: string[];
+        rowIndex: number;
+        columnId: string;
+    }) => void | Promise<void>;
+    rowHeight?: RowHeightValue;
+    onRowHeightChange?: (rowHeight: RowHeightValue) => void;
+    overscan?: number;
+    dir?: Direction;
+    autoFocus?: boolean | Partial<CellPosition>;
+    enableSingleCellSelection?: boolean;
+    enableColumnSelection?: boolean;
+    enableSearch?: boolean;
+    enablePaste?: boolean;
+    readOnly?: boolean;
+}
+declare function useDataGrid<TData>({ data, columns, rowHeight: rowHeightProp, overscan, dir: dirProp, initialState, ...props }: UseDataGridProps<TData>): {
+    dataGridRef: React$1.RefObject<HTMLDivElement | null>;
+    headerRef: React$1.RefObject<HTMLDivElement | null>;
+    rowMapRef: React$1.RefObject<Map<number, HTMLDivElement>>;
+    footerRef: React$1.RefObject<HTMLDivElement | null>;
+    dir: "ltr" | "rtl";
+    table: _tanstack_table_core.Table<TData>;
+    tableMeta: TableMeta<TData>;
+    virtualTotalSize: number;
+    virtualItems: _tanstack_virtual_core.VirtualItem[];
+    measureElement: (node: Element | null) => void;
+    columns: ColumnDef<TData, any>[];
+    columnSizeVars: {
+        [key: string]: number;
+    };
+    searchState: SearchState | undefined;
+    searchMatchesByRow: Map<number, Set<string>> | null;
+    activeSearchMatch: CellPosition | null;
+    cellSelectionMap: Map<number, Set<string>> | null;
+    focusedCell: CellPosition | null;
+    editingCell: CellPosition | null;
+    rowHeight: RowHeightValue;
+    contextMenu: ContextMenuState;
+    pasteDialog: PasteDialogState;
+    onRowAdd: ((event?: React$1.MouseEvent<HTMLDivElement>) => Promise<void>) | undefined;
+    adjustLayout: boolean;
+};
+
+interface DataGridProps<TData> extends Omit<ReturnType<typeof useDataGrid<TData>>, "dir">, Omit<React$1.ComponentProps<"div">, "contextMenu"> {
+    dir?: Direction;
+    height?: number;
+    stretchColumns?: boolean;
+}
+declare function DataGrid<TData>({ dataGridRef, headerRef, rowMapRef, footerRef, dir, table, tableMeta, virtualTotalSize, virtualItems, measureElement, columns, columnSizeVars, searchState, searchMatchesByRow, activeSearchMatch, cellSelectionMap, focusedCell, editingCell, rowHeight, contextMenu, pasteDialog, onRowAdd: onRowAddProp, height, stretchColumns, adjustLayout, className, ...props }: DataGridProps<TData>): react_jsx_runtime.JSX.Element;
+
+declare function getCellKey(rowIndex: number, columnId: string): string;
+declare function parseCellKey(cellKey: string): Required<CellPosition>;
+declare function getRowHeightValue(rowHeight: RowHeightValue): number;
+declare function getColumnPinningStyle<TData>(params: {
+    column: Column<TData>;
+    withBorder?: boolean;
+    dir?: Direction;
+}): React$1.CSSProperties;
+
+export { type BooleanFilterOperator, type CellOpts, type CellPosition, type CellRange, type CellSelectOption, type CellUpdate, type ContextMenuState, DataGrid, type DataGridCellProps, type DateFilterOperator, type Direction, type FileCellData, type FilterOperator, type FilterValue, type NavigationDirection, type NumberFilterOperator, type PasteDialogState, type RowHeightValue, type SearchState, type SelectFilterOperator, type SelectionState, type TextFilterOperator, type UseDataGridProps, getCellKey, getColumnPinningStyle as getGridColumnPinningStyle, getRowHeightValue, parseCellKey, useDataGrid };