Kmenger has uploaded a new change for review. https://gerrit.wikimedia.org/r/191208
Change subject: IndicatorElement: Add description ...................................................................... IndicatorElement: Add description Change-Id: Iac55ac0229e99ec4fa06a8f5f8470c6ca04d047a --- M src/elements/IndicatorElement.js 1 file changed, 11 insertions(+), 5 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/08/191208/1 diff --git a/src/elements/IndicatorElement.js b/src/elements/IndicatorElement.js index f299a98..5e1bf99 100644 --- a/src/elements/IndicatorElement.js +++ b/src/elements/IndicatorElement.js @@ -1,10 +1,16 @@ /** - * Element containing an indicator. + * IndicatorElement is often mixed into other classes to generate an indicator. + * Indicators are small graphics that are generally used in two ways: * - * Indicators are graphics, smaller than normal text. They can be used to describe unique status or - * behavior. Indicators should only be used in exceptional cases; such as a button that opens a menu - * instead of performing an action directly, or an item in a list which has errors that need to be - * resolved. + * - To draw attention to the status of an item. For example, an indicator might be + * used to show that an item in a list has errors that need to be resolved. + * - To clarify the function of a control that acts in an exceptional way (a button + * that opens a menu instead of performing an action directly, for example). + * + * For a list of indicators included in the library, please see the + * [OOjs UI documentation on MediaWiki] [1]. + * + * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators * * @abstract * @class -- To view, visit https://gerrit.wikimedia.org/r/191208 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Iac55ac0229e99ec4fa06a8f5f8470c6ca04d047a Gerrit-PatchSet: 1 Gerrit-Project: oojs/ui Gerrit-Branch: master Gerrit-Owner: Kmenger <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
