Components
Dialog

Dialog

The Dialog component is a powerful and highly customizable tool for creating dialog windows, also known as modals, in your application. It includes essential elements such as triggers, content, and close triggers.

API Reference

Root

PropTypeDefault
aria-label
string
closeOnEsc
boolean
closeOnOutsideClick
boolean
defaultOpen
boolean
dir
'ltr' | 'rtl'
finalFocusEl
HTMLElement | (() => MaybeElement)
getRootNode
() => ShadowRoot | Node | Document
id
string
ids
Partial<{ trigger: string container: string backdrop: string content: string closeTrigger: string title: string description: string }>
initialFocusEl
HTMLElement | (() => MaybeElement)
modal
boolean
onEsc
VoidFunction
onOpenChange
(details: OpenChangeDetails) => void
onOutsideClick
VoidFunction
open
boolean
preventScroll
boolean
restoreFocus
boolean
role
'dialog' | 'alertdialog'
trapFocus
boolean

Title

PropTypeDefault
asChild
boolean

Content

PropTypeDefault
asChild
boolean
lazyMount
boolean
onExitComplete
() => void
present
boolean
unmountOnExit
boolean

Trigger

PropTypeDefault
asChild
boolean

Backdrop

PropTypeDefault
asChild
boolean
lazyMount
boolean
onExitComplete
() => void
present
boolean
unmountOnExit
boolean

Container

PropTypeDefault
asChild
boolean

Description

PropTypeDefault
asChild
boolean

CloseTrigger

PropTypeDefault
asChild
boolean