SideNavigation

Props

API reference for SideNavigation. For usage examples, see the React tab.

SideNavigation

Name	Type	Default
aria-label (required)	`string`
Accessible label applied to the side navigation panel and nested navigation landmark.
children (required)	`ReactNode`
Content rendered next to the side navigation panel.
items (required)	`SideNavigationDataItem[]`
Navigation item and section data rendered inside the side panel.
about	`string`
accessKey	`string`
autoSave	`string`
closeOnNavigate	`"mobile" \| boolean`	`"mobile"`
Closes the panel after a navigation item is pressed. Defaults to closing on mobile viewports only.
color	`string`
content	`string`
contentAriaLabel	`string`
Accessible label for the content landmark when needed.
contentAs	`PanelInsetElement`	`"main"`
Element rendered for the content area.
contextMenu	`string`
currentKey	`Key`
Key of the current item. Used to apply the current page state.
dangerouslySetInnerHTML	`{ __html: string \| TrustedHTML; }`
datatype	`string`
defaultChecked	`boolean`
defaultOpen	`boolean`	`true`
Initial open state when uncontrolled. Note: On mobile viewports the panel renders as an overlay drawer, so `defaultOpen={true}` will show the drawer immediately on load. Consider using controlled `open` state with a responsive check if this is not desired.
disableKeyboardShortcut	`boolean`	`false`
Disable the keyboard shortcut for toggling the panel.
exportparts	`string`
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab)
footer	`ReactNode`
Optional panel footer content.
header	`ReactNode`
Optional content rendered in the panel header.
inlist	`any`
inputMode	`"decimal" \| "email" \| "none" \| "numeric" \| "search" \| "tel" \| "text" \| "url"`
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 (opens in new tab)
itemID	`string`
itemProp	`string`
itemRef	`string`
itemScope	`boolean`
itemType	`string`
keyboardShortcut	`string`	`"b"`
Keyboard shortcut key (used with Cmd/Ctrl modifier).
layout	`PanelLayout`	`"viewport"`
Layout mode of the panel. Use `viewport` for application shells and `contained` for bounded regions.
open	`boolean`
Controlled open state. When provided, component becomes controlled.
part	`string`
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab)
prefix	`string`
property	`string`
radioGroup	`string`
rel	`string`
resource	`string`
results	`number`
rev	`string`
security	`string`
side	`PanelSide`	`"left"`
Which side to position the panel.
typeof	`string`
unselectable	`"off" \| "on"`
vocab	`string`

