jenkins-bot has submitted this change and it was merged.
Change subject: Normalize configuration initialization
......................................................................
Normalize configuration initialization
In a few cases this was missing, and Kirsten actually ran into this
while writing some code. In many other cases the comments were slightly
varied, including 16 typos.
Bonus: Added documentation for a config option.
Change-Id: I98b3a553e4e3878d67d8996bf250ead7fd820b40
---
M src/Layout.js
M src/Theme.js
M src/Tool.js
M src/elements/FlaggedElement.js
M src/elements/GroupElement.js
M src/elements/IconElement.js
M src/elements/IndicatorElement.js
M src/elements/LabelElement.js
M src/elements/PendingElement.js
M src/elements/TitledElement.js
M src/layouts/BookletLayout.js
M src/layouts/FieldLayout.js
M src/layouts/FieldsetLayout.js
M src/layouts/GridLayout.js
M src/layouts/PanelLayout.js
M src/layouts/StackLayout.js
M src/toolgroups/ListToolGroup.js
M src/widgets/ActionWidget.js
M src/widgets/ButtonGroupWidget.js
M src/widgets/ButtonInputWidget.js
M src/widgets/IconWidget.js
M src/widgets/IndicatorWidget.js
M src/widgets/LabelWidget.js
M src/widgets/LookupInputWidget.js
M src/widgets/MenuWidget.js
M src/widgets/OptionWidget.js
M src/widgets/OutlineItemWidget.js
M src/widgets/OutlineWidget.js
M src/widgets/PopupWidget.js
M src/widgets/ProgressBarWidget.js
M src/widgets/SelectWidget.js
M src/widgets/TextInputMenuWidget.js
M src/widgets/TextInputWidget.js
33 files changed, 46 insertions(+), 28 deletions(-)
Approvals:
Catrope: Looks good to me, approved
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/src/Layout.js b/src/Layout.js
index 9a0d4ed..36a4cf4 100644
--- a/src/Layout.js
+++ b/src/Layout.js
@@ -10,7 +10,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.Layout = function OoUiLayout( config ) {
- // Initialize config
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/Theme.js b/src/Theme.js
index bb9bebd..65bf091 100644
--- a/src/Theme.js
+++ b/src/Theme.js
@@ -8,7 +8,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.Theme = function OoUiTheme( config ) {
- // Initialize config
+ // Configuration initialization
config = config || {};
};
diff --git a/src/Tool.js b/src/Tool.js
index bb123d0..2d1a3e3 100644
--- a/src/Tool.js
+++ b/src/Tool.js
@@ -13,7 +13,7 @@
* @cfg {string|Function} [title] Title text or a function that returns text
*/
OO.ui.Tool = function OoUiTool( toolGroup, config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/elements/FlaggedElement.js b/src/elements/FlaggedElement.js
index 273c2a6..f86b9c8 100644
--- a/src/elements/FlaggedElement.js
+++ b/src/elements/FlaggedElement.js
@@ -13,7 +13,7 @@
* @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use
#$element
*/
OO.ui.FlaggedElement = function OoUiFlaggedElement( config ) {
- // Config initialization
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/elements/GroupElement.js b/src/elements/GroupElement.js
index 1b5e3f8..e5f3cb1 100644
--- a/src/elements/GroupElement.js
+++ b/src/elements/GroupElement.js
@@ -9,7 +9,7 @@
* @cfg {jQuery} [$group] Container node, assigned to #$group, omit to use a
generated `<div>`
*/
OO.ui.GroupElement = function OoUiGroupElement( config ) {
- // Configuration
+ // Configuration intialization
config = config || {};
// Properties
diff --git a/src/elements/IconElement.js b/src/elements/IconElement.js
index 832fb3a..0548353 100644
--- a/src/elements/IconElement.js
+++ b/src/elements/IconElement.js
@@ -18,7 +18,7 @@
* @cfg {string} [iconTitle] Icon title text or a function that returns text
*/
OO.ui.IconElement = function OoUiIconElement( config ) {
- // Config intialization
+ // Configuration intialization
config = config || {};
// Properties
diff --git a/src/elements/IndicatorElement.js b/src/elements/IndicatorElement.js
index a1aa5ad..327c6b4 100644
--- a/src/elements/IndicatorElement.js
+++ b/src/elements/IndicatorElement.js
@@ -17,7 +17,7 @@
* @cfg {string} [indicatorTitle] Indicator title text or a function that
returns text
*/
OO.ui.IndicatorElement = function OoUiIndicatorElement( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/elements/LabelElement.js b/src/elements/LabelElement.js
index 886d6ca..1d270ab 100644
--- a/src/elements/LabelElement.js
+++ b/src/elements/LabelElement.js
@@ -11,7 +11,7 @@
* @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
*/
OO.ui.LabelElement = function OoUiLabelElement( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/elements/PendingElement.js b/src/elements/PendingElement.js
index 7961d7e..7bc136c 100644
--- a/src/elements/PendingElement.js
+++ b/src/elements/PendingElement.js
@@ -8,7 +8,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.PendingElement = function OoUiPendingElement( config ) {
- // Config initialisation
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/elements/TitledElement.js b/src/elements/TitledElement.js
index 43b19aa..c04baad 100644
--- a/src/elements/TitledElement.js
+++ b/src/elements/TitledElement.js
@@ -14,7 +14,7 @@
* static property 'title' is used.
*/
OO.ui.TitledElement = function OoUiTitledElement( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/layouts/BookletLayout.js b/src/layouts/BookletLayout.js
index 9317ffb..ce67154 100644
--- a/src/layouts/BookletLayout.js
+++ b/src/layouts/BookletLayout.js
@@ -12,7 +12,7 @@
* @cfg {boolean} [editable=false] Show controls for adding, removing and
reordering pages
*/
OO.ui.BookletLayout = function OoUiBookletLayout( config ) {
- // Initialize configuration
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/layouts/FieldLayout.js b/src/layouts/FieldLayout.js
index e7a3c45..0b9d2bb 100644
--- a/src/layouts/FieldLayout.js
+++ b/src/layouts/FieldLayout.js
@@ -22,7 +22,7 @@
* @cfg {string} [help] Explanatory text shown as a '?' icon.
*/
OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
- // Config initialization
+ // Configuration initialization
config = $.extend( { align: 'left' }, config );
// Parent constructor
diff --git a/src/layouts/FieldsetLayout.js b/src/layouts/FieldsetLayout.js
index d407e8e..2026f0f 100644
--- a/src/layouts/FieldsetLayout.js
+++ b/src/layouts/FieldsetLayout.js
@@ -14,7 +14,7 @@
* @cfg {OO.ui.FieldLayout[]} [items] Items to add
*/
OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
- // Config initialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/layouts/GridLayout.js b/src/layouts/GridLayout.js
index cbe92ee..dbbe659 100644
--- a/src/layouts/GridLayout.js
+++ b/src/layouts/GridLayout.js
@@ -13,7 +13,7 @@
OO.ui.GridLayout = function OoUiGridLayout( panels, config ) {
var i, len, widths;
- // Config initialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/layouts/PanelLayout.js b/src/layouts/PanelLayout.js
index 85bbcef..6c5de96 100644
--- a/src/layouts/PanelLayout.js
+++ b/src/layouts/PanelLayout.js
@@ -11,7 +11,7 @@
* @cfg {boolean} [expanded=true] Expand size to fill the entire parent element
*/
OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
- // Config initialization
+ // Configuration initialization
config = $.extend( {
scrollable: false,
padded: false,
diff --git a/src/layouts/StackLayout.js b/src/layouts/StackLayout.js
index 6d3b5b6..6e687b8 100644
--- a/src/layouts/StackLayout.js
+++ b/src/layouts/StackLayout.js
@@ -12,7 +12,7 @@
* @cfg {OO.ui.Layout[]} [items] Layouts to add
*/
OO.ui.StackLayout = function OoUiStackLayout( config ) {
- // Config initialization
+ // Configuration initialization
config = $.extend( { scrollable: true }, config );
// Parent constructor
diff --git a/src/toolgroups/ListToolGroup.js b/src/toolgroups/ListToolGroup.js
index 7a0ec6c..ef943f9 100644
--- a/src/toolgroups/ListToolGroup.js
+++ b/src/toolgroups/ListToolGroup.js
@@ -18,6 +18,9 @@
* @cfg {boolean} [expanded=false] Whether the collapsible tools are expanded
by default
*/
OO.ui.ListToolGroup = function OoUiListToolGroup( toolbar, config ) {
+ // Configuration intialization
+ config = config || {};
+
// Properties (must be set before parent constructor, which calls
#populate)
this.allowCollapse = config.allowCollapse;
this.forceExpand = config.forceExpand;
diff --git a/src/widgets/ActionWidget.js b/src/widgets/ActionWidget.js
index f436ab6..bbbae27 100644
--- a/src/widgets/ActionWidget.js
+++ b/src/widgets/ActionWidget.js
@@ -12,7 +12,7 @@
* @cfg {boolean} [framed=false] Render button with a frame
*/
OO.ui.ActionWidget = function OoUiActionWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = $.extend( { framed: false }, config );
// Parent constructor
diff --git a/src/widgets/ButtonGroupWidget.js b/src/widgets/ButtonGroupWidget.js
index 5fd1dc9..be0eb30 100644
--- a/src/widgets/ButtonGroupWidget.js
+++ b/src/widgets/ButtonGroupWidget.js
@@ -12,6 +12,9 @@
* @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
*/
OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
+ // Configuration initialization
+ config = config || {};
+
// Parent constructor
OO.ui.ButtonGroupWidget.super.call( this, config );
diff --git a/src/widgets/ButtonInputWidget.js b/src/widgets/ButtonInputWidget.js
index bfd8525..5147ad6 100644
--- a/src/widgets/ButtonInputWidget.js
+++ b/src/widgets/ButtonInputWidget.js
@@ -75,7 +75,11 @@
* @return {jQuery} Input element
*/
OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
+ // Configuration intialization
+ config = config || {};
+
var html = '<' + ( config.useInputTag ? 'input' : 'button' ) + '
type="' + config.type + '">';
+
return this.$( html );
};
diff --git a/src/widgets/IconWidget.js b/src/widgets/IconWidget.js
index 030349f..b444d43 100644
--- a/src/widgets/IconWidget.js
+++ b/src/widgets/IconWidget.js
@@ -12,7 +12,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.IconWidget = function OoUiIconWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/IndicatorWidget.js b/src/widgets/IndicatorWidget.js
index e3549b9..d2c7c62 100644
--- a/src/widgets/IndicatorWidget.js
+++ b/src/widgets/IndicatorWidget.js
@@ -12,7 +12,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/LabelWidget.js b/src/widgets/LabelWidget.js
index 7d1d8ca..e3660d8 100644
--- a/src/widgets/LabelWidget.js
+++ b/src/widgets/LabelWidget.js
@@ -9,7 +9,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/LookupInputWidget.js b/src/widgets/LookupInputWidget.js
index c11f2aa..b793201 100644
--- a/src/widgets/LookupInputWidget.js
+++ b/src/widgets/LookupInputWidget.js
@@ -14,9 +14,10 @@
* @param {OO.ui.TextInputWidget} input Input widget
* @param {Object} [config] Configuration options
* @cfg {jQuery} [$overlay] Overlay for dropdown; defaults to relative
positioning
+ * @cfg {jQuery} [$container=input.$element] Element to render menu under
*/
OO.ui.LookupInputWidget = function OoUiLookupInputWidget( input, config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Properties
diff --git a/src/widgets/MenuWidget.js b/src/widgets/MenuWidget.js
index 60ebfd7..dec2baa 100644
--- a/src/widgets/MenuWidget.js
+++ b/src/widgets/MenuWidget.js
@@ -17,7 +17,7 @@
* @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed
outside the menu
*/
OO.ui.MenuWidget = function OoUiMenuWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/OptionWidget.js b/src/widgets/OptionWidget.js
index 380864d..909925b 100644
--- a/src/widgets/OptionWidget.js
+++ b/src/widgets/OptionWidget.js
@@ -12,7 +12,7 @@
* @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option
styling
*/
OO.ui.OptionWidget = function OoUiOptionWidget( data, config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/OutlineItemWidget.js b/src/widgets/OutlineItemWidget.js
index 17ff98c..543d4c5 100644
--- a/src/widgets/OutlineItemWidget.js
+++ b/src/widgets/OutlineItemWidget.js
@@ -11,7 +11,7 @@
* @cfg {boolean} [movable] Allow modification from outline controls
*/
OO.ui.OutlineItemWidget = function OoUiOutlineItemWidget( data, config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/OutlineWidget.js b/src/widgets/OutlineWidget.js
index 2370bc0..a674921 100644
--- a/src/widgets/OutlineWidget.js
+++ b/src/widgets/OutlineWidget.js
@@ -10,7 +10,7 @@
* @param {Object} [config] Configuration options
*/
OO.ui.OutlineWidget = function OoUiOutlineWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/PopupWidget.js b/src/widgets/PopupWidget.js
index 11c897d..386d07d 100644
--- a/src/widgets/PopupWidget.js
+++ b/src/widgets/PopupWidget.js
@@ -20,7 +20,7 @@
* @cfg {boolean} [padded] Add padding to the body
*/
OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/ProgressBarWidget.js b/src/widgets/ProgressBarWidget.js
index b585cd9..4db8f21 100644
--- a/src/widgets/ProgressBarWidget.js
+++ b/src/widgets/ProgressBarWidget.js
@@ -9,7 +9,7 @@
* @cfg {number} [progress=0] Initial progress
*/
OO.ui.ProgressBarWidget = function OoUiProgressBarWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/SelectWidget.js b/src/widgets/SelectWidget.js
index 0625b45..6776dca 100644
--- a/src/widgets/SelectWidget.js
+++ b/src/widgets/SelectWidget.js
@@ -15,7 +15,7 @@
* @cfg {OO.ui.OptionWidget[]} [items] Options to add
*/
OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
- // Config intialization
+ // Configuration initialization
config = config || {};
// Parent constructor
diff --git a/src/widgets/TextInputMenuWidget.js
b/src/widgets/TextInputMenuWidget.js
index c28eaf4..0ead9bf 100644
--- a/src/widgets/TextInputMenuWidget.js
+++ b/src/widgets/TextInputMenuWidget.js
@@ -14,6 +14,9 @@
* @cfg {jQuery} [$container=input.$element] Element to render menu under
*/
OO.ui.TextInputMenuWidget = function OoUiTextInputMenuWidget( input, config ) {
+ // Configuration intialization
+ config = config || {};
+
// Parent constructor
OO.ui.TextInputMenuWidget.super.call( this, config );
diff --git a/src/widgets/TextInputWidget.js b/src/widgets/TextInputWidget.js
index f86f86b..2785ca0 100644
--- a/src/widgets/TextInputWidget.js
+++ b/src/widgets/TextInputWidget.js
@@ -239,7 +239,11 @@
* @return {jQuery} Input element
*/
OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
+ // Configuration initialization
+ config = config || {};
+
var type = config.type || 'text';
+
return config.multiline ? this.$( '<textarea>' ) : this.$( '<input
type="' + type + '" />' );
};
--
To view, visit https://gerrit.wikimedia.org/r/170797
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I98b3a553e4e3878d67d8996bf250ead7fd820b40
Gerrit-PatchSet: 2
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Trevor Parscal <[email protected]>
Gerrit-Reviewer: Catrope <[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
