dialog

A window overlaid on either the primary window or another dialog window, rendering the content underneath inert.

Philosophy

Dialogs demand attention and block interaction - use them when the user must make a decision before continuing. We split the anatomy into DialogTrigger, DialogContent, DialogHeader, etc. because every dialog has different needs but the same accessibility requirements: focus trapping, escape dismissal, and return focus.

How It's Built

Loading diagram...

Installation

npx @gentleduck/cli add dialog

npx @gentleduck/cli add dialog

Usage

import {
  Dialog,
  DialogContent,
  DialogDescription,
  DialogHeader,
  DialogTitle,
  DialogTrigger,
} from "@/components/ui/dialog"

<Dialog>
  <DialogTrigger>Open</DialogTrigger>
  <DialogContent>
    <DialogHeader>
      <DialogTitle>Are you absolutely sure?</DialogTitle>
      <DialogDescription>
        This action cannot be undone. This will permanently delete your account
        and remove your data from our servers.
      </DialogDescription>
    </DialogHeader>
  </DialogContent>
</Dialog>

Examples

Controlled Dialog

Active Trigger on Open

Style the trigger to appear active while the dialog is open using data-[state=open]:

Component Composition

Loading diagram...

Notes

To use the Dialog component from within a Context Menu or Dropdown Menu, you must encase the Context Menu or Dropdown Menu component in the Dialog component.

<Dialog>
  <ContextMenu>
    <ContextMenuTrigger>Right click</ContextMenuTrigger>
    <ContextMenuContent>
      <ContextMenuItem>Open</ContextMenuItem>
      <ContextMenuItem>Download</ContextMenuItem>
      <DialogTrigger asChild>
        <ContextMenuItem>
          <span>Delete</span>
        </ContextMenuItem>
      </DialogTrigger>
    </ContextMenuContent>
  </ContextMenu>
  <DialogContent>
    <DialogHeader>
      <DialogTitle>Are you absolutely sure?</DialogTitle>
      <DialogDescription>
        This action cannot be undone. Are you sure you want to permanently
        delete this file from our servers?
      </DialogDescription>
    </DialogHeader>
    <DialogFooter>
      <Button type="submit">Confirm</Button>
    </DialogFooter>
  </DialogContent>
</Dialog>

RTL Support

Set the direction once with DirectionProvider (or <html dir="rtl">) and the dialog follows. The portaled overlay and content get the resolved dir, so text, the close button and the footer order mirror without any extra props.

<DirectionProvider dir="rtl">
  <Dialog>
    <DialogTrigger>فتح</DialogTrigger>
    <DialogContent>
      <DialogHeader>
        <DialogTitle>عنوان النافذة</DialogTitle>
        <DialogDescription>وصف النافذة هنا.</DialogDescription>
      </DialogHeader>
    </DialogContent>
  </Dialog>
</DirectionProvider>

Motion

Alpha: Motion Compositions

Motion components work standalone, but some compositions may behave unexpectedly: this is still under active development. If you find a broken composition, please file an issue.

Use MotionDialog and MotionDialogContent for smooth enter/exit animations powered by motion. The dialog scales and fades in with a blur effect, and reverses on exit.

Requires the motion package. Use MotionDialog instead of Dialog and MotionDialogContent instead of DialogContent. All other sub-components (DialogTrigger, DialogHeader, etc.) stay the same.

API Reference

Dialog

Prop	Type	Default	Description
`defaultOpen`	`boolean`	`false`	Initial open state for uncontrolled usage
`open`	`boolean`	-	Controlled open state
`onOpenChange`	`(open: boolean) => void`	-	Callback when open state changes
`modal`	`boolean`	`true`	Enables modal focus/interaction behavior (focus trapping, scroll blocking)
`dir`	`'ltr' \| 'rtl'`	-	Optional override. Resolved by primitives `useDirection` (`dir` prop -> `DirectionProvider` -> `<html dir>`).
`children`	`React.ReactNode`	-	Dialog sub-components (`DialogTrigger`, `DialogContent`, etc.)
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Root>`	-	Additional props inherited from `DialogPrimitive.Root`

DialogTrigger

Prop	Type	Default	Description
`children`	`React.ReactNode`	-	Trigger content
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Trigger>`	-	Additional props inherited from `DialogPrimitive.Trigger`

