@cerebral/useragent

3.2.2 • Public • Published

@cerebral/useragent

Install

NPM

npm install @cerebral/useragent

Description

The useragent module puts information about the browser into your state tree, and it also updates this information when this information changes.

  • UA parser: browser and device
  • Window: size & orientation
  • Media queries
  • Feature detection
  • Internet connectivity

Instantiate

import { Controller } from 'cerebral'
import Useragent from '@cerebral/useragent'

const controller = Controller({
  modules: {
    useragent: Useragent({
      // Use CSS media queries to determine
      // custom sizes available in your model.
      // They will be toggle between true/false in your
      // model
      media: {
        small: '(min-width: 600px)',
        medium: '(min-width: 1024px)',
        large: '(min-width: 1440px)',
        portrait: '(orientation: portrait)'
      },

      // store all feature tests in model
      feature: true,

      parse: {
        // parse useragent.browser from ua string
        browser: true,
        // parse useragent.device from ua string
        device: true
      },

      // check the docs at: https://github.com/HubSpot/offline#advanced
      offline: {
        checkOnLoad: false,
        interceptRequests: true,
        reconnect: {
          initialDelay: 3,
          delay: 1.5
        },
        requests: false
      },

      // update window size on resize
      window: true
    })
  }
})

Package Sidebar

Install

npm i @cerebral/useragent

Weekly Downloads

20

Version

3.2.2

License

MIT

Unpacked Size

24.7 kB

Total Files

19

Last publish

Collaborators

  • fweinb
  • cerebral.js
  • christianalfoni
  • guria
  • gbucher
  • henri-hulski