Type Alias: OverlaySlotProps

type OverlaySlotProps = TourScope & {
  animated: boolean;
  color: string;
  onClick: () => void;
  opacity: number;
  padding: number;
  radius: number;
  refreshTick: number;
  stage: StageRect;
  transitioning: boolean;
  zIndex: number;
};

Scope of the overlay slot.

Type Declaration

Name	Type	Description
animated	boolean	The engine animates the stage frame by frame (config.animate); false means the rect jumps and CSS may transition it.
color	string	-
onClick()	() => void	Call when the dimmed area is clicked (runs overlayClickBehavior).
opacity	number	-
padding	number	-
radius	number	-
refreshTick	number	Bumped by driver.refresh(); re-measure on change.
stage	StageRect	The cutout rect, without padding, interpolated while transitioning.
transitioning	boolean	-
zIndex	number	-