@kdcloudjs/table 1.0.0

package/es/table/pipeline/features/rowDetail.js

@@ -0,0 +1,254 @@
+import _toArray from "@babel/runtime-corejs3/helpers/toArray";
+import _defineProperty from "@babel/runtime-corejs3/helpers/defineProperty";
+import _extends from "@babel/runtime-corejs3/helpers/extends";
+import _toConsumableArray from "@babel/runtime-corejs3/helpers/toConsumableArray";
+import _Symbol from "@babel/runtime-corejs3/core-js-stable/symbol";
+import _mapInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/map";
+import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
+import _Set from "@babel/runtime-corejs3/core-js-stable/set";
+import _concatInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/concat";
+import _findIndexInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/find-index";
+import _sliceInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/slice";
+import cx from 'classnames';
+import React from 'react';
+import { ExpansionCell, icons, InlineFlexCell } from '../../common-views';
+import { internals } from '../../internals';
+import { collectNodes, mergeCellProps } from '../../utils';
+import { always, flatMap } from '../../utils/others';
+import console from '../../utils/console';
+
+var rowDetailSymbol = _Symbol('row-detail');
+
+var fallbackRenderDetail = function fallbackRenderDetail() {
+  return /*#__PURE__*/React.createElement("div", {
+    style: {
+      margin: '8px 24px'
+    }
+  }, /*#__PURE__*/React.createElement("b", {
+    style: {
+      color: 'indianred'
+    }
+  }, "\u8BBE\u7F6E ", /*#__PURE__*/React.createElement("code", null, "rowDetail.renderDetail"), " \u6765\u81EA\u5B9A\u4E49\u8BE6\u60C5\u5185\u5BB9"));
+};
+
+export function rowDetail() {
+  var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return function rowDetailStep(pipeline) {
+    var _context, _context2;
+
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+
+    var stateKey = 'rowDetail';
+    var primaryKey = pipeline.ensurePrimaryKey('rowDetail');
+
+    if (typeof primaryKey !== 'string') {
+      throw new Error('rowDetail 仅支持字符串作为 primaryKey');
+    }
+
+    var rowDetailMetaKey = (_a = opts.rowDetailMetaKey) !== null && _a !== void 0 ? _a : rowDetailSymbol;
+    var indents = pipeline.ctx.indents;
+    var textOffset = indents.iconIndent + indents.iconWidth + indents.iconGap;
+    var clickArea = (_b = opts.clickArea) !== null && _b !== void 0 ? _b : 'cell';
+    var getDetailKey = (_c = opts.getDetailKey) !== null && _c !== void 0 ? _c : function (row) {
+      return row[primaryKey] + '_detail';
+    };
+    var renderDetail = (_d = opts.renderDetail) !== null && _d !== void 0 ? _d : fallbackRenderDetail;
+    var hasDetail = (_e = opts.hasDetail) !== null && _e !== void 0 ? _e : always(true);
+    var openKeys = (_h = (_g = (_f = opts.openKeys) !== null && _f !== void 0 ? _f : pipeline.getStateAtKey(stateKey)) !== null && _g !== void 0 ? _g : opts.defaultOpenAll ? _mapInstanceProperty(_context = _filterInstanceProperty(_context2 = pipeline.getDataSource()).call(_context2, hasDetail)).call(_context, function (row) {
+      return row[primaryKey];
+    }) : opts.defaultOpenKeys) !== null && _h !== void 0 ? _h : [];
+
+    var onChangeOpenKeys = function onChangeOpenKeys(nextKeys, key, action) {
+      var _a;
+
+      (_a = opts.onChangeOpenKeys) === null || _a === void 0 ? void 0 : _a.call(opts, nextKeys, key, action);
+      pipeline.setStateAtKey(stateKey, nextKeys, {
+        key: key,
+        action: action
+      });
+    };
+
+    var openKeySet = new _Set(openKeys);
+
+    var toggle = function toggle(rowKey) {
+      var expanded = openKeySet.has(rowKey);
+
+      if (expanded) {
+        onChangeOpenKeys(_filterInstanceProperty(openKeys).call(openKeys, function (key) {
+          return key !== rowKey;
+        }), rowKey, 'collapse');
+      } else {
+        var _context3;
+
+        onChangeOpenKeys(_concatInstanceProperty(_context3 = []).call(_context3, _toConsumableArray(openKeys), [rowKey]), rowKey, 'expand');
+      }
+    };
+
+    return pipeline.dataSource(flatMap(pipeline.getDataSource(), function (row, rowIndex) {
+      if (openKeySet.has(row[primaryKey])) {
+        return [row, _extends(_extends(_defineProperty({}, rowDetailMetaKey, true), row), _defineProperty({}, primaryKey, getDetailKey(row, rowIndex)))];
+      } else {
+        return [row];
+      }
+    })).columns(processColumns(pipeline.getColumns())).appendRowPropsGetter(function (row) {
+      if (row[rowDetailMetaKey]) {
+        return {
+          className: 'no-hover'
+        };
+      }
+    });
+
+    function processColumns(columns) {
+      if (columns.length === 0) {
+        return columns;
+      }
+
+      var expandColumnIndex = 0;
+
+      if (opts.expandColumnCode) {
+        expandColumnIndex = _findIndexInstanceProperty(columns).call(columns, function (col) {
+          return col.code === opts.expandColumnCode;
+        });
+
+        if (expandColumnIndex < 0) {
+          console.warn('没找到可展开的列，请检查设置的展开列code');
+          return columns;
+        }
+      }
+
+      var expandCol = columns[expandColumnIndex];
+
+      var tableColumns = _toConsumableArray(columns);
+
+      var render = function render(value, row, rowIndex) {
+        if (row[rowDetailMetaKey]) {
+          return renderDetail(row, rowIndex);
+        }
+
+        var content = internals.safeRender(expandCol, row, rowIndex);
+
+        if (!hasDetail(row, rowIndex)) {
+          return /*#__PURE__*/React.createElement(InlineFlexCell, {
+            style: {
+              marginLeft: textOffset
+            }
+          }, content);
+        }
+
+        var rowKey = row[primaryKey];
+        var expanded = openKeySet.has(rowKey);
+
+        var onClick = function onClick(e) {
+          if (opts.stopClickEventPropagation) {
+            e.stopPropagation();
+          }
+
+          toggle(rowKey);
+        };
+
+        var expandCls = expanded ? 'expanded' : 'collapsed';
+        var ExpandIcon = opts.expandIcon;
+        return /*#__PURE__*/React.createElement(ExpansionCell, {
+          className: cx('expansion-cell', expandCls),
+          style: {
+            cursor: clickArea === 'content' ? 'pointer' : undefined
+          },
+          onClick: clickArea === 'content' ? onClick : undefined
+        }, opts.expandIcon ? /*#__PURE__*/React.createElement(ExpandIcon, {
+          expanded: expanded,
+          onClick: clickArea === 'icon' ? onClick : undefined
+        }) : /*#__PURE__*/React.createElement(icons.CaretRight, {
+          style: {
+            cursor: clickArea === 'icon' ? 'pointer' : undefined,
+            marginLeft: indents.iconIndent,
+            marginRight: indents.iconGap
+          },
+          className: cx('expansion-icon', expandCls),
+          onClick: clickArea === 'icon' ? onClick : undefined
+        }), content);
+      };
+
+      var getCellProps = function getCellProps(value, row, rowIndex) {
+        var _a;
+
+        if (row[rowDetailMetaKey]) {
+          return {
+            style: _extends({
+              '--cell-padding': '0',
+              overflow: 'hidden'
+            }, opts.detailCellStyle)
+          };
+        }
+
+        var prevProps = (_a = expandCol.getCellProps) === null || _a === void 0 ? void 0 : _a.call(expandCol, value, row, rowIndex);
+
+        if (!hasDetail(row, rowIndex)) {
+          return prevProps;
+        }
+
+        return mergeCellProps(prevProps, {
+          onClick: function onClick(e) {
+            if (opts.stopClickEventPropagation) {
+              e.stopPropagation();
+            }
+
+            toggle(row[primaryKey]);
+          },
+          style: {
+            cursor: 'pointer'
+          }
+        });
+      };
+
+      var _tableColumns = _toArray(tableColumns),
+          firstCol = _tableColumns[0],
+          others = _sliceInstanceProperty(_tableColumns).call(_tableColumns, 1);
+
+      var firstColRender = function firstColRender(value, row, rowIndex) {
+        if (row[rowDetailMetaKey]) {
+          return renderDetail(row, rowIndex);
+        }
+
+        var content = internals.safeRender(firstCol, row, rowIndex);
+        return content;
+      };
+
+      tableColumns[0] = _extends(_extends({}, firstCol), {
+        render: firstColRender,
+        getSpanRect: function getSpanRect(value, row, rowIndex) {
+          if (row[rowDetailMetaKey]) {
+            // detail 总是成一行
+            return {
+              top: rowIndex,
+              bottom: rowIndex + 1,
+              left: 0,
+              right: collectNodes(pipeline.getColumns(), 'leaf-only').length
+            };
+          }
+        }
+      });
+      tableColumns[expandColumnIndex] = _extends(_extends({}, expandCol), {
+        title: /*#__PURE__*/React.createElement("div", {
+          style: {
+            display: 'inline-block',
+            marginLeft: textOffset
+          }
+        }, internals.safeRenderHeader(expandCol)),
+        render: render,
+        getCellProps: clickArea === 'cell' ? getCellProps : expandCol.getCellProps,
+        getSpanRect: function getSpanRect(value, row, rowIndex) {
+          if (row[rowDetailMetaKey]) {
+            // detail 总是成一行
+            return {
+              top: rowIndex,
+              bottom: rowIndex + 1,
+              left: 0,
+              right: collectNodes(pipeline.getColumns(), 'leaf-only').length
+            };
+          }
+        }
+      });
+      return tableColumns;
+    }
+  };
+}

