@gx-design-vue/pro-table 0.2.0-alpha.20 → 0.2.0-alpha.21

package/dist/interface.d.ts

@@ -1,4 +1,4 @@
-import { CSSProperties, ComputedRef, Ref } from "vue";
+import { 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";
@@ -282,6 +282,30 @@ interface ProTableIndexColumn {
   align?: AlignType;
   fixed?: DefaultProColumn['fixed'];
 }
+/** 行拖拽把手列配置 */
+interface ProTableRowDragOptions {
+  /** 把手列宽度，默认 40 */
+  width?: number;
+  /** 把手列对齐方式，默认 'center' */
+  align?: AlignType;
+  /** 把手列 fixed 位置，默认 'start' */
+  fixed?: 'start' | 'end';
+  /** 自定义把手渲染（默认 HolderOutlined 图标） */
+  handleRender?: (record: any, index: number) => CustomRender;
+  /** 是否禁用某行拖拽，返回 true 则该行不可拖动 */
+  disabled?: (record: any) => boolean;
+}
+/** 行拖拽排序结束事件 */
+interface ProTableRowSortEndEvent<DataRecord = RecordType> {
+  /** 原索引 */
+  from: number;
+  /** 新索引 */
+  to: number;
+  /** 重排后的完整数据 */
+  data: DataRecord[];
+  /** 被拖拽的记录 */
+  record: DataRecord;
+}
 interface ProTableScrollPolicy {
   mode?: 'auto' | 'manual' | 'disabled';
   breakpoint?: Breakpoint | number;
@@ -292,16 +316,25 @@ interface ProTableScrollPolicy {
   };
   actionFixed?: boolean | 'auto';
 }
-type ProColumnType<DataValue = RecordType, SearchParams = RecordType> = ProColumn<Omit<ColumnType<DataValue>, keyof DefaultProColumnWithKeyOrDataIndex> & {
+/** 列文本溢出（省略）配置 */
+interface ProColumnEllipsis {
+  /** 省略行数，默认 1 */
+  lines?: number;
+  /** 是否使用原生 title 属性展示完整文本（不走 Tooltip），默认 false */
+  showTitle?: boolean;
+  /** tooltip 配置；设为 false 则仅省略不显示 tooltip */
+  tooltip?: false | TooltipProps;
+}
+type ProColumnType<DataValue = RecordType, SearchParams = RecordType> = ProColumn<Omit<ColumnType<DataValue>, keyof DefaultProColumnWithKeyOrDataIndex | 'ellipsis'> & {
   children?: ProColumnType<DataValue, SearchParams>[];
   index?: number;
   copyText?: string | ((record: ProColumnType) => string);
-  tooltip?: false | (TooltipProps & {
-    width?: number;
-    targetStyle?: Partial<CSSProperties>;
-    hiddenLine?: number;
-    class?: string;
-  }); /** 不在列表中显示 */
+  /**
+   * 文本溢出配置：
+   * - true：单行省略 + tooltip
+   * - 对象：可指定 lines（省略行数，默认 1）、tooltip（false 关闭提示，或透传 TooltipProps）、showTitle（原生 title）
+   */
+  ellipsis?: boolean | ProColumnEllipsis; /** 不在列表中显示 */
   show?: boolean; /** 列表顺序值 */
   order?: number; /** 表单搜索配置 */
   searchConfig?: ProSearchMap<undefined, keyof DataValue | keyof SearchParams>; /** 是否拷贝 */
@@ -419,6 +452,10 @@ interface ProTableProps<DataRecord = RecordType, ParamsType = RecordType> extend
   onResizeColumn?: (width: number, column: ProColumnType<DataRecord>) => void;
   /** 启用列宽拖拽调整 */
   draggable?: boolean;
+  /** 启用行拖拽排序（把手列自动注入到首列，比序号列更靠前） */
+  rowDraggable?: boolean | ProTableRowDragOptions;
+  /** 行拖拽排序结束回调 */
+  onRowSortEnd?: (event: ProTableRowSortEndEvent<DataRecord>) => void;
   /**
    * keep-alive 页面重新进入时是否触发数据请求
    */
@@ -494,6 +531,7 @@ interface ProTableEmits<DataRecord = RecordType, ParamsType = RecordType> extend
   'sizeChange': ProTableProps<DataRecord, ParamsType>['onSizeChange'];
   'resizeColumn': ProTableProps<DataRecord, ParamsType>['onResizeColumn'];
   'fullscreenChange': ProTableProps<DataRecord, ParamsType>['onFullscreenChange'];
+  'rowSortEnd': ProTableProps<DataRecord, ParamsType>['onRowSortEnd'];
 }
 //#endregion
-export { BeforeSearchSubmit, ColConfig, ColumnWithKeyOrDataIndex, CustomDataFn, CustomDataRender, CustomRenderResult, DefaultProColumn, DefaultProColumnWithKeyOrDataIndex, DefaultRender, FormConfig, OperateRowProps, PageItemFn, PageItemRender, PageState, ProColumn, ProColumnType, ProColumnsValueType, ProCoreActionType, ProCoreFormType, 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 };
+export { BeforeSearchSubmit, ColConfig, ColumnWithKeyOrDataIndex, CustomDataFn, CustomDataRender, CustomRenderResult, DefaultProColumn, DefaultProColumnWithKeyOrDataIndex, DefaultRender, FormConfig, OperateRowProps, PageItemFn, PageItemRender, PageState, ProColumn, ProColumnEllipsis, ProColumnType, ProColumnsValueType, ProCoreActionType, ProCoreFormType, ProFieldValueFormat, ProFieldValueType, ProSchemaValueEnumType, ProSearchMap, ProTableBodyCellProps, ProTableClassNamesType, ProTableCustomProps, ProTableEmits, ProTableFetchParams, ProTableIndexColumn, ProTablePagination, ProTablePaginationConfig, ProTableProps, ProTableRef, ProTableRowDragOptions, ProTableRowSortEndEvent, ProTableScrollPolicy, ProTableSizeType, ProTableSlots, ProTableStylesType, RequestConfig, RequestData, RequestFunction, RowSelectionActions, TableSemanticName, TableSorterRecord, ToolbarOptionConfig, ToolbarPlacement };