useSorter.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = useFilterSorter;
  7. exports.getSortData = getSortData;
  8. var _vue = require("vue");
  9. var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
  10. var _CaretDownOutlined = _interopRequireDefault(require("@ant-design/icons-vue/lib/icons/CaretDownOutlined"));
  11. var _CaretUpOutlined = _interopRequireDefault(require("@ant-design/icons-vue/lib/icons/CaretUpOutlined"));
  12. var _tooltip = _interopRequireDefault(require("../../tooltip"));
  13. var _util = require("../util");
  14. var _classNames = _interopRequireDefault(require("../../_util/classNames"));
  15. var _useState = _interopRequireDefault(require("../../_util/hooks/useState"));
  16. var _KeyCode = _interopRequireDefault(require("../../_util/KeyCode"));
  17. const ASCEND = 'ascend';
  18. const DESCEND = 'descend';
  19. function getMultiplePriority(column) {
  20. if (typeof column.sorter === 'object' && typeof column.sorter.multiple === 'number') {
  21. return column.sorter.multiple;
  22. }
  23. return false;
  24. }
  25. function getSortFunction(sorter) {
  26. if (typeof sorter === 'function') {
  27. return sorter;
  28. }
  29. if (sorter && typeof sorter === 'object' && sorter.compare) {
  30. return sorter.compare;
  31. }
  32. return false;
  33. }
  34. function nextSortDirection(sortDirections, current) {
  35. if (!current) {
  36. return sortDirections[0];
  37. }
  38. return sortDirections[sortDirections.indexOf(current) + 1];
  39. }
  40. function collectSortStates(columns, init, pos) {
  41. let sortStates = [];
  42. function pushState(column, columnPos) {
  43. sortStates.push({
  44. column,
  45. key: (0, _util.getColumnKey)(column, columnPos),
  46. multiplePriority: getMultiplePriority(column),
  47. sortOrder: column.sortOrder
  48. });
  49. }
  50. (columns || []).forEach((column, index) => {
  51. const columnPos = (0, _util.getColumnPos)(index, pos);
  52. if (column.children) {
  53. if ('sortOrder' in column) {
  54. // Controlled
  55. pushState(column, columnPos);
  56. }
  57. sortStates = [...sortStates, ...collectSortStates(column.children, init, columnPos)];
  58. } else if (column.sorter) {
  59. if ('sortOrder' in column) {
  60. // Controlled
  61. pushState(column, columnPos);
  62. } else if (init && column.defaultSortOrder) {
  63. // Default sorter
  64. sortStates.push({
  65. column,
  66. key: (0, _util.getColumnKey)(column, columnPos),
  67. multiplePriority: getMultiplePriority(column),
  68. sortOrder: column.defaultSortOrder
  69. });
  70. }
  71. }
  72. });
  73. return sortStates;
  74. }
  75. function injectSorter(prefixCls, columns, sorterStates, triggerSorter, defaultSortDirections, tableLocale, tableShowSorterTooltip, pos) {
  76. return (columns || []).map((column, index) => {
  77. const columnPos = (0, _util.getColumnPos)(index, pos);
  78. let newColumn = column;
  79. if (newColumn.sorter) {
  80. const sortDirections = newColumn.sortDirections || defaultSortDirections;
  81. const showSorterTooltip = newColumn.showSorterTooltip === undefined ? tableShowSorterTooltip : newColumn.showSorterTooltip;
  82. const columnKey = (0, _util.getColumnKey)(newColumn, columnPos);
  83. const sorterState = sorterStates.find(_ref => {
  84. let {
  85. key
  86. } = _ref;
  87. return key === columnKey;
  88. });
  89. const sorterOrder = sorterState ? sorterState.sortOrder : null;
  90. const nextSortOrder = nextSortDirection(sortDirections, sorterOrder);
  91. const upNode = sortDirections.includes(ASCEND) && (0, _vue.createVNode)(_CaretUpOutlined.default, {
  92. "class": (0, _classNames.default)(`${prefixCls}-column-sorter-up`, {
  93. active: sorterOrder === ASCEND
  94. }),
  95. "role": "presentation"
  96. }, null);
  97. const downNode = sortDirections.includes(DESCEND) && (0, _vue.createVNode)(_CaretDownOutlined.default, {
  98. "role": "presentation",
  99. "class": (0, _classNames.default)(`${prefixCls}-column-sorter-down`, {
  100. active: sorterOrder === DESCEND
  101. })
  102. }, null);
  103. const {
  104. cancelSort,
  105. triggerAsc,
  106. triggerDesc
  107. } = tableLocale || {};
  108. let sortTip = cancelSort;
  109. if (nextSortOrder === DESCEND) {
  110. sortTip = triggerDesc;
  111. } else if (nextSortOrder === ASCEND) {
  112. sortTip = triggerAsc;
  113. }
  114. const tooltipProps = typeof showSorterTooltip === 'object' ? showSorterTooltip : {
  115. title: sortTip
  116. };
  117. newColumn = (0, _extends2.default)((0, _extends2.default)({}, newColumn), {
  118. className: (0, _classNames.default)(newColumn.className, {
  119. [`${prefixCls}-column-sort`]: sorterOrder
  120. }),
  121. title: renderProps => {
  122. const renderSortTitle = (0, _vue.createVNode)("div", {
  123. "class": `${prefixCls}-column-sorters`
  124. }, [(0, _vue.createVNode)("span", {
  125. "class": `${prefixCls}-column-title`
  126. }, [(0, _util.renderColumnTitle)(column.title, renderProps)]), (0, _vue.createVNode)("span", {
  127. "class": (0, _classNames.default)(`${prefixCls}-column-sorter`, {
  128. [`${prefixCls}-column-sorter-full`]: !!(upNode && downNode)
  129. })
  130. }, [(0, _vue.createVNode)("span", {
  131. "class": `${prefixCls}-column-sorter-inner`
  132. }, [upNode, downNode])])]);
  133. return showSorterTooltip ? (0, _vue.createVNode)(_tooltip.default, tooltipProps, {
  134. default: () => [renderSortTitle]
  135. }) : renderSortTitle;
  136. },
  137. customHeaderCell: col => {
  138. const cell = column.customHeaderCell && column.customHeaderCell(col) || {};
  139. const originOnClick = cell.onClick;
  140. const originOKeyDown = cell.onKeydown;
  141. cell.onClick = event => {
  142. triggerSorter({
  143. column,
  144. key: columnKey,
  145. sortOrder: nextSortOrder,
  146. multiplePriority: getMultiplePriority(column)
  147. });
  148. if (originOnClick) {
  149. originOnClick(event);
  150. }
  151. };
  152. cell.onKeydown = event => {
  153. if (event.keyCode === _KeyCode.default.ENTER) {
  154. triggerSorter({
  155. column,
  156. key: columnKey,
  157. sortOrder: nextSortOrder,
  158. multiplePriority: getMultiplePriority(column)
  159. });
  160. originOKeyDown === null || originOKeyDown === void 0 ? void 0 : originOKeyDown(event);
  161. }
  162. };
  163. // Inform the screen-reader so it can tell the visually impaired user which column is sorted
  164. if (sorterOrder) {
  165. cell['aria-sort'] = sorterOrder === 'ascend' ? 'ascending' : 'descending';
  166. }
  167. cell.class = (0, _classNames.default)(cell.class, `${prefixCls}-column-has-sorters`);
  168. cell.tabindex = 0;
  169. return cell;
  170. }
  171. });
  172. }
  173. if ('children' in newColumn) {
  174. newColumn = (0, _extends2.default)((0, _extends2.default)({}, newColumn), {
  175. children: injectSorter(prefixCls, newColumn.children, sorterStates, triggerSorter, defaultSortDirections, tableLocale, tableShowSorterTooltip, columnPos)
  176. });
  177. }
  178. return newColumn;
  179. });
  180. }
  181. function stateToInfo(sorterStates) {
  182. const {
  183. column,
  184. sortOrder
  185. } = sorterStates;
  186. return {
  187. column,
  188. order: sortOrder,
  189. field: column.dataIndex,
  190. columnKey: column.key
  191. };
  192. }
  193. function generateSorterInfo(sorterStates) {
  194. const list = sorterStates.filter(_ref2 => {
  195. let {
  196. sortOrder
  197. } = _ref2;
  198. return sortOrder;
  199. }).map(stateToInfo);
  200. // =========== Legacy compatible support ===========
  201. // https://github.com/ant-design/ant-design/pull/19226
  202. if (list.length === 0 && sorterStates.length) {
  203. return (0, _extends2.default)((0, _extends2.default)({}, stateToInfo(sorterStates[sorterStates.length - 1])), {
  204. column: undefined
  205. });
  206. }
  207. if (list.length <= 1) {
  208. return list[0] || {};
  209. }
  210. return list;
  211. }
  212. function getSortData(data, sortStates, childrenColumnName) {
  213. const innerSorterStates = sortStates.slice().sort((a, b) => b.multiplePriority - a.multiplePriority);
  214. const cloneData = data.slice();
  215. const runningSorters = innerSorterStates.filter(_ref3 => {
  216. let {
  217. column: {
  218. sorter
  219. },
  220. sortOrder
  221. } = _ref3;
  222. return getSortFunction(sorter) && sortOrder;
  223. });
  224. // Skip if no sorter needed
  225. if (!runningSorters.length) {
  226. return cloneData;
  227. }
  228. return cloneData.sort((record1, record2) => {
  229. for (let i = 0; i < runningSorters.length; i += 1) {
  230. const sorterState = runningSorters[i];
  231. const {
  232. column: {
  233. sorter
  234. },
  235. sortOrder
  236. } = sorterState;
  237. const compareFn = getSortFunction(sorter);
  238. if (compareFn && sortOrder) {
  239. const compareResult = compareFn(record1, record2, sortOrder);
  240. if (compareResult !== 0) {
  241. return sortOrder === ASCEND ? compareResult : -compareResult;
  242. }
  243. }
  244. }
  245. return 0;
  246. }).map(record => {
  247. const subRecords = record[childrenColumnName];
  248. if (subRecords) {
  249. return (0, _extends2.default)((0, _extends2.default)({}, record), {
  250. [childrenColumnName]: getSortData(subRecords, sortStates, childrenColumnName)
  251. });
  252. }
  253. return record;
  254. });
  255. }
  256. function useFilterSorter(_ref4) {
  257. let {
  258. prefixCls,
  259. mergedColumns,
  260. onSorterChange,
  261. sortDirections,
  262. tableLocale,
  263. showSorterTooltip
  264. } = _ref4;
  265. const [sortStates, setSortStates] = (0, _useState.default)(collectSortStates(mergedColumns.value, true));
  266. const mergedSorterStates = (0, _vue.computed)(() => {
  267. let validate = true;
  268. const collectedStates = collectSortStates(mergedColumns.value, false);
  269. // Return if not controlled
  270. if (!collectedStates.length) {
  271. return sortStates.value;
  272. }
  273. const validateStates = [];
  274. function patchStates(state) {
  275. if (validate) {
  276. validateStates.push(state);
  277. } else {
  278. validateStates.push((0, _extends2.default)((0, _extends2.default)({}, state), {
  279. sortOrder: null
  280. }));
  281. }
  282. }
  283. let multipleMode = null;
  284. collectedStates.forEach(state => {
  285. if (multipleMode === null) {
  286. patchStates(state);
  287. if (state.sortOrder) {
  288. if (state.multiplePriority === false) {
  289. validate = false;
  290. } else {
  291. multipleMode = true;
  292. }
  293. }
  294. } else if (multipleMode && state.multiplePriority !== false) {
  295. patchStates(state);
  296. } else {
  297. validate = false;
  298. patchStates(state);
  299. }
  300. });
  301. return validateStates;
  302. });
  303. // Get render columns title required props
  304. const columnTitleSorterProps = (0, _vue.computed)(() => {
  305. const sortColumns = mergedSorterStates.value.map(_ref5 => {
  306. let {
  307. column,
  308. sortOrder
  309. } = _ref5;
  310. return {
  311. column,
  312. order: sortOrder
  313. };
  314. });
  315. return {
  316. sortColumns,
  317. // Legacy
  318. sortColumn: sortColumns[0] && sortColumns[0].column,
  319. sortOrder: sortColumns[0] && sortColumns[0].order
  320. };
  321. });
  322. function triggerSorter(sortState) {
  323. let newSorterStates;
  324. if (sortState.multiplePriority === false || !mergedSorterStates.value.length || mergedSorterStates.value[0].multiplePriority === false) {
  325. newSorterStates = [sortState];
  326. } else {
  327. newSorterStates = [...mergedSorterStates.value.filter(_ref6 => {
  328. let {
  329. key
  330. } = _ref6;
  331. return key !== sortState.key;
  332. }), sortState];
  333. }
  334. setSortStates(newSorterStates);
  335. onSorterChange(generateSorterInfo(newSorterStates), newSorterStates);
  336. }
  337. const transformColumns = innerColumns => injectSorter(prefixCls.value, innerColumns, mergedSorterStates.value, triggerSorter, sortDirections.value, tableLocale.value, showSorterTooltip.value);
  338. const sorters = (0, _vue.computed)(() => generateSorterInfo(mergedSorterStates.value));
  339. return [transformColumns, mergedSorterStates, columnTitleSorterProps, sorters];
  340. }