package/es/table/pipeline/features/rowGrouping.d.ts

@@ -0,0 +1,14 @@
+import { TablePipeline } from '../pipeline';
+export interface RowGroupingFeatureOptions {
+    /** 非受控用法：是否默认展开所有分组 */
+    defaultOpenAll?: boolean;
+    /** 非受控用法：默认展开的 keys */
+    defaultOpenKeys?: string[];
+    /** 受控用法：当前展开的 keys */
+    openKeys?: string[];
+    /** 受控用法：当前展开 keys 改变回调 */
+    onChangeOpenKeys?(nextKeys: string[], key: string, action: 'expand' | 'collapse'): void;
+    /** 是否对触发 onChangeOpenKeys 的 click 事件调用 event.stopPropagation() */
+    stopClickEventPropagation?: boolean;
+}
+export declare function rowGrouping(opts?: RowGroupingFeatureOptions): (pipeline: TablePipeline) => TablePipeline;

package/es/table/pipeline/features/rowGrouping.js

@@ -0,0 +1,200 @@
+import _toConsumableArray from "@babel/runtime-corejs3/helpers/toConsumableArray";
+import _toArray from "@babel/runtime-corejs3/helpers/toArray";
+import _defineProperty from "@babel/runtime-corejs3/helpers/defineProperty";
+import _extends from "@babel/runtime-corejs3/helpers/extends";
+import _Symbol from "@babel/runtime-corejs3/core-js-stable/symbol";
+import _mapInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/map";
+import _Set from "@babel/runtime-corejs3/core-js-stable/set";
+import _concatInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/concat";
+import _sliceInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/slice";
+import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
+import cx from 'classnames';
+import React from 'react';
+import { ExpansionCell, icons, InlineFlexCell } from '../../common-views';
+import { internals } from '../../internals';
+import { collectNodes, isLeafNode, mergeCellProps } from '../../utils';
+import { flatMap } from '../../utils/others';
+
+var groupingMetaSymbol = _Symbol('row-grouping-meta');
+
+function attachGroupingMeta(row) {
+  return _extends(_defineProperty({}, groupingMetaSymbol, {
+    expandable: !isLeafNode(row)
+  }), row);
+}
+
+function getGroupingMeta(row) {
+  if (row[groupingMetaSymbol] == null) {
+    return {
+      isGroupHeader: false,
+      expandable: false
+    };
+  }
+
+  return {
+    isGroupHeader: true,
+    expandable: row[groupingMetaSymbol].expandable
+  };
+}
+
+function rowGroupingRowPropsGetter(row) {
+  if (getGroupingMeta(row).isGroupHeader) {
+    return {
+      className: 'alternative'
+    };
+  }
+}
+
+export function rowGrouping() {
+  var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return function (pipeline) {
+    var _context;
+
+    var _a, _b, _c;
+
+    var stateKey = 'rowGrouping';
+    var indents = pipeline.ctx.indents;
+    var textOffset = indents.iconIndent + indents.iconWidth + indents.iconGap;
+    var primaryKey = pipeline.ensurePrimaryKey('rowGrouping');
+
+    if (typeof primaryKey !== 'string') {
+      throw new Error('rowGrouping 仅支持字符串作为 primaryKey');
+    }
+
+    var openKeys = (_c = (_b = (_a = opts.openKeys) !== null && _a !== void 0 ? _a : pipeline.getStateAtKey(stateKey)) !== null && _b !== void 0 ? _b : opts.defaultOpenAll ? _mapInstanceProperty(_context = pipeline.getDataSource()).call(_context, function (row) {
+      return row[primaryKey];
+    }) : opts.defaultOpenKeys) !== null && _c !== void 0 ? _c : [];
+    var openKeySet = new _Set(openKeys);
+
+    var onChangeOpenKeys = function onChangeOpenKeys(nextKeys, key, action) {
+      var _a;
+
+      (_a = opts.onChangeOpenKeys) === null || _a === void 0 ? void 0 : _a.call(opts, nextKeys, key, action);
+      pipeline.setStateAtKey(stateKey, nextKeys, {
+        key: key,
+        action: action
+      });
+    };
+
+    return pipeline.mapDataSource(processDataSource).mapColumns(processColumns).appendRowPropsGetter(rowGroupingRowPropsGetter);
+
+    function processDataSource(input) {
+      return flatMap(input, function (row) {
+        var result = [attachGroupingMeta(row)];
+        var expanded = openKeySet.has(row[primaryKey]);
+
+        if (expanded) {
+          if (Array.isArray(row.children)) {
+            result = _concatInstanceProperty(result).call(result, row.children);
+          }
+        }
+
+        return result;
+      });
+    }
+
+    function processColumns(columns) {
+      var _context3;
+
+      if (columns.length === 0) {
+        return columns;
+      }
+
+      var columnFlatCount = collectNodes(columns, 'leaf-only').length;
+
+      var _columns = _toArray(columns),
+          firstCol = _columns[0],
+          others = _sliceInstanceProperty(_columns).call(_columns, 1);
+
+      var render = function render(value, row, rowIndex) {
+        var _a, _b;
+
+        var content = internals.safeRender(firstCol, row, rowIndex);
+        var meta = getGroupingMeta(row);
+
+        if (!meta.isGroupHeader || !meta.expandable) {
+          var marginLeft = textOffset + (meta.isGroupHeader ? 0 : indents.indentSize);
+          return /*#__PURE__*/React.createElement(InlineFlexCell, {
+            style: {
+              marginLeft: marginLeft
+            }
+          }, meta.isGroupHeader ? (_a = row.groupTitle) !== null && _a !== void 0 ? _a : content : content);
+        }
+
+        var expanded = openKeySet.has(row[primaryKey]);
+        var expandCls = expanded ? 'expanded' : 'collapsed';
+        return /*#__PURE__*/React.createElement(ExpansionCell, {
+          className: cx('expansion-cell', expandCls)
+        }, /*#__PURE__*/React.createElement(icons.CaretRight, {
+          className: cx('expansion-icon', expandCls),
+          style: {
+            marginLeft: indents.iconIndent,
+            marginRight: indents.iconGap
+          }
+        }), (_b = row.groupTitle) !== null && _b !== void 0 ? _b : content);
+      };
+
+      var getCellProps = function getCellProps(value, row, rowIndex) {
+        var _a;
+
+        var meta = getGroupingMeta(row);
+
+        if (!meta.isGroupHeader) {
+          return;
+        }
+
+        var expandable = meta.expandable;
+        var rowKey = row[primaryKey];
+        var expanded = openKeySet.has(rowKey);
+        var onClick;
+
+        if (expandable) {
+          onClick = function onClick(e) {
+            if (opts.stopClickEventPropagation) {
+              e.stopPropagation();
+            }
+
+            if (expanded) {
+              onChangeOpenKeys(_filterInstanceProperty(openKeys).call(openKeys, function (key) {
+                return key !== rowKey;
+              }), rowKey, 'collapse');
+            } else {
+              var _context2;
+
+              onChangeOpenKeys(_concatInstanceProperty(_context2 = []).call(_context2, _toConsumableArray(openKeys), [rowKey]), rowKey, 'expand');
+            }
+          };
+        }
+
+        var prevProps = (_a = firstCol.getCellProps) === null || _a === void 0 ? void 0 : _a.call(firstCol, value, row, rowIndex);
+        return mergeCellProps(prevProps, {
+          onClick: onClick,
+          style: {
+            cursor: expandable ? 'pointer' : undefined
+          }
+        });
+      };
+
+      return _concatInstanceProperty(_context3 = [_extends(_extends({}, firstCol), {
+        title: /*#__PURE__*/React.createElement("div", {
+          style: {
+            display: 'inline-block',
+            marginLeft: textOffset
+          }
+        }, internals.safeRenderHeader(firstCol)),
+        render: render,
+        getCellProps: getCellProps,
+        getSpanRect: function getSpanRect(value, row, rowIndex) {
+          if (getGroupingMeta(row).isGroupHeader) {
+            return {
+              top: rowIndex,
+              bottom: rowIndex + 1,
+              left: 0,
+              right: columnFlatCount
+            };
+          }
+        }
+      })]).call(_context3, _toConsumableArray(others));
+    }
+  };
+}

