Dialog

A modal overlay for displaying content that requires user interaction.

Installation

Install the component package, shared coss-svelte theme, and Bits UI peer.

npm install coss-svelte @coss-svelte/theme bits-ui

Usage

Import the Svelte component exports directly from the package.

import { Dialog, DialogClose, DialogDescription, DialogFooter, DialogHeader, DialogPanel, DialogPopup, DialogTitle, DialogTrigger } from "coss-svelte";

Anatomy

  • Dialog
  • DialogClose
  • DialogDescription
  • DialogFooter
  • DialogHeader
  • DialogPanel
  • DialogPopup
  • DialogTitle
  • DialogTrigger

API Reference

Dialog

A modal overlay for displaying content that requires user interaction.

PropTypeDefaultDescription
bind:openbooleanfalseOpen state for the popup or disclosure. Bind with `bind:open`.
triggerstring"Open"Fallback trigger text rendered when custom children are not provided.
titlestring""Title text rendered by the component's built-in fallback layout.
descriptionstring""Supporting text rendered by the component's built-in fallback layout.
children : Snippet<[]>

Inherits from Bits UI Dialog.Root.

DialogClose

Renders a control that closes the parent surface.

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

Inherits from Bits UI Dialog.Close.

DialogDescription

Provides supporting copy for the parent component.

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

Inherits from Bits UI Dialog.Description.

DialogFooter

Groups footer content and actions for the parent component.

children : Snippet<[]>

Inherits from Svelte <div> attributes.

DialogHeader

Groups heading content for the parent component.

children : Snippet<[]>

Inherits from Svelte <div> attributes.

DialogPanel

Renders the main panel surface for the parent component.

children : Snippet<[]>

Inherits from Svelte <div> attributes.

DialogPopup

Renders the floating or modal surface for the parent component.

PropTypeDefaultDescription
portalProps{ disabled?: boolean; to?: PortalTarget }{}Configures the exact Bits Portal target (`to`) or renders inline when `disabled`.
children : Snippet<[]>bind:ref : HTMLElement | null

Inherits from Bits UI Dialog.Content.

DialogTitle

Names the parent surface or section.

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

Inherits from Bits UI Dialog.Title.

DialogTrigger

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

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

Inherits from Bits UI Dialog.Trigger.

Implementation Details

Status
Stable
Foundation
bits
Category
Overlays & Popups
Particles
6