DialogPortal

Prop	Type	Default	Description
`container`	`HTMLElement`	-	Optional portal container
`forceMount`	`true`	-	Forces mounted state for all portal children
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Portal>`	-	Additional props inherited from `DialogPrimitive.Portal`

DialogOverlay

Prop	Type	Default	Description
`className`	`string`	-	Additional CSS classes
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Overlay>`	-	Additional props inherited from `DialogPrimitive.Overlay`

DialogContent

Prop	Type	Default	Description
`forceMount`	`true`	-	Force mounting for animation control
`closeText`	`string`	`'Close'`	Accessible label for the built-in close button
`hideClose`	`boolean`	`false`	When `true`, hides the built-in close button entirely
`className`	`string`	-	Additional CSS classes applied to the content panel
`children`	`React.ReactNode`	-	Dialog inner content
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Content>`	-	Additional props inherited from `DialogPrimitive.Content`

DialogContent renders a built-in close button in the top-end corner (top-right in LTR, top-left in RTL). Set hideClose to remove it when you handle closing via other UI (e.g. a custom header with its own close button).

DialogHeader

Prop	Type	Default	Description
`className`	`string`	-	Additional CSS classes applied to the header
`children`	`React.ReactNode`	-	Header content (typically `DialogTitle` and `DialogDescription`)
`...props`	`React.HTMLAttributes<HTMLDivElement>`	-	Additional props to spread to the header container

DialogFooter

Prop	Type	Default	Description
`className`	`string`	-	Additional CSS classes applied to the footer
`children`	`React.ReactNode`	-	Footer content (typically action buttons)
`...props`	`React.HTMLAttributes<HTMLDivElement>`	-	Additional props to spread to the footer container

DialogTitle

Prop	Type	Default	Description
`className`	`string`	-	Additional CSS classes applied to the title
`children`	`React.ReactNode`	-	Title text
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Title>`	-	Additional props inherited from `DialogPrimitive.Title`

DialogDescription

Prop	Type	Default	Description
`className`	`string`	-	Additional CSS classes applied to the description
`children`	`React.ReactNode`	-	Description text
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Description>`	-	Additional props inherited from `DialogPrimitive.Description`

DialogClose

Prop	Type	Default	Description
`children`	`React.ReactNode`	-	Close control content
`...props`	`React.ComponentPropsWithoutRef<typeof DialogPrimitive.Close>`	-	Additional props inherited from `DialogPrimitive.Close`

MotionDialog

Same props as Dialog. Wraps with useMotionRoot for exit animation support. Requires the motion package.

MotionDialogContent

Prop	Type	Default	Description
`open`	`boolean`	-	Required. Controlled open state for AnimatePresence enter/exit
`closeText`	`string`	`'Close'`	Accessible label for the built-in close button
`hideClose`	`boolean`	`false`	When `true`, hides the built-in close button
`className`	`string`	-	Additional CSS classes applied to the content panel
`children`	`React.ReactNode`	-	Dialog inner content

Requires motion package installed. Uses AnimatePresence + m.div for ~5KB bundle. Automatically respects prefers-reduced-motion.

Responsive Variants

The following responsive components automatically render a Dialog on desktop (>=768px) and a Drawer on mobile. Each accepts the same props as its non-responsive counterpart.

Component	Desktop renders	Mobile renders
`DialogResponsive`	`Dialog`	`Drawer`
`DialogTriggerResponsive`	`DialogTrigger`	`DrawerTrigger`
`DialogContentResponsive`	`DialogContent`	`DrawerContent`
`DialogHeaderResponsive`	`DialogHeader`	`DrawerHeader`
`DialogFooterResponsive`	`DialogFooter`	`DrawerFooter`
`DialogTitleResponsive`	`DialogTitle`	`DrawerTitle`
`DialogDescriptionResponsive`	`DialogDescription`	`DrawerDescription`
`DialogCloseResponsive`	`DialogClose`	`DrawerClose`