Skip to content

Commit

Permalink
docs: Document getAutoFilterFn in column-filtering.md (#5510)
Browse files Browse the repository at this point in the history
  • Loading branch information
geryogam authored May 10, 2024
1 parent 58f7991 commit b1d29b4
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/guide/column-filtering.md
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.

0 comments on commit b1d29b4

Please sign in to comment.