| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446 |
1×
5491×
2217×
2217×
5491×
5491×
5491×
164×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
2050×
2050×
212×
3441×
3441×
3441×
3441×
3441×
212×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
5491×
1×
1×
1×
1×
1×
1×
9063×
1×
9063×
1×
3360×
1×
5491×
5491×
5491×
100×
5491×
424×
36×
36×
388×
12×
12×
376×
376×
5067×
1918×
1918×
3149×
188×
188×
2961×
2961×
5491×
5491×
5491×
5491×
1×
5491×
5491×
5491×
1×
5491×
5491×
5491×
1×
5491×
5491×
5491×
1×
5491×
5491×
5491×
1×
21964×
21964×
3232×
18732×
18732×
3232×
2688×
3232×
3232×
3232×
672×
1×
1936×
968×
968×
1×
424×
24×
24×
400×
400×
400×
400×
400×
400×
424×
424×
| /**
* FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget,
* which is a widget that is specified by reference before any optional configuration settings.
*
* Field layouts can be configured with help text and/or labels. Labels are aligned in one of
* four ways:
*
* - **left**: The label is placed before the field-widget and aligned with the left margin.
* A left-alignment is used for forms with many fields.
* - **right**: The label is placed before the field-widget and aligned to the right margin.
* A right-alignment is used for long but familiar forms which users tab through,
* verifying the current field with a quick glance at the label.
* - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
* that users fill out from top to bottom.
* - **inline**: The label is placed after the field-widget and aligned to the left.
* An inline-alignment is best used with checkboxes or radio buttons.
*
* Help text can either be:
*
* - accessed via a help icon that appears in the upper right corner of the rendered field layout,
* or
* - shown as a subtle explanation below the label.
*
* If the help text is brief, or is essential to always expose it, set `helpInline` to `true`.
* If it is long or not essential, leave `helpInline` to its default, `false`.
*
* Please see the [OOUI documentation on MediaWiki][1] for examples and more information.
*
* [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets
*
* @class
* @extends OO.ui.Layout
* @mixes OO.ui.mixin.LabelElement
* @mixes OO.ui.mixin.TitledElement
*
* @constructor
* @param {OO.ui.Widget} fieldWidget Field widget
* @param {Object} [config] Configuration options
* @param {string} [config.align='left'] Alignment of the label: 'left', 'right', 'top'
* or 'inline'
* @param {Array} [config.errors] Error messages about the widget, which will be
* displayed below the widget.
* @param {Array} [config.warnings] Warning messages about the widget, which will be
* displayed below the widget.
* @param {Array} [config.successMessages] Success messages on user interactions with the widget,
* which will be displayed below the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* @param {Array} [config.notices] Notices about the widget, which will be displayed
* below the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* These are more visible than `help` messages when `helpInline` is set, and so
* might be good for transient messages.
* @param {string|OO.ui.HtmlSnippet} [config.help] Help text. When help text is specified
* and `helpInline` is `false`, a "help" icon will appear in the upper-right
* corner of the rendered field; clicking it will display the text in a popup.
* If `helpInline` is `true`, then a subtle description will be shown after the
* label.
* @param {boolean} [config.helpInline=false] Whether or not the help should be inline,
* or shown when the "help" icon is clicked.
* @param {jQuery} [config.$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if
* `help` is given.
* See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
*
* @throws {Error} An error is thrown if no widget is specified
*
* @property {OO.ui.Widget} fieldWidget
*/
OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
// Allow passing positional parameters inside the config object
if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
config = fieldWidget;
fieldWidget = config.fieldWidget;
}
// Make sure we have required constructor arguments
Iif ( fieldWidget === undefined ) {
throw new Error( 'Widget not found' );
}
// Configuration initialization
config = $.extend( { align: 'left', helpInline: false }, config );
if ( config.help && !config.label ) {
// Add an empty label. For some combinations of 'helpInline' and 'align'
// there would be no space in the interface to display the help text otherwise.
config.label = ' ';
}
// Parent constructor
OO.ui.FieldLayout.super.call( this, config );
// Mixin constructors
OO.ui.mixin.LabelElement.call( this, $.extend( {
$label: $( '<label>' )
}, config ) );
OO.ui.mixin.TitledElement.call( this, $.extend( { $titled: this.$label }, config ) );
// Properties
this.fieldWidget = fieldWidget;
this.errors = [];
this.warnings = [];
this.successMessages = [];
this.notices = [];
this.$field = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );
this.$messages = $( '<div>' );
this.$header = $( '<span>' );
this.$body = $( '<div>' );
this.align = null;
this.helpInline = config.helpInline;
// Events
this.fieldWidget.connect( this, {
disable: 'onFieldDisable'
} );
// Initialization
this.$help = config.help ?
this.createHelpElement( config.help, config.$overlay ) :
$( [] );
if ( this.fieldWidget.getInputId() ) {
this.$label.attr( 'for', this.fieldWidget.getInputId() );
if ( this.helpInline ) {
this.$help.attr( 'for', this.fieldWidget.getInputId() );
}
} else {
// We can't use `label for` with non-form elements, use `aria-labelledby` instead
const id = OO.ui.generateElementId();
this.$label.attr( 'id', id );
this.fieldWidget.setLabelledBy( id );
// Forward clicks on the label to the widget, like `label for` would do
this.$label.on( 'click', this.onLabelClick.bind( this ) );
if ( this.helpInline ) {
this.$help.on( 'click', this.onLabelClick.bind( this ) );
}
}
this.$element
.addClass( 'oo-ui-fieldLayout' )
.toggleClass( 'oo-ui-fieldLayout-disabled', this.fieldWidget.isDisabled() )
.append( this.$body );
this.$body.addClass( 'oo-ui-fieldLayout-body' );
this.$header.addClass( 'oo-ui-fieldLayout-header' );
this.$messages.addClass( 'oo-ui-fieldLayout-messages' );
this.$field
.addClass( 'oo-ui-fieldLayout-field' )
.append( this.fieldWidget.$element );
this.setErrors( config.errors || [] );
this.setWarnings( config.warnings || [] );
this.setSuccess( config.successMessages || [] );
this.setNotices( config.notices || [] );
this.setAlignment( config.align );
// Call this again to take into account the widget's accessKey
this.updateTitle();
};
/* Setup */
OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.LabelElement );
OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.TitledElement );
/* Methods */
/**
* Handle field disable events.
*
* @private
* @param {boolean} value Field is disabled
*/
OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
};
/**
* Handle click events on the field label, or inline help
*
* @param {jQuery.Event} event
*/
OO.ui.FieldLayout.prototype.onLabelClick = function () {
this.fieldWidget.simulateLabelClick();
};
/**
* Get the widget contained by the field.
*
* @return {OO.ui.Widget} Field widget
*/
OO.ui.FieldLayout.prototype.getField = function () {
return this.fieldWidget;
};
/**
* Return `true` if the given field widget can be used with `'inline'` alignment (see
* #setAlignment). Return `false` if it can't or if this can't be determined.
*
* @return {boolean}
*/
OO.ui.FieldLayout.prototype.isFieldInline = function () {
// This is very simplistic, but should be good enough.
return this.getField().$element.prop( 'tagName' ).toLowerCase() === 'span';
};
/**
* @protected
* @param {string} kind 'error' or 'notice'
* @param {string|OO.ui.HtmlSnippet} text
* @return {jQuery}
*/
OO.ui.FieldLayout.prototype.makeMessage = function ( kind, text ) {
return new OO.ui.MessageWidget( {
type: kind,
inline: true,
label: text
} ).$element;
};
/**
* Set the field alignment mode.
*
* @private
* @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
* @chainable
* @return {OO.ui.BookletLayout} The layout, for chaining
*/
OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
Eif ( value !== this.align ) {
// Default to 'left'
Iif ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
value = 'left';
}
// Validate
if ( value === 'inline' && !this.isFieldInline() ) {
value = 'top';
}
// Reorder elements
if ( this.helpInline ) {
if ( value === 'top' ) {
this.$header.append( this.$label );
this.$body.append( this.$header, this.$field, this.$help );
} else if ( value === 'inline' ) {
this.$header.append( this.$label, this.$help );
this.$body.append( this.$field, this.$header );
} else {
this.$header.append( this.$label, this.$help );
this.$body.append( this.$header, this.$field );
}
} else {
if ( value === 'top' ) {
this.$header.append( this.$help, this.$label );
this.$body.append( this.$header, this.$field );
} else if ( value === 'inline' ) {
this.$header.append( this.$help, this.$label );
this.$body.append( this.$field, this.$header );
} else {
this.$header.append( this.$label );
this.$body.append( this.$header, this.$help, this.$field );
}
}
// Set classes. The following classes can be used here:
// * oo-ui-fieldLayout-align-left
// * oo-ui-fieldLayout-align-right
// * oo-ui-fieldLayout-align-top
// * oo-ui-fieldLayout-align-inline
Iif ( this.align ) {
this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
}
this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
this.align = value;
}
return this;
};
/**
* Set the list of error messages.
*
* @param {Array} errors Error messages about the widget, which will be displayed below the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* @chainable
* @return {OO.ui.BookletLayout} The layout, for chaining
*/
OO.ui.FieldLayout.prototype.setErrors = function ( errors ) {
this.errors = errors.slice();
this.updateMessages();
return this;
};
/**
* Set the list of warning messages.
*
* @param {Array} warnings Warning messages about the widget, which will be displayed below
* the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* @chainable
* @return {OO.ui.BookletLayout} The layout, for chaining
*/
OO.ui.FieldLayout.prototype.setWarnings = function ( warnings ) {
this.warnings = warnings.slice();
this.updateMessages();
return this;
};
/**
* Set the list of success messages.
*
* @param {Array} successMessages Success messages about the widget, which will be displayed below
* the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* @chainable
* @return {OO.ui.BookletLayout} The layout, for chaining
*/
OO.ui.FieldLayout.prototype.setSuccess = function ( successMessages ) {
this.successMessages = successMessages.slice();
this.updateMessages();
return this;
};
/**
* Set the list of notice messages.
*
* @param {Array} notices Notices about the widget, which will be displayed below the widget.
* The array may contain strings or OO.ui.HtmlSnippet instances.
* @chainable
* @return {OO.ui.BookletLayout} The layout, for chaining
*/
OO.ui.FieldLayout.prototype.setNotices = function ( notices ) {
this.notices = notices.slice();
this.updateMessages();
return this;
};
/**
* Update the rendering of error, warning, success and notice messages.
*
* @private
*/
OO.ui.FieldLayout.prototype.updateMessages = function () {
this.$messages.empty();
if (
this.errors.length ||
this.warnings.length ||
this.successMessages.length ||
this.notices.length
) {
this.$body.after( this.$messages );
} else {
this.$messages.remove();
return;
}
let i;
for ( i = 0; i < this.errors.length; i++ ) {
this.$messages.append( this.makeMessage( 'error', this.errors[ i ] ) );
}
for ( i = 0; i < this.warnings.length; i++ ) {
this.$messages.append( this.makeMessage( 'warning', this.warnings[ i ] ) );
}
for ( i = 0; i < this.successMessages.length; i++ ) {
this.$messages.append( this.makeMessage( 'success', this.successMessages[ i ] ) );
}
for ( i = 0; i < this.notices.length; i++ ) {
this.$messages.append( this.makeMessage( 'notice', this.notices[ i ] ) );
}
};
/**
* Include information about the widget's accessKey in our title. TitledElement calls this method.
* (This is a bit of a hack.)
*
* @protected
* @param {string} title Tooltip label for 'title' attribute
* @return {string}
*/
OO.ui.FieldLayout.prototype.formatTitleWithAccessKey = function ( title ) {
if ( this.fieldWidget && this.fieldWidget.formatTitleWithAccessKey ) {
return this.fieldWidget.formatTitleWithAccessKey( title );
}
return title;
};
/**
* Creates and returns the help element. Also sets the `aria-describedby`
* attribute on the main element of the `fieldWidget`.
*
* @private
* @param {string|OO.ui.HtmlSnippet} [help] Help text.
* @param {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup.
* @return {jQuery} The element that should become `this.$help`.
*/
OO.ui.FieldLayout.prototype.createHelpElement = function ( help, $overlay ) {
let helpId, helpWidget;
if ( this.helpInline ) {
helpWidget = new OO.ui.LabelWidget( {
label: help,
classes: [ 'oo-ui-inline-help' ]
} );
helpId = helpWidget.getElementId();
} else {
helpWidget = new OO.ui.PopupButtonWidget( {
$overlay: $overlay,
popup: {
padded: true
},
classes: [ 'oo-ui-fieldLayout-help' ],
framed: false,
icon: 'info',
label: OO.ui.msg( 'ooui-field-help' ),
invisibleLabel: true
} );
helpWidget.popup.on( 'ready', function () {
const $popupElement = helpWidget.popup.$element;
$popupElement.attr( 'tabindex', 0 );
$popupElement.trigger( 'focus' );
} );
helpWidget.popup.on( 'closing', function () {
helpWidget.$button.trigger( 'focus' );
} );
Iif ( help instanceof OO.ui.HtmlSnippet ) {
helpWidget.getPopup().$body.html( help.toString() );
} else {
helpWidget.getPopup().$body.text( help );
}
helpId = helpWidget.getPopup().getBodyId();
}
// Set the 'aria-describedby' attribute on the fieldWidget
// Preference given to an input or a button
(
this.fieldWidget.$input ||
( this.fieldWidget.input && this.fieldWidget.input.$input ) ||
this.fieldWidget.$button ||
this.fieldWidget.$element
).attr( 'aria-describedby', helpId );
return helpWidget.$element;
};
|