Sheet
Side-panel dialog with slide animation.
Generated from the package's public source.
API
Backdropcomponent
Backdrop(props: SheetBackdropProps): Element
Props
class?stringstyle?string | CSSProperties
Closecomponent
Close(props: SheetCloseProps): Element
Props
ref?(el: HTMLButtonElement) => void
children: Element
Contentcomponent
Content(props: SheetContentProps): Element
Props
class?stringref?(el: HTMLDivElement) => voidstyle?string | CSSPropertiestrapFocus?boolean— Disable focus trapping. Default: true (trapping enabled).
children: Element
Descriptioncomponent
Description(props: SheetDescriptionProps): Element
Props
class?string
children: Element
Portalcomponent
Portal(props: SheetPortalProps): Element
children: Element
Rootcomponent
Root(props: SheetRootProps): Element
Props
class?stringdefaultOpen?boolean— Default open state (uncontrolled).onOpenChange?(open: boolean, details: ChangeDetails<DisclosureReason>) => void— Called when open state change is requested.open?Accessor<boolean>— Controlled open state.side?SheetSide— Which side the sheet slides in from. Default: "right".
children: Element
SheetBackdropPropsinterface
Props
class?stringstyle?string | CSSProperties
SheetClosePropsinterface
Props
ref?(el: HTMLButtonElement) => void
children: Element
SheetContentPropsinterface
Props
class?stringref?(el: HTMLDivElement) => voidstyle?string | CSSPropertiestrapFocus?boolean— Disable focus trapping. Default: true (trapping enabled).
children: Element
SheetDescriptionPropsinterface
Props
class?string
children: Element
SheetPortalPropsinterface
children: Element
SheetRootPropsinterface
Props
class?stringdefaultOpen?boolean— Default open state (uncontrolled).onOpenChange?(open: boolean, details: ChangeDetails<DisclosureReason>) => void— Called when open state change is requested.open?Accessor<boolean>— Controlled open state.side?SheetSide— Which side the sheet slides in from. Default: "right".
children: Element
SheetTitlePropsinterface
Props
class?string
children: Element
SheetTriggerPropsinterface
Props
ref?(el: HTMLButtonElement) => void
children: Element
Titlecomponent
Title(props: SheetTitleProps): Element
Props
class?string
children: Element
Triggercomponent
Trigger(props: SheetTriggerProps): Element
Props
ref?(el: HTMLButtonElement) => void
children: Element