SideSheet

Side sheets show secondary content anchored to the side of the screen.

Props

React props
NameTypeRequiredDefaultDescription
classNamestring | Partial<Record<"container" | "content" | "header" | "title" | "divider" | "sideSheet" | "closeButton" | "overlay", string>> | ClassNameComponent<SideSheetInterface>No—Root classes (string), static element classes (object), or state-aware element classes (function).
variantSideSheetVariantNo'standard'Rendering mode: `'standard'` for persistent layout chrome, `'modal'` for a dismissible overlay.
titlestringNo—Headline displayed in the side sheet header.
positionSideSheetPositionNo'right'Edge of the screen the panel is anchored to.
openbooleanNo—Controlled open state.
defaultOpenbooleanNotrueInitial open state when uncontrolled.
closeIconIconNoiCloseIcon for the built-in close button.
dividerbooleanNo—Show the trailing divider. Defaults to `true` for the standard variant. Ignored for `variant="modal"`, which never renders a divider.
transitionTransitionNo—Motion transition shared by every framework for the open/close width and opacity animation.
onOpenChange(open: boolean) => voidNo—Notifies an accepted open-state request.
containerElementNo—Portal target for `variant="modal"`. Defaults to `document.body`.