Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/191197
Change subject: FlaggedElement: Add description
......................................................................
FlaggedElement: Add description
Change-Id: Ib730e0eedcde742c1a2b69538b85b3abf413ae58
---
M src/elements/FlaggedElement.js
1 file changed, 15 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/97/191197/1
diff --git a/src/elements/FlaggedElement.js b/src/elements/FlaggedElement.js
index d01aaed..21de115 100644
--- a/src/elements/FlaggedElement.js
+++ b/src/elements/FlaggedElement.js
@@ -1,8 +1,20 @@
/**
- * Element with named flags that can be added, removed, listed and checked.
+ * The FlaggedElement class is an attribute mixin, meaning that it is used to
add
+ * additional functionality to an element created by another class. The class
provides
+ * a ‘flags’ property assigned the name (or an array of names) of styling
flags,
+ * which are used to customize the look and feel of a widget to better
describe its
+ * importance and functionality.
*
- * A flag, when set, adds a CSS class on the `$element` by combining
`oo-ui-flaggedElement-` with
- * the flag name. Flags are primarily useful for styling.
+ * The library currently contains the following styling flags for general use:
+ *
+ * - **progressive**: Progressive styling is applied to convey that the
widget will move the user forward in a process.
+ * - **destructive**: Destructive styling is applied to convey that the widget
will remove something.
+ * - **constructive**: Constructive styling is applied to convey that the
widget will create something.
+ *
+ * {@link OO.ui.ActionWidget ActionWidgets}, which are a special kind of
button that execute an action, use these flags: **primary** and **safe**.
+ * Please see the [OOjs UI documentation on MediaWiki] [1] for more
information.
+ *
+ * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
*
* @abstract
* @class
--
To view, visit https://gerrit.wikimedia.org/r/191197
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib730e0eedcde742c1a2b69538b85b3abf413ae58
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
