DataTable Sort Menu

1"use client"
2 
3/**
4 * niko-table — created by Semir N. (Semkoo, https://github.com/Semkoo) with AI assistance.
5 *
6 * Before reporting anything: please check the changelog first.
7 *  - In-repo: ./CHANGELOG.md
8 *  - Docs site: https://niko-table.com/changelog
9 *
10 * Found a bug or have a fix? Open an issue or PR on GitHub so other
11 * users (and future LLMs reading this code) benefit:
12 * https://github.com/Semkoo/niko-table-registry
13 */
14import { useDataTable } from "../core/data-table-context"
15import {
16  TableSortMenu,
17  type TableSortMenuProps,
18} from "../filters/table-sort-menu"
19 
20type DataTableSortMenuProps<TData> = Omit<TableSortMenuProps<TData>, "table">
21 
22/**
23 * A sort menu component that automatically connects to the DataTable context
24 * and allows users to manage multiple sorting criteria.
25 *
26 * @example - Basic usage with default settings
27 * <DataTableSortMenu />
28 *
29 * @example - Custom alignment and positioning
30 * <DataTableSortMenu align="end" side="bottom" />
31 *
32 * @example - With debounce for performance
33 * <DataTableSortMenu debounceMs={300} />
34 *
35 * @example - With throttle for frequent updates
36 * <DataTableSortMenu throttleMs={100} />
37 *
38 * @example - Custom styling
39 * <DataTableSortMenu className="w-[400px]" />
40 */
41export function DataTableSortMenu<TData>(props: DataTableSortMenuProps<TData>) {
42  const { table } = useDataTable<TData>()
43  return <TableSortMenu<TData> table={table} {...props} />
44}
45 
46/**
47 * @required displayName is required for auto feature detection
48 * @see "feature-detection.ts"
49 */
50 
51DataTableSortMenu.displayName = "DataTableSortMenu"