PageRenderTime 61ms CodeModel.GetById 32ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/pages/page-dialogs.html

https://github.com/dannyc/jquery-mobile
HTML | 138 lines | 101 code | 37 blank | 0 comment | 0 complexity | e11931688111a0da789dcbb7f75408db MD5 | raw file
    

  1. <!DOCTYPE html> 
    2. 

  2. <html> 
    3. 

  3. 	<head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<meta name="viewport" content="width=device-width, initial-scale=1"> 
    6. 

  6. 	<title>jQuery Mobile Docs - Dialogs</title> 
    7. 

  7. 	<link rel="stylesheet"  href="../../css/themes/default/" />  
    8. 

  8. 	<link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
    9. 

  9. 	<script src="../../js/jquery.js"></script>
    10. 

  10. 	<script src="../../experiments/themeswitcher/jquery.mobile.themeswitcher.js"></script>
    11. 

  11. 	<script src="../_assets/js/jqm-docs.js"></script>
    12. 

  12. 	<script src="../../js/"></script>
    13. 

  13. </head> 
    14. 

  14. <body> 
    15. 

  15. 

  16. 	<div data-role="page" class="type-interior">
    17. 

  17. 

  18. 		<div data-role="header" data-theme="f">
    19. 

  19. 		<h1>Dialogs</h1>
    20. 

  20. 		<a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse" class="ui-btn-right jqm-home">Home</a>
    21. 

  21. 	</div><!-- /header -->
    22. 

  22. 

  23. 	<div data-role="content" class="ui-body">
    24. 

  24. 			<div class="content-primary">
    25. 

  25. 			<h2>Creating dialogs</h2>
    26. 

  26. 			<p>Any page can be presented as a modal dialog by adding the <code>data-rel="dialog"</code> attribute to the page anchor link. When the "dialog" attribute is applied, the framework adds styles to add rounded corners, margins around the page and a dark background to make the "dialog" appear to be suspended above the page.</p>
    27. 

  27. 

  28. 			<p>
    29. 

  29. 			<code>
    30. 

  30. 			&lt;a href=&quot;foo.html&quot; data-rel=&quot;dialog&quot;&gt;Open dialog&lt;/a&gt;
    31. 

  31. 			</code>
    32. 

  32. 			</p>
    33. 

  33. 			
    34. 

  34. 			<a href="dialog.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="pop">Open dialog</a>
    35. 

  35. 			
    36. 

  36. 

  37. 			
    38. 

  38. 			<h2>Transitions</h2>
    39. 

  39. 			<p>By default, the dialog will open with a 'pop' transition.  Like all pages, you can specify any page transition you want on the dialog by adding the <code>data-transition</code> attribute to the link. To make it feel more dialog-like, we recommend specifying a transition of "pop", "slideup" or "flip".</p>
    40. 

  40. 			
    41. 

  41. <code>
    42. 

  42. &lt;a href=&quot;foo.html&quot; data-rel=&quot;dialog&quot; data-transition=&quot;pop&quot;&gt;Open dialog&lt;/a&gt;
    43. 

  43. </code>
    44. 

  44. 			
    45. 

  45. 			<div>
    46. 

  46. 			<a href="dialog.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="pop">data-transition="pop"</a>
    47. 

  47. 			<a href="dialog.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="slidedown">data-transition="slidedown"</a>
    48. 

  48. 			<a href="dialog.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="flip">data-transition="flip"</a>
    49. 

  49. 			</div>
    50. 

  50. 	
    51. 

  51. 	
    52. 

  52. 			<h2>Closing dialogs</h2>
    53. 

  53. 			<p>When any link is clicked within in a dialog, the framework will automatically close the dialog and transition to the requested page, just as if the dialog were a normal page. To create a "cancel" button in a dialog, just link to the page that triggered the dialog to open and add the <code>data-rel="back"</code> attribute to your link. This pattern of linking to the previous page is also usable in non-JS devices as well.</p>
    54. 

  54. 			<p>For JavaScript-generated links, you can simply set the href attribute to "#" and use the <code>data-rel="back"</code> attribute. You can also call the dialog's <code>close()</code> method to programmatically close dialogs, for example: <code>$('.ui-dialog').dialog('close')</code>. </p>
    55. 

    56. 

  56. 			<h3>The close button</h3>
    57. 

  57. 			<p>By default dialogs are automatically given an icon only close button if the dialog has a header. Clicking this button triggers the dialogs close function and is identical to clicking the browsers back button.  If you prefer to not have the close button or prefer to create your own there is a data attribute <code>data-include-close-btn</code> that configures if the button should be automatically added.</p>
    58. 

  58. 

  59. <code>
    60. 

  60. 	&lt;div data-role="page" id="popup" data-include-close-btn="false"&gt;
    61. 

  61. </code>
    62. 

  62. 

  63. 			<h3>Setting the close button text and icon position</h3>
    64. 

  64. 			<p>Just like the page plugin, you can set a dialog's close button text through an option or data attribute. The option can be configured for all dialogs by binding to the <code>mobileinit</code> event and setting the <code>$.mobile.dialog.prototype.options.closeBtnText</code> property to a string of your choosing, or you can place the data attribute <code>data-close-btn-text</code> to configure the text from your markup. Additionally you can configure the icon position using the <code>data-iconpos</code> attribute. By default the iconpos attribute is set to "notext" and the button text will not be visible. Setting the iconpos to "none" will create a text only button.</p>
    65. 

    66. 

  66. <code>
    67. 

  67. 	&lt;div data-role="page" id="popup" data-iconpos="left" data-close-btn-text="Nevermind"&gt;
    68. 

  68. </code>
    69. 

  69. 

  70. 			<h2>History &amp; Back button behavior</h2>
    71. 

  71. 			<p>Since dialogs are typically used to support actions within a page, the framework does not include dialogs in the hash state history tracking. This means that dialogs will not appear in your browsing history chronology when the Back button is clicked. For example, if you are on a page, click a link to open a dialog, close the dialog, then navigate to another page, if you were to click the browser's Back button at that point you will navigate back to the first page, not the dialog.</p>
    72. 

  72. 			
    73. 

  73. 			<h2>Styling &amp; theming</h2>
    74. 

  74. 			<p>Dialogs can be styled with different theme swatches, just like any page by adding <code>data-theme</code> attributes to the header, content, or footer containers. Here is an example of a different dialog design:</p>
    75. 

  75. 				<a href="dialog-alt.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="pop">An alternate color scheme</a>
    76. 

  76. 				
    77. 

  77. 			<p>Dialogs appear to be floating above an overlay layer. This overlay adopts the swatch A content color by default, but the <code>data-overlay-theme</code> attribute can be added to the page wrapper to set the overlay to any swatch letter. Here is an example of a dialog with the overlay set to swatch e:</p>
    78. 

  78. 				<a href="dialog-overlay.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="pop">Custom overlay swatch</a>
    79. 

  79. 		
    80. 

  80. 		
    81. 

  81. 			<p>Dialogs can also be used more like a control sheet to offer multiple buttons by removing the header:</p>
    82. 

  82. 						<a href="dialog-buttons.html" data-role="button" data-inline="true" data-rel="dialog" data-transition="slidedown">Share photos...</a>
    83. 

  83. 			
    84. 

  84. 			<h2>Dialog width and margins</h2>
    85. 

  85. 			<p>For the sake of readability, dialogs have a default <code>max-width</code> of 500 pixels (plus 15px padding on each side). There is also a 10% top <code>margin</code> to give dialogs larger top margin on larger screens, but collapse to a small margin on smartphones. To override these styles, add the following CSS override rule to your stylesheet and tweak as needed:</p>
    86. 

  86. 

  87. <code><pre>
    88. 

  88. .ui-dialog .ui-header, 
    89. 

  89. .ui-dialog .ui-content, 
    90. 

  90. .ui-dialog .ui-footer { 
    91. 

  91. <strong>	max-width: 500px; 
    92. 

  92. 	margin: 10% auto 15px auto; </strong>
    93. 

  93. }
    94. 

  94. </pre></code>
    95. 

  95. 

  96. 			
    97. 

  97. 

  98. 

  99. 			
    100. 

  100. 	</div><!--/content-primary -->		
    101. 

  101. 

  102. 	<div class="content-secondary">
    103. 

  103. 

  104. 		<div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">
    105. 

  105. 

  106. 				<h3>More in this section</h3>
    107. 

  107. 

  108. 				<ul data-role="listview" data-theme="c" data-dividertheme="d">
    109. 

  109. 

  110. 								<li data-role="list-divider">Pages &amp; Dialogs</li>
    111. 

  111. 								<li><a href="page-anatomy.html">Anatomy of a page</a></li>
    112. 

  112. 								<li><a href="page-template.html" data-ajax="false">Single page template</a></li>
    113. 

  113. 								<li><a href="multipage-template.html" data-ajax="false">Multi-page template</a></li>
    114. 

  114. 								<li><a href="page-titles.html">Page titles</a></li>
    115. 

  115. 								<li><a href="page-links.html">Linking pages</a></li>
    116. 

  116. 								<li><a href="page-transitions.html" data-ajax="false">Page transitions</a></li>
    117. 

  117. 								<li data-theme="a"><a href="page-dialogs.html">Dialogs</a></li>
    118. 

  118. 								<li><a href="page-cache.html">Prefetching &amp; caching pages</a></li>
    119. 

  119. 								<li><a href="page-navmodel.html">Ajax, hashes &amp; history</a></li>
    120. 

  120. 								<li><a href="page-dynamic.html">Dynamically injecting pages</a></li>
    121. 

  121. 								<li><a href="page-scripting.html">Scripting pages</a></li>
    122. 

  122. 								<li><a href="phonegap.html">PhoneGap apps</a></li>
    123. 

  123. 								<li><a href="touchoverflow.html">touchOverflow feature</a></li>
    124. 

  124. 								<li><a href="pages-themes.html">Theming pages</a></li>
    125. 

  125. 				</ul>
    126. 

  126. 		</div>
    127. 

  127. 	</div>		
    128. 

  128. 

  129. </div><!-- /content -->
    130. 

  130. 

  131. <div data-role="footer" class="footer-docs" data-theme="c">
    132. 

  132. 		<p>&copy; 2011 The jQuery Project</p>
    133. 

  133. </div>
    134. 

  134. 

  135. </div><!-- /page -->
    136. 

  136. 

  137. </body>
    138. 

  138. </html>
    139. 

  139.