@gx-design-vue/pro-table 0.2.0-alpha.7 → 0.2.0-alpha.9

package/dist/interface.d.ts

@@ -0,0 +1,492 @@
+import { CSSProperties, ComputedRef, Ref } from "vue";
+import { AlignType, Breakpoint, CustomRender, RecordType, SemanticClassNames, SemanticStyles, WithFalse } from "@gx-design-vue/pro-utils";
+import { SpinProps, TableEmits, TableProps, TableSlots, TooltipProps } from "antdv-next";
+import { ColumnType, FilterValue, SorterResult, TableCurrentDataSource, TablePaginationConfig } from "antdv-next/dist/table/interface";
+
+//#region src/interface.d.ts
+interface CustomRenderResult<T = RecordType> {
+  currentData: T[];
+  dataSource: T[];
+}
+type PageItemFn = (opt: {
+  page: number;
+  type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next';
+  originalElement: any;
+}) => CustomRender;
+type PageItemRender = WithFalse<PageItemFn>;
+type CustomDataFn<T = RecordType> = (params: CustomRenderResult<T>) => CustomRender;
+type DefaultRender = WithFalse<CustomRender>;
+type CustomDataRender<T = RecordType> = WithFalse<CustomDataFn<T>>;
+type ToolbarPlacement = 'left' | 'right';
+interface ToolbarOptionConfig {
+  reload?: boolean | ((onClick: () => void) => CustomRender);
+  fullScreen?: boolean | (() => Promise<void>);
+}
+type ColConfig = Partial<Record<Breakpoint, number>>;
+interface FormConfig {
+  className?: string;
+  /**
+   * actions 表单动作的配置参数
+   */
+  actions?: {
+    /**
+     * reset 是否展示重置按钮
+     */
+    reset?: boolean;
+    /**
+     * resetReload 是否展示重置按钮
+     */
+    resetReload?: boolean;
+    /**
+     * searchText 搜索按钮文案
+     */
+    searchText?: string;
+    /**
+     * resetText 重置按钮文案
+     */
+    resetText?: string;
+  };
+  /**
+   * collapsed 收起状态
+   */
+  collapsed?: boolean;
+  /**
+   * defaultCollapsed 默认收起状态
+   */
+  defaultCollapsed?: boolean;
+  /**
+   * autoRequest 表单搜索条件变化后自动请求request
+   */
+  autoRequest?: boolean;
+  /**
+   * collapseRender 展开收起自定义渲染
+   */
+  collapseRender?: WithFalse<(collapsed?: boolean) => CustomRender>;
+  /**
+   * span 支持断点（'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs'）一行展示几个 demo { xl: 4, lg: 3 }
+   */
+  span?: ColConfig;
+  /**
+   * breakpoint 断点配置支持写入具体宽度 一行展示几个(这里是指大于宽度生效)，优先级比span要高 demo { 1440: 4 }
+   */
+  breakpoint?: Record<number, number>;
+  /**
+   * gap 每项表单间的间隔
+   */
+  gap?: number | string;
+  /**
+   * label 搜索表单的label配置参数
+   */
+  label?: {
+    /**
+     * label label与表单项之间的间隔：仅支持数字
+     */
+    gap?: number;
+    /**
+     * colon label与表单项之间的间否使用冒号间隔
+     */
+    colon?: boolean;
+    /**
+     * width  label的宽度：支持数字和字符
+     */
+    width?: number | string;
+    /**
+     * align label在宽度内的对齐方式：'center' | 'left' | 'right'
+     */
+    align?: 'center' | 'left' | 'right';
+  };
+}
+type TableSorterRecord = SorterResult<RecordType>;
+interface PageState {
+  current: number;
+  pageSize: number;
+  total?: number;
+}
+interface RequestData<T = any> {
+  data: T[] | undefined;
+  success?: boolean;
+  total?: number;
+}
+interface RequestConfig<T> {
+  params: T extends undefined ? PageState : PageState & Partial<T>;
+  sorter: TableSorterRecord[];
+  filter: Record<string, FilterValue | null>;
+  extra?: TableCurrentDataSource;
+  signal?: AbortSignal;
+}
+type RequestFunction<T = any, D = undefined> = (props: RequestConfig<D>) => Promise<Partial<RequestData<T>> | undefined>;
+type BeforeSearchSubmit<D = undefined> = (props: RequestConfig<D>) => Promise<RequestConfig<D>['params']> | RequestConfig<D>['params'];
+interface ProTableFetchParams<R = RecordType> {
+  params?: R;
+  filters?: Record<string, FilterValue | null>;
+  sorter?: SorterResult | SorterResult[];
+  pagination?: ProTablePagination;
+  removeKeys?: (string | number)[];
+  isPolling?: boolean;
+  extra?: TableCurrentDataSource;
+}
+interface OperateRowProps<T = RecordType> {
+  row?: Partial<T>;
+  key?: keyof T;
+  value?: any;
+  type?: 'update' | 'push' | 'delete' | 'unshift';
+}
+interface RowSelectionActions<T = RecordType> {
+  clear: () => void;
+  select: (record: T, selected: boolean) => void;
+  selectAll: (records: T[], selected: boolean) => void;
+  remove: (keys: (string | number)[]) => void;
+  sync: () => void;
+}
+interface ProCoreActionType<T = RecordType, R = RecordType> {
+  loading: Ref<boolean>;
+  dataSource: ComputedRef<T[]>;
+  pageInfo: PageState;
+  reload: (info?: ProTableFetchParams<R>) => void;
+  reloadAndReset: (options?: {
+    callBack?: () => void;
+    wait?: boolean;
+  }) => void;
+  setPagination: (pagination: ProTablePaginationConfig) => void;
+  setPageInfo: (pagination: ProTablePaginationConfig, filters?: Record<string, FilterValue | null>, sorter?: SorterResult | SorterResult[], extra?: TableCurrentDataSource) => void;
+  setTableDataList: (data: T[]) => void;
+  operateTableDataRow: (props: OperateRowProps<T>) => void;
+  setLoading: (loading: boolean) => void;
+  selectedKeys: ComputedRef<(string | number)[]>;
+  selectedItems: ComputedRef<T[]>;
+  rowsSelection: RowSelectionActions<T>;
+}
+interface ProTableRef<T = RecordType, R = RecordType> {
+  actionRef: () => ProCoreActionType<T, R>;
+}
+interface ProTablePaginationConfig extends TablePaginationConfig {
+  total?: number;
+}
+type ProTablePagination = ProTablePaginationConfig | false;
+type TableSemanticName = 'root' | 'content' | 'search' | 'searchItem' | 'searchControl' | 'searchContent' | 'searchText' | 'searchButtons' | 'card' | 'toolbar' | 'toolbarAfter' | 'toolbarLeft' | 'toolbarRight' | 'toolbarTitle' | 'list' | 'listContent' | 'pagination' | 'table';
+type ProTableStylesType = SemanticStyles<TableSemanticName>;
+type ProTableClassNamesType = SemanticClassNames<TableSemanticName>;
+/**
+ * @param text 文本框
+ * @param date 日期 YYYY-MM-DD
+ * @param dateMonth 月选择器
+ * @param dateRange 日期范围 YYYY-MM-DD[]
+ * @param time: 时间 HH:mm:ss
+ * @param select 下拉选择器
+ */
+type ProFieldValueType = 'text' | 'number' | 'numberRange' | 'select' | 'treeSelect' | 'cascader' | 'date' | 'dateWeek' | 'dateQuarter' | 'dateMonth' | 'dateYear' | 'dateRange' | 'time';
+/**
+ * @param text 文本框
+ * @param date 日期 YYYY-MM-DD
+ * @param dateMonth 月选择器
+ * @param dateRange 日期范围 YYYY-MM-DD[]
+ * @param time: 时间 HH:mm:ss
+ * @param select 下拉选择器
+ */
+type ProFieldValueFormat = 'YYYY-MM-DD' | 'YYYY-MM' | 'YYYY-MM-DD HH:mm:ss' | 'HH:mm:ss';
+interface ProSchemaValueEnumType {
+  /** @name 演示的文案 */
+  label: any;
+  /** @name 演示的value值 */
+  value: any;
+  /** @name 是否禁用 */
+  disabled?: boolean;
+  [key: string]: any;
+}
+type ProSchemaValueType<ValueType> = (ValueType | ProFieldValueType);
+interface ProSearchMap<ValueType = 'text', ParamsKey = string> {
+  name: ParamsKey;
+  order?: number;
+  /** 选择如何渲染相应的模式 */
+  valueType?: ProSchemaValueType<ValueType>;
+  /** valueType为date|dateMonth|dateRange|time生效 */
+  valueFormat?: ProFieldValueFormat;
+  placeholder?: string | string[];
+  /** valueType为select生效 */
+  allowClear?: boolean;
+  /** valueType为select生效 */
+  showSearch?: boolean;
+  /** valueType为date生效 */
+  showToday?: boolean;
+  /** valueType为dateRange生效 */
+  rangeStartName?: string;
+  /** valueType为dateRange生效 */
+  rangeEndName?: string;
+  /** valueType为time生效 */
+  use12Hours?: boolean;
+  /** valueType为select生效 */
+  loading?: boolean;
+  /** valueType为date、dateRange生效 */
+  showTime?: RecordType | boolean;
+  /** 搜索表单的默认值 */
+  initialValue?: any;
+  /** 针对select、treeselect、cascader取值的key */
+  valueKey?: string;
+  /** 远程查询数据 */
+  request?: {
+    fetch?: () => Promise<ProSchemaValueEnumType[]>;
+    manual?: boolean;
+    debounceTime?: number;
+  };
+  /** 查询表单label */
+  label?: string;
+  /** 查询表单label - 宽度 */
+  labelWidth?: string | number;
+  /** 查询表单label - 对齐方式 */
+  labelAlign?: 'center' | 'left' | 'right';
+  /** 表单的属性值（ant-design） */
+  field?: {
+    rules?: RegExp;
+    [key: string]: any;
+  };
+  /**
+   * 支持 object 和Map，Map 是支持其他基础类型作为 key
+   *
+   * @name 映射值的类型
+   */
+  valueEnum?: ProSchemaValueEnumType[];
+}
+type ProColumnsValueType = 'text' | 'link' | 'time' | 'dateMonth' | 'dateTime' | 'date' | {
+  node?: string;
+  class?: string;
+  attr?: string;
+  click?: () => void;
+};
+type LooseAutocomplete<T> = T | (string & {});
+type DataIndex<T> = LooseAutocomplete<keyof T | 'action'>;
+type ColumnWithKeyOrDataIndex<T = any[]> = {
+  key: DataIndex<T>;
+  dataIndex?: DataIndex<T>;
+} | {
+  key?: DataIndex<T>;
+  dataIndex: DataIndex<T>;
+};
+interface DefaultProColumn {
+  uuid?: string | number;
+  align?: AlignType;
+  fixed?: boolean | 'right' | 'left' | 'start' | 'end';
+  width?: number | string;
+}
+type DefaultProColumnWithKeyOrDataIndex<T = any[]> = DefaultProColumn & ColumnWithKeyOrDataIndex<T>;
+type ProColumn<T = undefined, R = any[]> = T extends undefined ? DefaultProColumnWithKeyOrDataIndex<R> : DefaultProColumnWithKeyOrDataIndex<R> & T;
+interface ProTableIndexColumn {
+  title?: CustomRender;
+  width?: number | string;
+  align?: AlignType;
+  fixed?: DefaultProColumn['fixed'];
+}
+interface ProTableScrollPolicy {
+  mode?: 'auto' | 'manual' | 'disabled';
+  breakpoint?: Breakpoint | number;
+  modal?: boolean;
+  modalY?: number | {
+    desktop?: number;
+    mobile?: number;
+  };
+  actionFixed?: boolean | 'auto';
+}
+type ProColumnType<DataValue = RecordType, SearchParams = RecordType> = ProColumn<Omit<ColumnType<DataValue>, keyof DefaultProColumnWithKeyOrDataIndex> & {
+  children?: ProColumnType<DataValue, SearchParams>[];
+  index?: number;
+  copyText?: string | ((record: ProColumnType) => string);
+  tooltip?: false | (TooltipProps & {
+    width?: number;
+    targetStyle?: Partial<CSSProperties>;
+    hiddenLine?: number;
+    class?: string;
+  }); /** 不在列表中显示 */
+  show?: boolean; /** 列表顺序值 */
+  order?: number; /** 表单搜索配置 */
+  searchConfig?: ProSearchMap<undefined, keyof DataValue | keyof SearchParams>; /** 是否拷贝 */
+  copyable?: boolean; /** 值为空时，默认取值 */
+  columnEmptyText?: string | ((record: DataValue) => string);
+  valueType?: ProColumnsValueType;
+}, DataValue>;
+type OmitTableKey = 'columns' | 'dataSource' | 'rowKey' | 'align' | 'pagination' | 'onChange';
+interface ProTableProps<DataRecord = RecordType, ParamsType = RecordType> extends Omit<TableProps<DataRecord>, OmitTableKey> {
+  /**
+   * table loading 状态
+   */
+  loading?: boolean | SpinProps;
+  /**
+   * table 唯一字段
+   */
+  rowKey?: keyof DataRecord;
+  /**
+   * table 列相关属性
+   */
+  columns?: ProColumnType<DataRecord, ParamsType>[];
+  /**
+   * 自动序号列配置。true 使用默认序号列，对象可覆盖列标题、宽度、对齐和 fixed。
+   */
+  indexColumn?: boolean | ProTableIndexColumn;
+  /**
+   * 表格滚动策略。false 等价于 disabled；disabled 禁用自动滚动和 action 自动固定。
+   */
+  scrollPolicy?: false | ProTableScrollPolicy;
+  /**
+   * fitPage 适配页面高度，使其表格占据一屏
+   */
+  fitPage?: boolean;
+  /**
+   * table 数据源
+   */
+  dataSource?: DataRecord[];
+  /**
+   * table 样式 class 语义
+   */
+  proClasses?: ProTableClassNamesType;
+  /**
+   * table 样式 style 语义
+   */
+  proStyles?: ProTableStylesType;
+  /**
+   * table 展示卡片
+   */
+  cardBordered?: boolean;
+  /**
+   * table 列对齐方式
+   */
+  align?: ProColumnType['align'];
+  /**
+   * table 等待请求控制
+   */
+  waitRequest?: boolean;
+  /**
+   * table 轮询
+   */
+  polling?: boolean;
+  /**
+   * table 轮询时间
+   */
+  pollingTime?: number;
+  /**
+   * table 请求函数
+   */
+  request?: RequestFunction<DataRecord, ParamsType>;
+  /**
+   * table 是否立刻发送请求
+   */
+  immediate?: boolean;
+  /**
+   * table 自动请求
+   */
+  autoRequest?: boolean;
+  /**
+   * table 防抖时间
+   */
+  debounceTime?: number;
+  /**
+   * table 是否显示 loading
+   */
+  showLoading?: boolean;
+  /**
+   * table 搜索参数
+   */
+  params?: ParamsType;
+  /**
+   * table 请求结果处理
+   */
+  postData?: (data: DataRecord[]) => DataRecord[];
+  /**
+   * table 搜索表单配置
+   */
+  form?: FormConfig | false;
+  /**
+   * table 搜索表单项配置
+   */
+  searchMap?: ProSearchMap<undefined, keyof ParamsType | keyof DataRecord>[];
+  /**
+   * table 分页配置
+   */
+  pagination?: ProTablePagination;
+  onChange?: (pagination: ProTablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult<DataRecord> | SorterResult<DataRecord>[], extra: TableCurrentDataSource<DataRecord>) => void;
+  onReset?: (params?: Partial<ParamsType>) => void;
+  onReload?: (params?: Partial<ParamsType>) => void;
+  onSubmit?: (params?: Partial<ParamsType>) => void;
+  onLoadingChange?: (loading: boolean) => any;
+  onRequestError?: (e: Error) => void;
+  onSizeChange?: (size: ProTableSizeType) => void;
+  onBeforeSearchSubmit?: BeforeSearchSubmit<ParamsType>;
+  /** 列宽拖拽调整完成回调 */
+  onResizeColumn?: (width: number, column: ProColumnType<DataRecord>) => void;
+  /** 启用列宽拖拽调整 */
+  draggable?: boolean;
+  /**
+   * keep-alive 页面重新进入时是否触发数据请求
+   */
+  keepAliveReload?: boolean;
+  /**
+   * 全局空值默认显示文本，可被 column.columnEmptyText 覆盖
+   */
+  columnEmptyText?: string | ((record: DataRecord) => string);
+  /**
+   * 工具栏选项配置，设为 false 时不显示
+   */
+  options?: ToolbarOptionConfig | false;
+  /**
+   * 标题提示文案
+   */
+  titleTipText?: string;
+  /**
+   * 操作按钮配置
+   */
+  actionProps?: {
+    placement?: ToolbarPlacement;
+    actions?: DefaultRender[];
+  };
+  /**
+   * 全屏状态变化回调
+   */
+  onFullscreenChange?: (isFullscreen: boolean) => void;
+  emptyText?: DefaultRender;
+  headerTitle?: DefaultRender;
+  headerTitleTip?: DefaultRender;
+  listToolAfter?: DefaultRender;
+  customRender?: CustomDataRender;
+  pageItemRender?: PageItemRender;
+}
+interface ProTableBodyCellProps<T = any> {
+  text: any;
+  value: any;
+  record: T;
+  index: number;
+  column: ProColumnType<T>;
+}
+interface ProTableCustomProps<T = any> {
+  currentData: T[];
+  dataSource: T[];
+}
+interface ProTableSlots<DataRecord = any> extends Omit<TableSlots<DataRecord>, 'bodyCell' | 'headerCell'> {
+  form?: () => any;
+  actions?: () => any;
+  headerTitle?: () => any;
+  headerTitleTip?: () => any;
+  listToolAfter?: () => any;
+  pageItemRender?: (params: {
+    page: number;
+    type: 'page' | 'prev' | 'next' | 'jump-prev' | 'jump-next';
+    originalElement: any;
+  }) => any;
+  customRender?: (params: ProTableCustomProps<DataRecord>) => any;
+  bodyCell?: (props: ProTableBodyCellProps<DataRecord>) => any;
+  headerCell?: (props: {
+    column: ProColumnType<DataRecord>;
+    index: number;
+    text: any;
+  }) => any;
+}
+type ProTableSizeType = 'small' | 'medium' | 'middle' | 'large';
+interface ProTableEmits<DataRecord = RecordType, ParamsType = RecordType> extends Omit<TableEmits<DataRecord>, 'change'> {
+  'change': ProTableProps<DataRecord, ParamsType>['onChange'];
+  'reset': ProTableProps<DataRecord, ParamsType>['onReset'];
+  'reload': ProTableProps<DataRecord, ParamsType>['onReload'];
+  'submit': ProTableProps<DataRecord, ParamsType>['onSubmit'];
+  'loadingChange': ProTableProps<DataRecord, ParamsType>['onLoadingChange'];
+  'requestError': ProTableProps<DataRecord, ParamsType>['onRequestError'];
+  'sizeChange': ProTableProps<DataRecord, ParamsType>['onSizeChange'];
+  'resizeColumn': ProTableProps<DataRecord, ParamsType>['onResizeColumn'];
+  'fullscreenChange': ProTableProps<DataRecord, ParamsType>['onFullscreenChange'];
+}
+//#endregion
+export { BeforeSearchSubmit, ColConfig, ColumnWithKeyOrDataIndex, CustomDataFn, CustomDataRender, CustomRenderResult, DefaultProColumn, DefaultProColumnWithKeyOrDataIndex, DefaultRender, FormConfig, OperateRowProps, PageItemFn, PageItemRender, PageState, ProColumn, ProColumnType, ProColumnsValueType, ProCoreActionType, ProFieldValueFormat, ProFieldValueType, ProSchemaValueEnumType, ProSearchMap, ProTableBodyCellProps, ProTableClassNamesType, ProTableCustomProps, ProTableEmits, ProTableFetchParams, ProTableIndexColumn, ProTablePagination, ProTablePaginationConfig, ProTableProps, ProTableRef, ProTableScrollPolicy, ProTableSizeType, ProTableSlots, ProTableStylesType, RequestConfig, RequestData, RequestFunction, RowSelectionActions, TableSemanticName, TableSorterRecord, ToolbarOptionConfig, ToolbarPlacement };