shadcn-datagrid 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+import * as react from 'react';
+import { ReactNode, RefObject } from 'react';
+
+type SortDirection = 'asc' | 'desc' | null;
+type ColumnType = 'string' | 'number' | 'date' | 'boolean';
+type TextAlign = 'Left' | 'Right' | 'Center';
+type FormatType = 'C2' | 'N2' | string;
+type ActionMode = 'dropdown' | 'icons';
+type ActionVariant = 'default' | 'destructive';
+interface SortConfig {
+    field: string;
+    direction: SortDirection;
+}
+interface TooltipConfig<T> {
+    /** Custom content renderer for the tooltip. If omitted, shows the raw cell value. */
+    content?: (data: T) => ReactNode;
+    /** Tooltip placement side. Default: 'top' */
+    side?: 'top' | 'bottom' | 'left' | 'right';
+    /** Custom className for the tooltip content */
+    className?: string;
+}
+interface ColumnConfig<T> {
+    field: keyof T | string;
+    headerText: string;
+    width?: number | string;
+    minWidth?: number;
+    maxWidth?: number;
+    visible?: boolean;
+    textAlign?: TextAlign;
+    format?: FormatType;
+    type?: ColumnType;
+    allowSorting?: boolean;
+    template?: (data: T, rowIndex: number) => ReactNode;
+    exportFormatter?: (data: T) => string;
+    headerTemplate?: () => ReactNode;
+    className?: string;
+    headerClassName?: string;
+    /** Allow resizing this column. Default: true (when enableColumnResize is on). */
+    allowResizing?: boolean;
+    /**
+     * Tooltip configuration.
+     * - `false` or omitted → no tooltip (default)
+     * - `true` → auto-tooltip: shows the raw cell text only when truncated
+     * - `TooltipConfig<T>` object → custom tooltip with full control
+     */
+    tooltip?: boolean | TooltipConfig<T>;
+}
+interface ActionItem<T> {
+    label: string;
+    icon?: ReactNode;
+    onClick: (data: T) => void;
+    variant?: ActionVariant;
+    hidden?: (data: T) => boolean;
+    disabled?: (data: T) => boolean;
+}
+interface ActionConfig<T> {
+    mode: ActionMode;
+    actions: ActionItem<T>[];
+    showOnHover?: boolean;
+    showHeader?: boolean;
+    headerText?: string;
+    width?: number;
+}
+interface BulkActionItem<T> {
+    label: string;
+    icon?: ReactNode;
+    onClick: (selectedData: T[]) => void;
+    variant?: ActionVariant;
+}
+interface BulkActionConfig<T> {
+    enabled: boolean;
+    actions: BulkActionItem<T>[];
+}
+interface PaginationConfig {
+    page: number;
+    pageSize: number;
+    total: number;
+    pageSizeOptions?: number[];
+    onPageChange: (page: number) => void;
+    onPageSizeChange: (pageSize: number) => void;
+}
+type ContextMenuItem<T> = {
+    type?: 'item';
+    label: string;
+    icon?: ReactNode;
+    onClick: (data: T) => void;
+    variant?: ActionVariant;
+    hidden?: (data: T) => boolean;
+    disabled?: (data: T) => boolean;
+} | {
+    type: 'separator';
+} | {
+    type: 'label';
+    label: string;
+};
+type ExportFormat = 'csv' | 'print' | string;
+interface ExportConfig<T> {
+    enabled: boolean;
+    formats?: ExportFormat[];
+    fileName?: string;
+    onCustomExport?: (format: string, data: T[], columns: ColumnConfig<T>[]) => void;
+}
+interface ChildRowConfig<T> {
+    enabled: boolean;
+    childColumns?: ColumnConfig<any>[];
+    getChildData?: (row: T) => any[] | undefined;
+    fetchChildData?: (row: T) => Promise<any[]>;
+    childKeyField?: string;
+    expandedByDefault?: boolean;
+}
+interface DataGridClassNames {
+    root?: string;
+    toolbar?: string;
+    tableContainer?: string;
+    table?: string;
+    header?: string;
+    headerRow?: string;
+    headerCell?: string;
+    body?: string;
+    row?: string;
+    rowSelected?: string;
+    rowExpanded?: string;
+    cell?: string;
+    cellCheckbox?: string;
+    cellActions?: string;
+    cellExpander?: string;
+    pagination?: string;
+    empty?: string;
+    contextMenu?: string;
+    exportToolbar?: string;
+    childRow?: string;
+}
+interface DataGridProps<T extends object> {
+    columns: ColumnConfig<T>[];
+    data: T[];
+    isLoading?: boolean;
+    skeletonRowCount?: number;
+    pagination?: PaginationConfig;
+    actionConfig?: ActionConfig<T>;
+    bulkActionConfig?: BulkActionConfig<T>;
+    contextMenuItems?: ContextMenuItem<T>[];
+    exportConfig?: ExportConfig<T>;
+    childRowConfig?: ChildRowConfig<T>;
+    emptyMessage?: string;
+    emptyComponent?: ReactNode;
+    onRowClick?: (data: T) => void;
+    className?: string;
+    classNames?: DataGridClassNames;
+    keyField?: keyof T;
+    sortConfig?: SortConfig;
+    onSort?: (ordering: string | null) => void;
+    tableContainerRef?: RefObject<HTMLDivElement | null>;
+    stickyHeader?: boolean;
+    rowHeight?: number;
+    headerHeight?: number;
+    maxBodyHeight?: number | string;
+    alternatingRows?: boolean;
+    enableColumnResize?: boolean;
+    showHeaderBorder?: boolean;
+}
+
+declare function DataGrid<T extends object>({ columns, data, isLoading, skeletonRowCount, pagination, actionConfig, bulkActionConfig, contextMenuItems, exportConfig, childRowConfig, emptyMessage, emptyComponent, onRowClick, className, classNames, keyField, sortConfig: externalSortConfig, onSort, tableContainerRef: externalContainerRef, stickyHeader, rowHeight, maxBodyHeight, alternatingRows, enableColumnResize, showHeaderBorder, }: DataGridProps<T>): react.JSX.Element;
+
+declare function getCellExportValue<T extends object>(row: T, col: ColumnConfig<T>, rowIndex: number): string;
+declare function exportToCsv<T extends object>(data: T[], columns: ColumnConfig<T>[], fileName: string): void;
+declare function exportToPrint<T extends object>(data: T[], columns: ColumnConfig<T>[]): void;
+
+declare function formatCurrency(value: unknown, locale?: string, currency?: string): string;
+declare function formatNumber(value: unknown, locale?: string): string;
+declare function formatDateValue(value: unknown, dateFormat?: string): string;
+declare function formatValue(value: unknown, formatType?: FormatType, type?: string): string;
+
+export { type ActionConfig, type ActionItem, type ActionMode, type ActionVariant, type BulkActionConfig, type BulkActionItem, type ChildRowConfig, type ColumnConfig, type ColumnType, type ContextMenuItem, DataGrid, type DataGridClassNames, type DataGridProps, type ExportConfig, type ExportFormat, type FormatType, type PaginationConfig, type SortConfig, type SortDirection, type TextAlign, type TooltipConfig, exportToCsv, exportToPrint, formatCurrency, formatDateValue, formatNumber, formatValue, getCellExportValue };