CollapseInterface

mode

modeTypes

Items expanded on load. The <code>position</code> prop needs to be set in the Collapse.Item as well.

defaultKeys

number[]

The callback that runs when the active collapse item is changing

onChange

(key: number) => void

Decides whether the Collapse is as an accordion (only one item can be open at a time) or not.

isAccordion

boolean

Decides whether the Collapse items are collapsed by default.

isCollapsedByDefault

HTMLAttributes

defaultChecked

defaultValue

string | number | readonly string[]

suppressContentEditableWarning

suppressHydrationWarning

accessKey

string

autoFocus

className

contentEditable

Booleanish | "inherit" | "plaintext-only"

contextMenu

draggable

Booleanish

hidden

lang

nonce

slot

spellCheck

style

CSSProperties

tabIndex

number

title

translate

"yes" | "no"

radioGroup

role

AriaRole

about

content

datatype

inlist

prefix

property

resource

typeof

vocab

autoCapitalize

autoCorrect

autoSave

color

itemProp

itemScope

itemType

itemID

itemRef

results

security

unselectable

"on" | "off"

Hints at the type of data that might be entered by the user while editing the element or its contents
@see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

inputMode

"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Specify that a standard HTML element should behave like a defined custom built-in element
@see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

AriaAttributes

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-activedescendant

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-atomic

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.

aria-autocomplete

"both" | "list" | "none" | "inline"

Defines a string value that labels the current element, which is intended to be converted into Braille.
@see aria-label.

aria-braillelabel

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
@see aria-roledescription.

aria-brailleroledescription

aria-busy

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
@see aria-pressed
@see aria-selected.

aria-checked

boolean | "true" | "false" | "mixed"

Defines the total number of columns in a table, grid, or treegrid.
@see aria-colindex.

aria-colcount

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
@see aria-colcount
@see aria-colspan.

aria-colindex

Defines a human readable text alternative of aria-colindex.
@see aria-rowindextext.

aria-colindextext

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
@see aria-colindex
@see aria-rowspan.

aria-colspan

Identifies the element (or elements) whose contents or presence are controlled by the current element.
@see aria-owns.

aria-controls

Indicates the element that represents the current item within a container or set of related elements.

aria-current

boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Identifies the element (or elements) that describes the object.
@see aria-labelledby

aria-describedby

Defines a string value that describes or annotates the current element.
@see related aria-describedby.

aria-description

Identifies the element that provides a detailed, extended description for the object.
@see aria-describedby.

aria-details

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
@see aria-hidden
@see aria-readonly.

aria-disabled

Indicates what functions can be performed when a dragged object is released on the drop target.
@deprecated in ARIA 1.1

aria-dropeffect

"link" | "none" | "copy" | "execute" | "move" | "popup"

Identifies the element that provides an error message for the object.
@see aria-invalid
@see aria-describedby.

aria-errormessage

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-expanded

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.

aria-flowto

Indicates an element's "grabbed" state in a drag-and-drop operation.
@deprecated in ARIA 1.1

aria-grabbed

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-haspopup

boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates whether the element is exposed to an accessibility API.
@see aria-disabled.

aria-hidden

Indicates the entered value does not conform to the format expected by the application.
@see aria-errormessage.

aria-invalid

boolean | "true" | "false" | "grammar" | "spelling"

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-keyshortcuts

Defines a string value that labels the current element.
@see aria-labelledby.

aria-label

Identifies the element (or elements) that labels the current element.
@see aria-describedby.

aria-labelledby

Defines the hierarchical level of an element within a structure.

aria-level

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-live

"off" | "assertive" | "polite"

Indicates whether an element is modal when displayed.

aria-modal

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiline

Indicates that the user may select more than one item from the current selectable descendants.

aria-multiselectable

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-orientation

"vertical" | "horizontal"

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
@see aria-controls.

aria-owns

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.

aria-placeholder

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
@see aria-setsize.

aria-posinset

Indicates the current "pressed" state of toggle buttons.
@see aria-checked
@see aria-selected.

aria-pressed

Indicates that the element is not editable, but is otherwise operable.
@see aria-disabled.

aria-readonly

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
@see aria-atomic.

aria-relevant

"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates that user input is required on the element before a form may be submitted.

aria-required

Defines a human-readable, author-localized description for the role of an element.

aria-roledescription

Defines the total number of rows in a table, grid, or treegrid.
@see aria-rowindex.

aria-rowcount

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
@see aria-rowcount
@see aria-rowspan.

aria-rowindex

Defines a human readable text alternative of aria-rowindex.
@see aria-colindextext.

aria-rowindextext

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
@see aria-rowindex
@see aria-colspan.

aria-rowspan

Indicates the current "selected" state of various widgets.
@see aria-checked
@see aria-pressed.

aria-selected


# Collapse

**A content area which can be collapsed and expanded.**<br />
The children of the Collapse component is [CollapseItem](/docs/user-guide/components/layout-and-navigation/collapse-item). <br />


<Demo storybookPath="components-collapse--collapse-story" />

## Usage

```tsx
<Collapse defaultKeys={[1]}>
  <Collapse.CollapseItem
    header={<div style={{ padding: 16 }}>Obi-Wan</div>}
    position={1}
  >
    <div style={{ padding: 16 }}>R2D2</div>
  </Collapse.CollapseItem>
  <Collapse.CollapseItem header="Qui-Gon" position={2}>
    You must learn the ways of the Force if youre to come with me to Alderaan.
  </Collapse.CollapseItem>
  <Collapse.CollapseItem header="Mace" position={3}>
    You must learn the ways of the Force if youre to come with me to Alderaan.
  </Collapse.CollapseItem>
</Collapse>
```

## Props

<Props />

### CollapseItem Props

| Name          | Type                      | Description                                                                                           | Default |
|:--------------|:--------------------------|:------------------------------------------------------------------------------------------------------|:--------|
| children      | React.ReactNode           | The content of the component                                                                          | -       |
| header        | ReactElement ǀ string     | The title of the CollapseItem                                                                         | -       |
| position      | number                    | The id of the Item. Its value is related with the values defined in the <code>defaultKeys</code> prop | -       |
| isCollapsible | boolean                   | true" description="Decides whether the item can collapse or not                                       | -       |
| onStateChange | (isOpen: boolean) => void | The callback that runs when the state is changing                                                     | -       |

## Types

- <code>CollapseInterface</code>: props of the <code>Collapse</code> component processed by stratus extended by <code>{`Omit<HTMLAttributes<HTMLDivElement>, 'onChange'>`}</code>

Read more about [types](/docs/user-guide/getting-started/types "Types") here

- [Card.Accordion](/docs/user-guide/components/layout-and-navigation/card/card-accordion "Accordion")


Collapse

#Usage

#Props

#CollapseItem Props

#Types