Overlays

Accordion

Accordion — `Accordion`, `Accordion.Item`, `Accordion.Trigger`, `Accordion.Content`.

Client component4 exportsSource

Import

import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@the_viveksingh/vivek-ui'

One panel at a time

Each trigger is a button inside a heading, which is what lets a screen reader list the sections and jump between them. collapsible allows closing the open one.

Yes. package.json has no dependencies field at all. react and react-dom are peers, and every utility the library needs is written in-house.

<Accordion defaultValue="deps" collapsible>
  <AccordionItem value="deps">
    <AccordionTrigger>Does it really have zero dependencies?</AccordionTrigger>
    <AccordionContent>Yes. There is no dependencies field in package.json.</AccordionContent>
  </AccordionItem>
  <AccordionItem value="styling">
    <AccordionTrigger>How do I override a style?</AccordionTrigger>
    <AccordionContent>Pass a className. Library selectors carry zero specificity.</AccordionContent>
  </AccordionItem>
</Accordion>

Several at once

type="multiple" changes value from string | null to string[]. The props are a union, so the wrong onValueChange signature does not compile.

Yes. package.json has no dependencies field at all. react and react-dom are peers, and every utility the library needs is written in-house.

Pass a className. Every library selector is wrapped in :where(), so it carries zero specificity and one flat class of yours always wins.

<Accordion type="multiple" defaultValue={['deps', 'styling']} variant="contained">
  {/* same items */}
</Accordion>

Props

Generated from the package's own type declarations, so this table cannot drift from the code.

