Skip to content
MIZU.

Dialog

A modal with focus trap, Escape handling, scroll lock and an expo entrance.

View .md

Live — this one is real

Usage

tsx
"use client";

import { useState } from "react";
import {
  Button,
  Dialog,
  DialogTitle,
  DialogBody,
  DialogFooter,
  DialogClose,
} from "mizu-ui";

export function Modal() {
  const [open, setOpen] = useState(false);
  return (
    <>
      <Button onClick={() => setOpen(true)}>Open dialog</Button>
      <Dialog open={open} onOpenChange={setOpen} label="Archive notice">
        <DialogClose />
        <DialogTitle>Release when ready</DialogTitle>
        <DialogBody>…</DialogBody>
        <DialogFooter>
          <Button onClick={() => setOpen(false)}>Close</Button>
        </DialogFooter>
      </Dialog>
    </>
  );
}

It starts with "use client" because it keeps state or passes functions to components, so it pastes into a Next.js page as it is. Other React setups ignore the directive.

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/dialog 0xuser64bit/mizu/button

The example also uses Button, so the command adds it too.

Every component imports from its own path, its name in kebab case. To paste the example, replace its mizu-ui import with:

tsx
import { Dialog, DialogTitle, DialogBody, DialogFooter, DialogClose } from "@/components/ui/mizu/dialog";
import { Button } from "@/components/ui/mizu/button";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Client Component: its source starts with “use client”.

Inspect composite/Dialog.tsx

Source is included in the npm package under src/composite/Dialog.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
open / onOpenChangeboolean / fn—Controlled open state.
labelstring—Accessible name for the dialog.

Accessibility

Native showModal supplies background inertness and focus containment. Escape requests close, focus returns to the trigger and body scroll is locked. Local themes are preserved.

Motion

A CSS expo entrance communicates opening. Reduced motion removes the entrance.

Works alongside

AccordionTabsNavDrawer