IElevationProps

interface
Visual Style

Elevation contract — adds a shadow rung to a component via the design-token-mapped `elevation` prop, consumed by useElevation() which emits a `box-shadow: var(--origam-shadow-…)` utility class or inline style.

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.

elevation
TElevation
Shadow level — a numeric rung (0–24) mapped to the --origam-shadow-{n} token, or a named alias such as "sm" / "md" / "lg". Omitting it leaves no shadow.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Extending IElevationProps and consuming it

typescript