Skip to content

Type Alias: Popover ​

ts
type Popover = {
  align?: Alignment;
  component?: Component;
  description?: string;
  disableButtons?: AllowedButtons[];
  doneBtnText?: string;
  nextBtnText?: string;
  onCloseClick?: DriverHook;
  onDoneClick?: DriverHook;
  onNextClick?: DriverHook;
  onPopoverRender?: (popover, opts) => void;
  onPrevClick?: DriverHook;
  popoverClass?: string;
  prevBtnText?: string;
  progressText?: string;
  props?: Record<string, unknown>;
  showArrow?: boolean;
  showButtons?: AllowedButtons[];
  showProgress?: boolean;
  side?: Side;
  title?: string;
};

Properties ​

PropertyTypeDescription
align?Alignment-
component?Componentdriver-vue addition: a Vue component rendered as the popover body for this step, in place of the default title/description/footer. It receives the tour slot props (TourSlotProps) plus props below.
description?string-
disableButtons?AllowedButtons[]-
doneBtnText?string-
nextBtnText?string-
onCloseClick?DriverHook-
onDoneClick?DriverHook-
onNextClick?DriverHook-
onPopoverRender?(popover, opts) => void-
onPrevClick?DriverHook-
popoverClass?string-
prevBtnText?string-
progressText?string-
props?Record<string, unknown>driver-vue addition: extra props passed to component.
showArrow?booleandriver-vue addition: render the arrow pointing at the element. (default: true)
showButtons?AllowedButtons[]-
showProgress?boolean-
side?Side-
title?string-

Released under the MIT License.