Name	Type	Default
aria-activedescendant	`string`
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic	`Booleanish`
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	`"both" \| "inline" \| "list" \| "none"`
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-braillelabel	`string`
Defines a string value that labels the current element, which is intended to be converted into Braille. See: aria-label.
aria-brailleroledescription	`string`
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-busy	`Booleanish`
aria-checked	`"false" \| "mixed" \| "true" \| boolean`
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed aria-selected.
aria-colcount	`number`
Defines the total number of columns in a table, grid, or treegrid. See: aria-colindex.
aria-colindex	`number`
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 aria-colspan.
aria-colindextext	`string`
Defines a human readable text alternative of aria-colindex. See: aria-rowindextext.
aria-colspan	`number`
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. See: aria-colindex aria-rowspan.
aria-controls	`string`
Identifies the element (or elements) whose contents or presence are controlled by the current element. See: aria-owns.
aria-current	`"date" \| "false" \| "location" \| "page" \| "step" \| "time" \| "true" \| boolean`
Indicates the element that represents the current item within a container or set of related elements.
aria-describedby	`string`
Identifies the element (or elements) that describes the object. See: aria-labelledby
aria-description	`string`
Defines a string value that describes or annotates the current element. See: related aria-describedby.
aria-details	`string`
Identifies the element that provides a detailed, extended description for the object. See: aria-describedby.
aria-disabled	`Booleanish`
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See: aria-hidden aria-readonly.
aria-errormessage	`string`
Identifies the element that provides an error message for the object. See: aria-invalid aria-describedby.
aria-expanded	`Booleanish`
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto	`string`
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-haspopup	`"dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden	`Booleanish`
Indicates whether the element is exposed to an accessibility API. See: aria-disabled.
aria-invalid	`"false" \| "grammar" \| "spelling" \| "true" \| boolean`
Indicates the entered value does not conform to the format expected by the application. See: aria-errormessage.
aria-keyshortcuts	`string`
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelledby	`string`
Identifies the element (or elements) that labels the current element. See: aria-describedby.
aria-level	`number`
Defines the hierarchical level of an element within a structure.
aria-live	`"assertive" \| "off" \| "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-modal	`Booleanish`
Indicates whether an element is modal when displayed.
aria-multiline	`Booleanish`
Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable	`Booleanish`
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-owns	`string`
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-placeholder	`string`
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-posinset	`number`
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-pressed	`"false" \| "mixed" \| "true" \| boolean`
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected.
aria-readonly	`Booleanish`
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled.
aria-relevant	`"additions" \| "additions removals" \| "additions text" \| "all" \| "removals" \| "removals additions" \| "removals text" \| "text" \| "text additions" \| "text removals"`
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See: aria-atomic.
aria-required	`Booleanish`
Indicates that user input is required on the element before a form may be submitted.
aria-roledescription	`string`
Defines a human-readable, author-localized description for the role of an element.
aria-rowcount	`number`
Defines the total number of rows in a table, grid, or treegrid. See: aria-rowindex.
aria-rowindex	`number`
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 aria-rowspan.
aria-rowindextext	`string`
Defines a human readable text alternative of aria-rowindex. See: aria-colindextext.
aria-rowspan	`number`
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. See: aria-rowindex aria-colspan.
aria-selected	`Booleanish`
Indicates the current "selected" state of various widgets. See: aria-checked aria-pressed.
aria-setsize	`number`
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. See: aria-posinset.
aria-sort	`"ascending" \| "descending" \| "none" \| "other"`
Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax	`number`
Defines the maximum allowed value for a range widget.
aria-valuemin	`number`
Defines the minimum allowed value for a range widget.
aria-valuenow	`number`
Defines the current value for a range widget. See: aria-valuetext.
aria-valuetext	`string`
Defines the human readable text alternative of aria-valuenow for a range widget.
id	`string`
role	`AriaRole`
aria-dropeffectDeprecated	`"copy" \| "execute" \| "link" \| "move" \| "none" \| "popup"`
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1
aria-grabbedDeprecated	`Booleanish`
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1

Name	Type	Default
autoCapitalize	`"characters" \| "none" \| "off" \| "on" \| "sentences" \| "words" \| (string & {})`
autoCorrect	`string`
autoFocus	`boolean`
contentEditable	`"inherit" \| "plaintext-only" \| Booleanish`
dir	`string`
draggable	`Booleanish`
enterKeyHint	`"done" \| "enter" \| "go" \| "next" \| "previous" \| "search" \| "send"`
hidden	`boolean`
inert	`boolean`
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
is	`string`
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 (opens in new tab)
key	`Key \| null`
lang	`string`
nonce	`string`
popover	`"" \| "auto" \| "hint" \| "manual"`
popoverTarget	`string`
popoverTargetAction	`"hide" \| "show" \| "toggle"`
ref	`Ref<HTMLDivElement>`
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). See: React Docs (opens in new tab)
slot	`string`
spellCheck	`Booleanish`
suppressContentEditableWarning	`boolean`
suppressHydrationWarning	`boolean`
tabIndex	`number`
translate	`"no" \| "yes"`

