Type Alias: DriverState

type DriverState = {
  activeElement?: Element;
  activeIndex?: number;
  activeStep?: DriveStep;
  isActive: boolean;
  popover?: PopoverRenderModel;
  popoverDom?: PopoverDOM;
  previousElement?: Element;
  previousStep?: DriveStep;
  refreshTick: number;
  stage?: StageRect;
  transitioning: boolean;
};

The reactive, Vue-facing state of a driver. Read it through driver.state or the refs returned by useDriver(); the engine owns every write.

Properties

Property	Type	Description
activeElement?	Element	-
activeIndex?	number	-
activeStep?	DriveStep	-
isActive	boolean	-
popover?	PopoverRenderModel	The popover to render, or undefined while it is hidden.
popoverDom?	PopoverDOM	The rendered popover DOM, once the popover component reports it.
previousElement?	Element	-
previousStep?	DriveStep	-
refreshTick	number	Bumped by refresh() so components re-measure.
stage?	StageRect	The current cutout rect (interpolated while transitioning).
transitioning	boolean	The stage animation between two elements is in flight.