Type Alias: HintsConfig

type HintsConfig = {
  beacon?: HintBeacon;
  buttonText?: string;
  hints?: DriverHint[];
  onButtonClick?: HintHook;
  onDismiss?: HintHook;
  onOpen?: HintHook;
  overlay?: boolean;
  overlayColor?: string;
  overlayOpacity?: number;
  popoverClass?: string;
  popoverOffset?: number;
  showArrow?: boolean;
  teleportTo?: string | Element;
  zIndex?: number;
};

Properties

Property	Type	Description
beacon?	HintBeacon	-
buttonText?	string	-
hints?	DriverHint[]	-
onButtonClick?	HintHook	-
onDismiss?	HintHook	-
onOpen?	HintHook	-
overlay?	boolean	-
overlayColor?	string	-
overlayOpacity?	number	-
popoverClass?	string	-
popoverOffset?	number	-
showArrow?	boolean	driver-vue addition: render the popover arrow for every hint. (default: true)
teleportTo?	string | Element	driver-vue addition: where <DriverHints> teleports its UI. (default: "body")
zIndex?	number	driver-vue addition: base z-index (the tour's default is 10000).