ink
Version:
React for CLI
32 lines (30 loc) • 1.6 kB
JavaScript
/**
Measure the layout metrics of a particular `<Box>` element.
Returns an object with `x`, `y`, `width`, and `height` properties.
`x` and `y` are the element's position within the live layout region, computed by walking up the layout tree and accumulating each ancestor's offset. These are layout-tree coordinates, not terminal viewport coordinates. To compare them with mouse events, convert the event coordinates using the live region's viewport position. This is necessary even in alternate-screen mode when output, such as `<Static>` content, appears above the live region.
Note: `measureElement()` returns `{x: 0, y: 0, width: 0, height: 0}` when called during render (before layout is calculated). Call it from post-render code, such as `useEffect`, `useLayoutEffect`, input handlers, or timer callbacks. When content changes, pass the relevant dependency to your effect so it re-measures after each update.
*/
const measureElement = (node) => {
const { yogaNode } = node;
if (!yogaNode) {
return { x: 0, y: 0, width: 0, height: 0 };
}
let x = yogaNode.getComputedLeft();
let y = yogaNode.getComputedTop();
let current = node.parentNode;
while (current) {
if (current.yogaNode) {
x += current.yogaNode.getComputedLeft();
y += current.yogaNode.getComputedTop();
}
current = current.parentNode;
}
return {
x,
y,
width: yogaNode.getComputedWidth(),
height: yogaNode.getComputedHeight(),
};
};
export default measureElement;
//# sourceMappingURL=measure-element.js.map