║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║

---

title: Dialog description: A fully-managed, renderless dialog component jam-packed with accessibility and keyboard features, perfect for building completely custom dialogs and alerts. author: name: imskyleen url: https://github.com/imskyleen

<ComponentPreview name="demo-components-headless-dialog" />

Installation

<ComponentInstallation name="components-headless-dialog" />

Usage

<Dialog>
  <DialogPanel>
    <DialogHeader>
      <DialogTitle>Dialog Title</DialogTitle>
      <DialogDescription>Dialog Description</DialogDescription>
    </DialogHeader>
    <DialogFooter>
      <button>Accept</button>
    </DialogFooter>
    <DialogClose>Close</DialogClose>
  </DialogPanel>
</Dialog>

API Reference

Dialog

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialog" text="Animate UI API Reference - Dialog Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog" text="Headless UI API Reference - Dialog" />

</div>

DialogBackdrop

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogbackdrop" text="Animate UI API Reference - Dialog Backdrop Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog-backdrop" text="Headless UI API Reference - DialogBackdrop" />

</div>

<TypeTable type={{ transition: { description: 'The transition of the dialog backdrop', type: 'Transition', required: false, default: "{ duration: 0.2, ease: 'easeInOut' }", }, '...props': { description: 'The props of the dialog backdrop.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

DialogClose

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogclose" text="Animate UI API Reference - Dialog Close Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog-close" text="Headless UI API Reference - DialogClose" />

</div>

DialogPanel

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogpanel" text="Animate UI API Reference - Dialog Panel Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog-panel" text="Headless UI API Reference - DialogPanel" />

</div>

<TypeTable type={{ from: { description: 'The direction the dialog should flip from', type: "'top' | 'bottom' | 'left' | 'right'", required: false, default: 'top', }, transition: { description: 'The transition of the dialog panel', type: 'Transition', required: false, default: "{ type: 'spring', stiffness: 150, damping: 25 }", }, '...props': { description: 'The props of the dialog panel.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

DialogHeader

<ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogheader" text="Animate UI API Reference - Dialog Header Primitive" />

<TypeTable type={{ '...props': { description: 'The props of the dialog header.', type: "React.ComponentProps<'div'>", required: false, }, }} />

DialogTitle

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogtitle" text="Animate UI API Reference - Dialog Title Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog-title" text="Headless UI API Reference - DialogTitle" />

</div>

DialogDescription

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogdescription" text="Animate UI API Reference - Dialog Description Primitive" />

<ExternalLink href="https://headlessui.com/react/dialog#dialog-description" text="Headless UI API Reference - DialogDescription" />

</div>

DialogFooter

<ExternalLink href="https://animate-ui.com/docs/primitives/headless/dialog#dialogfooter" text="Animate UI API Reference - Dialog Footer Primitive" />

<TypeTable type={{ '...props': { description: 'The props of the dialog footer.', type: "React.ComponentProps<'div'>", required: false, }, }} />

Credits

• Headless Dialog
• Credit to shadcn/ui for style inspiration.

║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║