@canvas-components/react-list-table 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode, ForwardedRef } from 'react';
+import { ListTableOptions, ListTableQueryChange, ListTableScrollToOptions, ListTable, ListTableColumn, ListTablePaginationOptions, ListTableQueryOptions, ListTableRowSelectionOptions } from '@canvas-components/list-table';
+
+interface ReactListTableScrollConfig {
+    x?: number | string | true;
+    y?: number | string;
+}
+interface ReactListTableLocale {
+    emptyText?: string;
+}
+interface ReactListTableProps<RecordType = Record<string, unknown>> extends Omit<ListTableOptions<RecordType>, "type" | "ui" | "width" | "height" | "emptyText"> {
+    width?: number | string;
+    height?: number | string;
+    emptyText?: string;
+    scroll?: ReactListTableScrollConfig;
+    locale?: ReactListTableLocale;
+    onChange?: ListTableQueryChange<RecordType>;
+    className?: string;
+    style?: CSSProperties;
+    /** 表格标题栏左侧内容。 */
+    title?: ReactNode;
+    /** 标题栏右侧工具配置，传入 false 时隐藏整个标题栏工具区。 */
+    toolbar?: false | ReactListTableToolbarOptions;
+}
+interface ReactListTableToolbarOptions {
+    showRefresh?: boolean;
+    showFullscreen?: boolean;
+    showDensity?: boolean;
+    showColumnSetting?: boolean;
+    /** 列设置弹层宽度，数字值按像素处理。 */
+    columnSettingWidth?: number | string;
+    showExport?: boolean;
+    onRefresh?: () => void;
+    /** 自定义导出行为；未配置时默认异步导出全量 XLSX 数据。 */
+    onExport?: () => void;
+    /** 自定义全屏节点，默认使用表格根容器。 */
+    getFullscreenNode?: () => HTMLElement | null;
+    extra?: ReactNode;
+}
+/**
+ * React 表格实例透出方法。
+ */
+interface ReactListTableRef<RecordType = Record<string, unknown>> {
+    validate: () => Promise<RecordType[]>;
+    exportXlsx: () => void;
+    scrollTo: (options: ListTableScrollToOptions) => void;
+    getDebugSnapshot: () => ReturnType<ListTable<RecordType>["getDebugSnapshot"]>;
+    resetSorter: () => void;
+    resetFilter: () => void;
+}
+/**
+ * antd Table 风格的 props 类型别名。
+ */
+type ReactListTableTableProps<RecordType = Record<string, unknown>> = ReactListTableProps<RecordType>;
+/**
+ * 单列类型。
+ */
+type ReactListTableColumnType<RecordType = Record<string, unknown>> = ListTableColumn<RecordType>;
+/**
+ * 列数组类型。
+ */
+type ReactListTableColumnsType<RecordType = Record<string, unknown>> = Array<ReactListTableColumnType<RecordType>>;
+/**
+ * 行选择类型别名。
+ */
+type ReactListTableRowSelection<RecordType = Record<string, unknown>> = ListTableRowSelectionOptions<RecordType>;
+/**
+ * 分页类型别名。
+ */
+type ReactListTablePagination = ListTablePaginationOptions;
+/**
+ * 查询类型别名。
+ */
+type ReactListTableQuery<RecordType = Record<string, unknown>> = ListTableQueryOptions<RecordType>;
+
+/**
+ * ListTable 的 React 宿主组件。
+ */
+declare function ReactListTableInner<RecordType = Record<string, unknown>>(props: ReactListTableProps<RecordType>, ref: ForwardedRef<ReactListTableRef<RecordType>>): react.JSX.Element;
+declare const ReactListTable: <RecordType = Record<string, unknown>>(props: ReactListTableProps<RecordType> & {
+    ref?: ForwardedRef<ReactListTableRef<RecordType>>;
+}) => ReturnType<typeof ReactListTableInner>;
+
+export { ReactListTable, type ReactListTableColumnType, type ReactListTableColumnsType, type ReactListTableLocale, type ReactListTablePagination, type ReactListTableProps, type ReactListTableQuery, type ReactListTableRef, type ReactListTableRowSelection, type ReactListTableScrollConfig, type ReactListTableTableProps, type ReactListTableToolbarOptions };