Overlays & actionsExplore · Adapt · Compose
Dialog
Modal dialog with backdrop, centered panel, default close control, Escape + focus return, `presentation="slot"` for custom layouts (Alert Dialog, full-screen previews). Reveal the right amount of context without losing the user's place in the interface. Keep the trigger, content and dismissal behavior working as one interaction. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.
The examples use @/components/kamod-ui/dialog in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.
In this guide 7 sections
Installation
Install @kamod-ch/ui, then compose Dialog, DialogTrigger, and DialogContent as in the snippet below. The default modal is centered; for immersive full-viewport layouts use presentation="slot" and apply overlay + panel classes on DialogContent yourself (see Usage). Motion is optional — see With Motion for @kamod-ch/ui-motion.
pnpm add @kamod-ch/uiThe @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.
Usage
Default DialogContent is presentation="modal" (backdrop + centered panel). If your code used to put **fixed inset-0**, **flex items-center justify-center**, and **bg-black/50** on DialogContent itself, you must set **presentation="slot"** — otherwise you get two backdrops and a nested centered shell. Same pattern as AlertDialogContent and the docs “View Markdown” dialog. Width-only classes like sm:max-w-md on modal are fine without slot. lockBodyScroll defaults to true on Dialog.
import { Dialog } from "@/components/kamod-ui/dialog";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component examples & variants
Explore Dialog in different contexts, from the starting pattern to the compositions below. Begin with Custom layout: presentation="slot", then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.
Read the result and its implementation together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the component styles guide for hierarchy and the theming guide for shared surfaces and colors. The accessibility notes explain what to preserve when making those changes.
Custom layout: presentation="slot"
Use when you own the full-screen overlay (fixed inset-0, dimmed backdrop, flex center). Without slot, the default modal adds its own overlay + panel on top.
import { Button } from "@/components/kamod-ui/button"
import { Dialog, DialogClose, DialogContent, DialogTrigger } from "@/components/kamod-ui/dialog";
export const Example = () => (
<Dialog>
<DialogTrigger asChild>
<Button variant="outline">Custom overlay</Button>
</DialogTrigger>
<DialogContent
presentation="slot"
class="fixed inset-0 z-50 flex items-center justify-center bg-black/50 p-4"
>
<div class="max-w-sm rounded-lg border bg-background p-6 shadow-lg">
<p class="text-sm">Your panel markup only — single portaled root.</p>
<DialogClose asChild>
<Button class="mt-4" variant="outline">
Close
</Button>
</DialogClose>
</div>
</DialogContent>
</Dialog>
);Demo
Form in a dialog with FieldGroup — matches shadcn DialogDemo structure.
Basic
Minimal title and description.
Custom close
Primary dismiss control in the footer; showCloseButton={false} removes the corner X.
Scrollable content
Long content in a scroll region; header stays above.
Destructive actions
Footer with cancel and destructive confirm.
Props and data
Configure Dialog using the contracts below. Read the documented options alongside the source definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.
Props, slots and variants for this component.
TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.TypeScriptComponent props
? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.Dialog
Dialog component props and accepted values.
| Prop / type | Description |
|---|---|
Dialog lockBodyScroll | Documented Dialog lockBodyScroll option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
open / onOpenChange | Documented open / onOpenChange option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
defaultOpen | Documented defaultOpen option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
DialogContent presentation | Documented DialogContent presentation option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
DialogContent showCloseButton | Documented DialogContent showCloseButton option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
DialogContent forceMount | Documented DialogContent forceMount option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
DialogTrigger / DialogClose asChild | Documented DialogTrigger / DialogClose asChild option for Dialog. Check its type alongside the usage examples before supplying a value. Documented default |
Data type reference
Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the implementation source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.
DialogContextValueopen, setOpen, triggerRef, titleId, descriptionIdDialogPropsDialogClosePropsDialogContentPresentationDialogContentPropsDialogDescriptionPropsDialogFooterPropsDialogHeaderPropsDialogPortalPropsDialogTitlePropsDialogTriggerPropsAccessibility
Build the complete interaction, including the parts outside Dialog. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.
Built-in behavior and defaults
DialogContent supplies a modal dialog surface, focus containment, Escape dismissal and return focus. DialogTitle and DialogDescription connect its accessible name and description. The default modal presentation includes its own overlay and close control.
Labels and relationships
Use a title describing the task, followed by a concise explanation where useful. For long structured content, avoid turning every paragraph into one lengthy accessible description. Keep normal headings, labels and reading order inside the dialog.
Use the built-in title and description relationship. The trigger uses a real button and the dialog keeps its default close control. Add the actual task controls inside the content and verify initial focus for that task.
import {
Button, Dialog, DialogTrigger, DialogContent,
DialogHeader, DialogTitle, DialogDescription,
} from "@kamod-ch/ui";
export function ExportDetails() {
return (
<Dialog>
<DialogTrigger asChild><Button type="button">Export details</Button></DialogTrigger>
<DialogContent>
<DialogHeader>
<DialogTitle>About this export</DialogTitle>
<DialogDescription>The export includes the currently visible records.</DialogDescription>
</DialogHeader>
</DialogContent>
</Dialog>
);
}Keyboard and focus
Open from a meaningful trigger, verify initial focus, then test forward and reverse Tab navigation and Escape. When the trigger disappears after a successful action, your application must choose a sensible surviving focus destination.
States and integration details
Use presentation="slot" only when deliberately providing the custom surface the API expects. Avoid nesting a second modal shell around the content. If hiding the default close control, retain another clear, keyboard-operable way to dismiss.
Verify the complete interaction
Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.
- Open, traverse and close without a pointer; confirm focus does not escape into the background.
- Inspect the dialog's name and description, including content with long text or validation errors.
- Submit, dismiss and remove the opener in separate flows; verify return focus and body scrolling recover.
Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.
For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.
Build it into your interface
Use the Dialog examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.
Connect the behavior
Keep trigger and content within the component's documented composition. Give destructive actions a clear consequence and an explicit confirmation. Let the primitive manage focus and dismissal instead of adding a second document-level keyboard handler.
Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.
Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.
Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.
Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.
Refine the presentation
Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Dialog.
import type { ComponentChildren } from "preact";
export function ExampleSurface({ children }: { children: ComponentChildren }) {
return (
<div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
{children}
</div>
);
}Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.
Review the complete interaction
- Open with the keyboard, move through the content and verify focus returns to a sensible trigger when closed.
- Test Escape, outside interaction and nested overlays according to the component's documented behavior.
- Check long titles and content on a small screen; the important action must remain reachable without clipping.
The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.
Compose a complete interface
Dialog is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.
Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.
Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.
Sources & design references
Follow Dialog from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.
Bring it back to your app
A reference becomes useful when it fits your real content. Work through these decisions in order:
- Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
- Make the styling repeatable. Use the styles guide for local
classadjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode. - Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.