Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A platform detection library.
JavaScript HTML Shell
Tag: 0.4.0

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docs
tests
vendor
.gitattributes
.gitignore
.gitmodules
.npmignore
LICENSE.txt
README.md
package.json
platform.js

README.md

Platform.js

A platform detection library that works on nearly all JavaScript platforms1.

Disclaimer

Platform.js is for informational purposes only and not intended as a substitution for feature detection/inference checks.

BestieJS

Platform.js is part of the BestieJS "Best in Class" module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation.

Documentation

The documentation for Platform.js can be viewed here: /docs/README.md

For a list of upcoming features, check out our roadmap.

Installation and usage

In a browser or Adobe AIR:

<script src="platform.js"></script>

Via npm:

npm install platform

In Narwhal, Node.js, and RingoJS:

var platform = require('platform');

In Rhino:

load('platform.js');

In RequireJS:

require({
  'paths': {
    'platform': 'path/to/platform'
  }
},
['platform'], function(platform) {
  console.log(platform.name);
});

Usage example:

// on IE10 x86 platform preview running in IE7 compatibility mode on Windows 7 64 bit edition
platform.name; // 'IE'
platform.version; // '10.0'
platform.layout; // 'Trident'
platform.os; // 'Windows Server 2008 R2 / 7 x64'
platform.description; // 'IE 10.0 x86 (platform preview; running in IE 7 mode) on Windows Server 2008 R2 / 7 x64'

// or on an iPad
platform.name; // 'Safari'
platform.version; // '5.1'
platform.product; // 'iPad'
platform.manufacturer; // 'Apple'
platform.layout; // 'WebKit'
platform.os; // 'iOS 5.0'
platform.description; // 'Safari 5.1 on Apple iPad (iOS 5.0)'

// or parsing a given UA string
var info = platform.parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7.2; en; rv:2.0) Gecko/20100101 Firefox/4.0 Opera 11.52');
info.name; // 'Opera'
info.version; // '11.52'
info.layout; // 'Presto'
info.os; // 'Mac OS X 10.7.2'
info.description; // 'Opera 11.52 (identifying as Firefox 4.0) on Mac OS X 10.7.2'

Cloning this repo

To clone this repository including all submodules, using Git 1.6.5 or later:

git clone --recursive https://github.com/bestiejs/platform.js.git
cd platform.js

For older Git versions, just use:

git clone https://github.com/bestiejs/platform.js.git
cd platform.js
git submodule update --init

Feel free to fork if you see possible improvements!

Footnotes

  1. Platform.js has been tested in at least Adobe AIR 2.6, Chrome 5-15, Firefox 1.5-8, IE 6-10, Opera 9.25-11.52, Safari 2-5.1.1, Node.js 0.4.8-0.6.1, Narwhal 0.3.2, RingoJS 0.7-0.8, and Rhino 1.7RC3.

Authors

Contributors

Something went wrong with that request. Please try again.