import CaretDownOutlined from '@ant-design/icons-vue/CaretDownOutlined'; import CaretUpOutlined from '@ant-design/icons-vue/CaretUpOutlined'; import type { TransformColumns, ColumnsType, Key, ColumnType, SortOrder, CompareFn, ColumnTitleProps, SorterResult, ColumnGroupType, TableLocale, } from '../interface'; import type { TooltipProps } from '../../tooltip'; import Tooltip from '../../tooltip'; import { getColumnKey, getColumnPos, renderColumnTitle } from '../util'; import classNames from '../../_util/classNames'; import type { Ref } from 'vue'; import { computed } from 'vue'; import useState from '../../_util/hooks/useState'; import type { DefaultRecordType } from '../../vc-table/interface'; import KeyCode from '../../_util/KeyCode'; const ASCEND = 'ascend'; const DESCEND = 'descend'; function getMultiplePriority<RecordType>(column: ColumnType<RecordType>): number | false { if (typeof column.sorter === 'object' && typeof column.sorter.multiple === 'number') { return column.sorter.multiple; } return false; } function getSortFunction<RecordType>( sorter: ColumnType<RecordType>['sorter'], ): CompareFn<RecordType> | false { if (typeof sorter === 'function') { return sorter; } if (sorter && typeof sorter === 'object' && sorter.compare) { return sorter.compare; } return false; } function nextSortDirection(sortDirections: SortOrder[], current: SortOrder | null) { if (!current) { return sortDirections[0]; } return sortDirections[sortDirections.indexOf(current) + 1]; } export interface SortState<RecordType = DefaultRecordType> { column: ColumnType<RecordType>; key: Key; sortOrder: SortOrder | null; multiplePriority: number | false; } function collectSortStates<RecordType>( columns: ColumnsType<RecordType>, init: boolean, pos?: string, ): SortState<RecordType>[] { let sortStates: SortState<RecordType>[] = []; function pushState(column: ColumnsType<RecordType>[number], columnPos: string) { sortStates.push({ column, key: getColumnKey(column, columnPos), multiplePriority: getMultiplePriority(column), sortOrder: column.sortOrder!, }); } (columns || []).forEach((column, index) => { const columnPos = getColumnPos(index, pos); if ((column as ColumnGroupType<RecordType>).children) { if ('sortOrder' in column) { // Controlled pushState(column, columnPos); } sortStates = [ ...sortStates, ...collectSortStates((column as ColumnGroupType<RecordType>).children, init, columnPos), ]; } else if (column.sorter) { if ('sortOrder' in column) { // Controlled pushState(column, columnPos); } else if (init && column.defaultSortOrder) { // Default sorter sortStates.push({ column, key: getColumnKey(column, columnPos), multiplePriority: getMultiplePriority(column), sortOrder: column.defaultSortOrder!, }); } } }); return sortStates; } function injectSorter<RecordType>( prefixCls: string, columns: ColumnsType<RecordType>, sorterStates: SortState<RecordType>[], triggerSorter: (sorterStates: SortState<RecordType>) => void, defaultSortDirections: SortOrder[], tableLocale?: TableLocale, tableShowSorterTooltip?: boolean | TooltipProps, pos?: string, ): ColumnsType<RecordType> { return (columns || []).map((column, index) => { const columnPos = getColumnPos(index, pos); let newColumn: ColumnsType<RecordType>[number] = column; if (newColumn.sorter) { const sortDirections: SortOrder[] = newColumn.sortDirections || defaultSortDirections; const showSorterTooltip = newColumn.showSorterTooltip === undefined ? tableShowSorterTooltip : newColumn.showSorterTooltip; const columnKey = getColumnKey(newColumn, columnPos); const sorterState = sorterStates.find(({ key }) => key === columnKey); const sorterOrder = sorterState ? sorterState.sortOrder : null; const nextSortOrder = nextSortDirection(sortDirections, sorterOrder); const upNode = sortDirections.includes(ASCEND) && ( <CaretUpOutlined class={classNames(`${prefixCls}-column-sorter-up`, { active: sorterOrder === ASCEND, })} role="presentation" /> ); const downNode = sortDirections.includes(DESCEND) && ( <CaretDownOutlined role="presentation" class={classNames(`${prefixCls}-column-sorter-down`, { active: sorterOrder === DESCEND, })} /> ); const { cancelSort, triggerAsc, triggerDesc } = tableLocale || {}; let sortTip: string | undefined = cancelSort; if (nextSortOrder === DESCEND) { sortTip = triggerDesc; } else if (nextSortOrder === ASCEND) { sortTip = triggerAsc; } const tooltipProps: TooltipProps = typeof showSorterTooltip === 'object' ? showSorterTooltip : { title: sortTip }; newColumn = { ...newColumn, className: classNames(newColumn.className, { [`${prefixCls}-column-sort`]: sorterOrder }), title: (renderProps: ColumnTitleProps<RecordType>) => { const renderSortTitle = ( <div class={`${prefixCls}-column-sorters`}> <span class={`${prefixCls}-column-title`}> {renderColumnTitle(column.title, renderProps)} </span> <span class={classNames(`${prefixCls}-column-sorter`, { [`${prefixCls}-column-sorter-full`]: !!(upNode && downNode), })} > <span class={`${prefixCls}-column-sorter-inner`}> {upNode} {downNode} </span> </span> </div> ); return showSorterTooltip ? ( <Tooltip {...tooltipProps}>{renderSortTitle}</Tooltip> ) : ( renderSortTitle ); }, customHeaderCell: col => { const cell = (column.customHeaderCell && column.customHeaderCell(col)) || {}; const originOnClick = cell.onClick; const originOKeyDown = cell.onKeydown; cell.onClick = (event: MouseEvent) => { triggerSorter({ column, key: columnKey, sortOrder: nextSortOrder, multiplePriority: getMultiplePriority(column), }); if (originOnClick) { originOnClick(event); } }; cell.onKeydown = (event: KeyboardEvent) => { if (event.keyCode === KeyCode.ENTER) { triggerSorter({ column, key: columnKey, sortOrder: nextSortOrder, multiplePriority: getMultiplePriority(column), }); originOKeyDown?.(event); } }; // Inform the screen-reader so it can tell the visually impaired user which column is sorted if (sorterOrder) { cell['aria-sort'] = sorterOrder === 'ascend' ? 'ascending' : 'descending'; } cell.class = classNames(cell.class, `${prefixCls}-column-has-sorters`); cell.tabindex = 0; return cell; }, }; } if ('children' in newColumn) { newColumn = { ...newColumn, children: injectSorter( prefixCls, newColumn.children, sorterStates, triggerSorter, defaultSortDirections, tableLocale, tableShowSorterTooltip, columnPos, ), }; } return newColumn; }); } function stateToInfo<RecordType>(sorterStates: SortState<RecordType>) { const { column, sortOrder } = sorterStates; return { column, order: sortOrder, field: column.dataIndex, columnKey: column.key }; } function generateSorterInfo<RecordType>( sorterStates: SortState<RecordType>[], ): SorterResult<RecordType> | SorterResult<RecordType>[] { const list = sorterStates.filter(({ sortOrder }) => sortOrder).map(stateToInfo); // =========== Legacy compatible support =========== // https://github.com/ant-design/ant-design/pull/19226 if (list.length === 0 && sorterStates.length) { return { ...stateToInfo(sorterStates[sorterStates.length - 1]), column: undefined, }; } if (list.length <= 1) { return list[0] || {}; } return list; } export function getSortData<RecordType>( data: readonly RecordType[], sortStates: SortState<RecordType>[], childrenColumnName: string, ): RecordType[] { const innerSorterStates = sortStates .slice() .sort((a, b) => (b.multiplePriority as number) - (a.multiplePriority as number)); const cloneData = data.slice(); const runningSorters = innerSorterStates.filter( ({ column: { sorter }, sortOrder }) => getSortFunction(sorter) && sortOrder, ); // Skip if no sorter needed if (!runningSorters.length) { return cloneData; } return cloneData .sort((record1, record2) => { for (let i = 0; i < runningSorters.length; i += 1) { const sorterState = runningSorters[i]; const { column: { sorter }, sortOrder, } = sorterState; const compareFn = getSortFunction(sorter); if (compareFn && sortOrder) { const compareResult = compareFn(record1, record2, sortOrder); if (compareResult !== 0) { return sortOrder === ASCEND ? compareResult : -compareResult; } } } return 0; }) .map<RecordType>(record => { const subRecords = (record as any)[childrenColumnName]; if (subRecords) { return { ...record, [childrenColumnName]: getSortData(subRecords, sortStates, childrenColumnName), }; } return record; }); } interface SorterConfig<RecordType> { prefixCls: Ref<string>; mergedColumns: Ref<ColumnsType<RecordType>>; onSorterChange: ( sorterResult: SorterResult<RecordType> | SorterResult<RecordType>[], sortStates: SortState<RecordType>[], ) => void; sortDirections: Ref<SortOrder[]>; tableLocale?: Ref<TableLocale>; showSorterTooltip?: Ref<boolean | TooltipProps>; } export default function useFilterSorter<RecordType>({ prefixCls, mergedColumns, onSorterChange, sortDirections, tableLocale, showSorterTooltip, }: SorterConfig<RecordType>): [ TransformColumns<RecordType>, Ref<SortState<RecordType>[]>, Ref<ColumnTitleProps<RecordType>>, Ref<SorterResult<RecordType> | SorterResult<RecordType>[]>, ] { const [sortStates, setSortStates] = useState<SortState<RecordType>[]>( collectSortStates(mergedColumns.value, true), ); const mergedSorterStates = computed(() => { let validate = true; const collectedStates = collectSortStates(mergedColumns.value, false); // Return if not controlled if (!collectedStates.length) { return sortStates.value; } const validateStates: SortState<RecordType>[] = []; function patchStates(state: SortState<RecordType>) { if (validate) { validateStates.push(state); } else { validateStates.push({ ...state, sortOrder: null, }); } } let multipleMode: boolean | null = null; collectedStates.forEach(state => { if (multipleMode === null) { patchStates(state); if (state.sortOrder) { if (state.multiplePriority === false) { validate = false; } else { multipleMode = true; } } } else if (multipleMode && state.multiplePriority !== false) { patchStates(state); } else { validate = false; patchStates(state); } }); return validateStates; }); // Get render columns title required props const columnTitleSorterProps = computed<ColumnTitleProps<RecordType>>(() => { const sortColumns = mergedSorterStates.value.map(({ column, sortOrder }) => ({ column, order: sortOrder, })); return { sortColumns, // Legacy sortColumn: sortColumns[0] && sortColumns[0].column, sortOrder: (sortColumns[0] && sortColumns[0].order) as SortOrder, }; }); function triggerSorter(sortState: SortState<RecordType>) { let newSorterStates; if ( sortState.multiplePriority === false || !mergedSorterStates.value.length || mergedSorterStates.value[0].multiplePriority === false ) { newSorterStates = [sortState]; } else { newSorterStates = [ ...mergedSorterStates.value.filter(({ key }) => key !== sortState.key), sortState, ]; } setSortStates(newSorterStates); onSorterChange(generateSorterInfo(newSorterStates), newSorterStates); } const transformColumns = (innerColumns: ColumnsType<RecordType>) => injectSorter( prefixCls.value, innerColumns, mergedSorterStates.value, triggerSorter, sortDirections.value, tableLocale.value, showSorterTooltip.value, ); const sorters = computed(() => generateSorterInfo(mergedSorterStates.value)); return [transformColumns, mergedSorterStates, columnTitleSorterProps, sorters]; }