jQuery Mobile is a unified, HTML5-based user interface system for all popular mobile device platforms, built on the rock-solid jQuery and jQuery UI foundation. Its lightweight code is built with progressive enhancement, and has a flexible, easily themeable design.
jQuery Mobile 1.4.x works with versions of jQuery core from 1.8.3 to 1.11.1 / 2.1.1. You can find more information about how the library works, and what it is capable of, by reading the documentation and exploring the demos. Alternatively, more information can also be found on the jquerymobile site.
You can contribute to the project by reporting issues, suggesting new features, or submitting pull requests. Please read our Contributing Guidelines before submitting.
css- resolve dependencies, build, concat, and minify all the css, just the structure css, and just the theme css
demos- build the js and css, and make the docs ready for static consumption
With node and grunt installed you can run the default target by simply issuing the following from the project root:
npm install grunt
For example, if a user wished to exclude the form widgets to reduce the wire weight of their jQuery Mobile include they would first remove them from the meta module:
define(['./jquery.mobile.listview.filter','./jquery.mobile.listview.autodividers','./jquery.mobile.nojs',- './jquery.mobile.forms.checkboxradio',- './jquery.mobile.forms.button',- './jquery.mobile.forms.slider',- './jquery.mobile.forms.textinput',- './jquery.mobile.forms.select.custom',- './jquery.mobile.forms.select','./jquery.mobile.buttonMarkup','./jquery.mobile.controlGroup','./jquery.mobile.links',
And then run the build:
To create a new theme:
defaultfolder from CSS/Themes to a new folder named after your new theme (eg,
Add customizations to the
From the project root run the following
THEME=my-theme grunt build:css
The output will be available in the
Again this assumes the theme css files are available in the
css/themes/$THEME/ directory relative to the project root,
css/themes/my-theme/ in the example.
The root of the repository is also the root of the documentation and, along with the test suite, acts as the test bed for bug fixes and features. You'll need to set up a server and get the test suite running before you can contribute patches.
Most of the documentation and testing pages rely on PHP 5+, and as a result Apache and PHP are required for development. You can install them using one of the following methods:
- one-click - MAMP for OSX, XAMP for OSX/Windows
- existing web server - eg,
~/Sitesdirectory on OSX.
- virtual machine - If Vagrant is installed you can add this remote/branch and
In addition to vanilla Apache the following modules are required:
- Rewrite (mod_rewrite.so)
- Expire (mod_expires.so)
- Header (mod_headers.so)
Once you have your web server setup you can point it at the project directory.
Automated testing forms the backbone of the jQuery Mobile project's QA activities. As a contributor or patch submitter you will be expected to run the test suite for the code your patches affect. Our continuous integration server will address the remainder of the test suite.
You can run all the test suites by running the following command:
You can choose to run only a subset of the tests by adding the
--suites option like:
grunt test --suites=table,slider
will only run the tests under
You can also exclude some tests by using
!. For instance:
grunt test --type=integration --suites=\!navigation
will run all the integration tests but the navigation suite.
You can also specify which versions of jQuery you want to test jQuery Mobile by using the
grunt test --jqueries=1.11.1,git
Additionally, jQuery Mobile's test suite is split between integration and unit tests. Where the unit tests are meant to focus on a single piece of the library (eg, a widget) and the integration tests require multiple pieces of the library to function. You can target either type by including the
--types option when testing:
grunt test --types=unit grunt test --types=integration grunt test --types=unit,integration # default, equivalent to 'grunt test'