Manages state for a disclosure widget. Tracks whether the disclosure is expanded, and provides methods to toggle this state.
| install | yarn add @react-stately/disclosure |
|---|---|
| version | 3.0.0-alpha.0 |
| usage | import {useDisclosureState} from '@react-stately/disclosure' |
useDisclosureState(
(props: DisclosureProps
)): DisclosureState
See the docs for useDisclosure in react-aria for an example of useDisclosureState.
| Name | Type | Description |
isExpanded | boolean | Whether the disclosure is expanded (controlled). |
defaultExpanded | boolean | Whether the disclosure is expanded by default (uncontrolled). |
onExpandedChange | (
(isExpanded: boolean
)) => void | Handler that is called when the disclosure expanded state changes. |
| Name | Type | Description |
isExpanded | boolean | Whether the disclosure is currently expanded. |
| Method | Description |
setExpanded(
(isExpanded: boolean
)): void | Sets whether the disclosure is expanded. |
expand(): void | Expand the disclosure. |
collapse(): void | Collapse the disclosure. |
toggle(): void | Toggles the disclosure's visibility. |