alpha

DisclosureGroup

A DisclosureGroup is a grouping of related disclosures, sometimes called an Accordion. It supports both single and multiple expanded items.

install	`yarn add react-aria-components`
version	1.4.0
usage	`import {DisclosureGroup} from 'react-aria-components'`

View ARIA pattern

Under construction

This component is in alpha. More documentation is coming soon!

Example#

import {Button, UNSTABLE_Disclosure as Disclosure, UNSTABLE_DisclosureGroup as DisclosureGroup, UNSTABLE_DisclosurePanel as DisclosurePanel} from 'react-aria-components';

<DisclosureGroup defaultExpandedKeys={['personal']}>
  <Disclosure id="personal">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Personal Information
      </Button>
    </h3>
    <DisclosurePanel>
      <p>Personal information form here.</p>
    </DisclosurePanel>
  </Disclosure>
  <Disclosure id="billing">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Billing Address
      </Button>
    </h3>
    <DisclosurePanel>
      <p>Billing address form here.</p>
    </DisclosurePanel>
  </Disclosure>
</DisclosureGroup>

import {
  Button,
  UNSTABLE_Disclosure as Disclosure,
  UNSTABLE_DisclosureGroup as DisclosureGroup,
  UNSTABLE_DisclosurePanel as DisclosurePanel
} from 'react-aria-components';

<DisclosureGroup defaultExpandedKeys={['personal']}>
  <Disclosure id="personal">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Personal Information
      </Button>
    </h3>
    <DisclosurePanel>
      <p>Personal information form here.</p>
    </DisclosurePanel>
  </Disclosure>
  <Disclosure id="billing">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Billing Address
      </Button>
    </h3>
    <DisclosurePanel>
      <p>Billing address form here.</p>
    </DisclosurePanel>
  </Disclosure>
</DisclosureGroup>

import {
  Button,
  UNSTABLE_Disclosure
    as Disclosure,
  UNSTABLE_DisclosureGroup
    as DisclosureGroup,
  UNSTABLE_DisclosurePanel
    as DisclosurePanel
} from 'react-aria-components';

<DisclosureGroup
  defaultExpandedKeys={[
    'personal'
  ]}
>
  <Disclosure id="personal">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Personal
        Information
      </Button>
    </h3>
    <DisclosurePanel>
      <p>
        Personal
        information
        form here.
      </p>
    </DisclosurePanel>
  </Disclosure>
  <Disclosure id="billing">
    <h3>
      <Button slot="trigger">
        <svg viewBox="0 0 24 24">
          <path d="m8.25 4.5 7.5 7.5-7.5 7.5" />
        </svg>
        Billing Address
      </Button>
    </h3>
    <DisclosurePanel>
      <p>
        Billing address
        form here.
      </p>
    </DisclosurePanel>
  </Disclosure>
</DisclosureGroup>

Props#

DisclosureGroup#

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).
`children`	`ReactNode \| ( (values: DisclosureGroupRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: DisclosureGroupRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DisclosureGroupRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onExpandedChange`	`( (keys: Set<Key> )) => any`	Handler that is called when items are expanded or collapsed.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.

Disclosure#

Within a <DisclosureGroup>, most <Disclosure> props are set automatically. The id prop is required to identify the disclosure within the group.

Show props

