Type Alias: Config

type Config = {
  advanceOnClick?: boolean;
  allowClose?: boolean;
  allowKeyboardControl?: boolean;
  allowScroll?: boolean;
  animate?: boolean;
  components?: DriverComponents;
  disableActiveInteraction?: boolean;
  disableButtons?: AllowedButtons[];
  doneBtnText?: string;
  duration?: number;
  easing?: (t) => number;
  nextBtnText?: string;
  onCloseClick?: DriverHook;
  onDeselected?: DriverHook;
  onDestroyed?: DriverHook;
  onDestroyStarted?: DriverHook;
  onDoneClick?: DriverHook;
  onHighlighted?: DriverHook;
  onHighlightStarted?: DriverHook;
  onNextClick?: DriverHook;
  onPopoverRender?: (popover, opts) => void;
  onPrevClick?: DriverHook;
  overlayClass?: string;
  overlayClickBehavior?: "close" | "nextStep" | DriverHook;
  overlayColor?: string;
  overlayOpacity?: number;
  popoverClass?: string;
  popoverOffset?: number;
  prevBtnText?: string;
  progressText?: string;
  scrollAwayBehavior?: "stick" | "close" | DriverHook;
  scrollAwayOffset?: number;
  scrollBackOnClick?: boolean;
  showArrow?: boolean;
  showButtons?: AllowedButtons[];
  showProgress?: boolean;
  skipMissingElement?: boolean;
  smoothScroll?: boolean;
  stageClass?: string;
  stagePadding?: number;
  stageRadius?: number;
  steps?: DriveStep[];
  teleportTo?: string | Element;
  waitForElement?: number;
  zIndex?: number;
};

Properties

Property	Type	Description
advanceOnClick?	boolean	-
allowClose?	boolean	-
allowKeyboardControl?	boolean	-
allowScroll?	boolean	-
animate?	boolean	-
components?	DriverComponents	driver-vue addition: global component overrides, see DriverComponents.
disableActiveInteraction?	boolean	-
disableButtons?	AllowedButtons[]	-
doneBtnText?	string	-
duration?	number	-
easing?	(t) => number	driver-vue addition: easing of the stage animation between two elements. Receives the normalized time (0..1) and returns the normalized progress. (default: ease-in-out quad, as driver.js)
nextBtnText?	string	-
onCloseClick?	DriverHook	-
onDeselected?	DriverHook	-
onDestroyed?	DriverHook	-
onDestroyStarted?	DriverHook	-
onDoneClick?	DriverHook	-
onHighlighted?	DriverHook	-
onHighlightStarted?	DriverHook	-
onNextClick?	DriverHook	-
onPopoverRender?	(popover, opts) => void	-
onPrevClick?	DriverHook	-
overlayClass?	string	driver-vue addition: class added to the overlay root.
overlayClickBehavior?	"close" | "nextStep" | DriverHook	-
overlayColor?	string	-
overlayOpacity?	number	-
popoverClass?	string	-
popoverOffset?	number	-
prevBtnText?	string	-
progressText?	string	-
scrollAwayBehavior?	"stick" | "close" | DriverHook	driver-vue addition: what happens when the highlighted element is scrolled out of the viewport. "stick" keeps the popover pinned to the nearest edge with the arrow pointing back at the element; "close" ends the tour (only when allowClose is on); a function runs instead, once per departure. (default: "stick")
scrollAwayOffset?	number	driver-vue addition: how far (px) the element has to be past the viewport edge before scrollAwayBehavior runs. (default: 0)
scrollBackOnClick?	boolean	driver-vue addition: while the element is out of view, a click on the popover scrolls it back into view. (default: false)
showArrow?	boolean	driver-vue addition: render the popover arrow. (default: true)
showButtons?	AllowedButtons[]	-
showProgress?	boolean	-
skipMissingElement?	boolean	-
smoothScroll?	boolean	-
stageClass?	string	driver-vue addition: class added to the .driver-stage box, for per-tour highlight effects.
stagePadding?	number	-
stageRadius?	number	-
steps?	DriveStep[]	-
teleportTo?	string | Element	driver-vue addition: where <DriverTour> teleports its UI. (default: "body")
waitForElement?	number	-
zIndex?	number	driver-vue addition: base z-index of the overlay; the popover sits above it. (default: 10000)