IDisplayPlatform
interface
Display & Responsive
Platform detection snapshot — a set of boolean flags that identify the current runtime environment (OS, browser, form factor). Exposed as `platform` on the IDisplayInstance reactive object.
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.
- androidrequiredboolean
- True when the UA suggests an Android device.
- iosrequiredboolean
- True when the UA suggests an iOS device.
- cordovarequiredboolean
- True when running inside a Cordova/Capacitor shell.
- electronrequiredboolean
- True when running inside Electron.
- chromerequiredboolean
- True when the UA is Chromium-based.
- edgerequiredboolean
- True when the UA is Microsoft Edge.
- firefoxrequiredboolean
- True when the UA is Firefox.
- operarequiredboolean
- True when the UA is Opera.
- winrequiredboolean
- True when the OS is Windows.
- macrequiredboolean
- True when the OS is macOS.
- linuxrequiredboolean
- True when the OS is Linux (non-Android).
- touchrequiredboolean
- True when a primary touch input is detected.
- ssrrequiredboolean
- True when the code runs in a server-side rendering context.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading platform flags from useDisplay()