package/es/table/pipeline/features/singleSelect.d.ts

@@ -0,0 +1,23 @@
+import { ArtColumn } from '../../interfaces';
+import { TablePipeline } from '../pipeline';
+export interface SingleSelectFeatureOptions {
+    /** 是否高亮被选中的行 */
+    highlightRowWhenSelected?: boolean;
+    /** 非受控用法：默认选中的值 */
+    defaultValue?: string;
+    /** 受控用法：当前选中的值 */
+    value?: string;
+    /** 受控用法：选中值改变回调 */
+    onChange?: (next: string) => void;
+    /** 判断一行是否禁用 */
+    isDisabled?(row: any, rowIndex: number): boolean;
+    /** 点击事件的响应区域 */
+    clickArea?: 'radio' | 'cell' | 'row';
+    /** 单选框所在列的 column 配置，可指定 width，lock 等属性 */
+    radioColumn?: Partial<ArtColumn>;
+    /** 单选框所在列的位置 */
+    radioPlacement?: 'start' | 'end';
+    /** 是否对触发 onChange 的 click 事件调用 event.stopPropagation() */
+    stopClickEventPropagation?: boolean;
+}
+export declare function singleSelect(opts?: SingleSelectFeatureOptions): (pipeline: TablePipeline) => TablePipeline;

