Sheet
shadcn/uiExtends the Dialog component to display content that complements the main content of the screen.
Sheet
Installation
Props
<Sheet />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetTrigger />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetClose />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetPopup />
Name | Type | |
|---|---|---|
side | string(default: right) | |
variant | string(default: full) | |
showCloseButton | boolean(default: true) | |
reduceMotion | boolean(default: false) | |
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetHeader />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetFooter />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetTitle />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |
<SheetDescription />
Name | Type | |
|---|---|---|
open | boolean | |
defaultOpen | boolean | |
modal | boolean | "trap-focus" | |
onOpenChange | (...args) => void | |
onOpenChangeComplete | ((open: boolean) => void) | |
disablePointerDismissal | boolean | |
triggerId | string | |
defaultTriggerId | string | |
payload | object | |
nativeButton | boolean | |
render | React.ReactElement | |
keepMounted | boolean | |
container | HTMLElement | RefObject<HTMLElement> | |
initialFocus | boolean | HTMLElement | |
finalFocus | boolean | HTMLElement | |
forceRender | boolean |