parrot-module-device

0.12.16 • Public • Published

parrot-module-device

Dependency status Dev Dependencies Status

Automatically detect your device and provide some useful information: vendor, screen properties, browser vendor and version,...

Browser Compatibility

browser support

Install

npm install myModule --save

Get Started

With parrot.device you can have useful information of your clients (Browsers, mobiles, desktops,...)

Documentation

parrot.device

.detection()

This function is called automatically when your device is ready and provide you and resume of your device.

It's insert in the body of your html useful information as data attributes, like:

  • Language (en, es,...)
  • Operative System (Mac OS, Linux, Android, iOS, BlackBerry,...)
  • Type of device (desktop, tablet or mobile)
  • Orientation of the device (landscape or portrait)
  • Type of screen (normal or small)

For example:

<body data-lang="en" data-os="ios" data-device="mobile" data-orientation="portrait" data-screen="small" data-retina="false">

.noDetection()

Although detection is called automatically, maybe you don't want this behavior. With this function you can avoid the detection action and not insert the default data attributes in the body of your html .

.model

It's returns the technical model name of your device.

parrot.device.model
# => iPhone, Nexus 5, GT-N7100, One, Lumia 820 

Not always is possible determine this value.

.vendor

It's returns the official vendor of your device.

parrot.device.vendor
# => Apple, Google, Samsung, HTC, Nokia,... 

Not always is possible determine this value.

.cpu

It's returns the CPU arquitecture of your device.

parrot.device.cpu
# => 68k, amd64, arm, arm64, avr, ia32, ia64, irix, irix64, mips, mips64, pa-risc, ppc, sparc, sparc64 

Not always is possible determine this value.

.type

parrot.device.type
# => desktop, tablet, mobile 

.browser

It's returns the software under the browser of your device.

parrot.device.browser
# => {name: "Chrome", version: "39.0.2171.71", major: "39"} 
# => {name: "Mobile Safari", version: "4.0", major: "4"} 

.engine

It's returns the thecnology under the browser software of your device.

parrot.device.engine
# => {name: "WebKit", version: "530.17"} 

.os

It's returns the software under your device.

parrot.device.os
# => {name: "Mac OS", version: "10.10.1"} 
# => {name: "iOS", version: "8.0"} 
# => {name: "Android", version: "4.3"} 
# => {name: "Windows Phone", version: "8.0"} 

.screen

It's returns information about the screen of your device.

parrot.device.screen
# => {aspectRatio: "16:9", width: 1080, height: 920, size: "small", orientation: "portrait", pixelRatio: 1} 

License

MIT © ParrotJS

Package Sidebar

Install

npm i parrot-module-device

Weekly Downloads

0

Version

0.12.16

License

MIT

Last publish

Collaborators

  • kikobeats