Skip to content

Commit

Permalink
docs: Update useGroupBy docs to mention autoResetGroupBy (TanStack#…
Browse files Browse the repository at this point in the history
…4035)

Other plugin pages explicitly mention this flag (e.g. useExpanded), but useGroupBy didn't — added it in!
  • Loading branch information
alp-stripe authored Jun 27, 2022
1 parent 46bcc7c commit b77ed82
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/pages/docs/api/useGroupBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ The following options are supported via the main options object passed to `useTa
- Must be **memoized**
- Defaults to `defaultGroupByFn`
- This function is responsible for grouping rows based on the `state.groupBy` keys provided. It's very rare you would need to customize this function.
- `autoResetGroupBy: Boolean`
- Defaults to `true`
- When `true`, the `expanded` state will automatically reset if any of the following conditions are met:
- `data` is changed
- To disable, set to `false`
- For more information see the FAQ ["How do I stop my table state from automatically resetting when my data changes?"](../faq#how-do-i-stop-my-table-state-from-automatically-resetting-when-my-data-changes)

### Column Options

Expand Down

0 comments on commit b77ed82

Please sign in to comment.