@jdlinker/linker

import type { ProFieldEmptyText } from '@ant-design/pro-field'; import type { LightWrapperProps, ProFormProps, QueryFilterProps } from '@ant-design/pro-form'; import type { ParamsType } from '@ant-design/pro-provider'; import type { ProCoreActionType, ProSchema, ProSchemaComponentTypes, SearchTransformKeyFn, ProTableEditableFnType, RowEditableConfig } from '@ant-design/pro-utils'; import type { CardProps } from 'antd/lib/card'; import type { SpinProps } from 'antd/lib/spin'; import type { TableProps } from 'antd/lib/table'; import type { ColumnFilterItem, ColumnType, CompareFn, SortOrder } from 'antd/lib/table/interface'; import type { CSSProperties } from 'react'; import type { AlertRenderType } from './components/Alert'; import type { ListToolBarProps } from './components/ListToolBar'; import type { OptionConfig, ToolBarProps } from './components/ToolBar'; import type { DensitySize } from './components/ToolBar/DensityIcon'; import type { ColumnsState, useContainer } from './container'; import type { SearchConfig, TableFormItem } from './components/Form/FormRender'; import type { LabelTooltipType } from 'antd/lib/form/FormItemLabel'; import type { SizeType } from 'antd/lib/config-provider/SizeContext'; import type { NamePath } from 'antd/lib/form/interface'; import type React from 'react'; export declare type PageInfo = { pageSize: number; total: number; current: number; pageIndex?: number; }; export declare type RequestData<T> = { code: string; result: { data: T[] | undefined; pageIndex: number; pageSize: number; total: number; }; status: number; } & Record<string, any>; export declare type UseFetchDataAction<T = any> = { dataSource: T[]; setDataSource: (dataSource: T[]) => void; loading: boolean | SpinProps | undefined; pageInfo: PageInfo; reload: () => Promise<void>; fullScreen?: () => void; reset: () => void; pollingLoading: boolean; setPageInfo: (pageInfo: Partial<PageInfo>) => void; }; /** 转化列的定义 */ export declare type ColumnRenderInterface<T> = { item: ProColumns<T>; text: any; row: T; index: number; columnEmptyText?: ProFieldEmptyText; type: ProSchemaComponentTypes; counter: ReturnType<typeof useContainer>; }; export declare type TableRowSelection = TableProps<any>['rowSelection']; export declare type ExtraProColumnType<T> = Omit< ColumnType<T>, 'render' | 'children' | 'title' | 'filters' | 'onFilter' | 'sorter' > & { sorter?: | string | boolean | CompareFn<T> | { compare?: CompareFn<T>; /** Config multiple sorter order priority */ multiple?: number; }; }; export declare type ProColumnType<T = unknown, ValueType = 'text'> = ProSchema< T, ExtraProColumnType<T> & { index?: number; /** * 每个表单占据的格子大小 * * @param 总宽度 = span* colSize * @param 默认为 1 */ colSize?: number; /** 搜索表单的默认值 */ initialValue?: any; /** 是否缩略 */ ellipsis?: boolean; /** 是否拷贝 */ copyable?: boolean; /** @deprecated Use `search=false` instead 在查询表单中隐藏 */ hideInSearch?: boolean; /** 在查询表单中隐藏 */ search?: | false | { /** * Transform: (value: any) => ({ startTime: value[0], endTime: value[1] }), * * @name 转化值的key, 一般用于事件区间的转化 */ transform: SearchTransformKeyFn; }; /** 在 table 中隐藏 */ hideInTable?: boolean; /** 在新建表单中删除 */ hideInForm?: boolean; /** 不在配置工具中显示 */ hideInSetting?: boolean; /** 表头的筛选菜单项 */ filters?: boolean | ColumnFilterItem[]; /** 筛选的函数，设置为 false 会关闭自带的本地筛选 */ onFilter?: boolean | ColumnType<T>['onFilter']; /** Form 的排序 */ order?: number; /** 可编辑表格是否可编辑 */ editable?: boolean | ProTableEditableFnType<T>; /** @private */ listKey?: string; /** 只读 */ readonly?: boolean; /** @name 获得 dataSource 的方法 */ request?: (params?: Record<string, any>) => Promise<any>; }, ProSchemaComponentTypes, ValueType, { lightProps?: LightWrapperProps; } >; export declare type ProColumnGroupType<RecordType, ValueType> = { children: ProColumns<RecordType>[]; } & ProColumnType<RecordType, ValueType>; export declare type ProColumns<T = any, ValueType = 'text'> = | ProColumnGroupType<T, ValueType> | ProColumnType<T, ValueType>; export declare type BorderedType = 'search' | 'table'; export declare type Bordered = | boolean | { search?: boolean; table?: boolean; }; export declare type ColumnsStateType = { /** * 持久化的类型，支持 localStorage 和 sessionStorage * * @param localStorage 设置在关闭浏览器后也是存在的 * @param sessionStorage 关闭浏览器后会丢失 */ persistenceType?: 'localStorage' | 'sessionStorage'; /** 持久化的key，用于存储到 storage 中 */ persistenceKey?: string; /** ColumnsState 的值，columnsStateMap将会废弃 */ defaultValue?: Record<string, ColumnsState>; /** ColumnsState 的值，columnsStateMap将会废弃 */ value?: Record<string, ColumnsState>; onChange?: (map: Record<string, ColumnsState>) => void; }; /** ProTable 的类型定义继承自 antd 的 Table */ export declare type ProTableProps<T, U extends ParamsType, ValueType = 'text'> = { columns?: ProColumns<T, ValueType>[]; /** @name ListToolBar 的属性 */ toolbar?: ListToolBarProps; params?: U; /** * 列状态配置，可以配置是否浮动和是否展示 * * @deprecated 请使用 columnsState.value 代替 */ columnsStateMap?: Record<string, ColumnsState>; /** * 列状态配置修改触发事件 * * @deprecated 请使用 columnsState.onChange 代替 */ onColumnsStateChange?: (map: Record<string, ColumnsState>) => void; /** 列状态的配置，可以用来操作列功能 */ columnsState?: ColumnsStateType; onSizeChange?: (size: DensitySize) => void; /** @name table 外面卡片的设置 */ cardProps?: CardProps | false; /** @name 渲染 table */ tableRender?: ( props: ProTableProps<T, U, ValueType>, defaultDom: JSX.Element, /** 各个区域的 dom */ domList: { toolbar: JSX.Element | undefined; alert: JSX.Element | undefined; table: JSX.Element | undefined; } ) => React.ReactNode; /** @name 渲染 table 视图，用于定制 ProList，不推荐直接使用 */ tableViewRender?: (props: TableProps<T>, defaultDom: JSX.Element) => JSX.Element | undefined; tableExtraRender?: (props: ProTableProps<T, U, ValueType>, dataSource: T[]) => React.ReactNode; /** @name 一个获得 dataSource 的方法 */ request?: ( params: U & { pageSize?: number; current?: number; keyword?: string; }, sort: Record<string, SortOrder>, filter: Record<string, React.ReactText[] | null> ) => Promise<Partial<RequestData<T>>>; /** @name 对数据进行一些处理 */ postData?: (data: any[]) => any[]; /** @name 默认的数据 */ defaultData?: T[]; /** @name 初始化的参数，可以操作 table */ actionRef?: React.Ref<ActionType | undefined>; /** @name 操作自带的 form */ formRef?: TableFormItem<T>['formRef']; /** @name 渲染操作栏 */ toolBarRender?: ToolBarProps<T>['toolBarRender'] | false; /** @name 数据加载完成后触发 */ onLoad?: (dataSource: T[]) => void; /** @name loading 被修改时触发，一般是网络请求导致的 */ onLoadingChange?: (loading: boolean | SpinProps | undefined) => void; /** @name 数据加载失败时触发 */ onRequestError?: (e: Error) => void; /** * 是否轮询 ProTable 它不会自动提交表单，如果你想自动提交表单的功能，需要在 onValueChange 中调用 formRef.current?.submit() * * @param dataSource 返回当前的表单数据，你可以用它判断要不要打开轮询 */ polling?: number | ((dataSource: T[]) => number); /** @name 给封装的 table 的 className */ tableClassName?: string; /** @name 给封装的 table 的 style */ tableStyle?: CSSProperties; /** @name 左上角的 title */ headerTitle?: React.ReactNode; /** @name 标题旁边的 tooltip */ tooltip?: string | LabelTooltipType; /** @name 操作栏配置 */ options?: OptionConfig | false; /** * @type SearchConfig * @name 是否显示搜索表单 */ search?: false | SearchConfig; /** * 基本配置与 antd Form 相同, 但是劫持了 form onFinish 的配置 * * @name type="form" 和搜索表单的 Form 配置 */ form?: Omit<ProFormProps & QueryFilterProps, 'form'>; /** * 暂时只支持 moment - string 会格式化为 YYYY-DD-MM - number 代表时间戳 * * @name 如何格式化日期 */ dateFormatter?: 'string' | 'number' | false; /** @name 格式化搜索表单提交数据 */ beforeSearchSubmit?: (params: Partial<U>) => any; /** * 设置或者返回false 即可关闭 * * @name 自定义 table 的 alert */ tableAlertRender?: AlertRenderType<T>; /** * 设置或者返回false 即可关闭 * * @name 自定义 table 的 alert 的操作 */ tableAlertOptionRender?: AlertRenderType<T>; /** @name 选择项配置 */ rowSelection?: | (TableProps<T>['rowSelection'] & { alwaysShowAlert?: boolean; }) | false; style?: React.CSSProperties; /** 支持 ProTable 的类型 */ type?: ProSchemaComponentTypes; /** @name 提交表单时触发 */ onSubmit?: (params: U) => void; /** @name 重置表单时触发 */ onReset?: () => void; /** @name 空值时显示 */ columnEmptyText?: ProFieldEmptyText; /** @name 是否手动触发请求 */ manualRequest?: boolean; /** @name 编辑行相关的配置 */ editable?: RowEditableConfig<T>; /** @name 可编辑表格修改数据的改变 */ onDataSourceChange?: (dataSource: T[]) => void; /** @name 查询表单和 Table 的卡片 border 配置 */ cardBordered?: Bordered; /** @name 去抖时间 */ debounceTime?: number; /** * 只在request 存在的时候生效，可编辑表格也不会生效 * * @default true * @name 窗口聚焦时自动重新请求 */ revalidateOnFocus?: boolean; /** 默认的表格大小 */ defaultSize?: SizeType; /** @name, 可编辑表格的name,通过这个name 可以直接与 form通信，无需嵌套 */ name?: NamePath; /** @name 表单默认值 */ defaultParams?: U; } & Omit<TableProps<T>, 'columns' | 'rowSelection'>; export declare type ActionType = ProCoreActionType & { fullScreen?: () => void; setPageInfo?: (page: Partial<PageInfo>) => void; }; export declare type UseFetchProps = { dataSource?: any; loading: UseFetchDataAction['loading']; onLoadingChange?: (loading: UseFetchDataAction['loading']) => void; onLoad?: (dataSource: any[], extra: any) => void; onDataSourceChange?: (dataSource?: any) => void; postData: any; pageInfo: | { current?: number; pageSize?: number; defaultCurrent?: number; defaultPageSize?: number; } | false; onPageInfoChange?: (pageInfo: PageInfo) => void; effects?: any[]; onRequestError?: (e: Error) => void; manual: boolean; debounceTime?: number; polling?: number | ((dataSource: any[]) => number); revalidateOnFocus?: boolean; };