Dialog
shadcn/uiA window overlaid on either the primary window or another dialog window, rendering the content underneath inert.
Dialog
Installation
Props
<Dialog />
Name | Type | |
|---|---|---|
modal | boolean(default: true) | |
open | boolean | |
defaultOpen | boolean | |
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 |
<DialogClose />
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 |
<DialogPopup />
Name | Type | |
|---|---|---|
animationPreset | string(default: scale) | |
transitionPreset | string(default: outCubic) | |
reduceMotion | boolean(default: false) | |
showCloseButton | boolean(default: true) | |
containerClassName | any | |
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 |
<DialogDescription />
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 |
<DialogFooter />
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 |
<DialogHeader />
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 |
<DialogBackdrop />
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 |
<DialogViewport />
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 |
<DialogPortal />
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 |
<DialogTitle />
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 |
<DialogTrigger />
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 |