Skip to content

Commit

Permalink
Clarify expansion state
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
  • Loading branch information
mturley committed Sep 14, 2023
1 parent bd08667 commit 66a5fe8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion client/src/app/hooks/table-controls/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Items are paginated according to the user-selected page number and items-per-pag
### Expansion

Item details can be expanded, either with a "single expansion" variant where an entire row is expanded to show more detail or a "compound expansion" variant where individual cells in a row are expanded. This is tracked in state by a mapping of item ids (derived from the `idProperty` config argument) to an array of either boolean values (for single expansion) or `columnKey` values that are expanded for that item (for compound expansion). See [Unique Identifiers](#unique-identifiers) for more on `idProperty` and `columnKey`.
Item details can be expanded, either with a "single expansion" variant where an entire row is expanded to show more detail or a "compound expansion" variant where an individual cell in a row (one at a time per row) is expanded. This is tracked in state by a mapping of item ids (derived from the `idProperty` config argument) to either a boolean value (for single expansion) or a `columnKey` value (for compound expansion). See [Unique Identifiers](#unique-identifiers) for more on `idProperty` and `columnKey`.

- Single or compound expansion is defined by the optional `expandableVariant` config argument which defaults to `"single"`.
- Expansion state is provided by `useExpansionState` or `useExpansionUrlParams`.
Expand Down

0 comments on commit 66a5fe8

Please sign in to comment.