| 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 |
1×
4×
4×
4×
4×
4×
4×
2×
2×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
4×
2×
1×
1×
3×
1×
1×
1×
1×
1×
1×
1×
6×
6×
4×
2×
2×
4×
2×
2×
2×
4×
4×
4×
4×
1×
4×
4×
1×
1×
1×
4×
1×
4×
4×
4×
4×
13×
11×
11×
4×
1×
11×
1×
1×
6×
6×
6×
18×
6×
| /**
* MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget}
* intended to use a menu of selectable options.
*
* @example
* // A basic MenuTagMultiselectWidget.
* const widget = new OO.ui.MenuTagMultiselectWidget( {
* inputPosition: 'outline',
* options: [
* { data: 'option1', label: 'Option 1', icon: 'tag' },
* { data: 'option2', label: 'Option 2' },
* { data: 'option3', label: 'Option 3' },
* ],
* selected: [ 'option1', 'option2' ]
* } );
* $( document.body ).append( widget.$element );
*
* @class
* @extends OO.ui.TagMultiselectWidget
*
* @constructor
* @param {Object} [config] Configuration object
* @param {boolean} [config.clearInputOnChoose=true] Clear the text input value when a menu option is chosen
* @param {Object} [config.menu] Configuration object for the menu widget
* @param {jQuery} [config.$overlay] An overlay for the menu.
* See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
* @param {Object[]} [config.options=[]] Array of menu options in the format `{ data: …, label: … }`
*/
OO.ui.MenuTagMultiselectWidget = function OoUiMenuTagMultiselectWidget( config ) {
let $autoCloseIgnore = $( [] );
config = config || {};
// Ensure that any pre-selected items exist as menu options,
// so that they can be added as tags from #setValue
let options = config.options || [];
const selected = config.selected || [];
options = options.concat(
selected.map( function ( option ) {
if ( typeof option === 'string' ) {
return {
data: option,
label: option
};
}
return option;
} )
);
const configCopy = OO.copy( config );
configCopy.options = options;
configCopy.selected = selected;
// Parent constructor
OO.ui.MenuTagMultiselectWidget.super.call( this, configCopy );
$autoCloseIgnore = $autoCloseIgnore.add( this.$group );
Eif ( this.hasInput ) {
$autoCloseIgnore = $autoCloseIgnore.add( this.input.$element );
}
this.$overlay = ( config.$overlay === true ?
OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
this.clearInputOnChoose = config.clearInputOnChoose === undefined ||
!!config.clearInputOnChoose;
this.menu = this.createMenuWidget( $.extend( {
widget: this,
hideOnChoose: false,
input: this.hasInput ? this.input : null,
$input: this.hasInput ? this.input.$input : null,
filterFromInput: !!this.hasInput,
highlightOnFilter: !this.allowArbitrary,
multiselect: true,
$autoCloseIgnore: $autoCloseIgnore,
$floatableContainer: this.hasInput && this.inputPosition === 'outline' ?
this.input.$element : this.$element,
$overlay: this.$overlay,
disabled: this.isDisabled()
}, config.menu ) );
this.addOptions( options );
// Events
this.menu.connect( this, {
choose: 'onMenuChoose',
toggle: 'onMenuToggle'
} );
Eif ( this.hasInput ) {
this.input.connect( this, {
change: 'onInputChange'
} );
}
this.connect( this, {
resize: 'onResize'
} );
// Initialization
this.$overlay.append( this.menu.$element );
this.$element.addClass( 'oo-ui-menuTagMultiselectWidget' );
// Remove MenuSelectWidget's generic focus owner ARIA attribute
// TODO: Should this widget have a `role` that is compatible with this attribute?
this.menu.$focusOwner.removeAttr( 'aria-expanded' );
// TagMultiselectWidget already does this, but it doesn't work right because this.menu is
// not yet set up while the parent constructor runs, and #getAllowedValues rejects everything.
if ( selected.length > 0 ) {
this.setValue( selected );
}
};
/* Initialization */
OO.inheritClass( OO.ui.MenuTagMultiselectWidget, OO.ui.TagMultiselectWidget );
/* Methods */
/**
* Respond to resize event
*/
OO.ui.MenuTagMultiselectWidget.prototype.onResize = function () {
// Reposition the menu
this.menu.position();
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.onInputFocus = function () {
const valid = this.isValid();
// Parent method
OO.ui.MenuTagMultiselectWidget.super.prototype.onInputFocus.call( this );
this.menu.toggle( true );
if ( !valid ) {
this.menu.highlightItem();
}
};
/**
* Respond to input change event
*/
OO.ui.MenuTagMultiselectWidget.prototype.onInputChange = function () {
this.menu.toggle( true );
};
/**
* Respond to menu choose event, which is intentional by the user.
*
* @param {OO.ui.OptionWidget} menuItem Selected menu items
* @param {boolean} selected Item is selected
*/
OO.ui.MenuTagMultiselectWidget.prototype.onMenuChoose = function ( menuItem, selected ) {
if ( selected && !this.findItemFromData( menuItem.getData() ) ) {
// The menu item is selected, add it to the tags
this.addTag( menuItem.getData(), menuItem.getLabel() );
} else {
// The menu item was unselected, remove the tag
this.removeTagByData( menuItem.getData() );
}
if ( this.hasInput && this.clearInputOnChoose ) {
this.input.setValue( '' );
}
};
/**
* Respond to menu toggle event. Reset item highlights on hide.
*
* @param {boolean} isVisible The menu is visible
*/
OO.ui.MenuTagMultiselectWidget.prototype.onMenuToggle = function ( isVisible ) {
if ( !isVisible ) {
this.menu.highlightItem( null );
this.menu.scrollToTop();
}
setTimeout( function () {
// Remove MenuSelectWidget's generic focus owner ARIA attribute
// TODO: Should this widget have a `role` that is compatible with this attribute?
this.menu.$focusOwner.removeAttr( 'aria-expanded' );
}.bind( this ) );
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.onTagSelect = function ( tagItem ) {
const menuItem = this.menu.findItemFromData( tagItem.getData() );
if ( !this.allowArbitrary ) {
// Override the base behavior from TagMultiselectWidget; the base behavior
// in TagMultiselectWidget is to remove the tag to edit it in the input,
// but in our case, we want to utilize the menu selection behavior, and
// definitely not remove the item.
// If there is an input that is used for filtering, erase the value so we don't filter
if ( this.hasInput && this.menu.filterFromInput ) {
this.input.setValue( '' );
}
this.focus();
// Highlight the menu item
this.menu.highlightItem( menuItem );
this.menu.scrollItemIntoView( menuItem );
} else {
// Use the default
OO.ui.MenuTagMultiselectWidget.super.prototype.onTagSelect.call( this, tagItem );
}
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.removeItems = function ( items ) {
const widget = this;
// Parent
OO.ui.MenuTagMultiselectWidget.super.prototype.removeItems.call( this, items );
items.forEach( function ( tagItem ) {
const menuItem = widget.menu.findItemFromData( tagItem.getData() );
if ( menuItem ) {
// Synchronize the menu selection - unselect the removed tag
widget.menu.unselectItem( menuItem );
}
} );
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.setValue = function ( valueObject ) {
valueObject = Array.isArray( valueObject ) ? valueObject : [ valueObject ];
// We override this method from the parent, to make sure we are adding proper
// menu items, and are accounting for cases where we have this widget with
// a menu but also 'allowArbitrary'
if ( !this.menu ) {
return;
}
this.clearItems();
valueObject.forEach( function ( obj ) {
let data, label;
if ( typeof obj === 'string' ) {
data = label = obj;
} else {
data = obj.data;
label = obj.label;
}
// Check if the item is in the menu
const menuItem = this.menu.getItemFromLabel( label ) || this.menu.findItemFromData( data );
Eif ( menuItem ) {
// Menu item found, add the menu item
this.addTag( menuItem.getData(), menuItem.getLabel() );
// Make sure that item is also selected
this.menu.selectItem( menuItem );
} else if ( this.allowArbitrary ) {
// If the item isn't in the menu, only add it if we
// allow for arbitrary values
this.addTag( data, label );
}
}.bind( this ) );
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.setDisabled = function ( isDisabled ) {
// Parent method
OO.ui.MenuTagMultiselectWidget.super.prototype.setDisabled.call( this, isDisabled );
Iif ( this.menu ) {
// Protect against calling setDisabled() before the menu was initialized
this.menu.setDisabled( isDisabled );
}
};
/**
* Highlight the first selectable item in the menu, if configured.
*
* @private
* @chainable
*/
OO.ui.MenuTagMultiselectWidget.prototype.initializeMenuSelection = function () {
this.menu.highlightItem(
this.allowArbitrary ?
null :
this.menu.findFirstSelectableItem()
);
const highlightedItem = this.menu.findHighlightedItem();
// Scroll to the highlighted item, if it exists
if ( highlightedItem ) {
this.menu.scrollItemIntoView( highlightedItem );
}
};
/**
* @inheritdoc
*/
OO.ui.MenuTagMultiselectWidget.prototype.getTagInfoFromInput = function () {
const val = this.input.getValue(),
// Look for a highlighted item first
// Then look for the element that fits the data
item = this.menu.findHighlightedItem() || this.menu.findItemFromData( val ),
data = item ? item.getData() : val,
label = item ? item.getLabel() : val;
return { data: data, label: label };
};
/**
* Create the menu for this widget. This is in a separate method so that
* child classes can override this without polluting the constructor with
* unnecessary extra objects that will be overidden.
*
* @param {Object} menuConfig Configuration options
* @return {OO.ui.MenuSelectWidget} Menu widget
*/
OO.ui.MenuTagMultiselectWidget.prototype.createMenuWidget = function ( menuConfig ) {
return new OO.ui.MenuSelectWidget( menuConfig );
};
/**
* Add options to the menu, ensuring that they are unique by data.
*
* @param {Object[]} menuOptions Object defining options
*/
OO.ui.MenuTagMultiselectWidget.prototype.addOptions = function ( menuOptions ) {
const widget = this,
optionsData = [],
items = [];
menuOptions.forEach( function ( obj ) {
if ( optionsData.indexOf( obj.data ) === -1 ) {
optionsData.push( obj.data );
items.push(
widget.createMenuOptionWidget( obj.data, obj.label, obj.icon )
);
}
} );
this.menu.addItems( items );
};
/**
* Create a menu option widget.
*
* @param {string} data Item data
* @param {string} [label=data] Item label
* @param {string} [icon] Symbolic icon name
* @return {OO.ui.OptionWidget} Option widget
*/
OO.ui.MenuTagMultiselectWidget.prototype.createMenuOptionWidget = function ( data, label, icon ) {
return new OO.ui.MenuOptionWidget( {
data: data,
label: label || data,
icon: icon
} );
};
/**
* Get the menu
*
* @return {OO.ui.MenuSelectWidget} Menu
*/
OO.ui.MenuTagMultiselectWidget.prototype.getMenu = function () {
return this.menu;
};
/**
* Get the allowed values list
*
* @return {string[]} Allowed data values
*/
OO.ui.MenuTagMultiselectWidget.prototype.getAllowedValues = function () {
let menuDatas = [];
Eif ( this.menu ) {
// If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
menuDatas = this.menu.getItems().map( function ( menuItem ) {
return menuItem.getData();
} );
}
return this.allowedValues.concat( menuDatas );
};
|