Name	Type	Default
onAbort	`ReactEventHandler<HTMLDivElement>`
onAbortCapture	`ReactEventHandler<HTMLDivElement>`
onAnimationEnd	`AnimationEventHandler<HTMLDivElement>`
onAnimationEndCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationIteration	`AnimationEventHandler<HTMLDivElement>`
onAnimationIterationCapture	`AnimationEventHandler<HTMLDivElement>`
onAnimationStart	`AnimationEventHandler<HTMLDivElement>`
onAnimationStartCapture	`AnimationEventHandler<HTMLDivElement>`
onAuxClick	`MouseEventHandler<HTMLDivElement>`
onAuxClickCapture	`MouseEventHandler<HTMLDivElement>`
onBeforeInput	`InputEventHandler<HTMLDivElement>`
onBeforeInputCapture	`FormEventHandler<HTMLDivElement>`
onBeforeToggle	`ToggleEventHandler<HTMLDivElement>`
onBlur	`FocusEventHandler<HTMLDivElement>`
onBlurCapture	`FocusEventHandler<HTMLDivElement>`
onCanPlay	`ReactEventHandler<HTMLDivElement>`
onCanPlayCapture	`ReactEventHandler<HTMLDivElement>`
onCanPlayThrough	`ReactEventHandler<HTMLDivElement>`
onCanPlayThroughCapture	`ReactEventHandler<HTMLDivElement>`
onChange	`FormEventHandler<HTMLDivElement>`
onChangeCapture	`FormEventHandler<HTMLDivElement>`
onClick	`MouseEventHandler<HTMLDivElement>`
onClickCapture	`MouseEventHandler<HTMLDivElement>`
onCompositionEnd	`CompositionEventHandler<HTMLDivElement>`
onCompositionEndCapture	`CompositionEventHandler<HTMLDivElement>`
onCompositionStart	`CompositionEventHandler<HTMLDivElement>`
onCompositionStartCapture	`CompositionEventHandler<HTMLDivElement>`
onCompositionUpdate	`CompositionEventHandler<HTMLDivElement>`
onCompositionUpdateCapture	`CompositionEventHandler<HTMLDivElement>`
onContextMenu	`MouseEventHandler<HTMLDivElement>`
onContextMenuCapture	`MouseEventHandler<HTMLDivElement>`
onCopy	`ClipboardEventHandler<HTMLDivElement>`
onCopyCapture	`ClipboardEventHandler<HTMLDivElement>`
onCut	`ClipboardEventHandler<HTMLDivElement>`
onCutCapture	`ClipboardEventHandler<HTMLDivElement>`
onDoubleClick	`MouseEventHandler<HTMLDivElement>`
onDoubleClickCapture	`MouseEventHandler<HTMLDivElement>`
onDrag	`DragEventHandler<HTMLDivElement>`
onDragCapture	`DragEventHandler<HTMLDivElement>`
onDragEnd	`DragEventHandler<HTMLDivElement>`
onDragEndCapture	`DragEventHandler<HTMLDivElement>`
onDragEnter	`DragEventHandler<HTMLDivElement>`
onDragEnterCapture	`DragEventHandler<HTMLDivElement>`
onDragExit	`DragEventHandler<HTMLDivElement>`
onDragExitCapture	`DragEventHandler<HTMLDivElement>`
onDragLeave	`DragEventHandler<HTMLDivElement>`
onDragLeaveCapture	`DragEventHandler<HTMLDivElement>`
onDragOver	`DragEventHandler<HTMLDivElement>`
onDragOverCapture	`DragEventHandler<HTMLDivElement>`
onDragStart	`DragEventHandler<HTMLDivElement>`
onDragStartCapture	`DragEventHandler<HTMLDivElement>`
onDrop	`DragEventHandler<HTMLDivElement>`
onDropCapture	`DragEventHandler<HTMLDivElement>`
onDurationChange	`ReactEventHandler<HTMLDivElement>`
onDurationChangeCapture	`ReactEventHandler<HTMLDivElement>`
onEmptied	`ReactEventHandler<HTMLDivElement>`
onEmptiedCapture	`ReactEventHandler<HTMLDivElement>`
onEncrypted	`ReactEventHandler<HTMLDivElement>`
onEncryptedCapture	`ReactEventHandler<HTMLDivElement>`
onEnded	`ReactEventHandler<HTMLDivElement>`
onEndedCapture	`ReactEventHandler<HTMLDivElement>`
onError	`ReactEventHandler<HTMLDivElement>`
onErrorCapture	`ReactEventHandler<HTMLDivElement>`
onFocus	`FocusEventHandler<HTMLDivElement>`
onFocusCapture	`FocusEventHandler<HTMLDivElement>`
onGotPointerCapture	`PointerEventHandler<HTMLDivElement>`
onGotPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onInput	`FormEventHandler<HTMLDivElement>`
onInputCapture	`FormEventHandler<HTMLDivElement>`
onInvalid	`FormEventHandler<HTMLDivElement>`
onInvalidCapture	`FormEventHandler<HTMLDivElement>`
onItemPress	`((key: Key) => void)`
Called with an item's key when a data-driven navigation item is pressed.
onKeyDown	`KeyboardEventHandler<HTMLDivElement>`
onKeyDownCapture	`KeyboardEventHandler<HTMLDivElement>`
onKeyUp	`KeyboardEventHandler<HTMLDivElement>`
onKeyUpCapture	`KeyboardEventHandler<HTMLDivElement>`
onLoad	`ReactEventHandler<HTMLDivElement>`
onLoadCapture	`ReactEventHandler<HTMLDivElement>`
onLoadedData	`ReactEventHandler<HTMLDivElement>`
onLoadedDataCapture	`ReactEventHandler<HTMLDivElement>`
onLoadedMetadata	`ReactEventHandler<HTMLDivElement>`
onLoadedMetadataCapture	`ReactEventHandler<HTMLDivElement>`
onLoadStart	`ReactEventHandler<HTMLDivElement>`
onLoadStartCapture	`ReactEventHandler<HTMLDivElement>`
onLostPointerCapture	`PointerEventHandler<HTMLDivElement>`
onLostPointerCaptureCapture	`PointerEventHandler<HTMLDivElement>`
onMouseDown	`MouseEventHandler<HTMLDivElement>`
onMouseDownCapture	`MouseEventHandler<HTMLDivElement>`
onMouseEnter	`MouseEventHandler<HTMLDivElement>`
onMouseLeave	`MouseEventHandler<HTMLDivElement>`
onMouseMove	`MouseEventHandler<HTMLDivElement>`
onMouseMoveCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOut	`MouseEventHandler<HTMLDivElement>`
onMouseOutCapture	`MouseEventHandler<HTMLDivElement>`
onMouseOver	`MouseEventHandler<HTMLDivElement>`
onMouseOverCapture	`MouseEventHandler<HTMLDivElement>`
onMouseUp	`MouseEventHandler<HTMLDivElement>`
onMouseUpCapture	`MouseEventHandler<HTMLDivElement>`
onOpenChange	`((open: boolean) => void)`
Callback when open state changes. Required for controlled usage.
onPaste	`ClipboardEventHandler<HTMLDivElement>`
onPasteCapture	`ClipboardEventHandler<HTMLDivElement>`
onPause	`ReactEventHandler<HTMLDivElement>`
onPauseCapture	`ReactEventHandler<HTMLDivElement>`
onPlay	`ReactEventHandler<HTMLDivElement>`
onPlayCapture	`ReactEventHandler<HTMLDivElement>`
onPlaying	`ReactEventHandler<HTMLDivElement>`
onPlayingCapture	`ReactEventHandler<HTMLDivElement>`
onPointerCancel	`PointerEventHandler<HTMLDivElement>`
onPointerCancelCapture	`PointerEventHandler<HTMLDivElement>`
onPointerDown	`PointerEventHandler<HTMLDivElement>`
onPointerDownCapture	`PointerEventHandler<HTMLDivElement>`
onPointerEnter	`PointerEventHandler<HTMLDivElement>`
onPointerLeave	`PointerEventHandler<HTMLDivElement>`
onPointerMove	`PointerEventHandler<HTMLDivElement>`
onPointerMoveCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOut	`PointerEventHandler<HTMLDivElement>`
onPointerOutCapture	`PointerEventHandler<HTMLDivElement>`
onPointerOver	`PointerEventHandler<HTMLDivElement>`
onPointerOverCapture	`PointerEventHandler<HTMLDivElement>`
onPointerUp	`PointerEventHandler<HTMLDivElement>`
onPointerUpCapture	`PointerEventHandler<HTMLDivElement>`
onProgress	`ReactEventHandler<HTMLDivElement>`
onProgressCapture	`ReactEventHandler<HTMLDivElement>`
onRateChange	`ReactEventHandler<HTMLDivElement>`
onRateChangeCapture	`ReactEventHandler<HTMLDivElement>`
onReset	`FormEventHandler<HTMLDivElement>`
onResetCapture	`FormEventHandler<HTMLDivElement>`
onScroll	`UIEventHandler<HTMLDivElement>`
onScrollCapture	`UIEventHandler<HTMLDivElement>`
onScrollEnd	`UIEventHandler<HTMLDivElement>`
onScrollEndCapture	`UIEventHandler<HTMLDivElement>`
onSeeked	`ReactEventHandler<HTMLDivElement>`
onSeekedCapture	`ReactEventHandler<HTMLDivElement>`
onSeeking	`ReactEventHandler<HTMLDivElement>`
onSeekingCapture	`ReactEventHandler<HTMLDivElement>`
onSelect	`ReactEventHandler<HTMLDivElement>`
onSelectCapture	`ReactEventHandler<HTMLDivElement>`
onStalled	`ReactEventHandler<HTMLDivElement>`
onStalledCapture	`ReactEventHandler<HTMLDivElement>`
onSubmit	`FormEventHandler<HTMLDivElement>`
onSubmitCapture	`FormEventHandler<HTMLDivElement>`
onSuspend	`ReactEventHandler<HTMLDivElement>`
onSuspendCapture	`ReactEventHandler<HTMLDivElement>`
onTimeUpdate	`ReactEventHandler<HTMLDivElement>`
onTimeUpdateCapture	`ReactEventHandler<HTMLDivElement>`
onToggle	`ToggleEventHandler<HTMLDivElement>`
onTouchCancel	`TouchEventHandler<HTMLDivElement>`
onTouchCancelCapture	`TouchEventHandler<HTMLDivElement>`
onTouchEnd	`TouchEventHandler<HTMLDivElement>`
onTouchEndCapture	`TouchEventHandler<HTMLDivElement>`
onTouchMove	`TouchEventHandler<HTMLDivElement>`
onTouchMoveCapture	`TouchEventHandler<HTMLDivElement>`
onTouchStart	`TouchEventHandler<HTMLDivElement>`
onTouchStartCapture	`TouchEventHandler<HTMLDivElement>`
onTransitionCancel	`TransitionEventHandler<HTMLDivElement>`
onTransitionCancelCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionEnd	`TransitionEventHandler<HTMLDivElement>`
onTransitionEndCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionRun	`TransitionEventHandler<HTMLDivElement>`
onTransitionRunCapture	`TransitionEventHandler<HTMLDivElement>`
onTransitionStart	`TransitionEventHandler<HTMLDivElement>`
onTransitionStartCapture	`TransitionEventHandler<HTMLDivElement>`
onVolumeChange	`ReactEventHandler<HTMLDivElement>`
onVolumeChangeCapture	`ReactEventHandler<HTMLDivElement>`
onWaiting	`ReactEventHandler<HTMLDivElement>`
onWaitingCapture	`ReactEventHandler<HTMLDivElement>`
onWheel	`WheelEventHandler<HTMLDivElement>`
onWheelCapture	`WheelEventHandler<HTMLDivElement>`
onKeyPressDeprecated	`KeyboardEventHandler<HTMLDivElement>`
Use `onKeyUp` or `onKeyDown` instead
onKeyPressCaptureDeprecated	`KeyboardEventHandler<HTMLDivElement>`
Use `onKeyUpCapture` or `onKeyDownCapture` instead

