Hex Core JS
    Preparing search index...

    Type Alias BaseSingleNameFieldProps<FV, T>

    BaseSingleNameFieldProps: BaseFieldProps<FV> & {
        autoFocus?: boolean;
        id?: string;
        immediateValidation?: UseValidationDFAOptions<T>["immediateValidation"];
        label?: string;
        name: KeyWithValueType<FV, T>;
        scheduledValidation?: UseValidationDFAOptions<T>["scheduledValidation"];
        scheduleValidationDelayMS?: UseValidationDFAOptions<T>["scheduleDelayMS"];
        sideEffect?: (v: T) => void;
    }

    Generic props used for any type of field that applies to a single field in a form state (i.e. has a single name) (as opposed to a range-type field).

    Type Parameters

    Type Declaration

    • OptionalautoFocus?: boolean

      Indicates if the field should be auto-focused.

    • Optionalid?: string

      The id (HTML id) of the input.

    • OptionalimmediateValidation?: UseValidationDFAOptions<T>["immediateValidation"]

      Immediate validation function (syncronous).

    • Optionallabel?: string

      The label of the field.

    • name: KeyWithValueType<FV, T>

      The name (key in form state objects) of the field.

    • OptionalscheduledValidation?: UseValidationDFAOptions<T>["scheduledValidation"]

      Scheduled validation function (asyncronous).

    • OptionalscheduleValidationDelayMS?: UseValidationDFAOptions<T>["scheduleDelayMS"]

      The number of milliseconds to wait between a change and running scheduled validation.

    • OptionalsideEffect?: (v: T) => void

      A side effect function to call when the value changes as a result of user interaction with this input, and not external updates to the field value.