README.md

jquery.mobile.paramsHandler

A plug-in for adding URL parameters to jQuery Mobile pages.

Key notes

• Compatible with jQuery Mobile 1.4+
• Under the MIT license (basically use it as you please)
• URL parameters are maintained within the URL so page refreshes and navigating directly to a page will work
• Existing code will not break and pages which do not accept parameters will be unaffected

Steps to use

1. Download jquery.mobile.paramsHandler-1.4.2.js and add it to your page (after the jquery mobile library)
2. Add pages which you want to be able to accept parameters with $.mobile.paramsHandler.addPage(pageId, requiredParams, optionalParams, callback) and then call $.mobile.paramsHandler.init()
3. You can now go to those pages and when those pages are opened, your callback will be fired and the URL parameters will be given to you

Example usage

HTML

...
<div id="one" data-role="page">
    <a href="#two?param1=4&param2=2">Go to page "two" with some URL parameters</a>
</div>

<div id="two" data-role="page">
    <div id="param1display"></div>
    <div id="param2display"></div>
</div>
...

JS

$.mobile.paramsHandler.addPage(
    "two",                      // id of jquery mobile page you want to accept URL parameters
    ["param1", "param2"],       // required parameters for that page
    [],                         // optional parameters for that page,
    
    // callback function for when that page is about to show
    function (urlParams) {
        $("#param1display").html(urlParams.param1);
        $("#param2display").html(urlParams.param2);
    }
);

$.mobile.paramsHandler.init();