platform-detect

platform-detect

🃏 Minimalistic isomorphic library for detection of platform, runtime, APIs and more.

Check out the demo

• No dependencies
• Small size ~3kB
• Split into multiple files "import just what you need"
• ... but also available as a bundle of all detectors.

Detects

• Systems: Windows, Android, MacOsX, iOs, Linux
• Runtime
  • general: Node.js, browser, web worker
  • specific: website, PWA, Electron, NW.JS, console app, UWP (Windows Store)
• Context: has rendererer (i.e. has window); is console script (Node, web worker, NW background script, Electron main script); running on SDK build, with DEV context, Dev Tools open or debugger attached.
• Form factor: phone, tablet, desktop, tv
• Screen: touchscreen, input type (touch, mouse), tablet mode (whether keyboard is attached/detached on 2-in-1 like Surface Pro)

Installation

npm install platform-detect

Usage

import * as platform from 'platform-detect'


// The script has no window or GUI to render content to.
// It only runs in console / terminal. (Might be a Node script or WebWorker)
platform.isConsole
// App has a window, access to DOM. Can render GUI.
platform.hasWindow

// Fully functional Node & core modules are available. (Might be an Electron / NWJ.JS app or a good old Node console script)
platform.node
// App has been loaded as a plain website in a browser.
platform.website
// App is served from web (could be website or PWA)
platform.web
// App is packaged, compiled or bundled and not served from the web. Could be UWP, Electron, NW.JS, Chrome App, Cordova, etc...
platform.packaged
// Script is executed inside Web Worker.
platform.worker

// App has been loaded as a PWA / UWP / Electron / NW.JS / Cordova app
platform.pwa
platform.uwp
platform.electron
platform.nwjs
platform.cordova

Or import just what you need

import {windows, android, linux, macosx, tizen} from 'platform-detect/os.mjs'
import {chrome, edge, safari} from 'platform-detect/browser.mjs'
import {inputType, mouse, touch, touchscreen, tabletMode, formFactor} from 'platform-detect/formfactor.mjs'

if (formFactor === 'tv' && tizen) {
  console.log(`I'm a Samsung Smart TV!`)
}

if (windows && edge && (uwp || pwa)) {
  console.log(`I should use Fluent Design System`)
} else if (android || chromeos) {
  console.log(`I should use Material Design Language`)
}

if (touchscreen) {
  console.log(`This is a device with touchscreen`)
  if (!touch) {
    console.log(`But mouse is currently the primary input type`)
    console.log('inputType', inputType) // 'mouse'
    console.log(`The device is likely in tablet mode (Surface Pro with attached keyboard)`)
    console.log('tabletMode', tabletMode) // true
  }
}

You can choose between the old UMD module.

<script src="./node_modules/platform-detect/index.js"></script>

var platform = self['platform-detect']

console.log('pixel ratio of this device is', platform.pixelRatio)

Or the new ES Modules.

<script type="module">
import * as platform from './node_modules/platform-detect/index.js'

platform.on('orientation', orientation => console.log(orientation))
platform.on('tabletMode', tabletMode => console.log('the device', tabletMode ? 'entered' : 'left', 'tablet mode'))
</script>

API

Check out the demo for full table of APIs

Changelog

[1.0.0]

Added

• initial implementation