# Dialog

A modal overlay for displaying content that requires user interaction.

## Installation

Start from a Svelte 5 application, then install the component package, shared theme, and Bits UI peer:

```bash
pnpm add coss-svelte @coss-svelte/theme bits-ui
```

Import `@coss-svelte/theme/style-coss.css` after Tailwind from the application's global stylesheet.

## Usage

```svelte
<script lang="ts">
import {
	Button,
	Dialog,
	DialogClose,
	DialogDescription,
	DialogFooter,
	DialogHeader,
	DialogPanel,
	DialogPopup,
	DialogTitle,
	DialogTrigger,
	Field,
	FieldLabel,
	Form,
	Input,
} from "coss-svelte";
</script>

<Dialog>
	<DialogTrigger>Open Dialog</DialogTrigger>
	<DialogPopup class="sm:max-w-sm">
		<DialogHeader>
			<DialogTitle>Edit profile</DialogTitle>
			<DialogDescription>
				Make changes to your profile here. Click save when you’re done.
			</DialogDescription>
		</DialogHeader>
		<Form class="contents">
			<DialogPanel class="grid gap-4">
				<Field>
					<FieldLabel>Name</FieldLabel>
					<Input value="Margaret Welsh" type="text" />
				</Field>
				<Field>
					<FieldLabel>Username</FieldLabel>
					<Input value="@maggie.welsh" type="text" />
				</Field>
			</DialogPanel>
			<DialogFooter>
				<DialogClose>Cancel</DialogClose>
				<Button type="submit">Save</Button>
			</DialogFooter>
		</Form>
	</DialogPopup>
</Dialog>

```

## Anatomy

- `Dialog`
- `DialogClose`
- `DialogDescription`
- `DialogFooter`
- `DialogHeader`
- `DialogPanel`
- `DialogPopup`
- `DialogTitle`
- `DialogTrigger`

## API Reference

### Dialog

A modal overlay for displaying content that requires user interaction.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `bind:open` | `boolean` | `false` | Open state for the popup or disclosure. Bind with `bind:open`. |
| `trigger` | `string` | `"Open"` | Fallback trigger text rendered when custom children are not provided. |
| `title` | `string` | `""` | Title text rendered by the component's built-in fallback layout. |
| `description` | `string` | `""` | Supporting text rendered by the component's built-in fallback layout. |

**Composition and refs**

- `children: Snippet<[]>`

Inherits from [Bits UI Dialog.Root](https://bits-ui.com/docs/components/dialog#root).

### DialogClose

Renders a control that closes the parent surface.

**Composition and refs**

- `children: Snippet<[]>`
- `child: Snippet<[{ props: Record<string, unknown> }]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI Dialog.Close](https://bits-ui.com/docs/components/dialog#close).

### DialogDescription

Provides supporting copy for the parent component.

**Composition and refs**

- `children: Snippet<[]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI Dialog.Description](https://bits-ui.com/docs/components/dialog#description).

### DialogFooter

Groups footer content and actions for the parent component.

**Composition and refs**

- `children: Snippet<[]>`

Inherits from [Svelte <div> attributes](https://svelte.dev/docs/svelte/basic-markup#Attributes).

### DialogHeader

Groups heading content for the parent component.

**Composition and refs**

- `children: Snippet<[]>`

Inherits from [Svelte <div> attributes](https://svelte.dev/docs/svelte/basic-markup#Attributes).

### DialogPanel

Renders the main panel surface for the parent component.

**Composition and refs**

- `children: Snippet<[]>`

Inherits from [Svelte <div> attributes](https://svelte.dev/docs/svelte/basic-markup#Attributes).

### DialogPopup

Renders the floating or modal surface for the parent component.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `portalProps` | `{ disabled?: boolean; to?: PortalTarget }` | `{}` | Configures the exact Bits Portal target (`to`) or renders inline when `disabled`. |

**Composition and refs**

- `children: Snippet<[]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI Dialog.Content](https://bits-ui.com/docs/components/dialog#content).

### DialogTitle

Names the parent surface or section.

**Composition and refs**

- `children: Snippet<[]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI Dialog.Title](https://bits-ui.com/docs/components/dialog#title).

### DialogTrigger

Renders the control that opens, closes, or selects related content.

**Composition and refs**

- `children: Snippet<[]>`
- `child: Snippet<[{ props: Record<string, unknown> }]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI Dialog.Trigger](https://bits-ui.com/docs/components/dialog#trigger).

## Implementation Details

| Field | Value |
| --- | --- |
| Status | Stable |
| Foundation | bits |
| Category | Overlays & Popups |
| Particles | 6 |

## Status

Stable for the current coss-svelte surface.

## Agent Notes

- Import Svelte exports directly from `coss-svelte`.
- This is Svelte 5 code: use `class`, lowercase event properties, runes, snippets, and documented `bind:*` contracts. Do not emit JSX, React hooks, `className`, `asChild`, or Base UI imports.
- Prefer this route's example and generated API table over React COSS snippets; COSS React particles are design references only.
- The copy-and-own registry is a preview. Inspect `/r/dialog.json` for the complete local file and dependency closure.
- Dialog is stable in the current source catalog.