Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/191391
Change subject: ButtonGroupWidget: Add description and example
......................................................................
ButtonGroupWidget: Add description and example
Change-Id: Ie81db7e740045ff84f08bd7e916408c48b704990
---
M src/widgets/ButtonGroupWidget.js
1 file changed, 21 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/91/191391/1
diff --git a/src/widgets/ButtonGroupWidget.js b/src/widgets/ButtonGroupWidget.js
index 2fd95f6..eda2541 100644
--- a/src/widgets/ButtonGroupWidget.js
+++ b/src/widgets/ButtonGroupWidget.js
@@ -1,7 +1,26 @@
/**
- * Group widget for multiple related buttons.
+ * A ButtonGroupWidget groups related buttons and is used together with
OO.ui.ButtonWidget and
+ * its subclasses. Each button in a group is addressed by a unique reference.
Buttons can be added,
+ * removed, and cleared from the group.
*
- * Use together with OO.ui.ButtonWidget.
+ * @example
+ * // Example: A ButtonGroupWidget with two buttons
+ * var button1 = new OO.ui.PopupButtonWidget( {
+ * label : 'Select a category',
+ * icon : 'menu',
+ * popup : {
+ * $content: $( '<p>List of categories...</p>' ),
+ * padded: true,
+ * align: 'left'
+ * }
+ * } );
+ * var button2 = new OO.ui.ButtonWidget( {
+ * label : 'Add item'
+ * });
+ * var buttonGroup = new OO.ui.ButtonGroupWidget( {
+ * items: [button1, button2]
+ * } );
+ * $('body').append(buttonGroup.$element);
*
* @class
* @extends OO.ui.Widget
--
To view, visit https://gerrit.wikimedia.org/r/191391
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie81db7e740045ff84f08bd7e916408c48b704990
Gerrit-PatchSet: 1
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <kmen...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
