Skip to content

Type Alias: MountedHint ​

ts
type MountedHint = {
  animate: boolean;
  className: string;
  element: Element;
  expanded: boolean;
  hidden: boolean;
  hint: DriverHint;
  id: string;
  label: string;
  pageX: number;
  pageY: number;
  x: number;
  y: number;
};

A hint currently on the page, as rendered by <DriverHints>.

Properties ​

PropertyTypeDescription
animateboolean-
classNamestring-
elementElement-
expandedbooleanThis hint's popover is open.
hiddenbooleanThe element scrolled out of view; the beacon is hidden.
hintDriverHint-
idstring-
labelstring-
pageXnumberThe same point in document coordinates (viewport + scroll offset). The beacon is positioned absolutely with these, so it scrolls with the page natively instead of chasing the scroll from JavaScript.
pageYnumber-
xnumberThe beacon's anchor point, in viewport coordinates (the beacon is centered on it).
ynumber-

Released under the MIT License.