Apache DeviceMap - BrowserMap module
In addition, BrowserMap is capable of detecting the device groups a client belongs to. The following groups are provided by default:
smartphone- feature phones / smartphones;
tablet- various tablets, based on screen size and the presence of touch capabilities (the touch events Modernizr test is used for this feature);
highResolutionDisplay- devices that report a device pixel ratio greater or equal than 2, such as: iPhone 4 and above, iPod Touch gen. 4 and above, iPad 3, Samsung Galaxy S3, etc.;
browser- desktop browsers capable of CSS 3D transitions (another Modernizr test is used for this feature)
oldBrowser- less modern desktop browsers
A small demo is available at http://devicemap-vm.apache.org/browsermap/index.html.
- extensible probing mechanism;
- on-demand probing with probes' results cache and cache clearing mechanism;
- easy mechanism for overriding pre-defined device groups / adding new device groups;
- three ways of determining the correct URL to which a client should be forwarded, depending on its device group, in order of importance:
- usage of
<link rel="alternate" hreflang="<language_code>" data-bmap-devgroups="<device_group_name_list>" href="<alternate_url>" />tags in BrowserMap enabled pages;
- a specific URL defined for each
- modify the current URL to include a
DeviceGroupselector, in case none of the previous two methods has been set up (e.g.
- usage of
- device group override (by using a combined mechanism of a
GETparameter and cookie storage) so that a client from a certain device group can access the pages designed for a different device group; for clients that do not support cookies, the device group override uses just a
GETparameter which can optionally be appended to each URL pointing to a resource from the same domain as the current resource.
BrowserMap relevant files
The BrowserMap code is organised in two base folders:
bmap.js- this is where the
BrowserMapobject is defined (main object used for device detection)
bmaputil.js- file containing helper objects and methods
devicegroups.js- file containing the
DeviceGroupsobject descriptions for each identified device group
probes.js- file containing various
BrowserMapprobes used to detect various browser features that can determine a client's capabilities
Correct order of files inclusion in an HTML page
In order to have a functional BrowserMap instance, the previous files have to be included in this order:
DeviceGroup object has the following attributes:
ranking- determines the order in which, when added to the
DeviceGroups will be matched; a lower ranking means an earlier evaluation (e.g. 0 is evaluated before 10);
name- the name of the
DeviceGroup; can also act as a URL selector which will be used to create
DeviceGroups-specific URLs to which the clients will be forwarded
description- a string used to store a brief description of the
testFunction- a test function that must return a boolean value; the test function is used to check if a client matches the
DeviceGroupor not; the test function can use
isSelector- a boolean flag which is checked to see if a
DeviceGroup's name should be used as a selector or not.
To add a
DeviceGroup to the
BrowserMap object, one can use the
BrowserMap.addDeviceGroup(DeviceGroup object) method. The last
DeviceGroup added to
BrowserMap with the same name as a previously existing
DeviceGroup will be the one which will be stored, which can be useful if one tries to override the default
BrowserMap's own source files are located in
The main test file is located in
src/test/js and the tests are based on QUnit.
npm install -g grunt-cli npm install -d
The tests can be run with
grunt test inside the browsermap folder.
Packaging the app is done with
How to report issues or request enhancements
Please file a JIRA issue at https://issues.apache.org/jira/browse/DMAP and use the "browsermap" label.
If you're reporting a bug please provide an accurate description of the problem together with the debug output found on the demo page from http://devicemap-vm.apache.org/browsermap/index.html.