tdesign-pro-component/dist/types/components/ProTable/types.d.ts

ProComponents tdesign-vue-next + Vue3 + TS

import { Optional, PromiseFunction } from '@tdesign-pro-component/utils';
import { BaseTableCol, FormRule, LoadingProps, PaginationProps, SizeEnum, TNode, TableProps, TableRowData } from 'tdesign-vue-next';
import { ProFormCheckboxProps } from '../ProFormCheckbox';
import { ProFormRadioProps } from '../ProFormRadio/types';
import { ProFormTextProps } from '../ProFormText';
import { ProFormTextareaProps } from '../ProFormTextarea';
import { ProFormInputNumberProps } from '../ProFormInputNumber';
import { ProFormSelectProps } from '../ProFormSelect';
import { ProFormDatepickerProps } from '../ProFormDatepicker';
import { ProFormTreeSelectProps } from '../ProFormTreeSelect';
import { FilterKey } from '../ProForm';
import { CSSProperties, VNode } from 'vue';
export interface ProTableRequest<T = any> {
    form: T;
    pageNum: number;
    pageSize: number;
}
export interface ProTableResult<T = any> {
    list: T[];
    total: number;
    pageNum?: number;
    pageSize?: number;
}
export interface ProTableProps {
    options: ProTableOption[];
    request: <T = any>(data: ProTableRequest<T>) => Promise<ProTableResult<T>>;
    rowKey?: string;
    onSearchSuccess?: (data: ProTableResult<any>) => any;
    onSearchFail?: (exception: Error | string) => void;
    hideForm?: boolean;
    hidePage?: boolean;
    searchNum?: number;
    loadingAble?: boolean;
    size?: SizeEnum;
    filterEmptyStr?: boolean;
    bordered?: boolean;
    stripe?: boolean;
    hover?: boolean;
    empty?: string | VNode | TNode | (() => VNode | TNode);
    cellEmptyContent?: string | VNode | TNode | (() => VNode | TNode);
    selectData?: any[];
    selectAble?: boolean;
    tableProps?: TableProps;
    page?: {
        pageNum: number;
        pageSize: number;
        total: number;
    };
    pageProps?: PaginationProps;
    searchText?: string;
    searchStyle?: CSSProperties;
    searchIcon?: string;
    loadingProps?: LoadingProps;
}
export interface ProTableOption<T = any> {
    key: string;
    title: string | (() => TNode | VNode) | TNode | VNode;
    hideInTable?: boolean;
    tableColumnsProps?: TableProps['columns'];
    render?: (data: {
        row: T;
        colIndex: number;
        rowIndex: number;
    }) => VNode | TNode;
    fixed?: 'left' | 'right';
    children?: Array<BaseTableCol<TableRowData>>;
    sorter?: boolean;
    ellipsisTitle?: boolean;
    ellipsis?: boolean;
    width?: string | number;
    isSlot?: boolean;
    hideInSearch?: boolean;
    placeholder?: string;
    labelWidth?: string;
    type?: 'text' | 'treeSelect' | 'number' | 'textarea' | 'select' | 'radio' | 'checkbox' | 'datepicker';
    span?: number;
    offset?: number;
    data?: any[] | PromiseFunction<any[]>;
    labelAlign?: 'left' | 'right' | 'top';
    multiple?: boolean;
    range?: boolean;
    disabled?: boolean;
    rules?: FormRule[];
    checkboxProps?: Optional<ProFormCheckboxProps, FilterKey>;
    radioProps?: Optional<ProFormRadioProps, FilterKey>;
    textProps?: Optional<ProFormTextProps, FilterKey>;
    numberProps?: Optional<ProFormInputNumberProps, FilterKey>;
    textareaProps?: Optional<ProFormTextareaProps, FilterKey>;
    selectProps?: Optional<ProFormSelectProps, FilterKey>;
    datepickerProps?: Optional<ProFormDatepickerProps, FilterKey>;
    treeSelectProps?: Optional<ProFormTreeSelectProps, FilterKey>;
    readonly?: boolean;
    labelText?: string;
}
export interface ProTableRef {
    getFormValue: () => any;
    reset: (resetParam?: boolean) => void;
    reload: () => void;
    getTdesignTable: () => any;
    insertTableData: (index: number, data: any) => void;
}
export type TableOrder = 'desc' | 'asc';