Device

> device detection (phone, tablet, desktop, os)


Installation

$3

``bash


npm


$ npm install @xg4/device --save
`

`bash


yarn


$ yarn add @xg4/device
`

Usage

`js
// commonjs in node or browser
const Device = require('@xg4/device').default

// es module
import Device from '@xg4/device'

const device = new Device() // or new Device(userAgent)
`

$3

| name | description |
| ---- | ------------------------------------------------------------------------------ |
| type | device type (mobile, tablet, desktop, null) |
| os | device os (ios, android, blackberry, mac, windows, firefox, meego, tv, null) |

$3

| name | description | return |
| ------------------ | ----------------------- | ------- |
| isMac | / | Boolean |
| isIphone | / | Boolean |
| isIpod | / | Boolean |
| isIpad | / | Boolean |
| isIos | / | Boolean |
| isWindows | / | Boolean |
| isWindowsPhone | / | Boolean |
| isWindowsTablet | / | Boolean |
| isAndroid | / | Boolean |
| isAndroidPhone | / | Boolean |
| isAndroidTablet | / | Boolean |
| isBlackberry | / | Boolean |
| isBlackberryPhone | / | Boolean |
| isBlackberryTablet | / | Boolean |
| isFirefox | firefox os, not browser | Boolean |
| isFirefoxPhone | firefox os, not browser | Boolean |
| isFirefoxTablet | firefox os, not browser | Boolean |
| isMeego | / | Boolean |
| isCordova | / | Boolean |
| isNode | / | Boolean |
| isMobile | / | Boolean |
| isTablet | / | Boolean |
| isDesktop | / | Boolean |
| isTv | / | Boolean |

$3

`js
// commonjs in node or browser
const Orientation = require('@xg4/device').Orientation

// es module
import { Orientation } from '@xg4/device'

const orientation = new Orientation()

orientation.listen(function(event, type) {
// type === 'landscape' || 'portrait'
})
`

#### Orientation Instance Properties

- type: 'landscape' || 'portrait'

#### Orientation Instance Methods

- isPortrait: Boolean

- isLandscape: Boolean

- listen`: void

Contributing

Welcome

- Fork it

- Submit pull request

LICENSE

MIT