Mobile Document Scanner API Reference / Navigation
Type Alias: Navigation
Navigation = {
from:PhaseName|null;to:PhaseName;type:"phase"; } | {from:ModeName|null;phase:"rectify"|"edit";to:ModeName|null;type:"mode"; } | {open:boolean;overlay:OverlayName;phase:PhaseName;type:"overlay"; }
Defined in: src/results.ts:19
A move of the user between screens, modes, and overlays, which the navigate event reports. A minor release may add a type, so a switch on type needs a default branch.
Union Members
Type Literal
{ from: PhaseName | null; to: PhaseName; type: "phase"; }
The screen of a phase opened, after the screen of another phase or after none.
Type Literal
{ from: ModeName | null; phase: "rectify" | "edit"; to: ModeName | null; type: "mode"; }
A mode opened or closed on the screen of phase.
Type Literal
{ open: boolean; overlay: OverlayName; phase: PhaseName; type: "overlay"; }
An overlay opened or closed over the screen of phase. At most one overlay is open at a time.