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
| Property | Type | Description |
|---|---|---|
align | Alignment | - |
centered | boolean | No real element: center the popover in the viewport like a modal. |
component? | Component | - |
componentProps? | Record<string, unknown> | - |
description? | string | - |
disableButtons | AllowedButtons[] | - |
doneButton | boolean | The next button acts as the tour's done button. |
key | number | Increments per render so a fresh popover mounts on every step. |
nextBtnText | string | - |
offset | number | Gap between the cutout and the popover (stagePadding + popoverOffset). |
onCloseClick | () => void | - |
onNextClick | () => void | - |
onPrevClick | () => void | - |
padding | number | The stage padding, used to expand the anchor rect to the cutout. |
popoverClass | string | - |
prevBtnText | string | - |
progressText | string | - |
scrollBackOnClick | boolean | A click on the popover scrolls the element back while it is out of view. |
showArrow | boolean | - |
showButtons | AllowedButtons[] | - |
showProgress | boolean | - |
side | Side | - |
smoothScroll | boolean | - |
title? | string | - |