Type Alias: State

type State = {
  __activeElement?: Element;
  __activeOnDestroyed?: Element;
  __activeStagePosition?: StageRect;
  __activeStep?: DriveStep;
  __events?: {
     onClick: (e) => void;
     onKeydown: (e) => void;
     onKeyup: (e) => void;
     onResize: () => void;
     onScroll: () => void;
  };
  __pendingWaitCancel?: () => void;
  __previousElement?: Element;
  __previousStep?: DriveStep;
  __resizeTimeout?: number;
  __scrollAwayArmed?: boolean;
  __transitionCallback?: () => void;
  activeElement?: Element;
  activeIndex?: number;
  activeStep?: DriveStep;
  isInitialized?: boolean;
  popover?: PopoverDOM;
  previousElement?: Element;
  previousStep?: DriveStep;
};

The state shape driver.js exposes through getState() and the hook options. Kept for parity; prefer DriverState in Vue code.

Properties

Property	Type	Description
__activeElement?	Element	-
__activeOnDestroyed?	Element	-
__activeStagePosition?	StageRect	-
__activeStep?	DriveStep	-
__events?	{ onClick: (e) => void; onKeydown: (e) => void; onKeyup: (e) => void; onResize: () => void; onScroll: () => void; }	-
__events.onClick	(e) => void	-
__events.onKeydown	(e) => void	-
__events.onKeyup	(e) => void	-
__events.onResize	() => void	-
__events.onScroll	() => void	-
__pendingWaitCancel?	() => void	-
__previousElement?	Element	-
__previousStep?	DriveStep	-
__resizeTimeout?	number	-
__scrollAwayArmed?	boolean	The element has been in view since the step started, so leaving it counts.
__transitionCallback?	() => void	-
activeElement?	Element	-
activeIndex?	number	-
activeStep?	DriveStep	-
isInitialized?	boolean	-
popover?	PopoverDOM	-
previousElement?	Element	-
previousStep?	DriveStep	-