All files / spotlight-tour/src/engine getSpotlightRect.ts

100% Statements 1/1
100% Branches 0/0
100% Functions 1/1
100% Lines 1/1

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30                                            292x              
import type { Rect } from "../types";
 
/**
 * Compute the spotlight rect from a target rect: the target expanded by
 * `padding` px on every side. Pure — no DOM access.
 *
 * The result can go negative in `x`/`y` when the target sits at the viewport
 * edge; that is intentional (the overlay mask clips it).
 *
 * @param target - The target element's rect in viewport coordinates.
 * @param padding - Extra px added around the target on all sides.
 * @returns The padded spotlight rect.
 *
 * @example
 * ```ts
 * import { getSpotlightRect } from "@usefy/spotlight-tour/headless";
 *
 * const spotlight = getSpotlightRect({ x: 100, y: 50, width: 200, height: 40 }, 8);
 * // → { x: 92, y: 42, width: 216, height: 56 }
 * ```
 */
export function getSpotlightRect(target: Rect, padding: number): Rect {
  return {
    x: target.x - padding,
    y: target.y - padding,
    width: target.width + padding * 2,
    height: target.height + padding * 2,
  };
}