hd-utils
Version:
A handy utils for modern JS developers
14 lines (13 loc) • 756 B
TypeScript
import { GetHtmlElementCoordsOptions } from '../types';
/**
* @description Finding element's position (x, y coordinates) relative to the document.
* @example getElementCoords(document.getElementById("id")) // {x:1, y:1}
* @example getElementCoords(document.getElementById("id"), {position:"center"}) // {x:1, y:0}
* @example getElementCoords(document.getElementById("id"), {position:"top right"}) // {x:1, y:2}
* @example getElementCoords(document.getElementById("id"), {position:"top left"}) // {x:2, y:1}
* @example getElementCoords(document.getElementById("id"), {precise:true}) // {x:2.123, y:1.123}
*/
export default function getHtmlElementCoords(element: HTMLElement, options?: GetHtmlElementCoordsOptions): {
x: number;
y: number;
};