# mobile-device-detect

> Helpers for handling mobile devices

Latest version **0.4.3** (published 2020-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install mobile-device-detect
pnpm add mobile-device-detect
yarn add mobile-device-detect
bun add mobile-device-detect
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.3 |
| Published | 2020-06-15 |
| First published | 2018-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 46.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 199 |
| Author | Michael Laktionov |
| Maintainers | duskload |
| Keywords | useragent, mobile, phone, tablet, detect, device, browser, smart-tv, smarttv, version, model, console |

## Links

- npm: https://www.npmjs.com/package/mobile-device-detect
- Repository: https://github.com/duskload/mobile-device-detect
- Homepage: https://github.com/duskload/mobile-device-detect#readme
- Issues: https://github.com/duskload/mobile-device-detect/issues
- npm.io page: https://npm.io/package/mobile-device-detect

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.4.3 (latest) — 2020-06-15
- 0.3.3 — 2019-09-13
- 0.2.3 — 2018-07-03
- 0.2.2 — 2018-06-21
- 0.2.1 — 2018-06-14
- 0.2.0 — 2018-06-14
- 0.1.0 — 2018-06-14

## README

## mobile-device-detect

Helpers for handling mobile devices in javascript.

## Installation

To install, you can use npm or yarn:

```
npm install mobile-device-detect --save

or

yarn add mobile-device-detect
```

## Usage

Import any helper to your component, for example, in Vue.js:

```html
<script>
import { isMobile } from 'mobile-device-detect';
export default {
  name: 'HelloWorld',
  data () {
    return {
      msg: isMobile ? 'Welcome to Your Vue.js mobile App!' : 'Welcome to Your Vue.js App'
    }
  }
}
</script>

```
pass it to template: 

```html
<template>
  <div class="hello">
    {{ msg }}
  </div>
</template>
```

For react example, you can look into separated package [react-device-detect](https://github.com/duskload/react-device-detect)

### Selectors

| Property           | Return type     | Description                                                                            |
| ------------------ | -------- | -------------------------------------------------------------------------------------- |
| isMobile           | bool     | returns true if device type is `mobile` or `tablet`                                    |
| isMobileOnly       | bool     | returns true if device type is `mobile`                                                |
| isTablet           | bool     | returns true if device type is `tablet`                                                |
| isBrowser          | bool     | returns true if device type is `browser`                                               |
| isSmartTV          | bool     | returns true if device type is `smarttv`                                               |
| isWearable         | bool     | returns true if device type is `wearable`                                              |
| isConsole          | bool     | returns true if device type is `console`                                               |
| isAndroid          | bool     | returns true if os type is `Android`                                                   |
| isWinPhone         | bool     | returns true if os type is `Windows Phone`                                             |
| isIOS              | bool     | returns true if os type is `iOS`                                                       |
| isChrome           | bool     | returns true if browser is `Chrome`                                                    |
| isFirefox          | bool     | returns true if browser is `Firefox`                                                   |
| isSafari           | bool     | returns true if browser is `Safari`                                                    |
| isOpera            | bool     | returns true if browser is `Opera`                                                     |
| isIE               | bool     | returns true if browser is `Internet Explorer`                                         |
| isEdge             | bool     | returns true if browser is `Edge` or `Edge Chromium`                                                     |
| isYandex           | bool     | returns true if browser is `Yandex`                                                      |
| isChromium         | bool     | returns true if browser is `Chromium`                                                  |
| isMobileSafari     | bool     | returns true if browser is `Mobile Safari`                                             |
| osVersion          | string   | returns os version (e.g 7 for `Windows` or 6 for `Android`)                            |
| osName             | string   | returns os name (e.g `Windows`, `Android`)                                             |
| fullBrowserVersion | string   | returns full browser version (e.g 65.0.3325.181 for `Chrome`)                          |
| browserVersion     | string   | returns browser `major` version (e.g 65 in `Chrome` or 9 in `IE`)                      |
| browserName        | string   | returns browser name                                                                   |
| mobileVendor       | string   | returns mobile device vendor (e.g `LG`, `iPhone` etc)                                  |
| mobileModel        | string   | returns mobile device model (e.g `Nexus 5`)                                            |
| engineName         | string   | returns browser engine `name` (e.g `Gecko` for FF or `WebKit` for Chrome)              |
| engineVersion      | string   | returns engine version                                                                 |
| getUA              | string   | returns user agent                                                                     |
| deviceType         | string   | returns device type (e.g `mobile` or `tablet`)  |
| isIOS13            | boolean  | returns true/false if device is running on iOS13                                       |
| isIPhone13         | boolean  | returns true/false if device is iPhone and running on iOS13                            |
| isIPad13           | boolean  | returns true/false if device is iPad and running on iOS13                              |
| isIPod13           | boolean  | returns true/false if device is iPod and running on iOS13                              |
| isElectron         | boolean  | returns true/false if running on `Electron`                                            |
| isEdgeChromium     | boolean  | returns true/false if browser is `Edge Chromium`                                       | 
| isLegacyEdge       | boolean  | returns true if browser is `Edge`                                                      |
| isWindows          | boolean  | returns true/false if os is `Windows`                                                  |
| isMacOs            | boolean  | returns true/false if os is `Mac OS`                                                   |
| deviceDetect       | function | return data object which includes all data about device (e.g version, engine, os etc.) |

## License

MIT

---
_Source: https://npm.io/package/mobile-device-detect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._