react-glide-table 1.1.1 → 1.1.3

package/dist/types-BfthylVR.d.cts

@@ -0,0 +1,220 @@
+import { ColumnDef, RowSelectionState, Updater, Row } from '@tanstack/react-table';
+import { ReactNode, ComponentType } from 'react';
+
+type DataTableLabels = {
+    empty: string;
+    loading: string;
+    selection: (selectedCount: number) => ReactNode;
+    expandRow: string;
+    collapseRow: string;
+};
+/** Default copy. Override via the `labels` option. */
+declare const DEFAULT_DATA_TABLE_LABELS: DataTableLabels;
+declare function resolveDataTableLabels(partial?: Partial<DataTableLabels>): DataTableLabels;
+
+type RowSelectionMode = "none" | "single" | "multi";
+type CellEditType = "text" | "number";
+
+declare module "@tanstack/react-table" {
+    interface ColumnMeta<TData, TValue> {
+        /** Whether this column participates in vertical row spanning */
+        rowSpan?: boolean;
+        /** Merge key field. Falls back to the column id when omitted */
+        rowSpanKey?: string;
+        align?: "left" | "center" | "right";
+        className?: string;
+        headerClassName?: string;
+        /** When true, double-click starts inline editing */
+        editable?: boolean;
+        /** Inline editor input type. Defaults to text */
+        editType?: CellEditType;
+    }
+}
+type DataTableProps<T extends Record<string, unknown>> = {
+    data: T[];
+    columns: ColumnDef<T, unknown>[];
+    rowSelectionMode?: RowSelectionMode;
+    rowSelection?: RowSelectionState;
+    onRowSelectionChange?: (updater: Updater<RowSelectionState>) => void;
+    /** Total row count before filtering */
+    totalCount?: number;
+    /** Visible row count after filtering */
+    filteredCount?: number;
+    /** Left-side summary slot */
+    summary?: ReactNode;
+    /** Right-side action slot */
+    toolbar?: ReactNode;
+    /**
+     * UI copy overrides.
+     * Takes precedence over `emptyText` / `selectionLabel`.
+     */
+    labels?: Partial<DataTableLabels>;
+    /** @deprecated Prefer `labels.selection` */
+    selectionLabel?: (selectedCount: number) => ReactNode;
+    isPending?: boolean;
+    /** @deprecated Prefer `labels.empty` */
+    emptyText?: string;
+    /** @deprecated Prefer `labels.loading` */
+    loadingText?: string;
+    enableRowSpan?: boolean;
+    getRowId?: (row: T, index: number) => string;
+    onRowClick?: (row: T, index: number) => void;
+    preserveRowSelection?: boolean;
+    getRowClassName?: (row: T, index: number) => string | undefined;
+    /** Return false to make the row unselectable (row click and checkbox) */
+    getRowCanSelect?: (row: T, index: number) => boolean;
+    /** When false, row click does not toggle selection (checkbox-only) */
+    selectOnRowClick?: boolean;
+    /**
+     * Enable cell drag selection and fill handle. Defaults to true.
+     * When false, browser text selection is allowed and cell selection UI is off.
+     */
+    enableCellSelection?: boolean;
+    /**
+     * @deprecated Combining with paged/tree-transformed data can corrupt the source.
+     * Prefer onCellChange / onBatchChange.
+     */
+    onDataChange?: (data: T[]) => void;
+    /** Single-cell change (edit commit). Takes precedence over onDataChange */
+    onCellChange?: (rowId: string, columnId: string, value: unknown) => void;
+    /** Multi-cell change (fill handle, etc.). Takes precedence over onDataChange */
+    onBatchChange?: (changes: Array<{
+        rowId: string;
+        columnId: string;
+        value: unknown;
+    }>) => void;
+    /**
+     * Root className hook (combined with `DataTableJSX`).
+     * The package ships no CSS — style these hooks yourself or leave unstyled.
+     */
+    className?: string;
+    /**
+     * Per-part class hooks for Tailwind / utility CSS.
+     * Combined with semantic hooks (`DataTableJSX`, `data-table-cell`, …).
+     * Prefer `data-*` state variants, e.g. `row: "data-[selected]:bg-blue-600"`.
+     */
+    classNames?: DataTableClassNames;
+    /** Expand key field. Enables tree conversion / expand UI when set. Default `id` */
+    toggleField?: string;
+    /** Child → parent reference field. Default `parentId` */
+    childField?: string;
+    /** Nested children array field. Default `children` */
+    flattenField?: string;
+    /** Parent quantity field used for parentCount. Default `qty` */
+    qtyField?: string;
+    /** Expanded row key set (controlled) */
+    expandedRows?: Set<string>;
+    onExpandedRowsChange?: (next: Set<string>) => void;
+    /** When true, expand is disabled (children always visible) */
+    preventExpand?: boolean;
+    /**
+     * Enable row virtualization. Defaults to true.
+     * Forced off when enableRowSpan is true to preserve merges
+     * (HTML table + spacer rows; no absolute/translateY positioning).
+     */
+    enableVirtualization?: boolean;
+    /** Estimated virtual row height in px. Default 44; refined via measureElement */
+    estimateRowHeight?: number;
+    /** Virtualization overscan row count. Default 8 */
+    virtualOverscan?: number;
+    /**
+     * Optional UI part replacements for the unstyled DataTable renderer.
+     * Use with `createTable` / `Table.Column`, or pass columns directly to `DataTable`.
+     */
+    slots?: DataTableSlots<T>;
+};
+/**
+ * Named class hooks for the default DataTable shell.
+ * Pass Tailwind utilities directly without writing a separate CSS mapping file.
+ */
+type DataTableClassNames = {
+    root?: string;
+    pending?: string;
+    loadingText?: string;
+    toolbar?: string;
+    toolbarLeft?: string;
+    toolbarRight?: string;
+    toolbarCount?: string;
+    toolbarSelection?: string;
+    toolbarActions?: string;
+    scroll?: string;
+    table?: string;
+    head?: string;
+    headRow?: string;
+    headCell?: string;
+    body?: string;
+    emptyCell?: string;
+    virtualSpacer?: string;
+    virtualSpacerCell?: string;
+    row?: string;
+    cell?: string;
+    cellEditInput?: string;
+    expandCell?: string;
+    expandCellContent?: string;
+    expandCellIndent?: string;
+    expandCellValue?: string;
+    expandToggle?: string;
+    expandToggleIcon?: string;
+    fillHandle?: string;
+};
+type DataTableToolbarSlotProps = {
+    filteredCount?: number;
+    totalCount?: number;
+    summary?: ReactNode;
+    selectedCount: number;
+    selectionLabel?: (selectedCount: number) => ReactNode;
+    toolbar?: ReactNode;
+    className?: string;
+    classNames?: Pick<DataTableClassNames, "toolbar" | "toolbarLeft" | "toolbarRight" | "toolbarCount" | "toolbarSelection" | "toolbarActions">;
+};
+type DataTableRowSlotProps<T extends Record<string, unknown>> = {
+    row: Row<T>;
+    onToggleSelect: () => void;
+    virtualIndex?: number;
+    measureElement?: (node: Element | null) => void;
+};
+/**
+ * Slot replacements for the default DataTable shell (semantic HTML + behavior only).
+ * Row-level custom UI → `Row`; cell content → `Table.Column` / column `render`.
+ * Header/Cell are not split into separate slots in this contract.
+ */
+type DataTableSlots<T extends Record<string, unknown>> = {
+    /** Top summary / actions region */
+    Toolbar?: ComponentType<DataTableToolbarSlotProps>;
+    /** Full row replacement (cells, selection, edit UI) */
+    Row?: ComponentType<DataTableRowSlotProps<T>>;
+    /** Replace the pending state view */
+    Pending?: ComponentType<{
+        loadingText: string;
+        className?: string;
+        classNames?: Pick<DataTableClassNames, "pending" | "loadingText" | "root">;
+    }>;
+    /** Replace the empty-state cell content */
+    Empty?: ComponentType<{
+        emptyText: string;
+        columnCount: number;
+        classNames?: Pick<DataTableClassNames, "emptyCell">;
+    }>;
+};
+type TableColumnProps<T extends Record<string, unknown>, K extends string = keyof T & string> = {
+    /** Column id: data field name, or an arbitrary id for virtual columns */
+    field: K;
+    /** When true, uses id only (no accessorKey) — e.g. checkbox / No. columns */
+    virtual?: boolean;
+    children?: ReactNode;
+    sortable?: boolean;
+    width?: number;
+    align?: "left" | "center" | "right";
+    rowSpan?: boolean;
+    rowSpanKey?: string;
+    editable?: boolean;
+    editType?: CellEditType;
+    className?: string;
+    headerClassName?: string;
+    render?: (value: K extends keyof T ? T[K] : unknown, row: Row<T>, index: number) => ReactNode;
+};
+type TableProps<T extends Record<string, unknown>> = Omit<DataTableProps<T>, "columns"> & {
+    children: ReactNode;
+};
+
+export { type CellEditType as C, DEFAULT_DATA_TABLE_LABELS as D, type RowSelectionMode as R, type TableColumnProps as T, type DataTableClassNames as a, type DataTableLabels as b, type DataTableProps as c, type DataTableSlots as d, type TableProps as e, resolveDataTableLabels as r };

