You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Denis Demchenko 18881fdd97 Make `prefer-default-export` rule warning 3 years ago
docs Update docs 3 years ago
src Add support of the new Blink-based MS Edge 3 years ago
test Add support of the new Blink-based MS Edge 3 years ago
.babelrc chore(package): update lockfile package-lock.json 3 years ago
.coveralls.yml Add coveralls.yml 3 years ago
.editorconfig Fix failing tests 3 years ago
.eslintrc.yml Make `prefer-default-export` rule warning 3 years ago
.gitignore Compile 2 versions of files (es5 and bundled) 3 years ago
.npmignore Fix dotfiles 3 years ago
.npmrc Add .npmrc 3 years ago
.nycrc Fix nyc config to exclude built files from coverage 3 years ago
.testem.json Add testem as a main test runner 5 years ago
.travis.yml Update .travis.yml 3 years ago
CHANGELOG.md Write changelog 3 years ago
CONTRIBUTING.md Update rules for creating browser aliases 3 years ago
ISSUE_TEMPLATE.md Fix templates and repo meta information 3 years ago
LICENSE adds license 6 years ago
README.md Update changelog and readme 3 years ago
index.d.ts Export Parser types 3 years ago
jsdoc.json Rebuild documentation 3 years ago
package-lock.json Bump version to 2.3.0 3 years ago
package.json Bump version to 2.3.0 3 years ago
webpack.config.js chore(package): update lockfile package-lock.json 3 years ago

README.md

Bowser

A browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.

Build Status Greenkeeper badgeCoverage Status

Contents

Overview

The library is made to help to detect what browser your user has and gives you a convenient API to filter the users somehow depending on their browsers.

⚠️ Version 2.0 breaking changes ⚠️

Version 2.0 has drastically changed the API. All available methods are on the docs page.

For legacy code, check out the 1.x branch and install it through npm install bowser@1.9.4.

Use cases

First of all, require the library. This is a UMD Module, so it will work for AMD, TypeScript, ES6, and CommonJS module systems.

const Bowser = require("bowser"); // CommonJS

import * as Bowser from "bowser"; // TypeScript

import Bowser from "bowser"; // ES6 (and TypeScript with --esModuleInterop enabled)

By default, the exported version is the ES5 transpiled version, which do not include any polyfills.

In case you don't use your own babel-polyfill you may need to have pre-built bundle with all needed polyfills. So, for you it's suitable to require bowser like this: require('bowser/bundled'). As the result, you get a ES5 version of bowser with babel-polyfill bundled together.

You may need to use the source files, so they will be available in the package as well.

Browser props detection

Often we need to pick users' browser properties such as the name, the version, the rendering engine and so on. Here is an example how to do it with Bowser:

const browser = Bowser.getParser(window.navigator.userAgent);

console.log(`The current browser name is "${browser.getBrowserName()}"`);
// The current browser name is "Internet Explorer"

or

const browser = Bowser.getParser(window.navigator.userAgent);
console.log(browser.getBrowser());

// outputs
{
  name: "Internet Explorer"
  version: "11.0"
}

or

console.log(Bowser.parse(window.navigator.userAgent));

// outputs
{
  browser: {
    name: "Internet Explorer"
    version: "11.0"
  },
  os: {
    name: "Windows"
    version: "NT 6.3"
    versionName: "8.1"
  },
  platform: {
    type: "desktop"
  },
  engine: {
    name: "Trident"
    version: "7.0"
  }
}

Filtering browsers

You could want to filter some particular browsers to provide any special support for them or make any workarounds. It could look like this:

const browser = Bowser.getParser(window.navigator.userAgent);
const isValidBrowser = browser.satisfies({
  // declare browsers per OS
  windows: {
    "internet explorer": ">10",
  },
  macos: {
    safari: ">10.1"
  },

  // per platform (mobile, desktop or tablet)
  mobile: {
    safari: '>=9',
    'android browser': '>3.10'
  },

  // or in general
  chrome: "~20.1.1432",
  firefox: ">31",
  opera: ">=22"

  // also supports equality operator
  chrome: "=20.1.1432", // will match particular build only

  // and loose-equality operator
  chrome: "~20"         // will match any 20.* sub-version
  chrome: "~20.1"       // will match any 20.1.* sub-version (20.1.19 as well as 20.1.12.42-alpha.1)
});

Settings for any particular OS or platform has more priority and redefines settings of standalone browsers. Thus, you can define OS or platform specific rules and they will have more priority in the end.

More of API and possibilities you will find in the docs folder.

Browser names for .satisfies()

By default you are supposed to use the full browser name for .satisfies. But, there's a short way to define a browser using short aliases. The full list of aliases can be found in the file.

Similar Projects

  • Kong - A C# port of Bowser.

License

Licensed as MIT. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.