1
0
mirror of https://github.com/lancedikson/bowser synced 2024-10-27 20:34:22 +00:00
lancedikson_bowser/README.md

149 lines
4.4 KiB
Markdown
Raw Normal View History

2014-03-01 18:22:06 +00:00
## Bowser
A browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.
2011-04-27 22:14:35 +00:00
2018-08-24 22:06:25 +00:00
[![Build Status](https://travis-ci.org/lancedikson/bowser.svg?branch=master)](https://travis-ci.org/lancedikson/bowser/) [![Greenkeeper badge](https://badges.greenkeeper.io/lancedikson/bowser.svg)](https://greenkeeper.io/)
2014-02-22 21:34:00 +00:00
2017-10-18 08:47:53 +00:00
# Contents
2018-07-08 09:41:10 +00:00
- [Overview](#overview)
- [Use cases](#use-cases)
2018-07-08 10:21:54 +00:00
- [Advanced usage](#advanced-usage)
2018-07-08 09:41:10 +00:00
- [How can I help?](#contributing)
2011-04-27 22:14:35 +00:00
2017-10-18 08:47:53 +00:00
# Overview
2016-05-06 18:29:22 +00:00
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.
_Please, note that this is an alpha version. Check out the [1.x](https://github.com/lancedikson/bowser/tree/v1.x) branch for a stable version._
2016-06-30 17:52:55 +00:00
**Changes of version 2.0**
2018-07-09 16:14:22 +00:00
The upcoming 2.0 version has drastically changed API. All available methods can be found in the `docs` folder from now on and on a webpage soon.
2016-06-30 17:52:55 +00:00
2017-10-18 08:47:53 +00:00
# Use cases
2016-06-30 17:52:55 +00:00
2018-07-05 18:18:04 +00:00
First of all, require the library:
2016-06-30 17:52:55 +00:00
```javascript
2018-07-08 09:41:10 +00:00
const bowser = require('bowser');
2017-10-18 08:47:53 +00:00
```
2016-06-30 17:52:55 +00:00
By default, `require('bowser')` requires the *ES5 version of files*, which
2018-07-22 16:38:45 +00:00
**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.
2018-07-22 16:38:45 +00:00
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.
2018-07-22 16:38:45 +00:00
2017-10-18 08:47:53 +00:00
## 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:
```javascript
2018-07-08 09:41:10 +00:00
const browser = bowser.getParser(window.navigator.userAgent);
2016-06-30 17:52:55 +00:00
2018-07-05 18:18:04 +00:00
console.log(`The current browser name is "${browser.getBrowserName()}"`);
// The current browser name is "Internet Explorer"
2016-06-30 17:52:55 +00:00
```
2017-10-18 08:47:53 +00:00
or
2016-06-30 17:52:55 +00:00
```javascript
2017-10-18 08:47:53 +00:00
const impression = new Impression();
2016-06-30 17:52:55 +00:00
2018-07-08 09:41:10 +00:00
const browser = bowser.getParser(window.navigator.userAgent);
2017-10-18 08:47:53 +00:00
const browserInfo = browser.getBrowser();
impression.brName = browserInfo.name;
impression.brVer = browserInfo.version;
2015-11-06 17:52:11 +00:00
```
2017-10-18 08:47:53 +00:00
or
2015-11-06 17:52:11 +00:00
```javascript
2018-07-08 09:41:10 +00:00
const browser = bowser.getParser(window.navigator.userAgent);
2017-10-18 08:47:53 +00:00
impression.userTechData = browser.parse();
console.log(impression.userTechData);
2018-07-05 18:18:04 +00:00
// 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"
}
}
2017-10-18 08:47:53 +00:00
```
2015-11-06 17:52:11 +00:00
2017-10-18 08:47:53 +00:00
## Filtering browsers
2015-11-06 17:52:11 +00:00
You could want to filter some particular browsers to provide any special support for them or make any workarounds.
2017-10-18 08:47:53 +00:00
It could look like this:
2015-11-06 17:52:11 +00:00
```javascript
const browser = bowser.getParser(window.navigator.userAgent);
2018-07-08 09:41:10 +00:00
const isValidBrowser = browser.satisfies({
2018-07-05 18:18:04 +00:00
// declare browsers per OS
2017-10-18 08:47:53 +00:00
windows: {
2018-07-05 18:18:04 +00:00
"internet explorer": ">10",
2017-10-18 08:47:53 +00:00
},
macos: {
2018-07-05 18:18:04 +00:00
safari: ">10.1"
2017-10-18 08:47:53 +00:00
},
2018-07-05 18:18:04 +00:00
// per platform (mobile, desktop or tablet)
mobile: {
safari: '>9',
'android browser': '>3.10'
2017-10-18 08:47:53 +00:00
},
2018-07-05 18:18:04 +00:00
// or in general
chrome: ">20.1.1432",
firefox: ">31",
opera: ">22"
2018-08-16 16:04:10 +00:00
// 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)
2018-07-05 18:18:04 +00:00
});
2014-03-01 18:22:06 +00:00
```
2011-04-27 22:14:35 +00:00
2018-07-08 09:41:10 +00:00
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.
2016-05-06 18:29:22 +00:00
2018-07-08 09:41:10 +00:00
More of API and possibilities you will find in the `docs` folder.
2018-07-08 09:41:10 +00:00
# Contributing
2014-03-01 18:22:06 +00:00
If you'd like to contribute a change to bowser, modify the files in `src/`, then run the following (you'll need node + npm installed):
2013-12-13 12:17:10 +00:00
2014-03-01 18:22:06 +00:00
``` sh
$ npm install #build
$ npm test #run tests
$ npm run lint #check lint rules
2014-03-01 18:22:06 +00:00
```
2013-12-13 12:17:10 +00:00
2014-03-01 18:22:06 +00:00
### Adding tests
2018-07-08 09:41:10 +00:00
See the list in `test/acceptance/useragentstrings.yml` with example user agents and their expected bowser object.
2013-12-13 12:17:10 +00:00
Whenever you add support for new browsers or notice a bug / mismatch, please update the list and
check if all tests are still passing.
2015-07-26 01:55:21 +00:00
### Similar Projects
* [Kong](https://github.com/BigBadBleuCheese/Kong) - A C# port of Bowser.
2015-07-26 01:55:21 +00:00
### License
Licensed as MIT. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.