diff --git a/docs/events.html b/docs/api/events.html similarity index 82% rename from docs/events.html rename to docs/api/events.html index 3178e03d..5eee8f19 100755 --- a/docs/events.html +++ b/docs/api/events.html @@ -3,8 +3,8 @@ jQuery Mobile Docs - Events - - + + @@ -63,8 +63,13 @@ $('div').live('pagehide',function(event, ui){

Note that by binding to pagebeforecreate and returning false, you can prevent the page plugin from making its manipulations.

+
+

Note on Page IDs: Page elements in jQuery Mobile utilize the ID attribute for storing the location from which they came. When you place an ID attribute on a page that is brought into jQuery Mobile's single-page environment through Ajax, jQuery Mobile wraps that page with a new "page" div element, preserving any CSS references to your ID. However, this means that your ID attribute is no longer on the "page" element, so you must keep this in mind when binding to page events (pagebeforecreate, pagecreate, etc). To avoid issues, try using a class if possible.

+
+ +

Animation Events

-

Currently, jQuery Mobile exposes the animationComplete event, which you can utilize after adding or removing a class that applies a CSS transition.

+

jQuery Mobile exposes the animationComplete plugin, which you can utilize after adding or removing a class that applies a CSS transition.

diff --git a/docs/api/global-settings.html b/docs/api/global-settings.html new file mode 100755 index 00000000..f641c946 --- /dev/null +++ b/docs/api/global-settings.html @@ -0,0 +1,71 @@ + + + + + jQuery Mobile Docs - Configurable Default Settings + + + + + +
+ +
+

Configurable Default Settings

+
+ +
+

The following defaults are configurable via the $.mobile object:

+ +
+
subPageUrlKey (string, default: "ui-page"):
+
The url parameter used for referencing widget-generated sub-pages (such as those generated by nested listviews). Translates to to example.html&ui-page=subpageIdentifier. The hash segment before &ui-page= is used by the framework for making an Ajax request to the URL where the sub-page exists.
+ +
nonHistorySelectors (string, default: "dialog"):
+
Anchor links with a data-rel attribute value, or pages with a data-role value, that match these selectors will not be trackable in history (they won't update the location.hash and won't be bookmarkable).
+ + +
activePageClass (string, default: "ui-page-active"):
+
The class assigned to page currently in view, and during transitions
+ + +
activeBtnClass (string, default: "ui-page-active"):
+
The class used for "active" button state, from CSS framework.
+ +
ajaxLinksEnabled (boolean, default: true):
+
jQuery Mobile will automatically handle link clicks through Ajax, when possible.
+ +
ajaxFormsEnabled (boolean, default: true):
+
jQuery Mobile will automatically handle form submissions through Ajax, when possible.
+ + +
transitions (array, default: ['slide', 'slideup', 'slidedown', 'pop', 'flip', 'fade']):
+
Available CSS transitions in the CSS.
+ + +
defaultTransition (string, default: 'slide'):
+
Set the default transition for page changes that use Ajax. Set to 'none' for no transitions by default.
+ +
loadingMessage (string, default: "loading"):
+
Set the text that appears when a page is loading. If set to false, the message will not appear at all.
+ +
metaViewportContent (string, default: "width=device-width, minimum-scale=1, maximum-scale=1"):
+
Configure the auto-generated meta viewport tag's content attribute. If false, no meta tag will be appended to the DOM.
+ +
headExtras (markup string or jQuery object, default: null):
+
Additional markup to prepend to head element.
+ +
gradeA (function that returns a boolean, default: a function returning the value of $.support.mediaquery):
+
Any support conditions that must be met in order to proceed.
+ + +
+ + +

Visit the Configuring Default Settings page for instructions on configuring these properties.

+ +
+
+ + + \ No newline at end of file diff --git a/docs/api/globalconfig.html b/docs/api/globalconfig.html new file mode 100755 index 00000000..b74c8d6e --- /dev/null +++ b/docs/api/globalconfig.html @@ -0,0 +1,69 @@ + + + + + jQuery Mobile Docs - Configuring default settings + + + + + +
+ +
+

Configuring Default Settings

+
+ +
+

Working with jQuery Mobile's Auto-initialization

+

Unlike other jQuery projects, such as jQuery and jQuery UI, jQuery Mobile automatically applies many markup enhancements as soon as it loads (long before document.ready event fires). These enhancements are applied based on jQuery Mobile's default configuration, which is designed to work with common scenarios, but may or may not match your particular needs. Fortunately, these settings are easy to configure.

+ +

The mobileinit event

+

When the jQuery Mobile starts to execute, it triggers a mobileinit event on the document object, to which you can bind to apply overrides to jQuery Mobile's defaults.

+ + 
+				
+$(document).bind("mobileinit", function(){
+  //apply overrides here
+});
+				
+
+ +

Because the mobileinit event is triggered immediately upon execution, you'll need to bind your event handler before jQuery Mobile is loaded. Thus, we recommend linking to your JavaScript files in the following order:

+ + 
+				
+<script src="jquery.js"></script>
+<script src="custom-scripting.js"></script>
+<script src="jquery-mobile.js"></script>
+				
+
+ +

Within this event binding, you can configure defaults either by extending the $.mobile object using jQuery's $.extend method:

+ + 
+				
+$(document).bind("mobileinit", function(){
+  $.extend(  $.mobile , {
+    foo: bar
+  });
+});
+				
+
+ +

...or by setting them individually:

+ 
+				
+$(document).live("mobileinit", function(){
+  $.mobile.foo = bar;
+});
+				
+
+ +

Visit the Configurable Default Settings page for information on the configurable defaults.

+ +
+
+ + + \ No newline at end of file diff --git a/docs/api/index.html b/docs/api/index.html new file mode 100644 index 00000000..93a8af5d --- /dev/null +++ b/docs/api/index.html @@ -0,0 +1,30 @@ + + + + + jQuery UI Mobile Framework - API + + + + +
+ +
+

API

+
+ +
+ + + + +
+ +
+ + \ No newline at end of file diff --git a/docs/about/themes.html b/docs/api/themes.html similarity index 100% rename from docs/about/themes.html rename to docs/api/themes.html diff --git a/docs/index.html b/docs/index.html index f3ae5407..b7298784 100755 --- a/docs/index.html +++ b/docs/index.html @@ -23,7 +23,6 @@
  • Content formatting
  • Form elements
  • List views
    • -
  • Events
    • diff --git a/index.html b/index.html index 09e6af04..f71b0661 100755 --- a/index.html +++ b/index.html @@ -25,7 +25,14 @@
  • Features
  • Accessibility
  • Supported platforms
    • -
  • Theme system
    • + + +