Type Alias UseDrawFieldResult

type UseDrawFieldResult = {
    arm: () => void;
    box: FormFieldBox | null;
    cancel: () => void;
    phase: DrawPhase;
    save: () => void;
    surfaceProps: (page: PageRenderInfo) => DrawSurfaceProps;
}

Index

Properties

arm box cancel phase save surfaceProps

Properties

arm

arm: () => void

startDraw (setup screens 2522): arms the page, discarding any box not yet saved.

box

box: FormFieldBox | null

The box being dragged or the one that was drawn, in points on the page it was drawn on.

cancel

cancel: () => void

cancelDraw / Esc / Discard. Ignored once saved — the field is no longer the drawer's.

phase

phase: DrawPhase

save

save: () => void

saveField (2525). Only a drawn box can be saved, so a double-press adds one field.

surfaceProps

surfaceProps: (page: PageRenderInfo) => DrawSurfaceProps