interface / @typed/ui

Form.SchemaBoundPushOptions

Options for a schema-bound array append button.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Component options
Since
1.0.0
Member of
Form

Import

import { Form } from "@typed/ui";

Access Form.SchemaBoundPushOptions through the imported Form 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 SchemaBoundPushOptions<Values extends object, Name extends ArrayFieldName<Values>> extends Dom.HostOptions<HTMLButtonElement> {
    readonly name: Name;
    readonly value: ArrayFieldValue<Values, Name>;
    readonly content: Renderable.Any;
}

Property: content

Button label/content.

Property: name

Array-valued field to append to.

Property: value

Type-compatible item appended on activation.

Other public imports

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

Source