Skip to content

Commit fd866b8

Browse files
committed
jQuery.widget: Document suppressDisabledCheck flag for _on(). Fixes jquery#110.
1 parent 72a2175 commit fd866b8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

entries/jQuery.widget.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,13 @@
213213
Binds event handlers to the specified element(s). Delegation is supported via selectors inside the event names, e.g., "<code>click .foo</code>". The <code>_on()</code> method provides several benefits of direct event binding:
214214
<ul>
215215
<li>Maintains proper <code>this</code> context inside the handlers.</li>
216-
<li>Automatically handles disabled widgets: If the widget is disabled or the event occurs on an element with the <code>ui-state-disabled</code> class, the event handler is not invoked.</li>
216+
<li>Automatically handles disabled widgets: If the widget is disabled or the event occurs on an element with the <code>ui-state-disabled</code> class, the event handler is not invoked. Can be overridden with the <code>suppressDisabledCheck</code> parameter.</li>
217217
<li>Event handlers are automatically namespaced and cleaned up on destroy.</li>
218218
</ul>
219219
</desc>
220+
<argument name="suppressDisabledCheck" type="Boolean" optional="true" default="false">
221+
<desc>Whether or not to bypass the disabled check.</desc>
222+
</argument>
220223
<argument name="element" type="jQuery" optional="true">
221224
<desc>Which element(s) to bind the event handlers to. If no element is provided, <code>this.element</code> is used.</desc>
222225
</argument>

0 commit comments

Comments
 (0)