Manages state for a group of disclosures, e.g. an accordion. It supports both single and multiple expanded items.
| install | yarn add @react-stately/disclosure |
|---|---|
| version | 3.0.0-alpha.0 |
| usage | import {useDisclosureGroupState} from '@react-stately/disclosure' |
useDisclosureGroupState(
(props: DisclosureGroupProps
)): DisclosureGroupState
See the docs for useDisclosure in react-aria for an example of useDisclosureGroupState.
| Name | Type | Description |
allowsMultipleExpanded | boolean | Whether multiple items can be expanded at the same time. |
isDisabled | boolean | Whether all items are disabled. |
expandedKeys | Iterable<Key> | The currently expanded keys in the collection (controlled). |
defaultExpandedKeys | Iterable<Key> | The initial expanded keys in the collection (uncontrolled). |
onExpandedChange | (
(keys: Set<Key>
)) => any | Handler that is called when items are expanded or collapsed. |
| Name | Type | Description |
allowsMultipleExpanded | boolean | Whether multiple items can be expanded at the same time. |
isDisabled | boolean | Whether all items are disabled. |
expandedKeys | Set<Key> | A set of keys for items that are expanded. |
| Method | Description |
toggleKey(
(key: Key
)): void | Toggles the expanded state for an item by its key. |
setExpandedKeys(
(keys: Set<Key>
)): void | Replaces the set of expanded keys. |