|
| 1 | +import { SortingState, Updater } from "@tanstack/react-table"; |
| 2 | +import { useCallback, useMemo } from "react"; |
| 3 | +import { useSearchParams } from "react-router-dom"; |
| 4 | + |
| 5 | +/** |
| 6 | + * |
| 7 | + * useReactTableSortState is a custom hook that manages the sorting state of a |
| 8 | + * react-table instance. It uses the URL search params to store the sorting |
| 9 | + * state. It returns the sorting state and a function to update the sorting state. |
| 10 | + * |
| 11 | + */ |
| 12 | +export default function useReactTableSortState( |
| 13 | + sortByKey = "sortBy", |
| 14 | + sortOrderKey = "sortOrder" |
| 15 | +): [SortingState, (newSortBy: Updater<SortingState>) => void] { |
| 16 | + const [searchParams, setSearchParams] = useSearchParams(); |
| 17 | + |
| 18 | + const sortBy = searchParams.get(sortByKey) || undefined; |
| 19 | + const sortOrder = searchParams.get(sortOrderKey) || undefined; |
| 20 | + |
| 21 | + const tableSortByState = useMemo(() => { |
| 22 | + if (!sortBy || !sortOrder) { |
| 23 | + return []; |
| 24 | + } |
| 25 | + return [ |
| 26 | + { |
| 27 | + id: sortBy, |
| 28 | + desc: sortOrder === "desc" |
| 29 | + } |
| 30 | + ] satisfies SortingState; |
| 31 | + }, [sortBy, sortOrder]); |
| 32 | + |
| 33 | + console.log(tableSortByState); |
| 34 | + |
| 35 | + const updateSortByFn = useCallback( |
| 36 | + (newSortBy: Updater<SortingState>) => { |
| 37 | + const sort = typeof newSortBy === "function" ? newSortBy([]) : newSortBy; |
| 38 | + if (sort.length === 0) { |
| 39 | + searchParams.delete(sortByKey); |
| 40 | + searchParams.delete(sortOrderKey); |
| 41 | + } else { |
| 42 | + searchParams.set(sortByKey, sort[0]?.id); |
| 43 | + searchParams.set(sortOrderKey, sort[0].desc ? "desc" : "asc"); |
| 44 | + } |
| 45 | + setSearchParams(searchParams); |
| 46 | + }, |
| 47 | + [searchParams, setSearchParams, sortByKey, sortOrderKey] |
| 48 | + ); |
| 49 | + |
| 50 | + return [tableSortByState, updateSortByFn]; |
| 51 | +} |
0 commit comments