@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias EditFieldSpec<V>

    type EditFieldSpec<V extends FieldValues> = {
        choices?: readonly EditChoice[];
        control:
            | "text"
            | "mono"
            | "email"
            | "phone"
            | "choice"
            | "status"
            | "fixed";
        description?: string;
        identity?: boolean;
        inputMode?: "numeric"
        | "email"
        | "tel";
        label: string;
        masked?: boolean;
        maxLength?: number;
        name: EditPath<V>;
        placeholder?: string;
        required?: boolean;
        shownWhen?: (read: ValueReader) => boolean;
        validate?: (value: string, read: ValueReader) => true | string;
        width?: "full" | "half" | "third";
    }

    Type Parameters

    • V extends FieldValues
    Index
    choices? control description? identity? inputMode? label masked? maxLength? name placeholder? required? shownWhen? validate? width?
    choices?: readonly EditChoice[]
    control: "text" | "mono" | "email" | "phone" | "choice" | "status" | "fixed"

    mono is for identifiers and account numbers; fixed is shown, never edited.

    description?: string
    identity?: boolean

    Part of the instrument's identity (its provider id): earns the past-transactions warning.

    inputMode?: "numeric" | "email" | "tel"
    label: string
    masked?: boolean

    Account-like: the review step shows only the last 4.

    maxLength?: number
    name: EditPath<V>
    placeholder?: string
    required?: boolean
    shownWhen?: (read: ValueReader) => boolean

    Hidden fields neither validate nor count as changed.

    validate?: (value: string, read: ValueReader) => true | string
    width?: "full" | "half" | "third"

    Settings
    Member Visibility

    On This Page
    Properties