jenkins-bot has submitted this change and it was merged.
Change subject: FlaggedElement: Add description of event and config option
......................................................................
FlaggedElement: Add description of event and config option
Change-Id: I6bd93ea017436e10dc2730d0f785e93ae0013d3c
---
M src/elements/FlaggedElement.js
1 file changed, 10 insertions(+), 5 deletions(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/src/elements/FlaggedElement.js b/src/elements/FlaggedElement.js
index 21de115..ab36f2d 100644
--- a/src/elements/FlaggedElement.js
+++ b/src/elements/FlaggedElement.js
@@ -21,9 +21,10 @@
*
* @constructor
* @param {Object} [config] Configuration options
- * @cfg {string|string[]} [flags] Flags describing importance and
functionality, e.g. 'primary',
- * 'safe', 'progressive', 'destructive' or 'constructive'
- * @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use
#$element
+ * @cfg {string|string[]} [flags] The name or names of the flags (e.g.,
'constructive' or 'primary') to apply.
+ * Please see the [OOjs UI documentation on MediaWiki] [2] for more
information about available flags.
+ * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
+ * @cfg {jQuery} [$flagged] Flagged node, assigned to $flagged, omit to use
$element
*/
OO.ui.FlaggedElement = function OoUiFlaggedElement( config ) {
// Configuration initialization
@@ -42,8 +43,12 @@
/**
* @event flag
- * @param {Object.<string,boolean>} changes Object keyed by flag name
containing boolean
- * added/removed properties
+ * A flag event is emitted when the #clearFlags or #setFlags methods are used.
The `changes`
+ * parameter contains the name of each modified flag and indicates whether it
was
+ * added or removed.
+ *
+ * @param {Object.<string,boolean>} changes Object keyed by flag name. A
Boolean `true` indicates
+ * that the flag was added, `false` that the flag was removed.
*/
/* Methods */
--
To view, visit https://gerrit.wikimedia.org/r/192477
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I6bd93ea017436e10dc2730d0f785e93ae0013d3c
Gerrit-PatchSet: 3
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
