interface / @typed/ui/index

Dialog.HeadingOptions

Options for an accessible dialog heading.

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.HeadingOptions 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 HeadingOptions extends Dom.HostOptions<HTMLHeadingElement> {
    readonly content: Renderable.Any;
    readonly id?: string;
    readonly level?: 1 | 2 | 3 | 4 | 5 | 6;
}

Why

A stable id can serve as the dialog’s aria-labelledby target.

Ownership and lifetime

Options are inert; dynamic values follow the component Scope.

Property: content

Heading content.

Property: content: Why

Visible text supplies the dialog’s accessible name when referenced.

Property: content: Ownership and lifetime

Dynamic content follows the heading Scope.

Property: id

Optional id referenced by Content.labelledBy.

Property: id: Why

Stable relationships are required for accessible naming and hydration.

Property: id: Ownership and lifetime

The id is reflected and retains no resources.

Property: level

ARIA heading level, defaulting to two.

Property: level: Why

The level preserves document hierarchy independently of visual style.

Property: level: Ownership and lifetime

The value 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