@flyto/farco 1.2.1 → 1.4.0

package/dist/types/components/ftable/ftable.d.ts

@@ -1,335 +1,335 @@
 import { AnyObject, OmitNullUndefined } from '../../../../../../../../../src/types';
-import { TableData, TableInstance, TableColumnData, TableRowSelection, ButtonProps } from '@arco-design/web-vue';
+import { TableData, TableInstance, TableColumnData, PaginationProps, TableRowSelection, ButtonProps } from '@arco-design/web-vue';
 import { ExtractPublicPropTypes, PropType, StyleValue, VNodeChild } from 'vue';
 import { FButtonProps } from '../fbutton';
-
-/** 使用随机ID的标识 */
-export declare const RANDOM_ID_FLAG = "random-959595";
-export type ColConfig = {
-    key: string;
-    noEdit?: boolean;
-    label?: string;
-    hide?: boolean;
-    sort?: number;
-};
-export type ColsSetting = {
-    [k: string]: ColConfig;
-};
-export type FTableCol<T extends AnyObject = AnyObject, D extends AnyObject = OmitNullUndefined<T>> = Omit<TableColumnData, 'render'> & {
-    dataIndex: Extract<keyof T, string>;
-    hide?: boolean;
-    /** 禁止配置排序及隐藏等设置项 */
-    noSetting?: boolean;
-    /** 在title是一个组件时，在列配置弹层中，此列的label */
-    settingLabel?: string;
-    /** 自定义格式化显示值 */
-    render?: (data: Omit<Parameters<NonNullable<TableColumnData['render']>>[0], 'record'> & {
-        record: D & TableData;
-    }) => VNodeChild;
-    /**
-     * 自动合并单元格取值字段配置
-     *
-     * 如果没有配置，则默认使用dataIndex作为判断行列单元格是否相等的取值字段
-     */
-    merge?: string | {
-        row: string;
-        col: string;
-    };
-};
-export type FTableData<T extends AnyObject = AnyObject> = TableData & T;
-type MethodDataReturn<T extends AnyObject> = {
-    list: FTableData<T>[];
-    total: number;
-    message: string;
-};
-/**
- * 通过方法获取的数据
- */
-export type FTableMethodData<T extends AnyObject = AnyObject, Q extends AnyObject = AnyObject> = (
-/** 扩展参数，如果开启分页，将在每次执行时传入当前的分页数据 */
-params: Q & {
-    page?: {
-        index: number;
-        size: number;
-    };
-}) => Promise<MethodDataReturn<T>> | MethodDataReturn<T>;
-/**
- * 表格单元格合并配置（暂时只实现了行合并）
- *
- * 在不同行、列间，配置的字段值相等时，自动计算合并的行跨度
- */
-export type FTableMerge<T extends AnyObject = Record<string, any>> = {
-    /**
-     * 行合并字段
-     */
-    row: (keyof T)[];
-    /**
-     * 行分组字段，避免因为数据相同，不应该合并的行进行了合并显示
-     */
-    rowGroupBy?: (keyof T)[];
-};
-export type FTableSpanMethod<T> = (data: {
-    record: T;
-    column: FTableCol;
-    rowIndex: number;
-    columnIndex: number;
-}) => {
-    rowspan?: number;
-    colspan?: number;
-} | void;
-export type FTableToolBarBtn = {
-    label: string;
-    icon?: string;
-    size?: ButtonProps['size'];
-    type?: FButtonProps['type'];
-    status?: ButtonProps['status'];
-    tooltip?: string;
-    click?: () => void;
-};
-export type FTableToolBarQuick = {
-    colsSetting?: boolean;
-    export?: boolean | {
-        fileName: string;
-    };
-    print?: boolean;
-};
-export type FTableToolBar = {
-    /**
-     * 表格标题
-     */
-    title?: string;
-    /**
-     * 按钮组的简单配置
-     */
-    btns?: FTableToolBarBtn[];
-    /**
-     * 右侧快捷工具栏
-     */
-    quickTools?: boolean | FTableToolBarQuick;
-};
-export type FTableRemember = {
-    /**
-     * 选中数据时，使用哪个字段作为唯一标识符
-     */
-    valueKey: string;
-    /**
-     * 选中数据时，使用哪个字段作为显示值出现
-     */
-    labelKey: string;
-};
-export type FTableRowSelection = TableRowSelection & {
-    /**
-     * 双击选中当前行
-     */
-    dblClickSelect?: boolean;
-    /**
-     * 选中项的 tag 的宽度（只有在开启跨页记忆选择时生效）
-     */
-    tagWidth?: string;
-    /**
-     * 选中时，用哪个字段作为显示的label（只有在开启跨页记忆选择时生效）
-     * 此项如若不传，则使用 rowKey 字段作为显示的label
-     */
-    tagLabelKey?: string;
-    /**
-     * 自定义渲染选中项的 tag
-     */
-    renderTagLabel?: (item: {
-        [k: string | number]: any;
-    }) => VNodeChild;
-};
-export type FTablePage = {
-    /**
-     * 当前页数（非受控数据）
-     */
-    defaultIndex: number;
-    /**
-     * 每页显示条数（非受控数据）
-     */
-    defaultSize: number;
-    /**
-     * 条数选择列表
-     */
-    sizes?: number[];
-};
-export type FTableScroll = {
-    x?: string;
-    y?: string;
-    minWidth?: string;
-    maxHeight?: string;
-};
-export declare const fTableProps: {
-    /**
-     * 表格尺寸
-     */
-    size: {
-        type: PropType<TableInstance>;
-        default: string;
-    };
-    /**
-     * 唯一标识符
-     * 在记录table列排序、显示数据时，此值用于判断是否属于该table的数据
-     */
-    id: {
-        type: StringConstructor;
-        default: () => string;
-    };
-    /**
-     * 数据列表
-     * 支持Promise函数，可返回一个远程获取的数据
-     */
-    data: {
-        type: PropType<any[] | FTableMethodData<AnyObject<any>, AnyObject<any>>>;
-        default: () => never[];
-        required: boolean;
-    };
-    /**
-     * 非立即获取数据，由手动调用方法进行数据获取
-     */
-    noImmediatelyMethodData: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * 在非立即获取数据时，数据为空时，提示文本
-     */
-    noImmediatelyMethodDataEmptyText: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * 数据为空时，提示文本
-     */
-    emptyText: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * 列描述数据
-     */
-    cols: {
-        type: PropType<FTableCol<AnyObject<any>, OmitNullUndefined<AnyObject<any>>>[]>;
-        default: () => never[];
-    };
-    /**
-     * 行数据合并配置
-     */
-    merge: {
-        type: PropType<FTableMerge<Record<string, any>>>;
-        default: () => {
-            row: never[];
-            rowGroupBy: never[];
-        };
-    };
-    /**
-     * 顶部工具栏的配置
-     */
-    toolbar: {
-        type: PropType<false | FTableToolBar>;
-        default: () => {
-            quickTools: boolean;
-        };
-    };
-    /**
-     * 分页配置
-     * 目前仅支持非受控模式，为了冗余以后会实现的受控模式，所以目前在size及index变量名都加上了default
-     */
-    page: {
-        type: PropType<boolean | FTablePage>;
-        default: boolean;
-    };
-    /**
-     * 分页组件的props
-     * 剔除total、页数相关等参数
-     */
-    pageProps: {
-        type: PropType<Omit<PaginationProps, "total" | "current" | "defaultCurrent" | "pageSize" | "defaultPageSize">>;
-        default: null;
-    };
-    /**
-     * 表格行 key 的取值字段
-     */
-    rowKey: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * 行className
-     */
-    rowClass: {
-        type: PropType<string | any[] | Record<string, any> | ((record: FTableData, rowIndex: number) => any)>;
-        default: string;
-    };
-    /**
-     * 选择类型
-     */
-    selection: {
-        type: PropType<boolean | "checkbox" | "radio">;
-        default: boolean;
-    };
-    /**
-     * 选择器的配置项
-     * 同 TableRowSelection (如果传入type字段，则忽略selection配置)
-     */
-    selectionConfig: {
-        type: PropType<any>;
-        default: null;
-    };
-    /**
-     * 默认已选择的行（非受控模式）
-     * 提供 selectedKeys 参数（受控模式）
-     * 优先级高于selectionConfig配置
-     */
-    defaultSelectedRowKeys: {
-        type: PropType<TableInstance>;
-        default: null;
-    };
-    /**
-     * 默认已选择的行数据（非受控模式）
-     * 在采用跨页记忆选择时，右侧需要根据选择的数据来进行渲染，如果只有一个keys，组件刚渲染时，并没有其他页的数据，会导致渲染异常
-     * 传入此参数后，无论是 defaultSelectedRowKeys 还是 selectionConfig.defaultSelectedRowKeys 均会无效。将会以此参数来作为默认值传入
-     */
-    defaultSelectedRows: {
-        type: PropType<Record<string | number, any>[]>;
-        default: null;
-    };
-    /**
-     * 标头吸顶
-     */
-    stickyHeader: {
-        type: (BooleanConstructor | NumberConstructor)[];
-        default: boolean;
-    };
-    /**
-     * 滚动条设置
-     */
-    scroll: {
-        type: PropType<FTableScroll>;
-        default: () => {
-            x: string;
-        };
-    };
-    /**
-     * 显示外边框
-     */
-    bordered: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * 包裹层的class
-     */
-    wrapClass: {
-        type: PropType<string | object | []>;
-        default: string;
-    };
-    /**
-     * 包裹层的style
-     */
-    wrapStyle: {
-        type: PropType<StyleValue>;
-        default: string;
-    };
-};
-export type FTableProps = Omit<TableInstance['$props'], 'columns' | 'loading' | 'pagination' | 'tableRowSelection'> & ExtractPublicPropTypes<typeof fTableProps>;
-export {};
+
+/** 使用随机ID的标识 */
+export declare const RANDOM_ID_FLAG = "random-959595";
+export type ColConfig = {
+    key: string;
+    noEdit?: boolean;
+    label?: string;
+    hide?: boolean;
+    sort?: number;
+};
+export type ColsSetting = {
+    [k: string]: ColConfig;
+};
+export type FTableCol<T extends AnyObject = AnyObject, D extends AnyObject = OmitNullUndefined<T>> = Omit<TableColumnData, 'render'> & {
+    dataIndex: Extract<keyof T, string>;
+    hide?: boolean;
+    /** 禁止配置排序及隐藏等设置项 */
+    noSetting?: boolean;
+    /** 在title是一个组件时，在列配置弹层中，此列的label */
+    settingLabel?: string;
+    /** 自定义格式化显示值 */
+    render?: (data: Omit<Parameters<NonNullable<TableColumnData['render']>>[0], 'record'> & {
+        record: D & TableData;
+    }) => VNodeChild;
+    /**
+     * 自动合并单元格取值字段配置
+     *
+     * 如果没有配置，则默认使用dataIndex作为判断行列单元格是否相等的取值字段
+     */
+    merge?: string | {
+        row: string;
+        col: string;
+    };
+};
+export type FTableData<T extends AnyObject = AnyObject> = TableData & T;
+type MethodDataReturn<T extends AnyObject> = {
+    list: FTableData<T>[];
+    total: number;
+    message: string;
+};
+/**
+ * 通过方法获取的数据
+ */
+export type FTableMethodData<T extends AnyObject = AnyObject, Q extends AnyObject = AnyObject> = (
+/** 扩展参数，如果开启分页，将在每次执行时传入当前的分页数据 */
+params: Q & {
+    page?: {
+        index: number;
+        size: number;
+    };
+}) => Promise<MethodDataReturn<T>> | MethodDataReturn<T>;
+/**
+ * 表格单元格合并配置（暂时只实现了行合并）
+ *
+ * 在不同行、列间，配置的字段值相等时，自动计算合并的行跨度
+ */
+export type FTableMerge<T extends AnyObject = Record<string, any>> = {
+    /**
+     * 行合并字段
+     */
+    row: (keyof T)[];
+    /**
+     * 行分组字段，避免因为数据相同，不应该合并的行进行了合并显示
+     */
+    rowGroupBy?: (keyof T)[];
+};
+export type FTableSpanMethod<T> = (data: {
+    record: T;
+    column: FTableCol;
+    rowIndex: number;
+    columnIndex: number;
+}) => {
+    rowspan?: number;
+    colspan?: number;
+} | void;
+export type FTableToolBarBtn = {
+    label: string;
+    icon?: string;
+    size?: ButtonProps['size'];
+    type?: FButtonProps['type'];
+    status?: ButtonProps['status'];
+    tooltip?: string;
+    click?: () => void;
+};
+export type FTableToolBarQuick = {
+    colsSetting?: boolean;
+    export?: boolean | {
+        fileName: string;
+    };
+    print?: boolean;
+};
+export type FTableToolBar = {
+    /**
+     * 表格标题
+     */
+    title?: string;
+    /**
+     * 按钮组的简单配置
+     */
+    btns?: FTableToolBarBtn[];
+    /**
+     * 右侧快捷工具栏
+     */
+    quickTools?: boolean | FTableToolBarQuick;
+};
+export type FTableRemember = {
+    /**
+     * 选中数据时，使用哪个字段作为唯一标识符
+     */
+    valueKey: string;
+    /**
+     * 选中数据时，使用哪个字段作为显示值出现
+     */
+    labelKey: string;
+};
+export type FTableRowSelection = TableRowSelection & {
+    /**
+     * 双击选中当前行
+     */
+    dblClickSelect?: boolean;
+    /**
+     * 选中项的 tag 的宽度（只有在开启跨页记忆选择时生效）
+     */
+    tagWidth?: string;
+    /**
+     * 选中时，用哪个字段作为显示的label（只有在开启跨页记忆选择时生效）
+     * 此项如若不传，则使用 rowKey 字段作为显示的label
+     */
+    tagLabelKey?: string;
+    /**
+     * 自定义渲染选中项的 tag
+     */
+    renderTagLabel?: (item: {
+        [k: string | number]: any;
+    }) => VNodeChild;
+};
+export type FTablePage = {
+    /**
+     * 当前页数（非受控数据）
+     */
+    defaultIndex: number;
+    /**
+     * 每页显示条数（非受控数据）
+     */
+    defaultSize: number;
+    /**
+     * 条数选择列表
+     */
+    sizes?: number[];
+};
+export type FTableScroll = {
+    x?: string;
+    y?: string;
+    minWidth?: string;
+    maxHeight?: string;
+};
+export declare const fTableProps: {
+    /**
+     * 表格尺寸
+     */
+    size: {
+        type: PropType<TableInstance["$props"]["size"]>;
+        default: string;
+    };
+    /**
+     * 唯一标识符
+     * 在记录table列排序、显示数据时，此值用于判断是否属于该table的数据
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    /**
+     * 数据列表
+     * 支持Promise函数，可返回一个远程获取的数据
+     */
+    data: {
+        type: PropType<FTableData[] | FTableMethodData>;
+        default: () => never[];
+        required: boolean;
+    };
+    /**
+     * 非立即获取数据，由手动调用方法进行数据获取
+     */
+    noImmediatelyMethodData: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 在非立即获取数据时，数据为空时，提示文本
+     */
+    noImmediatelyMethodDataEmptyText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 数据为空时，提示文本
+     */
+    emptyText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 列描述数据
+     */
+    cols: {
+        type: PropType<FTableCol[]>;
+        default: () => never[];
+    };
+    /**
+     * 行数据合并配置
+     */
+    merge: {
+        type: PropType<FTableMerge>;
+        default: () => {
+            row: never[];
+            rowGroupBy: never[];
+        };
+    };
+    /**
+     * 顶部工具栏的配置
+     */
+    toolbar: {
+        type: PropType<FTableToolBar | false>;
+        default: () => {
+            quickTools: boolean;
+        };
+    };
+    /**
+     * 分页配置
+     * 目前仅支持非受控模式，为了冗余以后会实现的受控模式，所以目前在size及index变量名都加上了default
+     */
+    page: {
+        type: PropType<boolean | FTablePage>;
+        default: boolean;
+    };
+    /**
+     * 分页组件的props
+     * 剔除total、页数相关等参数
+     */
+    pageProps: {
+        type: PropType<Omit<PaginationProps, "total" | "current" | "defaultCurrent" | "pageSize" | "defaultPageSize">>;
+        default: null;
+    };
+    /**
+     * 表格行 key 的取值字段
+     */
+    rowKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 行className
+     */
+    rowClass: {
+        type: PropType<string | any[] | Record<string, any> | ((record: FTableData, rowIndex: number) => any)>;
+        default: string;
+    };
+    /**
+     * 选择类型
+     */
+    selection: {
+        type: PropType<"checkbox" | "radio" | boolean>;
+        default: boolean;
+    };
+    /**
+     * 选择器的配置项
+     * 同 TableRowSelection (如果传入type字段，则忽略selection配置)
+     */
+    selectionConfig: {
+        type: PropType<FTableRowSelection>;
+        default: null;
+    };
+    /**
+     * 默认已选择的行（非受控模式）
+     * 提供 selectedKeys 参数（受控模式）
+     * 优先级高于selectionConfig配置
+     */
+    defaultSelectedRowKeys: {
+        type: PropType<TableInstance["$props"]["defaultSelectedKeys"]>;
+        default: null;
+    };
+    /**
+     * 默认已选择的行数据（非受控模式）
+     * 在采用跨页记忆选择时，右侧需要根据选择的数据来进行渲染，如果只有一个keys，组件刚渲染时，并没有其他页的数据，会导致渲染异常
+     * 传入此参数后，无论是 defaultSelectedRowKeys 还是 selectionConfig.defaultSelectedRowKeys 均会无效。将会以此参数来作为默认值传入
+     */
+    defaultSelectedRows: {
+        type: PropType<Record<string | number, any>[]>;
+        default: null;
+    };
+    /**
+     * 标头吸顶
+     */
+    stickyHeader: {
+        type: (BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    };
+    /**
+     * 滚动条设置
+     */
+    scroll: {
+        type: PropType<FTableScroll>;
+        default: () => {
+            x: string;
+        };
+    };
+    /**
+     * 显示外边框
+     */
+    bordered: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 包裹层的class
+     */
+    wrapClass: {
+        type: PropType<string | object | []>;
+        default: string;
+    };
+    /**
+     * 包裹层的style
+     */
+    wrapStyle: {
+        type: PropType<StyleValue>;
+        default: string;
+    };
+};
+export type FTableProps = Omit<TableInstance['$props'], 'columns' | 'loading' | 'pagination' | 'tableRowSelection'> & ExtractPublicPropTypes<typeof fTableProps>;
+export {};