package/es/table/pipeline/features/singleSelect.js

@@ -0,0 +1,122 @@
+import _extends from "@babel/runtime-corejs3/helpers/extends";
+import _sliceInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/slice";
+import React from 'react';
+import { internals } from '../../internals';
+import { always } from '../../utils/others';
+import { mergeCellProps } from '../../utils';
+export function singleSelect() {
+  var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return function singleSelectStep(pipeline) {
+    var _context;
+
+    var _a, _b, _c, _d, _e;
+
+    var Radio = pipeline.ctx.components.Radio;
+
+    if (Radio == null) {
+      throw new Error('使用 singleSelect 之前需要通过 pipeline context 设置 components.Radio');
+    }
+
+    var stateKey = 'singleSelect';
+    var clickArea = (_a = opts.clickArea) !== null && _a !== void 0 ? _a : 'radio';
+    var isDisabled = (_b = opts.isDisabled) !== null && _b !== void 0 ? _b : always(false);
+    var primaryKey = pipeline.ensurePrimaryKey('singleSelect');
+    var value = (_d = (_c = opts.value) !== null && _c !== void 0 ? _c : pipeline.getStateAtKey(stateKey)) !== null && _d !== void 0 ? _d : opts.defaultValue;
+
+    var onChange = function onChange(rowKey) {
+      var _a;
+
+      (_a = opts.onChange) === null || _a === void 0 ? void 0 : _a.call(opts, rowKey);
+      pipeline.setStateAtKey(stateKey, rowKey);
+    };
+
+    var radioColumn = _extends(_extends({
+      name: '',
+      width: 50,
+      align: 'center'
+    }, opts.radioColumn), {
+      getCellProps: function getCellProps(value, row, rowIndex) {
+        var _a, _b;
+
+        if (clickArea === 'cell') {
+          var rowKey = internals.safeGetRowKey(primaryKey, row, rowIndex);
+          var disabled = isDisabled(row, rowIndex);
+          var preCellProps = (_b = (_a = opts.radioColumn) === null || _a === void 0 ? void 0 : _a.getCellProps) === null || _b === void 0 ? void 0 : _b.call(_a, value, row, rowIndex);
+          return mergeCellProps(preCellProps, {
+            style: {
+              cursor: disabled ? 'not-allowed' : 'pointer'
+            },
+            onClick: disabled ? undefined : function (e) {
+              if (opts.stopClickEventPropagation) {
+                e.stopPropagation();
+              }
+
+              onChange(rowKey);
+            }
+          });
+        }
+      },
+      render: function render(_, row, rowIndex) {
+        var rowKey = internals.safeGetRowKey(primaryKey, row, rowIndex);
+        return /*#__PURE__*/React.createElement(Radio, {
+          checked: value === rowKey,
+          disabled: isDisabled(row, rowIndex),
+          onChange: clickArea === 'radio' ? function (arg1, arg2) {
+            var _a;
+
+            var nativeEvent = (_a = arg2 === null || arg2 === void 0 ? void 0 : arg2.nativeEvent) !== null && _a !== void 0 ? _a : arg1 === null || arg1 === void 0 ? void 0 : arg1.nativeEvent;
+
+            if (nativeEvent && opts.stopClickEventPropagation) {
+              nativeEvent.stopPropagation();
+            }
+
+            onChange(rowKey);
+          } : undefined
+        });
+      }
+    });
+
+    var nextColumns = _sliceInstanceProperty(_context = pipeline.getColumns()).call(_context);
+
+    var radioPlacement = (_e = opts.radioPlacement) !== null && _e !== void 0 ? _e : 'start';
+
+    if (radioPlacement === 'start') {
+      nextColumns.unshift(radioColumn);
+    } else {
+      nextColumns.push(radioColumn);
+    }
+
+    pipeline.columns(nextColumns);
+    pipeline.appendRowPropsGetter(function (row, rowIndex) {
+      var rowKey = internals.safeGetRowKey(primaryKey, row, rowIndex);
+      var style = {};
+      var className;
+      var onClick;
+
+      if (opts.highlightRowWhenSelected) {
+        if (value === rowKey) {
+          className = 'highlight';
+        }
+      }
+
+      if (clickArea === 'row' && !isDisabled(row, rowIndex)) {
+        style.cursor = 'pointer';
+
+        onClick = function onClick(e) {
+          if (opts.stopClickEventPropagation) {
+            e.stopPropagation();
+          }
+
+          onChange(rowKey);
+        };
+      }
+
+      return {
+        className: className,
+        style: style,
+        onClick: onClick
+      };
+    });
+    return pipeline;
+  };
+}

