import * as React from 'react'; import warning from '../../../_util/warning'; import type { ColumnFilterItem, ColumnsType, ColumnTitleProps, ColumnType, FilterKey, FilterValue, GetPopupContainer, Key, TableLocale, TransformColumns, } from '../../interface'; import { getColumnKey, getColumnPos, renderColumnTitle } from '../../util'; import FilterDropdown from './FilterDropdown'; export interface FilterState { column: ColumnType; key: Key; filteredKeys?: FilterKey; forceFiltered?: boolean; } function collectFilterStates( columns: ColumnsType, init: boolean, pos?: string, ): FilterState[] { let filterStates: FilterState[] = []; (columns || []).forEach((column, index) => { const columnPos = getColumnPos(index, pos); if (column.filters || 'filterDropdown' in column || 'onFilter' in column) { if ('filteredValue' in column) { // Controlled let filteredValues = column.filteredValue; if (!('filterDropdown' in column)) { filteredValues = filteredValues?.map(String) ?? filteredValues; } filterStates.push({ column, key: getColumnKey(column, columnPos), filteredKeys: filteredValues as FilterKey, forceFiltered: column.filtered, }); } else { // Uncontrolled filterStates.push({ column, key: getColumnKey(column, columnPos), filteredKeys: (init && column.defaultFilteredValue ? column.defaultFilteredValue! : undefined) as FilterKey, forceFiltered: column.filtered, }); } } if ('children' in column) { filterStates = [...filterStates, ...collectFilterStates(column.children, init, columnPos)]; } }); return filterStates; } function injectFilter( prefixCls: string, dropdownPrefixCls: string, columns: ColumnsType, filterStates: FilterState[], triggerFilter: (filterState: FilterState) => void, getPopupContainer: GetPopupContainer | undefined, locale: TableLocale, pos?: string, ): ColumnsType { return columns.map((column, index) => { const columnPos = getColumnPos(index, pos); const { filterMultiple = true, filterMode, filterSearch } = column as ColumnType; let newColumn: ColumnsType[number] = column; if (newColumn.filters || newColumn.filterDropdown) { const columnKey = getColumnKey(newColumn, columnPos); const filterState = filterStates.find(({ key }) => columnKey === key); newColumn = { ...newColumn, title: (renderProps: ColumnTitleProps) => ( {renderColumnTitle(column.title, renderProps)} ), }; } if ('children' in newColumn) { newColumn = { ...newColumn, children: injectFilter( prefixCls, dropdownPrefixCls, newColumn.children, filterStates, triggerFilter, getPopupContainer, locale, columnPos, ), }; } return newColumn; }); } export function flattenKeys(filters?: ColumnFilterItem[]) { let keys: FilterValue = []; (filters || []).forEach(({ value, children }) => { keys.push(value); if (children) { keys = [...keys, ...flattenKeys(children)]; } }); return keys; } function generateFilterInfo(filterStates: FilterState[]) { const currentFilters: Record = {}; filterStates.forEach(({ key, filteredKeys, column }) => { const { filters, filterDropdown } = column; if (filterDropdown) { currentFilters[key] = filteredKeys || null; } else if (Array.isArray(filteredKeys)) { const keys = flattenKeys(filters); currentFilters[key] = keys.filter(originKey => filteredKeys.includes(String(originKey))); } else { currentFilters[key] = null; } }); return currentFilters; } export function getFilterData( data: RecordType[], filterStates: FilterState[], ) { return filterStates.reduce((currentData, filterState) => { const { column: { onFilter, filters }, filteredKeys, } = filterState; if (onFilter && filteredKeys && filteredKeys.length) { return currentData.filter(record => filteredKeys.some(key => { const keys = flattenKeys(filters); const keyIndex = keys.findIndex(k => String(k) === String(key)); const realKey = keyIndex !== -1 ? keys[keyIndex] : key; return onFilter(realKey, record); }), ); } return currentData; }, data); } interface FilterConfig { prefixCls: string; dropdownPrefixCls: string; mergedColumns: ColumnsType; locale: TableLocale; onFilterChange: ( filters: Record, filterStates: FilterState[], ) => void; getPopupContainer?: GetPopupContainer; } function useFilter({ prefixCls, dropdownPrefixCls, mergedColumns, onFilterChange, getPopupContainer, locale: tableLocale, }: FilterConfig): [ TransformColumns, FilterState[], () => Record, ] { const [filterStates, setFilterStates] = React.useState[]>( collectFilterStates(mergedColumns, true), ); const mergedFilterStates = React.useMemo(() => { const collectedStates = collectFilterStates(mergedColumns, false); let filteredKeysIsAllNotControlled = true; let filteredKeysIsAllControlled = true; collectedStates.forEach(({ filteredKeys }) => { if (filteredKeys !== undefined) { filteredKeysIsAllNotControlled = false; } else { filteredKeysIsAllControlled = false; } }); // Return if not controlled if (filteredKeysIsAllNotControlled) { return filterStates; } warning( filteredKeysIsAllControlled, 'Table', 'Columns should all contain `filteredValue` or not contain `filteredValue`.', ); return collectedStates; }, [mergedColumns, filterStates]); const getFilters = React.useCallback( () => generateFilterInfo(mergedFilterStates), [mergedFilterStates], ); const triggerFilter = (filterState: FilterState) => { const newFilterStates = mergedFilterStates.filter(({ key }) => key !== filterState.key); newFilterStates.push(filterState); setFilterStates(newFilterStates); onFilterChange(generateFilterInfo(newFilterStates), newFilterStates); }; const transformColumns = (innerColumns: ColumnsType) => injectFilter( prefixCls, dropdownPrefixCls, innerColumns, mergedFilterStates, triggerFilter, getPopupContainer, tableLocale, ); return [transformColumns, mergedFilterStates, getFilters]; } export default useFilter;