ILayerItem

interface
Layout & Sizing

Extends ILayer with identity, size and position metadata — represents a single registered layout item (AppBar, Drawer, BottomNav …) inside ILayoutProvide.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

id
required
string
Unique identifier assigned to the layout item on registration.
size
required
number
Current rendered size of the item (height or width depending on position).
position
required
TDirectionBoth
Docking edge: "top" | "bottom" | "left" | "right".

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Iterating registered layout items

typescript