SideSheet

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

Props

React props
NameTypeRequiredDefaultDescription
classNamestring | ClassNameComponent<SideSheetInterface>NoClasses or state-aware element classes applied through the shared style contract.
variantSideSheetVariantNo'standard'Rendering mode: `'standard'` for persistent layout chrome, `'modal'` for a dismissible overlay.
titlestringNoHeadline displayed in the side sheet header.
positionSideSheetPositionNo'right'Edge of the screen the panel is anchored to.
openbooleanNoControlled open state.
defaultOpenbooleanNotrueInitial open state when uncontrolled.
closeIconIconNoiCloseIcon for the built-in close button.
dividerbooleanNoShow the trailing divider. Defaults to `true` for the standard variant. Ignored for `variant="modal"`, which never renders a divider.
transitionTransitionNoMotion transition shared by every framework for the open/close width and opacity animation.
onOpenChange(open: boolean) => voidNoNotifies an accepted open-state request.
containerElementNoPortal target for `variant="modal"`. Defaults to `document.body`.