Skip to content

Document getAutoFilterFn in column-filtering.md #5510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KevinVandy merged 2 commits into from
May 10, 2024
Merged

Document getAutoFilterFn in column-filtering.md #5510

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32324fe
Document getAutoFilterFn in column-filtering.md
geryogam Apr 24, 2024
a8f770e
Merge branch 'main' into patch-3
geryogam Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/guide/column-filtering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,15 +323,15 @@ const table = useReactTable({

There are a lot of Column and Table APIs that you can use to interact with the column filter state and hook up to your UI components. Here is a list of the available APIs and their most common use-cases:

- `table.setColumnFilters` - Overwrite the entire column filter state with a new state
- `table.resetColumnFilters` - Useful for a "clear all/reset filters" button
- `table.setColumnFilters` - Overwrite the entire column filter state with a new state.
- `table.resetColumnFilters` - Useful for a "clear all/reset filters" button.

- **`column.getFilterValue`** - Useful for getting the default initial filter value for an input, or even directly providing the filter value to a filter input
- **`column.setFilterValue`** - Useful for connecting filter inputs to their `onChange` or `onBlur` handlers
- **`column.getFilterValue`** - Useful for getting the default initial filter value for an input, or even directly providing the filter value to a filter input.
- **`column.setFilterValue`** - Useful for connecting filter inputs to their `onChange` or `onBlur` handlers.

- `column.getCanFilter` - Useful for disabling/enabling filter inputs
- `column.getIsFiltered` - Useful for displaying a visual indicator that a column is currently being filtered
- `column.getFilterIndex` - Useful for displaying in what order the current filter is being applied
- `column.getCanFilter` - Useful for disabling/enabling filter inputs.
- `column.getIsFiltered` - Useful for displaying a visual indicator that a column is currently being filtered.
- `column.getFilterIndex` - Useful for displaying in what order the current filter is being applied.

- `column.getAutoFilterFn` -
- `column.getFilterFn` - Useful for displaying which filter mode or function is currently being used
- `column.getAutoFilterFn` - Used internally to find the default filter function for a column if none is specified.
- `column.getFilterFn` - Useful for displaying which filter mode or function is currently being used.