Interface EditDoneArgs

Why an edit finished, and (when keyboard-driven) on which key — the argument every field's COMMIT channel (onDone) carries.

'cancel' delivers the value the field REVERTED to (the session baseline), not the abandoned text.

interface EditDoneArgs {
    altKey?: boolean;
    key?: "Enter" | "Tab" | "Escape";
    reason: "cancel" | "accept";
    shiftKey?: boolean;
}

Properties

altKey?: boolean

Alt held on the done key.

key?: "Enter" | "Tab" | "Escape"

The done key that triggered this, when keyboard-driven.

reason: "cancel" | "accept"

shiftKey?: boolean

Shift held on the done key (e.g. reverse traverse/field direction).