useSorter.js 11 KB

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