package/dist/types-BfthylVR.d.ts

@@ -0,0 +1,220 @@
+import { ColumnDef, RowSelectionState, Updater, Row } from '@tanstack/react-table';
+import { ReactNode, ComponentType } from 'react';
+
+type DataTableLabels = {
+    empty: string;
+    loading: string;
+    selection: (selectedCount: number) => ReactNode;
+    expandRow: string;
+    collapseRow: string;
+};
+/** Default copy. Override via the `labels` option. */
+declare const DEFAULT_DATA_TABLE_LABELS: DataTableLabels;
+declare function resolveDataTableLabels(partial?: Partial<DataTableLabels>): DataTableLabels;
+
+type RowSelectionMode = "none" | "single" | "multi";
+type CellEditType = "text" | "number";
+
+declare module "@tanstack/react-table" {
+    interface ColumnMeta<TData, TValue> {
+        /** Whether this column participates in vertical row spanning */
+        rowSpan?: boolean;
+        /** Merge key field. Falls back to the column id when omitted */
+        rowSpanKey?: string;
+        align?: "left" | "center" | "right";
+        className?: string;
+        headerClassName?: string;
+        /** When true, double-click starts inline editing */
+        editable?: boolean;
+        /** Inline editor input type. Defaults to text */
+        editType?: CellEditType;
+    }
+}
+type DataTableProps<T extends Record<string, unknown>> = {
+    data: T[];
+    columns: ColumnDef<T, unknown>[];
+    rowSelectionMode?: RowSelectionMode;
+    rowSelection?: RowSelectionState;
+    onRowSelectionChange?: (updater: Updater<RowSelectionState>) => void;
+    /** Total row count before filtering */
+    totalCount?: number;
+    /** Visible row count after filtering */
+    filteredCount?: number;
+    /** Left-side summary slot */
+    summary?: ReactNode;
+    /** Right-side action slot */
+    toolbar?: ReactNode;
+    /**
+     * UI copy overrides.
+     * Takes precedence over `emptyText` / `selectionLabel`.
+     */
+    labels?: Partial<DataTableLabels>;
+    /** @deprecated Prefer `labels.selection` */
+    selectionLabel?: (selectedCount: number) => ReactNode;
+    isPending?: boolean;
+    /** @deprecated Prefer `labels.empty` */
+    emptyText?: string;
+    /** @deprecated Prefer `labels.loading` */
+    loadingText?: string;
+    enableRowSpan?: boolean;
+    getRowId?: (row: T, index: number) => string;
+    onRowClick?: (row: T, index: number) => void;
+    preserveRowSelection?: boolean;
+    getRowClassName?: (row: T, index: number) => string | undefined;
+    /** Return false to make the row unselectable (row click and checkbox) */
+    getRowCanSelect?: (row: T, index: number) => boolean;
+    /** When false, row click does not toggle selection (checkbox-only) */
+    selectOnRowClick?: boolean;
+    /**
+     * Enable cell drag selection and fill handle. Defaults to true.
+     * When false, browser text selection is allowed and cell selection UI is off.
+     */
+    enableCellSelection?: boolean;
+    /**
+     * @deprecated Combining with paged/tree-transformed data can corrupt the source.
+     * Prefer onCellChange / onBatchChange.
+     */
+    onDataChange?: (data: T[]) => void;
+    /** Single-cell change (edit commit). Takes precedence over onDataChange */
+    onCellChange?: (rowId: string, columnId: string, value: unknown) => void;
+    /** Multi-cell change (fill handle, etc.). Takes precedence over onDataChange */
+    onBatchChange?: (changes: Array<{
+        rowId: string;
+        columnId: string;
+        value: unknown;
+    }>) => void;
+    /**
+     * Root className hook (combined with `DataTableJSX`).
+     * The package ships no CSS — style these hooks yourself or leave unstyled.
+     */
+    className?: string;
+    /**
+     * Per-part class hooks for Tailwind / utility CSS.
+     * Combined with semantic hooks (`DataTableJSX`, `data-table-cell`, …).
+     * Prefer `data-*` state variants, e.g. `row: "data-[selected]:bg-blue-600"`.
+     */
+    classNames?: DataTableClassNames;
+    /** Expand key field. Enables tree conversion / expand UI when set. Default `id` */
+    toggleField?: string;
+    /** Child → parent reference field. Default `parentId` */
+    childField?: string;
+    /** Nested children array field. Default `children` */
+    flattenField?: string;
+    /** Parent quantity field used for parentCount. Default `qty` */
+    qtyField?: string;
+    /** Expanded row key set (controlled) */
+    expandedRows?: Set<string>;
+    onExpandedRowsChange?: (next: Set<string>) => void;
+    /** When true, expand is disabled (children always visible) */
+    preventExpand?: boolean;
+    /**
+     * Enable row virtualization. Defaults to true.
+     * Forced off when enableRowSpan is true to preserve merges
+     * (HTML table + spacer rows; no absolute/translateY positioning).
+     */
+    enableVirtualization?: boolean;
+    /** Estimated virtual row height in px. Default 44; refined via measureElement */
+    estimateRowHeight?: number;
+    /** Virtualization overscan row count. Default 8 */
+    virtualOverscan?: number;
+    /**
+     * Optional UI part replacements for the unstyled DataTable renderer.
+     * Use with `createTable` / `Table.Column`, or pass columns directly to `DataTable`.
+     */
+    slots?: DataTableSlots<T>;
+};
+/**
+ * Named class hooks for the default DataTable shell.
+ * Pass Tailwind utilities directly without writing a separate CSS mapping file.
+ */
+type DataTableClassNames = {
+    root?: string;
+    pending?: string;
+    loadingText?: string;
+    toolbar?: string;
+    toolbarLeft?: string;
+    toolbarRight?: string;
+    toolbarCount?: string;
+    toolbarSelection?: string;
+    toolbarActions?: string;
+    scroll?: string;
+    table?: string;
+    head?: string;
+    headRow?: string;
+    headCell?: string;
+    body?: string;
+    emptyCell?: string;
+    virtualSpacer?: string;
+    virtualSpacerCell?: string;
+    row?: string;
+    cell?: string;
+    cellEditInput?: string;
+    expandCell?: string;
+    expandCellContent?: string;
+    expandCellIndent?: string;
+    expandCellValue?: string;
+    expandToggle?: string;
+    expandToggleIcon?: string;
+    fillHandle?: string;
+};
+type DataTableToolbarSlotProps = {
+    filteredCount?: number;
+    totalCount?: number;
+    summary?: ReactNode;
+    selectedCount: number;
+    selectionLabel?: (selectedCount: number) => ReactNode;
+    toolbar?: ReactNode;
+    className?: string;
+    classNames?: Pick<DataTableClassNames, "toolbar" | "toolbarLeft" | "toolbarRight" | "toolbarCount" | "toolbarSelection" | "toolbarActions">;
+};
+type DataTableRowSlotProps<T extends Record<string, unknown>> = {
+    row: Row<T>;
+    onToggleSelect: () => void;
+    virtualIndex?: number;
+    measureElement?: (node: Element | null) => void;
+};
+/**
+ * Slot replacements for the default DataTable shell (semantic HTML + behavior only).
+ * Row-level custom UI → `Row`; cell content → `Table.Column` / column `render`.
+ * Header/Cell are not split into separate slots in this contract.
+ */
+type DataTableSlots<T extends Record<string, unknown>> = {
+    /** Top summary / actions region */
+    Toolbar?: ComponentType<DataTableToolbarSlotProps>;
+    /** Full row replacement (cells, selection, edit UI) */
+    Row?: ComponentType<DataTableRowSlotProps<T>>;
+    /** Replace the pending state view */
+    Pending?: ComponentType<{
+        loadingText: string;
+        className?: string;
+        classNames?: Pick<DataTableClassNames, "pending" | "loadingText" | "root">;
+    }>;
+    /** Replace the empty-state cell content */
+    Empty?: ComponentType<{
+        emptyText: string;
+        columnCount: number;
+        classNames?: Pick<DataTableClassNames, "emptyCell">;
+    }>;
+};
+type TableColumnProps<T extends Record<string, unknown>, K extends string = keyof T & string> = {
+    /** Column id: data field name, or an arbitrary id for virtual columns */
+    field: K;
+    /** When true, uses id only (no accessorKey) — e.g. checkbox / No. columns */
+    virtual?: boolean;
+    children?: ReactNode;
+    sortable?: boolean;
+    width?: number;
+    align?: "left" | "center" | "right";
+    rowSpan?: boolean;
+    rowSpanKey?: string;
+    editable?: boolean;
+    editType?: CellEditType;
+    className?: string;
+    headerClassName?: string;
+    render?: (value: K extends keyof T ? T[K] : unknown, row: Row<T>, index: number) => ReactNode;
+};
+type TableProps<T extends Record<string, unknown>> = Omit<DataTableProps<T>, "columns"> & {
+    children: ReactNode;
+};
+
+export { type CellEditType as C, DEFAULT_DATA_TABLE_LABELS as D, type RowSelectionMode as R, type TableColumnProps as T, type DataTableClassNames as a, type DataTableLabels as b, type DataTableProps as c, type DataTableSlots as d, type TableProps as e, resolveDataTableLabels as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-glide-table",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zpxlffjrm/react-glide-table.git"
@@ -11,6 +11,7 @@
   "homepage": "https://github.com/zpxlffjrm/react-glide-table#readme",
   "type": "module",
   "license": "MIT",
+  "sideEffects": false,
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
@@ -22,6 +23,16 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "import": "./dist/core.js",
+      "require": "./dist/core.cjs"
+    },
+    "./compound": {
+      "types": "./dist/compound.d.ts",
+      "import": "./dist/compound.js",
+      "require": "./dist/compound.cjs"
     }
   },
   "files": [