Name	Type	Default
defaultValue	`string \| number \| readonly string[]`

Name	Type	Default
className	`string`
style	`CSSProperties`

SideNavigation.Trigger

Name	Type	Default
children	`ChildrenOrFunction<ButtonRenderProps>`
The children of the component. A function may be provided to alter the children based on component state.
isDisabled	`boolean`
Whether the button is disabled.
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.

Name	Type	Default
aria-controls	`string`
Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-current	`"date" \| "false" \| "location" \| "page" \| "step" \| "time" \| "true" \| boolean`
Indicates whether this element represents the current item within a container or set of related elements.
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.
aria-disabled	`"false" \| "true" \| boolean`
Indicates whether the element is disabled to users of assistive technology.
aria-expanded	`"false" \| "true" \| boolean`
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-haspopup	`"dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
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-pressed	`"false" \| "mixed" \| "true" \| boolean`
Indicates the current "pressed" state of toggle buttons.
id	`string`
The element's unique identifier. See MDN (opens in new tab).

Name	Type	Default
autoFocus	`boolean`
Whether the element should receive focus on render.
dir	`string`
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.
hidden	`boolean`
inert	`boolean`
lang	`string`
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.
ref	`Ref<HTMLButtonElement>`
Requires React 19
render	`DOMRenderFunction<"button", ButtonRenderProps>`
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). Only a single root DOM element can be rendered (no fragments). You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
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.
suppressHydrationWarning	`boolean`
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab).
translate	`"no" \| "yes"`

Name	Type	Default
onAnimationEnd	`AnimationEventHandler<HTMLButtonElement>`
onAnimationEndCapture	`AnimationEventHandler<HTMLButtonElement>`
onAnimationIteration	`AnimationEventHandler<HTMLButtonElement>`
onAnimationIterationCapture	`AnimationEventHandler<HTMLButtonElement>`
onAnimationStart	`AnimationEventHandler<HTMLButtonElement>`
onAnimationStartCapture	`AnimationEventHandler<HTMLButtonElement>`
onAuxClick	`MouseEventHandler<HTMLButtonElement>`
onAuxClickCapture	`MouseEventHandler<HTMLButtonElement>`
onBlur	`((e: FocusEvent<Element, Element>) => void)`
Handler that is called when the element loses focus.
onClickCapture	`MouseEventHandler<HTMLButtonElement>`
onContextMenu	`MouseEventHandler<HTMLButtonElement>`
onContextMenuCapture	`MouseEventHandler<HTMLButtonElement>`
onDoubleClick	`MouseEventHandler<HTMLButtonElement>`
onDoubleClickCapture	`MouseEventHandler<HTMLButtonElement>`
onFocus	`((e: FocusEvent<Element, Element>) => void)`
Handler that is called when the element receives focus.
onFocusChange	`((isFocused: boolean) => void)`
Handler that is called when the element's focus status changes.
onGotPointerCapture	`PointerEventHandler<HTMLButtonElement>`
onGotPointerCaptureCapture	`PointerEventHandler<HTMLButtonElement>`
onHoverChange	`((isHovering: boolean) => void)`
Handler that is called when the hover state changes.
onHoverEnd	`((e: HoverEvent) => void)`
Handler that is called when a hover interaction ends.
onHoverStart	`((e: HoverEvent) => void)`
Handler that is called when a hover interaction starts.
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.
onLostPointerCapture	`PointerEventHandler<HTMLButtonElement>`
onLostPointerCaptureCapture	`PointerEventHandler<HTMLButtonElement>`
onMouseDown	`MouseEventHandler<HTMLButtonElement>`
onMouseDownCapture	`MouseEventHandler<HTMLButtonElement>`
onMouseEnter	`MouseEventHandler<HTMLButtonElement>`
onMouseLeave	`MouseEventHandler<HTMLButtonElement>`
onMouseMove	`MouseEventHandler<HTMLButtonElement>`
onMouseMoveCapture	`MouseEventHandler<HTMLButtonElement>`
onMouseOut	`MouseEventHandler<HTMLButtonElement>`
onMouseOutCapture	`MouseEventHandler<HTMLButtonElement>`
onMouseOver	`MouseEventHandler<HTMLButtonElement>`
onMouseOverCapture	`MouseEventHandler<HTMLButtonElement>`
onMouseUp	`MouseEventHandler<HTMLButtonElement>`
onMouseUpCapture	`MouseEventHandler<HTMLButtonElement>`
onPointerCancel	`PointerEventHandler<HTMLButtonElement>`
onPointerCancelCapture	`PointerEventHandler<HTMLButtonElement>`
onPointerDown	`PointerEventHandler<HTMLButtonElement>`
onPointerDownCapture	`PointerEventHandler<HTMLButtonElement>`
onPointerEnter	`PointerEventHandler<HTMLButtonElement>`
onPointerLeave	`PointerEventHandler<HTMLButtonElement>`
onPointerMove	`PointerEventHandler<HTMLButtonElement>`
onPointerMoveCapture	`PointerEventHandler<HTMLButtonElement>`
onPointerOut	`PointerEventHandler<HTMLButtonElement>`
onPointerOutCapture	`PointerEventHandler<HTMLButtonElement>`
onPointerOver	`PointerEventHandler<HTMLButtonElement>`
onPointerOverCapture	`PointerEventHandler<HTMLButtonElement>`
onPointerUp	`PointerEventHandler<HTMLButtonElement>`
onPointerUpCapture	`PointerEventHandler<HTMLButtonElement>`
onPress	`((e: PressEvent) => void)`
Handler that is called when the press is released over the target.
onPressChange	`((isPressed: boolean) => void)`
Handler that is called when the press state changes.
onPressEnd	`((e: PressEvent) => void)`
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressStart	`((e: PressEvent) => void)`
Handler that is called when a press interaction starts.
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.
onScroll	`UIEventHandler<HTMLButtonElement>`
onScrollCapture	`UIEventHandler<HTMLButtonElement>`
onTouchCancel	`TouchEventHandler<HTMLButtonElement>`
onTouchCancelCapture	`TouchEventHandler<HTMLButtonElement>`
onTouchEnd	`TouchEventHandler<HTMLButtonElement>`
onTouchEndCapture	`TouchEventHandler<HTMLButtonElement>`
onTouchMove	`TouchEventHandler<HTMLButtonElement>`
onTouchMoveCapture	`TouchEventHandler<HTMLButtonElement>`
onTouchStart	`TouchEventHandler<HTMLButtonElement>`
onTouchStartCapture	`TouchEventHandler<HTMLButtonElement>`
onTransitionCancel	`TransitionEventHandler<HTMLButtonElement>`
onTransitionCancelCapture	`TransitionEventHandler<HTMLButtonElement>`
onTransitionEnd	`TransitionEventHandler<HTMLButtonElement>`
onTransitionEndCapture	`TransitionEventHandler<HTMLButtonElement>`
onTransitionRun	`TransitionEventHandler<HTMLButtonElement>`
onTransitionRunCapture	`TransitionEventHandler<HTMLButtonElement>`
onTransitionStart	`TransitionEventHandler<HTMLButtonElement>`
onTransitionStartCapture	`TransitionEventHandler<HTMLButtonElement>`
onWheel	`WheelEventHandler<HTMLButtonElement>`
onWheelCapture	`WheelEventHandler<HTMLButtonElement>`

Name	Type	Default
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. See MDN (opens in new tab).
formAction	`string \| ((formData: FormData) => void \| Promise<void>)`
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.
type	`"button" \| "reset" \| "submit"`	`'button'`
The behavior of the button when used in an HTML form.
value	`string`
The value associated with the button's name when it's submitted with the form data.

Name	Type	Default
className	`ClassNameOrFunction<ButtonRenderProps>`	`'react-aria-Button'`
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state.
style	`StyleOrFunction<ButtonRenderProps>`
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state.

SideNavigation

Props

SideNavigation

Accessibility (54)(54 props)

Advanced (23)(23 props)

Events (170)(170 props)

Forms (1)(1 prop)

Styling (2)(2 props)

SideNavigation.Trigger

Accessibility (11)(11 props)

Advanced (12)(12 props)

Events (76)(76 props)

Forms (9)(9 props)

Styling (2)(2 props)