interface / @typed/ui/index

Dialog.DescriptionOptions

Options for descriptive dialog text.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Dialog naming and description
Since
1.0.0
Member of
Dialog

Import

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

Access Dialog.DescriptionOptions through the imported Dialog export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export interface DescriptionOptions extends Dom.HostOptions<HTMLParagraphElement> {
    readonly content: Renderable.Any;
    readonly id?: string;
}

Why

A stable id lets dialog content establish aria-describedby explicitly.

Ownership and lifetime

Options are inert; dynamic content follows the component Scope.

Property: content

Descriptive content.

Property: content: Why

Referenced text supplies context beyond the dialog’s accessible name.

Property: content: Ownership and lifetime

Dynamic content follows the description Scope.

Property: id

Optional id referenced by Content.describedBy.

Property: id: Why

A stable DOM relationship exposes the description to assistive technology.

Property: id: Ownership and lifetime

The id is reflected and retains no resources.

Other public imports

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

Source