function / @typed/ui/Dialog

Description

Renders descriptive dialog text with an optional relationship id.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Dialog naming and description
Since
1.0.0

Import

import { Description } from "@typed/ui/Dialog";

Signatures

export declare function Description<const Options extends DescriptionOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, DescriptionInternalProps<Options>>, Options["content"], Host>): Fx<RenderEvent, Renderable.Error<Options | Host>, Renderable.Services<Options | Host> | Scope.Scope | RenderTemplate>;

Why

The helper keeps accessible description wiring explicit and platform-native.

Ownership and lifetime

Running the Fx owns dynamic content by Scope. A custom host must preserve id.

Examples

import { Description } from "@typed/ui/Dialog"

const detail = Description({ id: "confirm-detail", content: "This cannot be undone." })

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source