Skip to content

Commit 5674bcd

Browse files
committed
Dialog: Document button pass-thru options
Fixes jquerygh-208 Closes jquerygh-236
1 parent 0890a1c commit 5674bcd

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

entries/dialog.xml

+8-1
Original file line numberDiff line numberDiff line change
@@ -105,17 +105,24 @@
105105
<example-value>[
106106
{
107107
text: "Ok",
108+
icons: {
109+
primary: "ui-icon-heart"
110+
},
108111
click: function() {
109112
$( this ).dialog( "close" );
110113
}
114+
115+
// Uncommenting the following line would hide the text,
116+
// resulting in the label being used as a tooltip
117+
//showText: false
111118
}
112119
]</example-value>
113120
<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>
114121
<type name="Object">
115122
<desc>The keys are the button labels and the values are the callbacks for when the associated button is clicked.</desc>
116123
</type>
117124
<type name="Array">
118-
<desc>Each element of the array must be an object defining the attributes, properties, and event handlers to set on the button.</desc>
125+
<desc>Each element of the array must be an object defining the attributes, properties, and event handlers to set on the button. In addition, a key of <code>icons</code> can be used to control <a href="/button/#option-icons">button's <code>icons</code> option</a>, and a key of <code>showText</code> can be used to control <a href="/button/#option-text">button's <code>text</code> option</a>.</desc>
119126
</type>
120127
</option>
121128
<option name="closeOnEscape" default="true" example-value="false">

0 commit comments

Comments
 (0)