Props for Accordion
PropTypeDefaultDescription
aboutstring——
accessKeystring——
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicBooleanish—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-autocomplete"none" | "list" | "inline" | "both"—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-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyBooleanish——
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledBooleanish—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"none" | "link" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedBooleanish—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—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-grabbedBooleanish—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenBooleanish—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—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-modalBooleanish—Indicates whether an element is modal when displayed.
aria-multilineBooleanish—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableBooleanish—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—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.
aria-placeholderstring—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-posinsetnumber—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.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyBooleanish—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredBooleanish—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedBooleanish—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize"off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {})——
autoCorrectstring——
autoFocusboolean——
autoSavestring——
childrenReactNode——
classNamestring——
colorstring——
contentstring——
contentEditableBooleanish | "inherit" | "plaintext-only"——
contextMenustring——
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }——
datatypestring——
defaultCheckedboolean——
dirstring——
draggableBooleanish——
enterKeyHint"enter" | "done" | "go" | "next" | "previous" | "search" | "send"——
exportpartsstring——
headingLevelHeadingLevel—Heading level for every trigger, `1`–`6`. Default `3`. There is no correct universal default — it depends entirely on what is above the accordion on the page — so set it to whatever keeps the document outline gap-free.
hiddenboolean——
idstring——
inertboolean——
inlistany——
inputMode"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring——
itemPropstring——
itemRefstring——
itemScopeboolean——
itemTypestring——
langstring——
noncestring——
onAbortReactEventHandler<HTMLDivElement>——
onAbortCaptureReactEventHandler<HTMLDivElement>——
onAnimationEndAnimationEventHandler<HTMLDivElement>——
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>——
onAnimationIterationAnimationEventHandler<HTMLDivElement>——
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>——
onAnimationStartAnimationEventHandler<HTMLDivElement>——
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>——
onAuxClickMouseEventHandler<HTMLDivElement>——
onAuxClickCaptureMouseEventHandler<HTMLDivElement>——
onBeforeInputInputEventHandler<HTMLDivElement>——
onBeforeInputCaptureInputEventHandler<HTMLDivElement>——
onBeforeToggleToggleEventHandler<HTMLDivElement>——
onBlurFocusEventHandler<HTMLDivElement>——
onBlurCaptureFocusEventHandler<HTMLDivElement>——
onCanPlayReactEventHandler<HTMLDivElement>——
onCanPlayCaptureReactEventHandler<HTMLDivElement>——
onCanPlayThroughReactEventHandler<HTMLDivElement>——
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>——
onChangeCaptureChangeEventHandler<HTMLDivElement, Element>——
onClickMouseEventHandler<HTMLDivElement>——
onClickCaptureMouseEventHandler<HTMLDivElement>——
onCompositionEndCompositionEventHandler<HTMLDivElement>——
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>——
onCompositionStartCompositionEventHandler<HTMLDivElement>——
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>——
onCompositionUpdateCompositionEventHandler<HTMLDivElement>——
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>——
onContextMenuMouseEventHandler<HTMLDivElement>——
onContextMenuCaptureMouseEventHandler<HTMLDivElement>——
onCopyClipboardEventHandler<HTMLDivElement>——
onCopyCaptureClipboardEventHandler<HTMLDivElement>——
onCutClipboardEventHandler<HTMLDivElement>——
onCutCaptureClipboardEventHandler<HTMLDivElement>——
onDoubleClickMouseEventHandler<HTMLDivElement>——
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>——
onDragDragEventHandler<HTMLDivElement>——
onDragCaptureDragEventHandler<HTMLDivElement>——
onDragEndDragEventHandler<HTMLDivElement>——
onDragEndCaptureDragEventHandler<HTMLDivElement>——
onDragEnterDragEventHandler<HTMLDivElement>——
onDragEnterCaptureDragEventHandler<HTMLDivElement>——
onDragExitDragEventHandler<HTMLDivElement>——
onDragExitCaptureDragEventHandler<HTMLDivElement>——
onDragLeaveDragEventHandler<HTMLDivElement>——
onDragLeaveCaptureDragEventHandler<HTMLDivElement>——
onDragOverDragEventHandler<HTMLDivElement>——
onDragOverCaptureDragEventHandler<HTMLDivElement>——
onDragStartDragEventHandler<HTMLDivElement>——
onDragStartCaptureDragEventHandler<HTMLDivElement>——
onDropDragEventHandler<HTMLDivElement>——
onDropCaptureDragEventHandler<HTMLDivElement>——
onDurationChangeReactEventHandler<HTMLDivElement>——
onDurationChangeCaptureReactEventHandler<HTMLDivElement>——
onEmptiedReactEventHandler<HTMLDivElement>——
onEmptiedCaptureReactEventHandler<HTMLDivElement>——
onEncryptedReactEventHandler<HTMLDivElement>——
onEncryptedCaptureReactEventHandler<HTMLDivElement>——
onEndedReactEventHandler<HTMLDivElement>——
onEndedCaptureReactEventHandler<HTMLDivElement>——
onErrorReactEventHandler<HTMLDivElement>——
onErrorCaptureReactEventHandler<HTMLDivElement>——
onFocusFocusEventHandler<HTMLDivElement>——
onFocusCaptureFocusEventHandler<HTMLDivElement>——
onGotPointerCapturePointerEventHandler<HTMLDivElement>——
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>——
onInputInputEventHandler<HTMLDivElement>——
onInputCaptureInputEventHandler<HTMLDivElement>——
onInvalidReactEventHandler<HTMLDivElement>——
onInvalidCaptureReactEventHandler<HTMLDivElement>——
onKeyDownKeyboardEventHandler<HTMLDivElement>——
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>——
onKeyPressKeyboardEventHandler<HTMLDivElement>——
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>——
onKeyUpKeyboardEventHandler<HTMLDivElement>——
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>——
onLoadReactEventHandler<HTMLDivElement>——
onLoadCaptureReactEventHandler<HTMLDivElement>——
onLoadedDataReactEventHandler<HTMLDivElement>——
onLoadedDataCaptureReactEventHandler<HTMLDivElement>——
onLoadedMetadataReactEventHandler<HTMLDivElement>——
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>——
onLoadStartReactEventHandler<HTMLDivElement>——
onLoadStartCaptureReactEventHandler<HTMLDivElement>——
onLostPointerCapturePointerEventHandler<HTMLDivElement>——
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>——
onMouseDownMouseEventHandler<HTMLDivElement>——
onMouseDownCaptureMouseEventHandler<HTMLDivElement>——
onMouseEnterMouseEventHandler<HTMLDivElement>——
onMouseLeaveMouseEventHandler<HTMLDivElement>——
onMouseMoveMouseEventHandler<HTMLDivElement>——
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>——
onMouseOutMouseEventHandler<HTMLDivElement>——
onMouseOutCaptureMouseEventHandler<HTMLDivElement>——
onMouseOverMouseEventHandler<HTMLDivElement>——
onMouseOverCaptureMouseEventHandler<HTMLDivElement>——
onMouseUpMouseEventHandler<HTMLDivElement>——
onMouseUpCaptureMouseEventHandler<HTMLDivElement>——
onPasteClipboardEventHandler<HTMLDivElement>——
onPasteCaptureClipboardEventHandler<HTMLDivElement>——
onPauseReactEventHandler<HTMLDivElement>——
onPauseCaptureReactEventHandler<HTMLDivElement>——
onPlayReactEventHandler<HTMLDivElement>——
onPlayCaptureReactEventHandler<HTMLDivElement>——
onPlayingReactEventHandler<HTMLDivElement>——
onPlayingCaptureReactEventHandler<HTMLDivElement>——
onPointerCancelPointerEventHandler<HTMLDivElement>——
onPointerCancelCapturePointerEventHandler<HTMLDivElement>——
onPointerDownPointerEventHandler<HTMLDivElement>——
onPointerDownCapturePointerEventHandler<HTMLDivElement>——
onPointerEnterPointerEventHandler<HTMLDivElement>——
onPointerLeavePointerEventHandler<HTMLDivElement>——
onPointerMovePointerEventHandler<HTMLDivElement>——
onPointerMoveCapturePointerEventHandler<HTMLDivElement>——
onPointerOutPointerEventHandler<HTMLDivElement>——
onPointerOutCapturePointerEventHandler<HTMLDivElement>——
onPointerOverPointerEventHandler<HTMLDivElement>——
onPointerOverCapturePointerEventHandler<HTMLDivElement>——
onPointerUpPointerEventHandler<HTMLDivElement>——
onPointerUpCapturePointerEventHandler<HTMLDivElement>——
onProgressReactEventHandler<HTMLDivElement>——
onProgressCaptureReactEventHandler<HTMLDivElement>——
onRateChangeReactEventHandler<HTMLDivElement>——
onRateChangeCaptureReactEventHandler<HTMLDivElement>——
onResetReactEventHandler<HTMLDivElement>——
onResetCaptureReactEventHandler<HTMLDivElement>——
onScrollUIEventHandler<HTMLDivElement>——
onScrollCaptureUIEventHandler<HTMLDivElement>——
onScrollEndUIEventHandler<HTMLDivElement>——
onScrollEndCaptureUIEventHandler<HTMLDivElement>——
onSeekedReactEventHandler<HTMLDivElement>——
onSeekedCaptureReactEventHandler<HTMLDivElement>——
onSeekingReactEventHandler<HTMLDivElement>——
onSeekingCaptureReactEventHandler<HTMLDivElement>——
onSelectReactEventHandler<HTMLDivElement>——
onSelectCaptureReactEventHandler<HTMLDivElement>——
onStalledReactEventHandler<HTMLDivElement>——
onStalledCaptureReactEventHandler<HTMLDivElement>——
onSubmitSubmitEventHandler<HTMLDivElement>——
onSubmitCaptureSubmitEventHandler<HTMLDivElement>——
onSuspendReactEventHandler<HTMLDivElement>——
onSuspendCaptureReactEventHandler<HTMLDivElement>——
onTimeUpdateReactEventHandler<HTMLDivElement>——
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>——
onToggleToggleEventHandler<HTMLDivElement>——
onTouchCancelTouchEventHandler<HTMLDivElement>——
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>——
onTouchEndTouchEventHandler<HTMLDivElement>——
onTouchEndCaptureTouchEventHandler<HTMLDivElement>——
onTouchMoveTouchEventHandler<HTMLDivElement>——
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>——
onTouchStartTouchEventHandler<HTMLDivElement>——
onTouchStartCaptureTouchEventHandler<HTMLDivElement>——
onTransitionCancelTransitionEventHandler<HTMLDivElement>——
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>——
onTransitionEndTransitionEventHandler<HTMLDivElement>——
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>——
onTransitionRunTransitionEventHandler<HTMLDivElement>——
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>——
onTransitionStartTransitionEventHandler<HTMLDivElement>——
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>——
onVolumeChangeReactEventHandler<HTMLDivElement>——
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>——
onWaitingReactEventHandler<HTMLDivElement>——
onWaitingCaptureReactEventHandler<HTMLDivElement>——
onWheelWheelEventHandler<HTMLDivElement>——
onWheelCaptureWheelEventHandler<HTMLDivElement>——
partstring——
popover"" | "auto" | "manual" | "hint"——
popoverTargetstring——
popoverTargetAction"toggle" | "show" | "hide"——
prefixstring——
propertystring——
radioGroupstring——
relstring——
resourcestring——
resultsnumber——
revstring——
roleAriaRole——
securitystring——
sizeAccordionSize——
slotstring——
spellCheckBooleanish——
styleCSSProperties——
suppressContentEditableWarningboolean——
suppressHydrationWarningboolean——
tabIndexnumber——
titlestring——
translate"yes" | "no"——
typeofstring——
unselectable"off" | "on"——
variantAccordionVariant——
vocabstring——

Variant 1

Additional props when the component is used in this form.

Accordion props, variant 1
PropTypeDefaultDescription
collapsibleboolean—Whether clicking the open item closes it, leaving nothing open. Default `false` — an accordion that can empty itself is a choice, not an accident.
defaultValuestring—Uncontrolled initial open item.
onValueChange(value: string) => void——
type"single"—One item open at a time. The default.
valuestring—Controlled: the open item's value, or `null` for none.

Variant 2

Additional props when the component is used in this form.

Accordion props, variant 2
PropTypeDefaultDescription
collapsiblenever—Meaningless here: every item is always closable in `multiple` mode.
defaultValuestring[]—Uncontrolled initial open items.
onValueChange(value: string[]) => void——
type required"multiple"—Any number of items open at once.
valuestring[]—Controlled: the values of every open item.

Every remaining prop is spread onto the root element, so all standard HTML and ARIA attributes work. className and style are merged with the library's own, never replaced, and the ref forwards to the root DOM node.

Exports

AccordionAccordionContentAccordionItemAccordionTrigger

Rendering