IInternalDisplayOptions

interface
Layout & Sizing

Resolved, non-optional display configuration used internally by the display composable after applying defaults — both mobileBreakpoint and thresholds are guaranteed to be present.

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.

mobileBreakpoint
required
number | TBreakpoint
The resolved breakpoint at or below which the display is considered mobile — a pixel value or a named TBreakpoint.
thresholds
required
TDisplayThresholds
Full resolved map of breakpoint pixel thresholds (xs, sm, md, lg, xl, xxl) used by the reactive display instance.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Internal usage inside the display plugin setup

typescript