Documentation navigation

Published API · 0.1.0-rc.1

foldkit-ui · fieldset

Published foldkit-ui API declarations for fieldset.

./fieldset

@wsagency/wseffect-foldkit-ui · MIT · source · MIT license · WS-AGENCY-NOTICE · THIRD-PARTY-NOTICES

This entry point is published in @wsagency/wseffect-foldkit-ui@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.

import * as Wseffect from '@wsagency/wseffect-foldkit-ui/fieldset'

Exported declarations

descriptionId

Returns the description element id, derived from the fieldset's base id.

descriptionId: (id: string) => string

FieldsetAttributes

Attribute groups the fieldset component provides to the consumer's `toView` callback.

export type FieldsetAttributes<Message> = Readonly<{
    fieldset: ReadonlyArray<Attribute<Message>>;
    legend: ReadonlyArray<Attribute<Message>>;
    description: ReadonlyArray<Attribute<Message>>;
}>;

legendId

Returns the legend element id, derived from the fieldset's base id.

legendId: (id: string) => string

view

Renders an accessible fieldset by building ARIA attribute groups and delegating layout to the consumer's `toView` callback.

view: <Message>(config: ViewConfig<Message>, h: HtmlBuilder<Message>) => Html

ViewConfig

Configuration for rendering a fieldset with `view`.

export type ViewConfig<Message> = Readonly<{
    id: string;
    toView: (attributes: FieldsetAttributes<Message>) => Html;
    isDisabled?: boolean;
    hasDescription?: boolean;
}>;