|
12 | 12 | <note id="functional-css"/>
|
13 | 13 | <added>1.0</added>
|
14 | 14 | <options>
|
15 |
| - <option name="autoOpen" default="true"> |
| 15 | + <option name="autoOpen" default="true" example-value="false"> |
16 | 16 | <desc>If set to <code>true</code>, the dialog will automatically open upon initialization. If <code>false</code>, the dialog will stay hidden until the <a href="#method-open"><code>open()</code></a> method is called.</desc>
|
17 | 17 | <type name="Boolean" />
|
18 | 18 | </option>
|
19 |
| - <option name="buttons" default="{}"> |
| 19 | + <option name="buttons" default="{}" example-value='{ Ok: function() { $( this ).dialog( "close" ); } }'> |
20 | 20 | <desc>Specifies which buttons should be displayed on the dialog. The context of the callback is the dialog element; if you need access to the button, it is available as the target of the event object.</desc>
|
21 | 21 | <type name="Object">
|
22 | 22 | <desc>The keys are the button labels and the values are the callbacks for when the associated button is clicked.</desc>
|
|
25 | 25 | <desc>Each element of the array must be an object defining the attributes, properties, and event handlers to set on the button.</desc>
|
26 | 26 | </type>
|
27 | 27 | </option>
|
28 |
| - <option name="closeOnEscape" default="true"> |
| 28 | + <option name="closeOnEscape" default="true" example-value="false"> |
29 | 29 | <desc>Specifies whether the dialog should close when it has focus and the user presses the esacpe (ESC) key.</desc>
|
30 | 30 | <type name="Boolean" />
|
31 | 31 | </option>
|
32 |
| - <option name="closeText" default='"close"'> |
| 32 | + <option name="closeText" default='"close"' example-value='"hide"'> |
33 | 33 | <desc>Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.</desc>
|
34 | 34 | <type name="String" />
|
35 | 35 | </option>
|
36 |
| - <option name="dialogClass" default='""'> |
| 36 | + <option name="dialogClass" default='""' example-value='"alert"'> |
37 | 37 | <desc>The specified class name(s) will be added to the dialog, for additional theming.</desc>
|
38 | 38 | <type name="String" />
|
39 | 39 | </option>
|
40 | 40 | <xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
|
41 |
| - <option name="draggable" default="true"> |
| 41 | + <option name="draggable" default="true" example-value="false"> |
42 | 42 | <desc>If set to <code>true</code>, the dialog will be draggable by the title bar. Requires the <a href="/draggable/">jQuery UI Draggable wiget</a> to be included.</desc>
|
43 | 43 | <type name="Boolean" />
|
44 | 44 | </option>
|
45 |
| - <option name="height" default='"auto"'> |
| 45 | + <option name="height" default='"auto"' example-value="400"> |
46 | 46 | <desc>The height of the dialog.</desc>
|
47 | 47 | <type name="Number">
|
48 | 48 | <desc>The height in pixels.</desc>
|
|
51 | 51 | <desc>The only supported string value is <code>"auto"</code> which will allow the dialog height to adjust based on its content.</desc>
|
52 | 52 | </type>
|
53 | 53 | </option>
|
54 |
| - <option name="hide" default="null"> |
| 54 | + <option name="hide" default="null" example-value='"explode"'> |
55 | 55 | <desc>If and how to animate the hiding of the dialog.</desc>
|
56 | 56 | <type name="Number">
|
57 | 57 | <desc>
|
|
67 | 67 | <desc>If the value is an object, then <code>effect</code>, <code>duration</code>, and <code>easing</code> properties may be provided. The <code>effect</code> property must be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used.</desc>
|
68 | 68 | </type>
|
69 | 69 | </option>
|
70 |
| - <option name="maxHeight" default="false"> |
| 70 | + <option name="maxHeight" default="false" example-value="600"> |
71 | 71 | <desc>The maximum height to which the dialog can be resized, in pixels.</desc>
|
72 | 72 | <type name="Number" />
|
73 | 73 | </option>
|
74 |
| - <option name="maxWidth" default="false"> |
| 74 | + <option name="maxWidth" default="false" example-value="600"> |
75 | 75 | <desc>The maximum width to which the dialog can be resized, in pixels.</desc>
|
76 | 76 | <type name="Number" />
|
77 | 77 | </option>
|
78 |
| - <option name="minHeight" default="150"> |
| 78 | + <option name="minHeight" default="150" example-value="200"> |
79 | 79 | <desc>The minimum height to which the dialog can be resized, in pixels.</desc>
|
80 | 80 | <type name="Number" />
|
81 | 81 | </option>
|
82 |
| - <option name="minWidth" default="150"> |
| 82 | + <option name="minWidth" default="150" example-value="200"> |
83 | 83 | <desc>The minimum width to which the dialog can be resized, in pixels.</desc>
|
84 | 84 | <type name="Number" />
|
85 | 85 | </option>
|
86 |
| - <option name="modal" default="false"> |
| 86 | + <option name="modal" default="false" example-value="true"> |
87 | 87 | <desc>If set to <code>true</code>, the dialog will have modal behavior; other items on the page will be disabled, i.e., cannot be interacted with. Modal dialogs create an overlay below the dialog but above other page elements.</desc>
|
88 | 88 | <type name="Boolean" />
|
89 | 89 | </option>
|
90 |
| - <option name="position" default='{ my: "center", at: "center", of: window }'> |
| 90 | + <option name="position" default='{ my: "center", at: "center", of: window }' example-value='{ my: "left top", at: "left bottom", of: button }'> |
91 | 91 | <desc>Specifies where the dialog should be displayed. The dialog will handle collisions such that as much of the dialog is visible as possible.</desc>
|
92 | 92 | <type name="Object">
|
93 | 93 | <desc>Identifies the position of the dialog when opened. The <code>of</code> option defaults to the window, but you can specify another element to position against. You can refer to the <a href="/position">jQuery UI Position</a> utility for more details about the various options.</desc>
|
|
99 | 99 | <desc>An array containing an <em>x, y</em> coordinate pair in pixel offset from the top left corner of the viewport or the name of a possible string value.</desc>
|
100 | 100 | </type>
|
101 | 101 | </option>
|
102 |
| - <option name="resizable" default="true"> |
| 102 | + <option name="resizable" default="true" example-value="false"> |
103 | 103 | <desc>If set to <code>true</code>, the dialog will be resizable. Requires the <a href="/resizable/">jQuery UI Resizable widget</a> to be included.</desc>
|
104 | 104 | <type name="Boolean" />
|
105 | 105 | </option>
|
106 |
| - <option name="show" default="null"> |
| 106 | + <option name="show" default="null" example-value='"slow"'> |
107 | 107 | <desc>If and how to animate the showing of the dialog.</desc>
|
108 | 108 | <type name="Number">
|
109 | 109 | <desc>
|
|
119 | 119 | <desc>If the value is an object, then <code>effect</code>, <code>duration</code>, and <code>easing</code> properties may be provided. The <code>effect</code> property must be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If <code>duration</code> or <code>easing</code> is omitted, then the default values will be used.</desc>
|
120 | 120 | </type>
|
121 | 121 | </option>
|
122 |
| - <option name="stack" default="true"> |
| 122 | + <option name="stack" default="true" example-value="false"> |
123 | 123 | <desc>Specifies whether the dialog will stack on top of other dialogs. This will cause the dialog to move to the front of other dialogs when it gains focus.</desc>
|
124 | 124 | <type name="Boolean" />
|
125 | 125 | </option>
|
126 |
| - <option name="title" default='""'> |
| 126 | + <option name="title" default='""' example-value='"Dialog Title"'> |
127 | 127 | <desc>Specifies the title of the dialog. Any valid HTML may be set as the title. The title can also be specified by the <code>title</code> attribute on the dialog source element.</desc>
|
128 | 128 | <type name="String" />
|
129 | 129 | </option>
|
130 |
| - <option name="width" default="300"> |
| 130 | + <option name="width" default="300" example-value="500"> |
131 | 131 | <desc>The width of the dialog, in pixels.</desc>
|
132 | 132 | <type name="Number" />
|
133 | 133 | </option>
|
134 |
| - <option name="zIndex" default="1000"> |
| 134 | + <option name="zIndex" default="1000" example-value="20"> |
135 | 135 | <desc>The starting z-index for the dialog.</desc>
|
136 | 136 | <type name="Integer" />
|
137 | 137 | </option>
|
|
0 commit comments