Skip to content

Type Alias: PopoverRenderModel ​

ts
type PopoverRenderModel = {
  align: Alignment;
  centered: boolean;
  component?: Component;
  componentProps?: Record<string, unknown>;
  description?: string;
  disableButtons: AllowedButtons[];
  doneButton: boolean;
  key: number;
  nextBtnText: string;
  offset: number;
  onCloseClick: () => void;
  onNextClick: () => void;
  onPrevClick: () => void;
  padding: number;
  popoverClass: string;
  prevBtnText: string;
  progressText: string;
  scrollBackOnClick: boolean;
  showArrow: boolean;
  showButtons: AllowedButtons[];
  showProgress: boolean;
  side: Side;
  smoothScroll: boolean;
  title?: string;
};

Everything a popover needs to render, fully resolved against the step and the config. Consumed by <DriverPopover>, slots and custom components.

Properties ​

PropertyTypeDescription
alignAlignment-
centeredbooleanNo real element: center the popover in the viewport like a modal.
component?Component-
componentProps?Record<string, unknown>-
description?string-
disableButtonsAllowedButtons[]-
doneButtonbooleanThe next button acts as the tour's done button.
keynumberIncrements per render so a fresh popover mounts on every step.
nextBtnTextstring-
offsetnumberGap between the cutout and the popover (stagePadding + popoverOffset).
onCloseClick() => void-
onNextClick() => void-
onPrevClick() => void-
paddingnumberThe stage padding, used to expand the anchor rect to the cutout.
popoverClassstring-
prevBtnTextstring-
progressTextstring-
scrollBackOnClickbooleanA click on the popover scrolls the element back while it is out of view.
showArrowboolean-
showButtonsAllowedButtons[]-
showProgressboolean-
sideSide-
smoothScrollboolean-
title?string-

Released under the MIT License.