Name	Type	Description
`children`	`ReactNode \| ( (values: DisclosureRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	The children of the component. A function may be provided to alter the children based on component state.
`id`	`Key`	An id for the disclosure when used within a DisclosureGroup, matching the id used in `expandedKeys`.
`isDisabled`	`boolean`	Whether the disclosure is disabled.
`isExpanded`	`boolean`	Whether the disclosure is expanded (controlled).
`defaultExpanded`	`boolean`	Whether the disclosure is expanded by default (uncontrolled).
`className`	`string \| ( (values: DisclosureRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DisclosureRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onExpandedChange`	`( (isExpanded: boolean )) => void`	Handler that is called when the disclosure's expanded state changes.

Layout

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Button#

Show props

Name	Type	Default	Description
`form`	`string`	—	The `<form>` element to associate the button with. The value of this attribute must be the id of a `<form>` in the same document.
`formAction`	`string`	—	The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.
`formEncType`	`string`	—	Indicates how to encode the form data that is submitted.
`formMethod`	`string`	—	Indicates the HTTP method used to submit the form.
`formNoValidate`	`boolean`	—	Indicates that the form is not to be validated when it is submitted.
`formTarget`	`string`	—	Overrides the target attribute of the button's form owner.
`name`	`string`	—	Submitted as a pair with the button's value as part of the form data.
`value`	`string`	—	The value associated with the button's name when it's submitted with the form data.
`isPending`	`boolean`	—	Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers.
`isDisabled`	`boolean`	—	Whether the button is disabled.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`type`	`'button' \| 'submit' \| 'reset'`	`'button'`	The behavior of the button when used in an HTML form.
`preventFocusOnPress`	`boolean`	—	Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
`children`	`ReactNode \| ( (values: ButtonRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: ButtonRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: ButtonRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	—	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onPress`	`( (e: PressEvent )) => void`	Handler that is called when the press is released over the target.
`onPressStart`	`( (e: PressEvent )) => void`	Handler that is called when a press interaction starts.
`onPressEnd`	`( (e: PressEvent )) => void`	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
`onPressChange`	`( (isPressed: boolean )) => void`	Handler that is called when the press state changes.
`onPressUp`	`( (e: PressEvent )) => void`	Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is released.
`onHoverStart`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction starts.
`onHoverEnd`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction ends.
`onHoverChange`	`( (isHovering: boolean )) => void`	Handler that is called when the hover state changes.

Layout

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.
`excludeFromTabOrder`	`boolean`	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`aria-expanded`	`boolean \| 'true' \| 'false'`	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`aria-haspopup`	`boolean \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog' \| 'true' \| 'false'`	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-controls`	`string`	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-pressed`	`boolean \| 'true' \| 'false' \| 'mixed'`	Indicates the current "pressed" state of toggle buttons.
`aria-label`	`string`	Defines a string value that labels the current element.
`aria-labelledby`	`string`	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	Identifies the element (or elements) that provide a detailed, extended description for the object.

DisclosurePanel#

Show props

Name	Type	Description
`children`	`ReactNode`	The children of the component.
`className`	`string \| ( (values: {} & & {defaultClassName: string \| \| undefined } )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: {} & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	The inline style for the element. A function may be provided to compute the style based on component state.

Accessibility

Name	Type	Default	Description
`role`	`'group' \| 'region'`	`'group'`	The accessibility role for the disclosure's panel.

Styling#

React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.

.react-aria-DisclosureGroup {
  /* ... */
}

.react-aria-DisclosureGroup {
  /* ... */
}

.react-aria-DisclosureGroup {
  /* ... */
}

A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.

<DisclosureGroup className="my-accordion">
  {/* ... */}
</DisclosureGroup>

<DisclosureGroup className="my-accordion">
  {/* ... */}
</DisclosureGroup>

<DisclosureGroup className="my-accordion">
  {/* ... */}
</DisclosureGroup>

In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using data attributes, which you can target in CSS selectors. For example:

.react-aria-DisclosureGroup[data-disabled] {
  /* ... */
}

.react-aria-DisclosureGroup[data-disabled] {
  /* ... */
}

.react-aria-DisclosureGroup[data-disabled] {
  /* ... */
}

The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.

<Disclosure
  className={({ isExpanded }) =>
    isExpanded ? 'border-blue-500' : 'border-gray-600'}
/>

<Disclosure
  className={({ isExpanded }) =>
    isExpanded ? 'border-blue-500' : 'border-gray-600'}
/>

<Disclosure
  className={(
    { isExpanded }
  ) =>
    isExpanded
      ? 'border-blue-500'
      : 'border-gray-600'}
/>

The states, selectors, and render props for each component used in a DisclosureGroup are documented below.

DisclosureGroup#

A DisclosureGroup can be targeted with the .react-aria-DisclosureGroup CSS selector, or by overriding with a custom className. It supports the following states:

Name	CSS Selector	Description
`isDisabled`	`[data-disabled]`	Whether the disclosure group is disabled.
`state`	`—`	State of the disclosure group.

Disclosure#

A Disclosure can be targeted with the .react-aria-Disclosure CSS selector, or by overriding with a custom className. It supports the following states:

Name	CSS Selector	Description
`isExpanded`	`[data-expanded]`	Whether the disclosure is expanded.
`isFocusVisibleWithin`	`[data-focus-visible-within]`	Whether the disclosure has keyboard focus.
`isDisabled`	`[data-disabled]`	Whether the disclosure is disabled.
`state`	`—`	State of the disclosure.

Button#

A Button can be targeted with the .react-aria-Button CSS selector, or by overriding with a custom className. It supports the following states:

Name	CSS Selector	Description
`isHovered`	`[data-hovered]`	Whether the button is currently hovered with a mouse.
`isPressed`	`[data-pressed]`	Whether the button is currently in a pressed state.
`isFocused`	`[data-focused]`	Whether the button is focused, either via a mouse or keyboard.
`isFocusVisible`	`[data-focus-visible]`	Whether the button is keyboard focused.
`isDisabled`	`[data-disabled]`	Whether the button is disabled.
`isPending`	`[data-pending]`	Whether the button is currently in a pending state.

DisclosurePanel#

A DisclosurePanel can be targeted with the .react-aria-DisclosurePanel CSS selector, or by overriding with a custom className.

Name	Type	Description
`isDisabled`	`boolean`	Whether the disclosure group is disabled.
`state`	`DisclosureGroupState`	State of the disclosure group.

Properties

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.

Methods

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.

string | number

Name	Type	Description
`isExpanded`	`boolean`	Whether the disclosure is expanded.
`isFocusVisibleWithin`	`boolean`	Whether the disclosure has keyboard focus.
`isDisabled`	`boolean`	Whether the disclosure is disabled.
`state`	`DisclosureState`	State of the disclosure.

Properties

Name	Type	Description
`isExpanded`	`boolean`	Whether the disclosure is currently expanded.

Methods

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.

Name	Type	Description
`isHovered`	`boolean`	Whether the button is currently hovered with a mouse.
`isPressed`	`boolean`	Whether the button is currently in a pressed state.
`isFocused`	`boolean`	Whether the button is focused, either via a mouse or keyboard.
`isFocusVisible`	`boolean`	Whether the button is keyboard focused.
`isDisabled`	`boolean`	Whether the button is disabled.
`isPending`	`boolean`	Whether the button is currently in a pending state.

Properties

Name	Type	Description
`type`	`'pressstart' \| 'pressend' \| 'pressup' \| 'press'`	The type of press event being fired.
`pointerType`	`PointerType`	The pointer type that triggered the press event.
`target`	`Element`	The target element of the press event.
`shiftKey`	`boolean`	Whether the shift keyboard modifier was held during the press event.
`ctrlKey`	`boolean`	Whether the ctrl keyboard modifier was held during the press event.
`metaKey`	`boolean`	Whether the meta keyboard modifier was held during the press event.
`altKey`	`boolean`	Whether the alt keyboard modifier was held during the press event.
`x`	`number`	X position relative to the target.
`y`	`number`	Y position relative to the target.

Methods

Method	Description
`continuePropagation(): void`	By default, press events stop propagation to parent elements. In cases where a handler decides not to handle a specific event, it can call `continuePropagation()` to allow a parent to handle it.

'mouse'
  | 'pen'
  | 'touch'
  | 'keyboard'
  | 'virtual'

BaseEvent<ReactKeyboardEvent<any>>

SyntheticEvent & {stopPropagation: () => void,
continuePropagation: () => void
}

Name	Type	Description
`type`	`'hoverstart' \| 'hoverend'`	The type of hover event being fired.
`pointerType`	`'mouse' \| 'pen'`	The pointer type that triggered the hover event.
`target`	`HTMLElement`	The target element of the hover event.