web-apps/vendor/jquery.browser/README.md

81 lines
2.5 KiB
Markdown
Raw Normal View History

2016-03-11 00:48:53 +00:00
A jQuery plugin for browser detection. jQuery removed support for browser detection on 1.9.1 so it was abstracted into a jQuery plugin
## Installation
Include script *after* the jQuery library:
<script src="/path/to/jquery.browser.js"></script>
## Usage
Returns true if the current useragent is some version of Microsoft's Internet Explorer. Supports all IE versions including IE11
$.browser.msie;
Returns true if the current useragent is some version of a Webkit browser (Safari, Chrome and Opera 15+).
$.browser.webkit;
Returns true if the current useragent is some version of Firefox.
$.browser.mozilla;
Reading the browser verion
$.browser.version
## Things not included in the original jQuery $.browser implementation
- Detect Windows, Mac, Linux, iPad, iPhone, Android and Windows Phone useragents
```javascript
$.browser.ipad
$.browser.iphone
$.browser["windows phone"]
$.browser.android
$.browser.win
$.browser.mac
$.browser.linux
```
- Detect the browser's major version
```javascript
// User Agent for Chrome
// Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/32.0.1664.3 Safari/537.36
$.browser.versionNumber // Returns 32 as a number
```
- Support for new useragent on IE11
- Support for webkit based Opera browsers
- Added testing using PhantomJS and different browser user agents
## Testing
Testing for this plugin is done with [Casperjs v1.1](http://casperjs.org/) to take advantage of multiple phantomjs browsers with different user agents.
For instructions on how to install [Casperjs v1.1](http://casperjs.org/) go to http://docs.casperjs.org/en/latest/installation.html
**Note: Testing requires Casperjs v1.1**
Install the grunt-cli dependency by running `npm install -g grunt-cli`
Run `npm install` to install all dependencies including grunt and all tasks
Once Casperjs and the grunt-cli npm package is installed you can execute all the tests by using:
grunt test
## Development
- Source hosted at [GitHub](https://github.com/gabceb/jquery-browser-plugin)
- Report issues, questions, feature requests on [GitHub Issues](https://github.com/gabceb/jquery-browser-plugin/issues)
## Attributions
- [Examples and original implementation](http://api.jquery.com/jQuery.browser/)
- [Original Gist used for the plugin](https://gist.github.com/adeelejaz/4714079)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/gabceb/jquery-browser-plugin/trend.png)](https://bitdeli.com/free "Bitdeli Badge")