@ccs-ui/rc-pro 2.3.4 → 2.3.6-alpha-1

package/es/pro-table/table.d.ts

@@ -1,36 +1,52 @@
 import { TableProps } from 'antd';
 import { ColumnGroupType, ColumnType } from 'antd/es/table';
 import { TableSticky } from 'rc-table/lib/interface';
-import React, { CSSProperties, ReactElement, ReactNode } from 'react';
+import React, { CSSProperties, ReactNode } from 'react';
 import CCS from '..';
 import { PropsWithCss, PropsWithNodeChildren, TableColumns } from '../ccs';
 import { CcsFieldNamesType } from '../context';
+import { EllipsisProps } from '../ellipsis';
 import './index.less';
 type ParamType = Record<string, any>;
 export type ShowDependType = {
     name: string;
     value: any;
 };
-export type SearchEventType = 'search' | 'reset' | 'reload' | 'changePage' | 'initSearch';
-type SearchBeforeType = ParamType & {
-    query: ParamType;
-};
+export declare enum TableEvent {
+    Search = "search",
+    Reset = "reset",
+    Reload = "reload",
+    ChangePage = "changePage",
+    InitSearch = "initSearch",
+    FullScreen = "fullScreen",
+    ColumnFilter = "columnFilter",
+    SelectedRows = "SelectedRows"
+}
 export type TableColumn<RecordType = any> = (Omit<ColumnGroupType<RecordType>, 'ellipsis'> | Omit<ColumnType<RecordType>, 'ellipsis'>) & {
+    dataIndex?: keyof RecordType;
     /** 隐藏列 */
     hidden?: boolean;
     /** 省略显示行数,最大支持10行 */
-    ellipsis?: boolean | number;
+    ellipsis?: Omit<EllipsisProps, 'content'> | boolean | number;
 };
 type TableTitleType<T> = {
-    selectedRows: T[];
+    /** 选中Key */
+    selectedRowKeys?: React.Key[];
+    /** 选中记录 */
+    selectedRows?: T[];
+    /** table datasource */
     data: T[];
-    onClear: () => void;
+    /** 清空选择,传入key取消指定选中，否清空所有 */
+    onClear: (key?: React.Key) => void;
 };
-export type CcsTableProps<T> = Omit<TableProps<T>, 'columns' | 'title'> & {
+export type TableExtraNode<T> = ReactNode | (({ selectedRowKeys, selectedRows, data, onClear, }: TableTitleType<T>) => ReactNode);
+export type CcsTableProps<T> = Omit<TableProps<T>, 'columns' | 'title' | 'summary'> & {
     data?: CCS.TableData<T>;
+    /** 为空时,默认一条数据 */
+    emptyDefaultOne?: boolean;
     /** request 方法 */
     request?: (params: any) => Promise<any>;
-    /** request 额外参数 dataSource: ['data', 'result']; current: ['data', 'pageNo']; pageSize: ['data', 'pageSize']; total: ['data', 'totalNum'] */
+    /** request 额外参数  */
     requestParam?: ParamType;
     /** 接口字段指定,默认： */
     fieldNames?: CcsFieldNamesType;
@@ -43,9 +59,12 @@ export type CcsTableProps<T> = Omit<TableProps<T>, 'columns' | 'title'> & {
     /** 列配置 */
     columns?: TableColumns<T>;
     /** table title  */
-    title?: ({ selectedRows, data, onClear }: TableTitleType<T>) => ReactNode;
+    title?: TableExtraNode<T>;
+    /** table summary */
+    summary?: (data: readonly T[], columns: TableColumn<T>[]) => React.ReactNode;
 };
-export type CcsProTableProps<RecordType> = Pick<PropsWithCss, 'className'> & PropsWithNodeChildren & {
+export type TableEventHandle = (eventName: TableEvent, options?: any) => void;
+export type CcsProTableProps<RecordType = any> = Pick<PropsWithCss, 'className'> & PropsWithNodeChildren & {
     /** api权限标识 */
     auth?: string | 'ignore';
     /** 是否初始查询，默认true */
@@ -59,9 +78,9 @@ export type CcsProTableProps<RecordType> = Pick<PropsWithCss, 'className'> & Pro
     /** 查询form 初始值 */
     formInitValues?: ParamType;
     /** 按钮 操作部分 */
-    toolbar?: ReactElement;
-    /** 操作按钮扩展 */
-    toolbarExtra?: ReactElement;
+    toolbar?: TableExtraNode<RecordType>;
+    /** 边框 */
+    bordered?: boolean;
     /** 展开查询条件，默认false */
     expandForm?: boolean;
     /** table 数据区域 */
@@ -79,30 +98,18 @@ export type CcsProTableProps<RecordType> = Pick<PropsWithCss, 'className'> & Pro
     proRef?: CCS.TableInstanceRef<RecordType>;
     /** 显示序号 */
     showNumber?: boolean;
-    /** 执行search 后回调函数 */
-    searchEvent?: () => void;
-    /** 请求前格式化参数 */
-    onSearchBefore?: (params: SearchBeforeType, eventType?: SearchEventType) => SearchBeforeType;
-    /** 请求后格式化结果 */
-    onSearchAfter?: (result: any, eventType?: SearchEventType) => any;
-};
-export type TableEventType = {
-    key: 'columnFilter' | 'fullScreen';
-    columnHiddenKeys?: any;
-    full?: any;
+    /** table 事件 */
+    onEvent?: TableEventHandle;
 };
 export type TableStickyProps = boolean | (TableSticky & {
     isInDialog?: boolean;
 });
 export declare const classPrefix = "ccs-pl";
-export declare const TableSelectionContext: React.Context<{
-    selectedRows?: any[] | undefined;
-}>;
 /**
  * 布局组件 包括form、查询、toolbar、table 自动初始化数据
  * @param CcsProTableType
  * @param ref
  * @returns
  */
-declare const InternalProTable: <RecordType extends object = any>(props: CcsProTableProps<RecordType>) => import("react/jsx-runtime").JSX.Element;
+declare const InternalProTable: <RecordType_1 extends object = any>(props: CcsProTableProps<RecordType_1>) => import("react/jsx-runtime").JSX.Element;
 export default InternalProTable;