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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- xrequirednumber
- Horizontal distance from the left of the viewport.
- yrequirednumber
- Vertical distance from the top of the viewport.
- widthrequirednumber
- Width of the element in pixels.
- heightrequirednumber
- Height of the element in pixels.
- toprequirednumber
- Distance from the top of the viewport (same as y).
- bottomrequirednumber
- Distance from the top of the viewport to the bottom edge (top + height).
- leftrequirednumber
- Distance from the left of the viewport (same as x).
- rightrequirednumber
- 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.