DataTable Clear Filter

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  TableClearFilter,
17  type TableClearFilterProps,
18} from "../filters/table-clear-filter"
19 
20type DataTableClearFilterProps<TData> = Omit<
21  TableClearFilterProps<TData>,
22  "table"
23>
24 
25/**
26 * Context-aware clear filter button component that automatically gets the table from DataTableRoot context.
27 * Automatically hides when there are no active filters to clear.
28 *
29 * @example - Clear all filters (default)
30 * <DataTableClearFilter />
31 *
32 * @example - Only reset column filters, keep search
33 * <DataTableClearFilter enableResetGlobalFilter={false} />
34 *
35 * @example - Only reset search, keep column filters
36 * <DataTableClearFilter enableResetColumnFilters={false} />
37 *
38 * @example - Only reset sorting
39 * <DataTableClearFilter enableResetColumnFilters={false} enableResetGlobalFilter={false} />
40 *
41 * @example - Custom styling and text
42 * <DataTableClearFilter
43 *   variant="ghost"
44 *   size="sm"
45 *   className="text-red-500"
46 * >
47 *   Clear All
48 * </DataTableClearFilter>
49 *
50 * @example - Without icon
51 * <DataTableClearFilter showIcon={false}>
52 *   Reset Filters
53 * </DataTableClearFilter>
54 */
55export function DataTableClearFilter<TData>(
56  props: DataTableClearFilterProps<TData>,
57) {
58  const { table } = useDataTable<TData>()
59  return <TableClearFilter table={table} {...props} />
60}
61 
62DataTableClearFilter.displayName = "DataTableClearFilter"