schneidermr / happy-browser

A browser detection tool

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Code Climate Test Coverage Issue Count

1. Happy Browser

A browser detection tool

2. Browser Supported

Chrome Firefox IE Edge Opera Safari
>= 45 >=3.5 >7 >=12 >3 >3

3. Install

yarn add --save-dev happy-brwoser
npm install --dev happy-browser

4. Usage

4.1 Import

import HappyBrowser from 'HappyBrowser';
# or
const HappyBrowser = require('HappyBrowser');

# then
require('happy-browser/dist/happy-browser.min.css');

4.2 Detect Specific Browser

HappyBrowser.isChrome()
HappyBrowser.isOpera()
HappyBrowser.isSafari()
HappyBrowser.isIE()
HappyBrowser.isEdge()
HappyBrowser.isChrome()
HappyBrowser.isBlink()

4.3 Alert

HappyBrowser.alert({
  alertWhen: (browser) => true,
  alertMode: HappyBrowser.alertMode.banner,
  jumpURL: 'https://browsehappy.com/'
})

5. Configuration

5.1 Alert Mode

static alertMode = {
  jump: 'jump', // jump to JumpURL directly
  banner: 'banner' // show banner in webpage
};

5.2 alertWhen

The alertWhen function returns Boolean, true means alerting, false for not. The browser object is passed to alertWhen:

browser = {
    name: String,
    version: String
}    

6. Contribution

PR welcome!

About

A browser detection tool


Languages

Language:JavaScript 91.2%Language:CSS 7.5%Language:HTML 1.2%