IDisplayOptions
interface
Display & Responsive
Configuration bag for the useDisplay() plugin — sets the global mobile breakpoint and the named breakpoint thresholds at install time.
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.
- mobileBreakpointnumber | TBreakpoint
- Global breakpoint below which `mobile` is true. Defaults to "sm".
- thresholdsPartial<TDisplayThresholds>
- Override the pixel widths for each named breakpoint (xs, sm, md, lg, xl, xxl).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Passing custom thresholds to the plugin