IBox

interface
Layout & Sizing

Bounding-box snapshot — the shape returned by useResizeObserver and intersection utilities, describing an element's position and dimensions in the viewport.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

x
required
number
Horizontal distance from the left of the viewport.
y
required
number
Vertical distance from the top of the viewport.
width
required
number
Width of the element in pixels.
height
required
number
Height of the element in pixels.
top
required
number
Distance from the top of the viewport (same as y).
bottom
required
number
Distance from the top of the viewport to the bottom edge (top + height).
left
required
number
Distance from the left of the viewport (same as x).
right
required
number
Distance from the left of the viewport to the right edge (left + width).

Ecosystem

Used by

Components and composables that extend or consume this interface.