ILayoutItemProps

interface
Layout & Sizing

Props for components that register themselves as layout items (AppBar, Drawer, BottomNav …) inside an OrigamLayout.

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.

name
string
Identifier used to match overlapping layout items declared in the parent ILayoutProps.overlaps.
order
string | number
Stacking order in the parent OrigamLayout. Falls back to a unique-ID-based order when omitted.
absolute
boolean
When true, the item does not consume layout space — it is positioned absolutely over the main area.
location
TDirectionBoth
Docking edge: "top" | "bottom" | "left" | "right". Determines which side of the layout the item occupies.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

AppBar as a layout item

html