Skip to content

dreambo8563/vue-device-detector

Repository files navigation

Codacy Badge All Contributors Build Status Greenkeeper badge Known Vulnerabilities License: MIT npm type definitions npm FOSSA Status

vue-device-detector (for Vue 3)

vue-device-detector is a simple vue plugin to inspect the device type.

  • focus on mobile
  • vue friendly
  • strong typed

TODO:

  • add dingding api
  • add weixin api

Install

npm install vue-device-detector --save

Quick Start

import device from "vue-device-detector"
Vue.use(device)

Methods

  • this.$device in Component context.
  • Vue.$device in global.

API list

you can get the following properties under this.$device

interface IDeviceDetector {
  ios: Boolean
  iphone: Boolean
  iphoneX: Boolean
  iPhoneXR: Boolean
  iPhoneXSMax: Boolean
  ipod: Boolean
  ipad: Boolean
  android: Boolean
  androidPhone: Boolean
  windows: Boolean
  mobile: Boolean
  dingding: Boolean //钉钉
  wechat: Boolean, // 微信
  wechatMiniApp: Boolean //微信小程序
}

eg. on iphoneX

console.log(this.$device.iphoneX) // true
console.log(this.$device.ios) // true
console.log(this.$device.android) // false

License

FOSSA Status

Contributors

Thanks goes to these wonderful people (emoji key):

Vincent Guo
Vincent Guo

💻 📖 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!