Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Selectmenu: Add documentation for _renderButtonItem extension point #226

Closed
wants to merge 1 commit into from
Closed

Selectmenu: Add documentation for _renderButtonItem extension point #226

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 47 additions & 0 deletions entries/selectmenu.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,53 @@
<desc>Returns a <code>jQuery</code> object containing the button element.</desc>
</method>
</methods>
<extension-points>
<method name="_renderButtonItem" return="jQuery">
<desc>
<p>Method that controls the creation of the generated button content. The method must create and return a new element.</p>
</desc>
<argument name="item" type="Object">
<property name="disabled" type="Boolean">
<desc>Whether the item is disabled.</desc>
</property>
<property name="element" type="jQuery">
<desc>A reference to the item's original <code>&lt;option&gt;</code> element.</desc>
</property>
<property name="index" type="Number">
<desc>The numeric index of the item.</desc>
</property>
<property name="label" type="String">
<desc>The string to display for the item.</desc>
</property>
<property name="optgroup" type="String">
<desc>If the item is within an <code>&lt;optgroup&gt;</code>, this is set to that <code>&lt;optgroup&gt;</code>'s label.</desc>
</property>
<property name="value" type="String">
<desc>The <code>value</code> attribute of the item's original <code>&lt;option&gt;</code>.</desc>
</property>
</argument>
<example>
<desc>Add a <a href="/theming/icons/">jQuery UI icon</a> to each generated button who's select has a <code>data-icon</code> attribute.</desc>
<code><![CDATA[
_renderButtonItem = function( item ) {
var buttonItem = $( "<span>", {
"class": "ui-selectmenu-text"
})
this._setText( buttonItem, item.label );

buttonItem
.css( "padding-left", "2.5em" )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of having examples that use .css() for general styling.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just going to update this to match the _renderItem() functionality.

.append( "<span>" )
.find( "span" )
.addClass( "ui-icon " + item.element.attr( "data-icon") )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indent after .find().

.css( "left", "0.5em" );

return buttonItem;
}
]]></code>
</example>
</method>
</extension-points>
<example>
<desc>A simple jQuery UI Selectmenu</desc>
<code><![CDATA[
Expand Down