Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/196725
Change subject: Widget: Clarify description
......................................................................
Widget: Clarify description
Change-Id: Ib17c529c338c5393d85fde0cb54398842afe11d9
---
M src/Widget.js
1 file changed, 11 insertions(+), 4 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/25/196725/1
diff --git a/src/Widget.js b/src/Widget.js
index b9680f1..4929e05 100644
--- a/src/Widget.js
+++ b/src/Widget.js
@@ -10,7 +10,8 @@
*
* @constructor
* @param {Object} [config] Configuration options
- * @cfg {boolean} [disabled=false] Disable
+ * @cfg {boolean} [disabled=false] Disable the widget. Disabled widgets cannot
be used and their
+ * appearance reflects this state.
*/
OO.ui.Widget = function OoUiWidget( config ) {
// Initialize config
@@ -40,11 +41,17 @@
/**
* @event disable
+ *
+ * A 'disable' event is emitted when a widget is disabled.
+ *
* @param {boolean} disabled Widget is disabled
*/
/**
* @event toggle
+ *
+ * A 'toggle' event is emitted when the visibility of the widget changes.
+ *
* @param {boolean} visible Widget is visible
*/
@@ -53,16 +60,16 @@
/**
* Check if the widget is disabled.
*
- * @return {boolean} Button is disabled
+ * @return {boolean} Widget is disabled
*/
OO.ui.Widget.prototype.isDisabled = function () {
return this.disabled;
};
/**
- * Set the disabled state of the widget.
+ * Set the 'disabled' state of the widget.
*
- * This should probably change the widgets' appearance and prevent it from
being used.
+ * When a widget is disabled, it cannot be used and its appearance is updated
to reflect this state.
*
* @param {boolean} disabled Disable widget
* @chainable
--
To view, visit https://gerrit.wikimedia.org/r/196725
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib17c529c338c5393d85fde0cb54398842afe11d9
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
