Search documentation

Search by topic, API name, or import path.

GitHub ↗

Module / v1.0.0-beta.13

@typed/ui/Dialog

20 unique exports available through this public import path, including their members and aliases.

Learn this UI primitive →

import * as Dialog from "@typed/ui/Dialog";

Cancelable dismissal

  • RequestClose

    function

    Renders a button that starts the cancelable native close-request lifecycle.

  • requestClose

    function

    Requests the native dialog close lifecycle, including its cancel event.

Dialog naming and description

  • Description

    function

    Renders descriptive dialog text with an optional relationship id.

  • DescriptionOptions

    interface

    Options for descriptive dialog text.

  • Heading

    function

    Renders a dialog heading with explicit ARIA level semantics.

  • HeadingOptions

    interface

    Options for an accessible dialog heading.

Direct dismissal

  • Close

    function

    Renders a button that closes a dialog without a cancel request.

  • CloseOptions

    interface

    Options for dialog close and close-request buttons.

  • Dismiss

    variable

    Alias for direct Close behavior.

  • close

    function

    Marks dialog state closed without requesting native cancellation.

Native content host

  • Content

    function

    Renders native dialog content synchronized with hydrated state.

  • ContentOptions

    type-alias

    Dialog content options with exactly one accessible naming strategy.

  • Dialog

    variable

    Canonical widget alias for Content.

Open state

  • InitialState

    interface

    Optional initial dialog state.

  • State

    interface

    Current renderer-independent dialog visibility.

  • StateSchema

    variable

    Schema for dialog hydration state.

  • makeState

    function

    Creates hydrated dialog state independent of rendering.

  • setOpen

    function

    Sets desired dialog visibility.

Opening controls

  • Trigger

    function

    Renders a native button that opens dialog content.

  • TriggerOptions

    interface

    Options for a dialog-opening button.