Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface FormInputConfig<FormInputValue>

    interface FormInputConfig<FormInputValue = unknown> {
        aria?: Record<string, string>;
        autofocus?: boolean;
        classes?: string;
        dataset?: Record<string, string>;
        disabled?: boolean;
        id?: string;
        input?: any;
        localize?: boolean;
        model?: any;
        name: string;
        named?: boolean;
        placeholder?: string;
        readonly?: boolean;
        required?: boolean;
        rootId?: string;
        value?: FormInputValue;
    }

    Type Parameters

    • FormInputValue = unknown
    Index

    Properties

    aria? autofocus? classes? dataset? disabled? id? input? localize? model? name named? placeholder? readonly? required? rootId? value?

    Properties

    aria?: Record<string, string>

    Aria attributes to assign to the input

    autofocus?: boolean

    Is the field autofocused?

    classes?: string

    Space-delimited class names to apply to the input.

    dataset?: Record<string, string>

    Additional dataset attributes to assign to the input

    disabled?: boolean

    Is the field disabled?

    id?: string

    An id to assign to the element

    input?: any
    localize?: boolean

    Localize values of this field?

    model?: any

    The DataModel instance the field belongs to

    name: string

    The name of the form element

    named?: boolean

    Whether the element should be named in the form. If false, the element will be given a name via data attribute only.

    placeholder?: string

    A placeholder value, if supported by the element type

    readonly?: boolean

    Is the field readonly?

    required?: boolean

    Is the field required?

    rootId?: string

    Some parent CSS id within which field names are unique. If provided, this root ID is used to automatically assign "id" attributes to input elements and "for" attributes to corresponding labels.

    value?: FormInputValue

    The current value of the form element

    Settings

    Member Visibility

    On This Page

    Properties