Robin Malfait
00cc8c50e3
* add Alert component * expose Alert * rename forgotten FLYOUT to POPOVER * use PopoverRenderPropArg * organize imports in a consistent way * ensure Portals behave as expected Portals can be nested from a React perspective, however in the DOM they are rendered as siblings, this is mostly fine. However, when they are rendered inside a Dialog, the Dialog itself is marked with `role="modal"` which makes all the other content inert. This means that rendering Menu.Items in a Portal or an Alert in a portal makes it non-interactable. Alerts are not even announced. To fix this, we ensure that we make the `root` of the Portal the actual dialog. This allows you to still interact with it, because an open modal is the "root" for the assistive technology. But there is a catch, a Dialog in a Dialog *can* render as a sibling, because you force the focus into the new Dialog. So we also ensured that Dialogs are always rendered in the portal root, and not inside another Dialog. * add dialog with alert example * add internal Description component * add internal Label component * add RadioGroup component * expose RadioGroup * add RadioGroup example * ensure to include tha RadioGroup.Option own id * update changelog * split documentation
2.8 KiB
2.8 KiB
Disclosure
A component for showing/hiding content.
Installation
# npm
npm install @headlessui/react
# Yarn
yarn add @headlessui/react
Basic example
<Disclosure>
<Disclosure.Button>Toggle</Disclosure.Button>
<Disclosure.Panel>Contents</Disclosure.Panel>
</Disclosure>
Component API
Disclosure
<Disclosure>
<Disclosure.Button>Toggle</Disclosure.Button>
<Disclosure.Panel>Contents</Disclosure.Panel>
</Disclosure>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
as |
String | Component | React.Fragment (no wrapper element) |
The element or component the Disclosure should render as. |
Render prop object
| Prop | Type | Description |
|---|---|---|
open |
Boolean | Whether or not the disclosure is open. |
Disclosure.Button
Props
| Prop | Type | Default | Description |
|---|---|---|---|
as |
String | Component | button |
The element or component the Disclosure.Button should render as. |
Render prop object
| Prop | Type | Description |
|---|---|---|
open |
Boolean | Whether or not the disclosure is open. |
Disclosure.Panel
Props
| Prop | Type | Default | Description |
|---|---|---|---|
as |
String | Component | div |
The element or component the Disclosure.Panel should render as. |
static |
Boolean | false |
Whether the element should ignore the internally managed open/closed state. |
unmount |
Boolean | true |
Whether the element should be unmounted or hidden based on the open/closed state. |
Note
:
staticandunmountcan not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
| Prop | Type | Description |
|---|---|---|
open |
Boolean | Whether or not the disclosure is open. |