Permalink
Browse files

Widget: Clarification of the version property and grammatical changes.

  • Loading branch information...
tjvantoll committed Feb 21, 2013
1 parent bee024f commit 4c1b2b3ad6fc2a246d2cd813a747ed87c80d7b3c
Showing with 3 additions and 3 deletions.
  1. +3 −3 entries/jQuery.widget.xml
@@ -103,16 +103,16 @@
<strong>options</strong>: An object containing the options currently being used by the widget. On instantiation, any options provided by the user will automatically be merged with any default values defined in <code>$.myNamespace.myWidget.prototype.options</code>. User specified options override the defaults.
</li>
<li>
- <strong>uuid</strong>: A unique, integer identifier for the widget.
+ <strong>uuid</strong>: A unique integer identifier for the widget.
</li>
<li>
- <strong>version</strong>: The string version of jQuery UI this widget is using.
+ <strong>version</strong>: The string version of the widget. For jQuery UI widgets this will be set to the version of jQuery UI the widget is using. Widget developers have to set this property in their prototype explicitly.
</li>
<li>
<strong>widgetEventPrefix</strong>: The prefix prepended to the name of events fired from this widget. For example the <code>widgetEventPrefix</code> of the <a href="/draggable">draggable widget</a> is <code>"drag"</code>, therefore when a draggable is created, the name of the event fired is <code>"dragcreate"</code>. By default the <code>widgetEventPrefix</code> of a widget is its name. <em>Note: This property is deprecated and will be removed in a later release. Event names will be changed to widgetName:eventName (e.g. <code>"draggable:create"</code>.</em>
</li>
<li>
- <strong>widgetFullName</strong>: The full name of the widget including the namespace. For <code>$.widget( "myNamespace.myWidget", {} )</code>, <code>widgetFullName</code> will be <code>"myNamespace.myWidget"</code>.
+ <strong>widgetFullName</strong>: The full name of the widget including the namespace. For <code>$.widget( "myNamespace.myWidget", {} )</code>, <code>widgetFullName</code> will be <code>"myNamespace-myWidget"</code>.
</li>
<li>
<strong>widgetName</strong>: The name of the widget. For <code>$.widget( "myNamespace.myWidget", {} )</code>, <code>widgetName</code> will be <code>"myWidget"</code>.

0 comments on commit 4c1b2b3

Please sign in to comment.