Documentation navigation

Published API · 0.1.0-rc.1

foldkit-ui · input

Published foldkit-ui API declarations for input.

./input

@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/input'

Exported declarations

descriptionId

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

descriptionId: (id: string) => string

InputAttributes

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

export type InputAttributes<Message> = Readonly<{
    input: ReadonlyArray<Attribute<Message>>;
    label: ReadonlyArray<Attribute<Message>>;
    description: ReadonlyArray<Attribute<Message>>;
}>;

view

Renders an accessible input 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 an input with `view`.

export type ViewConfig<Message> = Readonly<{
    id: string;
    toView: (attributes: InputAttributes<Message>) => Html;
    onInput?: (value: string) => Message;
    value?: string;
    isDisabled?: boolean;
    isReadOnly?: boolean;
    isInvalid?: boolean;
    isAutofocus?: boolean;
    hasDescription?: boolean;
    name?: string;
    type?: string;
    placeholder?: string;
}>;