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.
lancedikson_bowser/README.md

115 lines
3.2 KiB

## Bowser
A Browser detector. Because sometimes, there is no other way, and not even good modern browsers always provide good feature detection mechanisms.
13 years ago
10 years ago
[![bowser ci](https://secure.travis-ci.org/ded/bowser.png)](https://travis-ci.org/ded/bowser/)
So... it works like this:
13 years ago
``` js
if (bowser.msie && bowser.version <= 6) {
alert('Hello China');
}
```
13 years ago
## 1.0.0 breaking changes
`browser = require('bowser').browser;` becomes `browser = require('bowser');`
## Flags set for detected Browsers[Engines]
13 years ago
* `chrome`[`webkit`]
* `firefox`[`gecko`]
* `msie`
* `msedge`
* Android native browser as `android`[`webkit`]
* iOS native browser as `ios`[`webkit`]
* `opera`[`webkit` if >12]
* `phantom`[`webkit`]
* `safari`[`webkit`]
* `seamonkey`[`gecko`]
* BlackBerry native browser as `blackberry`[`webkit`]
* WebOS native browser as `webos`[`webkit`]
* Amazon Kindle browser as `silk`[`webkit`]
* Bada browser as `bada`[`webkit`]
* Tizen browser as `tizen`[`webkit`]
* Sailfish browser as `sailfish`[`gecko`]
For all detected browsers the browser version is set in the `version` field.
## Flags set for detected Operating Systems
10 years ago
* `mac`
* Windows other than Windows Phone as `windows`
* Windows Phone as `windowsphone`
* `linux` for Linux other than `android`, `chromeos`, `webos`, `tizen`, and `sailfish`
* `chromeos`
* `android`
* `ios` (`iphone`/`ipad`/`ipod`)
* `blackberry`
* `firefoxos`
* `webos` (`touchpad`)
* `bada`
* `tizen`
* `sailfish`
10 years ago
Android, iOS, Windows Phone, WebOS, Bada, and Tizen will all report the OS version number if it is contained in the UA string in the `osversion` field. iOS is always reported as `ios` and additionally as `iphone`/`ipad`/`ipod`, whichever one matches best. If WebOS device is an HP TouchPad the flag `touchpad` is additionally set.
10 years ago
All detected mobile OSes are additionally flagged `mobile`, **if they are not powering a tablet device**. If a tablet device is detected, the flag `tablet` is set instead.
13 years ago
### Notes
10 years ago
Safari, Chrome and some other minor browsers will report that they have `webkit` engines, Firefox and Seamonkey will report that they have `gecko` engines.
13 years ago
``` js
if (bowser.webkit) {
// do stuff with safari & chrome & opera & android & blackberry & webos & silk
}
```
13 years ago
### Ender Support
13 years ago
`package.json`
13 years ago
``` json
"dependencies": {
"bowser": "x.x.x"
}
```
13 years ago
``` js
if (require('bowser').chrome) {
alert('Hello Silicon Valley')
}
```
### Graded Browser Support
``` js
if (bowser.a) {
// support full feature set
}
else if (bowser.c) {
// serve degraded version
}
else {
// unsupported (bowser.x)
}
```
### Contributing
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):
``` sh
$ npm install
$ make test
```
Please do not check-in the built files `bowser.js` and `bowser.min.js` in pull requests.
### Adding tests
See the list in `src/useragents.js` with example user agents and their expected bowser object.
Whenever you add support for new browsers or notice a bug / mismatch, please update the list and
check if all tests are still passing.
9 years ago
### License
Licensed as MIT. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.