Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/192979
Change subject: RadioSelectWidget: Add description and example
......................................................................
RadioSelectWidget: Add description and example
Change-Id: I74aa4c7a7f45b31075807fa8b18f69eb55de3b78
---
M src/widgets/RadioSelectWidget.js
1 file changed, 27 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/79/192979/1
diff --git a/src/widgets/RadioSelectWidget.js b/src/widgets/RadioSelectWidget.js
index 2f405dc..e6cab86 100644
--- a/src/widgets/RadioSelectWidget.js
+++ b/src/widgets/RadioSelectWidget.js
@@ -1,7 +1,32 @@
/**
- * Select widget containing radio button options.
+ * RadioSelectWidget is a {@link OO.ui.SelectWidget select widget} that
contains radio
+ * options and is used together with OO.ui.RadioOptionWidget. The
RadioSelectWidget provides
+ * an interface for adding, removing and selecting options.
+ * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
*
- * Use together with OO.ui.RadioOptionWidget.
+ * @example
+ * // A RadioSelectWidget with RadioOptions.
+ * var option1 = new OO.ui.RadioOptionWidget( {
+ * data: 'a',
+ * label: 'Selected radio option'
+ * } );
+ *
+ * var option2 = new OO.ui.RadioOptionWidget( {
+ * data: 'b',
+ * label: 'Unselected radio option'
+ * } );
+ *
+ * var radioSelect=new OO.ui.RadioSelectWidget( {
+ * items: [option1, option2]
+ * } );
+ *
+ * // Select 'option 1' using the RadioSelectWidget's selectItem() method.
+ * radioSelect.selectItem( option1 );
+ *
+ * $('body').append(radioSelect.$element);
+ *
+ * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
+
*
* @class
* @extends OO.ui.SelectWidget
--
To view, visit https://gerrit.wikimedia.org/r/192979
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I74aa4c7a7f45b31075807fa8b18f69eb55de3b78
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
