vue-device-detector

A Vue plugin that add global functionality to check a device type, the client is displayed on. Moreover it add directives to hide DOM elements on specific device types.
Works in relation to the Include Media SASS library. This means that this plugin has the same device types and share the breakpoints to differ them.
So far this plugin is not hard related to the library, so there is no dependency and changes there will have no affects here.

Advantage
Installation
- Module
Device Types
Configuration
- Example
- Practise
Usage
- Functions
- Directives

Advantage

This plugin helps to adjust the behavior of your Vue client for different devices. Especially when working with the Include Media library
Sometimes it is not possible to simply work with @include media('...') in the style sheets, to hide elements or functionality. In such cases a Vue component method have to know on which device type the client is displayed. To be conform with the style sheets, it is useful to have the same understanding what a device type is and define it the same way. Using this plugin provides a good synergy between the script and style parts, when using Include Media (tested with version 1.4.9)

Installation

npm install weilbith/vue-device-detector

Module

import Vue from 'vue'
import VueDeviceDetecor from 'vue-device-detector'

The plugin registered itself to Vue. Anyway it could been added by Vue.use(VueDeviceDetector).

Device Types

As said the device types refer to the Include Media library. The exact list can be found here and contains the following entries:

mobile
tablet
desktop

The types are related to so called breakpoints, also defined to Include Media. A breakpoint define the minimum window width of a client, so it is recognized as this device type.
Check this definitions for the correct values.

Type	Breakpoint
mobile	320px
tablet	768px
desktop	1024

Configuration

The plugin does work with a default configuration. Anyway it is possible to provide an options object.
Therefore only the property breaker is defined so far. It divide the device types into two sections: The desktop types and the mobile types. Do not mix this denotation with the device types mobile and desktop.
It should help to work with a client that only differ between two groups of types.
The breaker describe the first element of the upper group. All types that are "smaller" are in the lower group, the rest in the upper.
The default breaker is set to desktop.

Example

breaker: desktop

LowerGroup: mobile, tablet
UpperGroup: desktop

Practise

import Vue from 'vue'
import { VueDeviceDetecor, DeviceTypEnum } from 'vue-device-detector'

Vue.use(VueDeviceDetector, { breaker: DeviceTypEnum.desktop })

Usage

Functions

The plugin provides three functions to use:

Function	Arguments	Description
`$isMobile`	None	Check in relation to the configuartion if the device type is in the lower group.
`$isDesktop`	None	Check in relation to the configuartion if the device type is in the upper group.
`$isDevice`	Type	Check if the device type is exactly the specified one.

Examples The plugin functionality is registered globally an can be be accessed by any component.

<script>
  // Import the device type enumeration.
  import { DeviceTypeEnum } from 'vue-device-detector '
  
  export default {
    ...
    methods: {
      doOnUpperGroup () {
        // Do something only on devices of the upper group.
        if (this.$isDesktop()) {
          // Do your stuff here...
        }
      },
      
      doOnTablet () {
        // Do something only if the device match the specific type.
        if (this.$isDevice(DeviceTypeEnum.tablet)) {
          // Do your stuff here...
        }
      }
    },
    ...
  }
</script>

Directives

The plugin provide some directives as well. They are used as quick solution to hide elements on specific devices.
When such a directive is added to an element and the defined device type is detected, the element display value will be set to none.
In fact this the same as using it in the style sheet itself like @include media('>=desktop') { display: none; }.

Name	Binding	Description
`v-hide-on-mobile`	None	Hide the element if the device type is part of the lower group.
`v-hide-on-desktop`	None	Hide the element if the device type is part of the upper group.
`v-hide-on-device`	Type	Hide element if the device type is equal the specified type.

Examples

<template>
  <div id="my-component">
     <!-- Hide element on lower group devices -->
     <div v-hide-on-mobile > Only on desktop </div>
     
     <!-- Hide element on upper group devices -->
     <div v-hide-on-desktop > Only on mobile </div>
     
     <!-- Hide element on device type 'mobile' using enumeration object -->
     <div v-hide-on-device="deviceTypeEnum.mobile" />
     
     <!-- Hide element on device type 'tablet' using computed value -->
     <div v-hide-on-device="device" />
     
     <!-- Hide element on device type 'destop' using plain key property -->
     <div v-hide-on-device="{type: 'desktop'}" />
  </div>
</template

<script>
  import { DeviceTypeEnum } from 'vue-device-detector'
  
  export default {
    data () {
      return {
        // Add this here, so it is accessable when render the template.
        deviceTypeEnum: DeviceTypeEnum,
        ...
    },
    ...
    computed: {
      device () {
        // For some reason specify a device type from here.
        return DeviceTypeEnum.tablet
      }
    }
  }
</script>

<style>
  div {
    position: relatvie;
    min-width: 20px;
    min-height: 20px;
    background-color: red;
  }
<style>

IvanLencina/vue-device-detector