SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface InputFieldApi

    What useInputField hands the host input component.

    interface InputFieldApi {
        dirty: boolean;
        engaged: boolean;
        error: string | null;
        inputProps: {
            onBlur: (e: FocusEvent) => void;
            onChange: (e: ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void;
            onFocus: (e: FocusEvent) => void;
            onKeyDown: (e: KeyboardEvent) => void;
            ref: (el: HTMLTextAreaElement | HTMLInputElement | null) => void;
            value: string;
        };
        text: string;
        cancel(): void;
        commit(): void;
        revert(): void;
    }
    Index
    dirty engaged error inputProps text
    cancel commit revert
    dirty: boolean

    true when the text differs from the committed value's text.

    engaged: boolean

    true while an edit SESSION is open — for a plain field that means focused (or edited while focus stayed after a commit), and it is what the modal ✓/✗ adornments key off. A done key ends the session even though focus stays, exactly like the formula field's engagement.

    error: string | null

    Validation error for the current text — a message KEY (translate at display). null when valid.

    inputProps: {
        onBlur: (e: FocusEvent) => void;
        onChange: (e: ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void;
        onFocus: (e: FocusEvent) => void;
        onKeyDown: (e: KeyboardEvent) => void;
        ref: (el: HTMLTextAreaElement | HTMLInputElement | null) => void;
        value: string;
    }

    Spread onto the <input>: value + handlers + element ref.

    text

    text: string

    The live display text.

    • Explicit cancel — a dialog's Cancel, the adornment ✗. Reverts and fires reason: 'cancel'.

      Returns void

    • Explicit accept — a dialog's OK, the adornment ✓.

      Returns void

    • Restore the committed value's text (the field-level Escape).

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods