@expcat/tigercat-vue 1.0.7 → 1.2.0

package/dist/components/Table.d.ts

@@ -1,7 +1,10 @@
 import * as vue from 'vue';
-import { PropType } from 'vue';
-import { TableColumn, SortState, TableSize, PaginationConfig, RowSelectionConfig, ExpandableConfig, FilterRule } from '@expcat/tigercat-core';
+import * as _expcat_tigercat_core from '@expcat/tigercat-core';
+import { TableColumn, SortState, TableSize, PaginationConfig, RowSelectionConfig, ExpandableConfig, TableResponsiveMode, FilterRule } from '@expcat/tigercat-core';
 
+/**
+ * Public TS prop interface for Vue Table — surfaces in IDE / docs.
+ */
 interface VueTableProps {
     columns: TableColumn[];
     columnLockable?: boolean;
@@ -23,121 +26,87 @@ interface VueTableProps {
     rowClassName?: string | ((record: Record<string, unknown>, index: number) => string);
     stickyHeader?: boolean;
     maxHeight?: string | number;
+    tableLayout?: 'auto' | 'fixed';
+    responsiveMode?: TableResponsiveMode;
     virtual?: boolean;
     virtualHeight?: number;
     virtualItemHeight?: number;
+    autoVirtual?: boolean;
+    autoVirtualThreshold?: number;
+    virtualThreshold?: number;
     editable?: boolean;
     editableCells?: Map<string, Set<number>>;
     filterMode?: 'basic' | 'advanced';
     advancedFilterRules?: FilterRule[];
     columnDraggable?: boolean;
+    rowDraggable?: boolean;
     summaryRow?: {
         show: boolean;
         data: Record<string, unknown>;
     };
     groupBy?: string;
     exportable?: boolean;
+    exportFormat?: 'csv' | 'excel';
     exportFilename?: string;
 }
+
 declare const Table: vue.DefineComponent<vue.ExtractPropTypes<{
-    /**
-     * Table columns configuration
-     */
-    columns: {
-        type: PropType<TableColumn[]>;
-        required: true;
-    };
-    /**
-     * Whether to show a lock button in each column header.
-     */
-    columnLockable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Table data source
-     */
-    dataSource: {
-        type: PropType<Record<string, unknown>[]>;
-        default: () => never[];
-    };
-    /**
-     * Controlled sort state.
-     */
-    sort: {
-        type: PropType<SortState>;
-    };
-    /**
-     * Default sort state for uncontrolled mode.
-     */
-    defaultSort: {
-        type: PropType<SortState>;
-        default: () => {
+    readonly columns: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableColumn[]>;
+        readonly required: true;
+    };
+    readonly columnLockable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly dataSource: {
+        readonly type: vue.PropType<Record<string, unknown>[]>;
+        readonly default: () => never[];
+    };
+    readonly sort: {
+        readonly type: vue.PropType<_expcat_tigercat_core.SortState>;
+    };
+    readonly defaultSort: {
+        readonly type: vue.PropType<_expcat_tigercat_core.SortState>;
+        readonly default: () => {
             key: null;
             direction: null;
         };
     };
-    /**
-     * Controlled filters.
-     */
-    filters: {
-        type: PropType<Record<string, unknown>>;
-    };
-    /**
-     * Default filters for uncontrolled mode.
-     */
-    defaultFilters: {
-        type: PropType<Record<string, unknown>>;
-        default: () => {};
-    };
-    /**
-     * Table size
-     */
-    size: {
-        type: PropType<TableSize>;
-        default: TableSize;
-    };
-    /**
-     * Whether to show border
-     */
-    bordered: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Whether to show striped rows
-     */
-    striped: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Whether to highlight row on hover
-     */
-    hoverable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Loading state
-     */
-    loading: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Empty state text
-     */
-    emptyText: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Pagination configuration
-     */
-    pagination: {
-        type: PropType<PaginationConfig | false>;
-        default: () => {
+    readonly filters: {
+        readonly type: vue.PropType<Record<string, unknown>>;
+    };
+    readonly defaultFilters: {
+        readonly type: vue.PropType<Record<string, unknown>>;
+        readonly default: () => {};
+    };
+    readonly size: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableSize>;
+        readonly default: _expcat_tigercat_core.TableSize;
+    };
+    readonly bordered: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly striped: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly hoverable: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly loading: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly emptyText: {
+        readonly type: StringConstructor;
+        readonly default: "No data";
+    };
+    readonly pagination: {
+        readonly type: vue.PropType<_expcat_tigercat_core.PaginationConfig | false>;
+        readonly default: () => {
             current: number;
             pageSize: number;
             total: number;
@@ -146,200 +115,161 @@ declare const Table: vue.DefineComponent<vue.ExtractPropTypes<{
             showTotal: boolean;
         };
     };
-    /**
-     * Row selection configuration
-     */
-    rowSelection: {
-        type: PropType<RowSelectionConfig>;
-    };
-    /**
-     * Row expansion configuration
-     */
-    expandable: {
-        type: PropType<ExpandableConfig>;
-    };
-    /**
-     * Function to get row key
-     */
-    rowKey: {
-        type: PropType<string | ((record: Record<string, unknown>) => string | number)>;
-        default: string;
-    };
-    /**
-     * Custom row class name
-     */
-    rowClassName: {
-        type: PropType<string | ((record: Record<string, unknown>, index: number) => string)>;
-    };
-    /**
-     * Whether table head is sticky
-     */
-    stickyHeader: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Max height for scrollable table
-     */
-    maxHeight: {
-        type: PropType<string | number>;
-    };
-    /**
-     * Table layout algorithm
-     */
-    tableLayout: {
-        type: PropType<"auto" | "fixed">;
-        default: string;
-    };
-    virtual: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    virtualHeight: {
-        type: NumberConstructor;
-        default: number;
-    };
-    virtualItemHeight: {
-        type: NumberConstructor;
-        default: number;
-    };
-    editable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editableCells: {
-        type: PropType<Map<string, Set<number>>>;
-    };
-    filterMode: {
-        type: PropType<"basic" | "advanced">;
-        default: string;
-    };
-    advancedFilterRules: {
-        type: PropType<FilterRule[]>;
-        default: () => never[];
-    };
-    columnDraggable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    summaryRow: {
-        type: PropType<{
+    readonly rowSelection: {
+        readonly type: vue.PropType<_expcat_tigercat_core.RowSelectionConfig>;
+    };
+    readonly expandable: {
+        readonly type: vue.PropType<_expcat_tigercat_core.ExpandableConfig>;
+    };
+    readonly rowKey: {
+        readonly type: vue.PropType<string | ((record: Record<string, unknown>) => string | number)>;
+        readonly default: "id";
+    };
+    readonly rowClassName: {
+        readonly type: vue.PropType<string | ((record: Record<string, unknown>, index: number) => string)>;
+    };
+    readonly stickyHeader: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly maxHeight: {
+        readonly type: vue.PropType<string | number>;
+    };
+    readonly tableLayout: {
+        readonly type: vue.PropType<"auto" | "fixed">;
+        readonly default: "auto";
+    };
+    readonly responsiveMode: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableResponsiveMode>;
+        readonly default: _expcat_tigercat_core.TableResponsiveMode;
+    };
+    readonly virtual: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly autoVirtual: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly virtualHeight: {
+        readonly type: NumberConstructor;
+        readonly default: 400;
+    };
+    readonly virtualItemHeight: {
+        readonly type: NumberConstructor;
+        readonly default: 40;
+    };
+    readonly autoVirtualThreshold: {
+        readonly type: NumberConstructor;
+        readonly default: 10000;
+    };
+    readonly virtualThreshold: {
+        readonly type: NumberConstructor;
+        readonly default: 1000;
+    };
+    readonly editable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly editableCells: {
+        readonly type: vue.PropType<Map<string, Set<number>>>;
+    };
+    readonly filterMode: {
+        readonly type: vue.PropType<"basic" | "advanced">;
+        readonly default: "basic";
+    };
+    readonly advancedFilterRules: {
+        readonly type: vue.PropType<_expcat_tigercat_core.FilterRule[]>;
+        readonly default: () => never[];
+    };
+    readonly columnDraggable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly rowDraggable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly summaryRow: {
+        readonly type: vue.PropType<{
             show: boolean;
             data: Record<string, unknown>;
         }>;
     };
-    groupBy: {
-        type: StringConstructor;
+    readonly groupBy: {
+        readonly type: StringConstructor;
+    };
+    readonly exportable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
     };
-    exportable: {
-        type: BooleanConstructor;
-        default: boolean;
+    readonly exportFormat: {
+        readonly type: vue.PropType<"csv" | "excel">;
+        readonly default: "csv";
     };
-    exportFilename: {
-        type: StringConstructor;
-        default: string;
+    readonly exportFilename: {
+        readonly type: StringConstructor;
+        readonly default: "export";
     };
 }>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("change" | "export" | "row-click" | "selection-change" | "sort-change" | "filter-change" | "page-change" | "expand-change" | "cell-change" | "column-order-change")[], "change" | "export" | "row-click" | "selection-change" | "sort-change" | "filter-change" | "page-change" | "expand-change" | "cell-change" | "column-order-change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
-    /**
-     * Table columns configuration
-     */
-    columns: {
-        type: PropType<TableColumn[]>;
-        required: true;
-    };
-    /**
-     * Whether to show a lock button in each column header.
-     */
-    columnLockable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Table data source
-     */
-    dataSource: {
-        type: PropType<Record<string, unknown>[]>;
-        default: () => never[];
-    };
-    /**
-     * Controlled sort state.
-     */
-    sort: {
-        type: PropType<SortState>;
-    };
-    /**
-     * Default sort state for uncontrolled mode.
-     */
-    defaultSort: {
-        type: PropType<SortState>;
-        default: () => {
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, string[], string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    readonly columns: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableColumn[]>;
+        readonly required: true;
+    };
+    readonly columnLockable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly dataSource: {
+        readonly type: vue.PropType<Record<string, unknown>[]>;
+        readonly default: () => never[];
+    };
+    readonly sort: {
+        readonly type: vue.PropType<_expcat_tigercat_core.SortState>;
+    };
+    readonly defaultSort: {
+        readonly type: vue.PropType<_expcat_tigercat_core.SortState>;
+        readonly default: () => {
             key: null;
             direction: null;
         };
     };
-    /**
-     * Controlled filters.
-     */
-    filters: {
-        type: PropType<Record<string, unknown>>;
-    };
-    /**
-     * Default filters for uncontrolled mode.
-     */
-    defaultFilters: {
-        type: PropType<Record<string, unknown>>;
-        default: () => {};
-    };
-    /**
-     * Table size
-     */
-    size: {
-        type: PropType<TableSize>;
-        default: TableSize;
-    };
-    /**
-     * Whether to show border
-     */
-    bordered: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Whether to show striped rows
-     */
-    striped: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Whether to highlight row on hover
-     */
-    hoverable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Loading state
-     */
-    loading: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Empty state text
-     */
-    emptyText: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Pagination configuration
-     */
-    pagination: {
-        type: PropType<PaginationConfig | false>;
-        default: () => {
+    readonly filters: {
+        readonly type: vue.PropType<Record<string, unknown>>;
+    };
+    readonly defaultFilters: {
+        readonly type: vue.PropType<Record<string, unknown>>;
+        readonly default: () => {};
+    };
+    readonly size: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableSize>;
+        readonly default: _expcat_tigercat_core.TableSize;
+    };
+    readonly bordered: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly striped: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly hoverable: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly loading: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly emptyText: {
+        readonly type: StringConstructor;
+        readonly default: "No data";
+    };
+    readonly pagination: {
+        readonly type: vue.PropType<_expcat_tigercat_core.PaginationConfig | false>;
+        readonly default: () => {
             current: number;
             pageSize: number;
             total: number;
@@ -348,134 +278,134 @@ declare const Table: vue.DefineComponent<vue.ExtractPropTypes<{
             showTotal: boolean;
         };
     };
-    /**
-     * Row selection configuration
-     */
-    rowSelection: {
-        type: PropType<RowSelectionConfig>;
-    };
-    /**
-     * Row expansion configuration
-     */
-    expandable: {
-        type: PropType<ExpandableConfig>;
-    };
-    /**
-     * Function to get row key
-     */
-    rowKey: {
-        type: PropType<string | ((record: Record<string, unknown>) => string | number)>;
-        default: string;
-    };
-    /**
-     * Custom row class name
-     */
-    rowClassName: {
-        type: PropType<string | ((record: Record<string, unknown>, index: number) => string)>;
-    };
-    /**
-     * Whether table head is sticky
-     */
-    stickyHeader: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Max height for scrollable table
-     */
-    maxHeight: {
-        type: PropType<string | number>;
-    };
-    /**
-     * Table layout algorithm
-     */
-    tableLayout: {
-        type: PropType<"auto" | "fixed">;
-        default: string;
-    };
-    virtual: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    virtualHeight: {
-        type: NumberConstructor;
-        default: number;
-    };
-    virtualItemHeight: {
-        type: NumberConstructor;
-        default: number;
-    };
-    editable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    editableCells: {
-        type: PropType<Map<string, Set<number>>>;
-    };
-    filterMode: {
-        type: PropType<"basic" | "advanced">;
-        default: string;
-    };
-    advancedFilterRules: {
-        type: PropType<FilterRule[]>;
-        default: () => never[];
-    };
-    columnDraggable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    summaryRow: {
-        type: PropType<{
+    readonly rowSelection: {
+        readonly type: vue.PropType<_expcat_tigercat_core.RowSelectionConfig>;
+    };
+    readonly expandable: {
+        readonly type: vue.PropType<_expcat_tigercat_core.ExpandableConfig>;
+    };
+    readonly rowKey: {
+        readonly type: vue.PropType<string | ((record: Record<string, unknown>) => string | number)>;
+        readonly default: "id";
+    };
+    readonly rowClassName: {
+        readonly type: vue.PropType<string | ((record: Record<string, unknown>, index: number) => string)>;
+    };
+    readonly stickyHeader: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly maxHeight: {
+        readonly type: vue.PropType<string | number>;
+    };
+    readonly tableLayout: {
+        readonly type: vue.PropType<"auto" | "fixed">;
+        readonly default: "auto";
+    };
+    readonly responsiveMode: {
+        readonly type: vue.PropType<_expcat_tigercat_core.TableResponsiveMode>;
+        readonly default: _expcat_tigercat_core.TableResponsiveMode;
+    };
+    readonly virtual: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly autoVirtual: {
+        readonly type: BooleanConstructor;
+        readonly default: true;
+    };
+    readonly virtualHeight: {
+        readonly type: NumberConstructor;
+        readonly default: 400;
+    };
+    readonly virtualItemHeight: {
+        readonly type: NumberConstructor;
+        readonly default: 40;
+    };
+    readonly autoVirtualThreshold: {
+        readonly type: NumberConstructor;
+        readonly default: 10000;
+    };
+    readonly virtualThreshold: {
+        readonly type: NumberConstructor;
+        readonly default: 1000;
+    };
+    readonly editable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly editableCells: {
+        readonly type: vue.PropType<Map<string, Set<number>>>;
+    };
+    readonly filterMode: {
+        readonly type: vue.PropType<"basic" | "advanced">;
+        readonly default: "basic";
+    };
+    readonly advancedFilterRules: {
+        readonly type: vue.PropType<_expcat_tigercat_core.FilterRule[]>;
+        readonly default: () => never[];
+    };
+    readonly columnDraggable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly rowDraggable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
+    };
+    readonly summaryRow: {
+        readonly type: vue.PropType<{
             show: boolean;
             data: Record<string, unknown>;
         }>;
     };
-    groupBy: {
-        type: StringConstructor;
+    readonly groupBy: {
+        readonly type: StringConstructor;
+    };
+    readonly exportable: {
+        readonly type: BooleanConstructor;
+        readonly default: false;
     };
-    exportable: {
-        type: BooleanConstructor;
-        default: boolean;
+    readonly exportFormat: {
+        readonly type: vue.PropType<"csv" | "excel">;
+        readonly default: "csv";
     };
-    exportFilename: {
-        type: StringConstructor;
-        default: string;
+    readonly exportFilename: {
+        readonly type: StringConstructor;
+        readonly default: "export";
     };
 }>> & Readonly<{
-    onChange?: ((...args: any[]) => any) | undefined;
-    onExport?: ((...args: any[]) => any) | undefined;
-    "onRow-click"?: ((...args: any[]) => any) | undefined;
-    "onSelection-change"?: ((...args: any[]) => any) | undefined;
-    "onSort-change"?: ((...args: any[]) => any) | undefined;
-    "onFilter-change"?: ((...args: any[]) => any) | undefined;
-    "onPage-change"?: ((...args: any[]) => any) | undefined;
-    "onExpand-change"?: ((...args: any[]) => any) | undefined;
-    "onCell-change"?: ((...args: any[]) => any) | undefined;
-    "onColumn-order-change"?: ((...args: any[]) => any) | undefined;
+    [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
 }>, {
-    pagination: false | PaginationConfig;
-    size: TableSize;
-    loading: boolean;
-    virtual: boolean;
-    dataSource: Record<string, unknown>[];
-    columnLockable: boolean;
-    defaultSort: SortState;
-    defaultFilters: Record<string, unknown>;
-    bordered: boolean;
-    striped: boolean;
-    hoverable: boolean;
-    emptyText: string;
-    rowKey: string | ((record: Record<string, unknown>) => string | number);
-    stickyHeader: boolean;
-    tableLayout: "auto" | "fixed";
-    virtualHeight: number;
-    virtualItemHeight: number;
-    editable: boolean;
-    filterMode: "basic" | "advanced";
-    advancedFilterRules: FilterRule[];
-    columnDraggable: boolean;
-    exportable: boolean;
-    exportFilename: string;
+    readonly pagination: false | _expcat_tigercat_core.PaginationConfig;
+    readonly emptyText: string;
+    readonly loading: boolean;
+    readonly size: _expcat_tigercat_core.TableSize;
+    readonly virtual: boolean;
+    readonly dataSource: Record<string, unknown>[];
+    readonly columnLockable: boolean;
+    readonly defaultSort: _expcat_tigercat_core.SortState;
+    readonly defaultFilters: Record<string, unknown>;
+    readonly bordered: boolean;
+    readonly striped: boolean;
+    readonly hoverable: boolean;
+    readonly rowKey: string | ((record: Record<string, unknown>) => string | number);
+    readonly stickyHeader: boolean;
+    readonly tableLayout: "auto" | "fixed";
+    readonly responsiveMode: _expcat_tigercat_core.TableResponsiveMode;
+    readonly autoVirtual: boolean;
+    readonly virtualHeight: number;
+    readonly virtualItemHeight: number;
+    readonly autoVirtualThreshold: number;
+    readonly virtualThreshold: number;
+    readonly editable: boolean;
+    readonly filterMode: "basic" | "advanced";
+    readonly advancedFilterRules: _expcat_tigercat_core.FilterRule[];
+    readonly columnDraggable: boolean;
+    readonly rowDraggable: boolean;
+    readonly exportable: boolean;
+    readonly exportFormat: "csv" | "excel";
+    readonly exportFilename: string;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 export { Table, type VueTableProps, Table as default };