@expcat/tigercat-core 1.0.7 → 1.2.0

package/dist/table-export-6ISYSoVB.d.cts

@@ -0,0 +1,490 @@
+/**
+ * Table component types and interfaces
+ */
+/**
+ * Table size types
+ */
+type TableSize = 'sm' | 'md' | 'lg';
+type TableExportFormat = 'csv' | 'excel';
+type TableResponsiveMode = 'card' | 'scroll';
+/**
+ * Sort direction
+ */
+type SortDirection = 'asc' | 'desc' | null;
+/**
+ * Sort state
+ */
+interface SortState {
+    /**
+     * Column key to sort by
+     */
+    key: string | null;
+    /**
+     * Sort direction
+     */
+    direction: SortDirection;
+}
+/**
+ * Column alignment
+ */
+type ColumnAlign = 'left' | 'center' | 'right';
+/**
+ * Filter type
+ */
+type FilterType = 'text' | 'select' | 'custom';
+/**
+ * Filter option for select filter
+ */
+interface FilterOption {
+    /**
+     * Option label
+     */
+    label: string;
+    /**
+     * Option value
+     */
+    value: string | number;
+}
+/**
+ * Column filter configuration
+ */
+interface ColumnFilter {
+    /**
+     * Filter type
+     * @default 'text'
+     */
+    type?: FilterType;
+    /**
+     * Filter options (for select type)
+     */
+    options?: FilterOption[];
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Custom filter function
+     * @param value - Cell value
+     * @param filterValue - Current filter value
+     * @returns Whether the row should be shown
+     */
+    filterFn?: (value: unknown, filterValue: unknown) => boolean;
+}
+/**
+ * Table column configuration
+ */
+interface TableColumn<T = Record<string, unknown>> {
+    /**
+     * Column key (must be unique)
+     */
+    key: string;
+    /**
+     * Column title/header text
+     */
+    title: string;
+    /**
+     * Data key to access in row object
+     * If not provided, uses `key`
+     */
+    dataKey?: string;
+    /**
+     * Column width (CSS value)
+     */
+    width?: string | number;
+    /**
+     * Column alignment
+     * @default 'left'
+     */
+    align?: ColumnAlign;
+    /**
+     * Whether column is sortable
+     * @default false
+     */
+    sortable?: boolean;
+    /**
+     * Custom sort function
+     * @param a - First value
+     * @param b - Second value
+     * @returns Sort comparison result
+     */
+    sortFn?: (a: unknown, b: unknown) => number;
+    /**
+     * Column filter configuration
+     */
+    filter?: ColumnFilter;
+    /**
+     * Whether column is fixed
+     * @default false
+     */
+    fixed?: 'left' | 'right' | false;
+    /**
+     * Custom render function for cell content
+     * Framework-specific implementations will handle this differently
+     */
+    render?: (record: T, index: number) => unknown;
+    /**
+     * Custom render function for header
+     */
+    renderHeader?: () => unknown;
+    /**
+     * CSS class for column cells
+     */
+    className?: string;
+    /**
+     * CSS class for header cell
+     */
+    headerClassName?: string;
+}
+/**
+ * Pagination configuration
+ */
+interface PaginationConfig {
+    /**
+     * Current page number (1-indexed)
+     * @default 1
+     */
+    current?: number;
+    /**
+     * Default current page number (1-indexed) for uncontrolled mode.
+     * Used when `current` is not provided.
+     * @default 1
+     */
+    defaultCurrent?: number;
+    /**
+     * Number of items per page
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Default page size for uncontrolled mode.
+     * Used when `pageSize` is not provided.
+     * @default 10
+     */
+    defaultPageSize?: number;
+    /**
+     * Total number of items
+     */
+    total?: number;
+    /**
+     * Available page size options
+     * @default [10, 20, 50, 100]
+     */
+    pageSizeOptions?: number[];
+    /**
+     * Whether to show page size selector
+     * @default true
+     */
+    showSizeChanger?: boolean;
+    /**
+     * Whether to show total count
+     * @default true
+     */
+    showTotal?: boolean;
+    /**
+     * Custom total text render function
+     */
+    totalText?: (total: number, range: [number, number]) => string;
+}
+/**
+ * Table row selection configuration
+ */
+interface RowSelectionConfig<T = Record<string, unknown>> {
+    /**
+     * Selected row keys
+     */
+    selectedRowKeys?: (string | number)[];
+    /**
+     * Default selected row keys for uncontrolled mode.
+     * Used when `selectedRowKeys` is not provided.
+     */
+    defaultSelectedRowKeys?: (string | number)[];
+    /**
+     * Function to get row key
+     * @default (record) => record.id
+     */
+    getRowKey?: (record: T) => string | number;
+    /**
+     * Whether to show checkbox column
+     * @default true
+     */
+    showCheckbox?: boolean;
+    /**
+     * Selection type
+     * @default 'checkbox'
+     */
+    type?: 'checkbox' | 'radio';
+    /**
+     * Function to determine if row can be selected
+     */
+    getCheckboxProps?: (record: T) => {
+        disabled?: boolean;
+    };
+}
+/**
+ * Table row expansion configuration
+ */
+interface ExpandableConfig<T = Record<string, unknown>> {
+    /**
+     * Currently expanded row keys (controlled mode).
+     * When provided, internal expand state will not be mutated.
+     */
+    expandedRowKeys?: (string | number)[];
+    /**
+     * Default expanded row keys for uncontrolled mode.
+     * Used when `expandedRowKeys` is not provided.
+     */
+    defaultExpandedRowKeys?: (string | number)[];
+    /**
+     * Render function for expanded row content.
+     * Framework-specific implementations may also support slots/children.
+     */
+    expandedRowRender?: (record: T, index: number) => unknown;
+    /**
+     * Determine whether a row is expandable.
+     * Return false to hide the expand icon for that row.
+     * @default () => true
+     */
+    rowExpandable?: (record: T) => boolean;
+    /**
+     * Whether clicking the entire row toggles expand state.
+     * When false, only clicking the expand icon triggers expansion.
+     * @default false
+     */
+    expandRowByClick?: boolean;
+    /**
+     * Position of the expand toggle column.
+     * @default 'start'
+     */
+    expandIconPosition?: 'start' | 'end';
+}
+/**
+ * Base table props interface
+ */
+interface TableProps<T = Record<string, unknown>> {
+    /**
+     * Table columns configuration
+     */
+    columns: TableColumn<T>[];
+    /**
+     * Whether to show a lock button in each column header.
+     * Clicking the lock toggles the column fixed state.
+     * @default false
+     */
+    columnLockable?: boolean;
+    /**
+     * Table data source
+     * @default []
+     */
+    dataSource?: T[];
+    /**
+     * Controlled sort state.
+     * When provided, internal sort state will not be mutated.
+     */
+    sort?: SortState;
+    /**
+     * Default sort state for uncontrolled mode.
+     */
+    defaultSort?: SortState;
+    /**
+     * Controlled filters.
+     * When provided, internal filter state will not be mutated.
+     */
+    filters?: Record<string, unknown>;
+    /**
+     * Default filters for uncontrolled mode.
+     */
+    defaultFilters?: Record<string, unknown>;
+    /**
+     * Table size
+     * @default 'md'
+     */
+    size?: TableSize;
+    /**
+     * Whether to show border
+     * @default false
+     */
+    bordered?: boolean;
+    /**
+     * Whether to show striped rows
+     * @default false
+     */
+    striped?: boolean;
+    /**
+     * Whether to highlight row on hover
+     * @default true
+     */
+    hoverable?: boolean;
+    /**
+     * Loading state
+     * @default false
+     */
+    loading?: boolean;
+    /**
+     * Empty state text
+     * @default 'No data'
+     */
+    emptyText?: string;
+    /**
+     * Pagination configuration
+     * Set to false to disable pagination
+     */
+    pagination?: PaginationConfig | false;
+    /**
+     * Row selection configuration
+     */
+    rowSelection?: RowSelectionConfig<T>;
+    /**
+     * Row expansion configuration.
+     * Adds an expand toggle column and renders expanded content below each row.
+     */
+    expandable?: ExpandableConfig<T>;
+    /**
+     * Function to get row key
+     * @default (record) => record.id
+     */
+    rowKey?: string | ((record: T) => string | number);
+    /**
+     * Custom row class name
+     */
+    rowClassName?: string | ((record: T, index: number) => string);
+    /**
+     * Whether table head is sticky
+     * @default false
+     */
+    stickyHeader?: boolean;
+    /**
+     * Max height for scrollable table
+     */
+    maxHeight?: string | number;
+    /**
+     * Table layout algorithm
+     * @default 'auto'
+     */
+    tableLayout?: 'auto' | 'fixed';
+    /**
+     * Mobile layout below 640px. `scroll` keeps the table horizontally scrollable;
+     * `card` renders each row as a stacked card list.
+     * @default 'scroll'
+     */
+    responsiveMode?: TableResponsiveMode;
+    /**
+     * Enable virtual scrolling for large datasets
+     * @default false
+     */
+    virtual?: boolean;
+    /**
+     * Automatically enable Table's virtual scroll container for very large data sets.
+     * @default true
+     */
+    autoVirtual?: boolean;
+    /**
+     * Virtual scroll viewport height (px)
+     * @default 400
+     */
+    virtualHeight?: number;
+    /**
+     * Virtual scroll row height (px)
+     * @default 40
+     */
+    virtualItemHeight?: number;
+    /**
+     * Row count at which Table enables virtual mode automatically when `autoVirtual` is true.
+     * @default 10000
+     */
+    autoVirtualThreshold?: number;
+    /**
+     * Row count at which Table marks virtual rendering as recommended.
+     * Table does not enable virtualization automatically; use this signal to
+     * switch to `virtual` or the dedicated `VirtualTable` component.
+     * @default 1000
+     */
+    virtualThreshold?: number;
+    /**
+     * Enable cell editing
+     * @default false
+     */
+    editable?: boolean;
+    /**
+     * Set of editable cells: Map<columnKey, Set<rowIndex>>
+     * If not provided and editable=true, all cells are editable
+     */
+    editableCells?: Map<string, Set<number>>;
+    /**
+     * Filter mode
+     * @default 'basic'
+     */
+    filterMode?: 'basic' | 'advanced';
+    /**
+     * Advanced filter rules (used when filterMode='advanced')
+     */
+    advancedFilterRules?: FilterRule[];
+    /**
+     * Enable column drag reorder
+     * @default false
+     */
+    columnDraggable?: boolean;
+    /**
+     * Enable row drag reorder.
+     * @default false
+     */
+    rowDraggable?: boolean;
+    /**
+     * Summary row configuration
+     */
+    summaryRow?: {
+        show: boolean;
+        data: Record<string, unknown>;
+    };
+    /**
+     * Group rows by column key
+     */
+    groupBy?: string;
+    /**
+     * Enable table export
+     * @default false
+     */
+    exportable?: boolean;
+    /**
+     * Export format.
+     * @default 'csv'
+     */
+    exportFormat?: TableExportFormat;
+    /**
+     * Export filename (without extension)
+     * @default 'export'
+     */
+    exportFilename?: string;
+}
+/**
+ * Filter rule for advanced filtering
+ */
+interface FilterRule {
+    column: string;
+    operator: 'equals' | 'contains' | 'gt' | 'lt' | 'between' | 'notEquals';
+    value: unknown;
+    valueTo?: unknown;
+    logic?: 'and' | 'or';
+}
+
+/**
+ * Table export utilities (CSV / Excel-compatible HTML worksheet)
+ */
+
+/**
+ * Export table data to CSV string
+ */
+declare function exportTableToCsv<T>(columns: TableColumn<T>[], data: T[], _filename?: string): string;
+declare function exportTableToExcel<T>(columns: TableColumn<T>[], data: T[]): string;
+/**
+ * Trigger a CSV file download in the browser
+ */
+declare function downloadCsv(csvContent: string, filename?: string): void;
+declare function downloadExcel(excelContent: string, filename?: string): void;
+declare function exportTableData<T>(columns: TableColumn<T>[], data: T[], format?: TableExportFormat): string;
+declare function downloadTableExport(content: string, filename?: string, format?: TableExportFormat): void;
+/**
+ * Get export button classes
+ */
+declare const tableExportButtonClasses = "inline-flex items-center gap-1.5 px-3 py-1.5 text-sm font-medium rounded-[var(--tiger-radius-md,0.5rem)] border border-[var(--tiger-border,#e5e7eb)] text-[var(--tiger-text,#111827)] bg-[var(--tiger-surface,#ffffff)] hover:bg-[var(--tiger-surface-muted,#f9fafb)] transition-colors";
+
+export { type ColumnAlign as C, type ExpandableConfig as E, type FilterOption as F, type PaginationConfig as P, type RowSelectionConfig as R, type SortDirection as S, type TableResponsiveMode as T, type TableColumn as a, type TableSize as b, type TableProps as c, type FilterRule as d, type ColumnFilter as e, type SortState as f, exportTableToCsv as g, exportTableToExcel as h, downloadCsv as i, downloadExcel as j, exportTableData as k, downloadTableExport as l, type TableExportFormat as m, type FilterType as n, tableExportButtonClasses as t };