Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/194410
Change subject: IndicatorWidget: Add description and example
......................................................................
IndicatorWidget: Add description and example
Change-Id: I7d2209d644b6aa8c8785a485409c459248978187
---
M src/widgets/IndicatorWidget.js
1 file changed, 17 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/10/194410/1
diff --git a/src/widgets/IndicatorWidget.js b/src/widgets/IndicatorWidget.js
index d2c7c62..265f8dd 100644
--- a/src/widgets/IndicatorWidget.js
+++ b/src/widgets/IndicatorWidget.js
@@ -1,7 +1,22 @@
/**
- * Indicator widget.
+ * IndicatorWidgets create indicators, which are small graphics that are
generally used to draw
+ * attention to the status of an item or to clarify the function of a control.
For a list of
+ * indicators included in the library, please see the [OOjs UI documentation
on MediaWiki][1].
*
- * See OO.ui.IndicatorElement for more information.
+ * @example
+ * // Example of an indicator widget
+ * var indicator1 = new OO.ui.IndicatorWidget( {
+ * indicator: 'alert'
+ * });
+ *
+ * // Create a fieldset layout to add a label
+ * var fieldset = new OO.ui.FieldsetLayout( );
+ * fieldset.addItems( [
+ * new OO.ui.FieldLayout( indicator1, {label: 'An alert indicator:'} )
+ * ] );
+ * $( 'body' ).append( fieldset.$element );
+ *
+ * [1]:
https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
*
* @class
* @extends OO.ui.Widget
--
To view, visit https://gerrit.wikimedia.org/r/194410
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I7d2209d644b6aa8c8785a485409c459248978187
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