package/es/table/pipeline/features/sort.d.ts

@@ -0,0 +1,40 @@
+import React, { ReactNode } from 'react';
+import { ArtColumn, SortItem, SortOrder } from '../../interfaces';
+import { TablePipeline } from '../pipeline';
+export interface SortHeaderCellProps {
+    /** 调用 makeSortTransform(...) 时的参数 */
+    sortOptions: Required<Omit<SortFeatureOptions, 'SortHeaderCell' | 'defaultSorts'>>;
+    /** 在添加排序相关的内容之前 表头原有的渲染内容 */
+    children: ReactNode;
+    /** 当前排序 */
+    sortOrder: SortOrder;
+    /** 多列排序下，sortIndex 指明了当前排序字段起作用的顺序. 当 sortOrder 为 none 时，sortIndex 固定为 -1 */
+    sortIndex: number;
+    /** 当前列的配置 */
+    column: ArtColumn;
+    /** 切换排序的回调 */
+    onToggle(e: React.MouseEvent): void;
+}
+export interface SortFeatureOptions {
+    /** (非受控用法) 默认的排序字段列表 */
+    defaultSorts?: SortItem[];
+    /** (受控用法) 排序字段列表 */
+    sorts?: SortItem[];
+    /** 更新排序字段列表的回调函数 */
+    onChangeSorts?(nextSorts: SortItem[], currentSort: SortItem): void;
+    /** 排序切换顺序 */
+    orders?: SortOrder[];
+    /** 排序模式。单选 single，多选 multiple，默认为多选 */
+    mode?: 'single' | 'multiple';
+    /** 自定义排序表头 */
+    SortHeaderCell?: React.ComponentType<SortHeaderCellProps>;
+    /** 是否保持 dataSource 不变 */
+    keepDataSource?: boolean;
+    /** 排序激活时 是否高亮这一列的单元格 */
+    highlightColumnWhenActive?: boolean;
+    /** 是否对触发 onChangeOpenKeys 的 click 事件调用 event.stopPropagation() */
+    stopClickEventPropagation?: boolean;
+    /** sort icon 是否 hover 之后显示 */
+    sortIconHoverShow?: boolean;
+}
+export declare function sort(opts?: SortFeatureOptions): (pipeline: TablePipeline) => TablePipeline;