Merge "resourceloader: Fix @covers for CSSMin tests"
[lhc/web/wiklou.git] / resources / src / mediawiki.rcfilters / ui / mw.rcfilters.ui.FilterTagMultiselectWidget.js
1 ( function ( mw ) {
2 /**
3 * List displaying all filter groups
4 *
5 * @class
6 * @extends OO.ui.MenuTagMultiselectWidget
7 * @mixins OO.ui.mixin.PendingElement
8 *
9 * @constructor
10 * @param {mw.rcfilters.Controller} controller Controller
11 * @param {mw.rcfilters.dm.FiltersViewModel} model View model
12 * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
13 * @param {Object} config Configuration object
14 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
15 */
16 mw.rcfilters.ui.FilterTagMultiselectWidget = function MwRcfiltersUiFilterTagMultiselectWidget( controller, model, savedQueriesModel, config ) {
17 var rcFiltersRow,
18 areSavedQueriesEnabled = mw.config.get( 'wgStructuredChangeFiltersEnableSaving' ),
19 title = new OO.ui.LabelWidget( {
20 label: mw.msg( 'rcfilters-activefilters' ),
21 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-title' ]
22 } ),
23 $contentWrapper = $( '<div>' )
24 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
25
26 config = config || {};
27
28 this.controller = controller;
29 this.model = model;
30 this.queriesModel = savedQueriesModel;
31 this.$overlay = config.$overlay || this.$element;
32 this.matchingQuery = null;
33 this.areSavedQueriesEnabled = areSavedQueriesEnabled;
34
35 // Parent
36 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.call( this, $.extend( true, {
37 label: mw.msg( 'rcfilters-filterlist-title' ),
38 placeholder: mw.msg( 'rcfilters-empty-filter' ),
39 inputPosition: 'outline',
40 allowArbitrary: false,
41 allowDisplayInvalidTags: false,
42 allowReordering: false,
43 $overlay: this.$overlay,
44 menu: {
45 hideWhenOutOfView: false,
46 hideOnChoose: false,
47 width: 650,
48 footers: [
49 {
50 name: 'viewSelect',
51 sticky: false,
52 // View select menu, appears on default view only
53 $element: $( '<div>' )
54 .append( new mw.rcfilters.ui.ViewSwitchWidget( this.controller, this.model ).$element ),
55 views: [ 'default' ]
56 },
57 {
58 name: 'feedback',
59 // Feedback footer, appears on all views
60 $element: $( '<div>' )
61 .append(
62 new OO.ui.ButtonWidget( {
63 framed: false,
64 icon: 'feedback',
65 flags: [ 'progressive' ],
66 label: mw.msg( 'rcfilters-filterlist-feedbacklink' ),
67 href: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
68 } ).$element
69 )
70 }
71 ]
72 },
73 input: {
74 icon: 'menu',
75 placeholder: mw.msg( 'rcfilters-search-placeholder' )
76 }
77 }, config ) );
78
79 this.savedQueryTitle = new OO.ui.LabelWidget( {
80 label: '',
81 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
82 } );
83
84 this.resetButton = new OO.ui.ButtonWidget( {
85 framed: false,
86 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
87 } );
88
89 if ( areSavedQueriesEnabled ) {
90 this.saveQueryButton = new mw.rcfilters.ui.SaveFiltersPopupButtonWidget(
91 this.controller,
92 this.queriesModel
93 );
94
95 this.saveQueryButton.$element.on( 'mousedown', function ( e ) { e.stopPropagation(); } );
96
97 this.saveQueryButton.connect( this, {
98 click: 'onSaveQueryButtonClick',
99 saveCurrent: 'setSavedQueryVisibility'
100 } );
101 }
102
103 this.emptyFilterMessage = new OO.ui.LabelWidget( {
104 label: mw.msg( 'rcfilters-empty-filter' ),
105 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
106 } );
107 this.$content.append( this.emptyFilterMessage.$element );
108
109 // Events
110 this.resetButton.connect( this, { click: 'onResetButtonClick' } );
111 // Stop propagation for mousedown, so that the widget doesn't
112 // trigger the focus on the input and scrolls up when we click the reset button
113 this.resetButton.$element.on( 'mousedown', function ( e ) { e.stopPropagation(); } );
114 this.model.connect( this, {
115 initialize: 'onModelInitialize',
116 update: 'onModelUpdate',
117 itemUpdate: 'onModelItemUpdate',
118 highlightChange: 'onModelHighlightChange'
119 } );
120 this.input.connect( this, { change: 'onInputChange' } );
121 this.queriesModel.connect( this, { itemUpdate: 'onSavedQueriesItemUpdate' } );
122
123 // The filter list and button should appear side by side regardless of how
124 // wide the button is; the button also changes its width depending
125 // on language and its state, so the safest way to present both side
126 // by side is with a table layout
127 rcFiltersRow = $( '<div>' )
128 .addClass( 'mw-rcfilters-ui-row' )
129 .append(
130 this.$content
131 .addClass( 'mw-rcfilters-ui-cell' )
132 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
133 );
134
135 if ( areSavedQueriesEnabled ) {
136 rcFiltersRow.append(
137 $( '<div>' )
138 .addClass( 'mw-rcfilters-ui-cell' )
139 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
140 .append( this.saveQueryButton.$element )
141 );
142 }
143
144 // Add a selector at the right of the input
145 this.viewsSelectWidget = new OO.ui.ButtonSelectWidget( {
146 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
147 items: [
148 new OO.ui.ButtonOptionWidget( {
149 framed: false,
150 data: 'namespaces',
151 icon: 'article',
152 title: mw.msg( 'rcfilters-view-namespaces-tooltip' )
153 } ),
154 new OO.ui.ButtonOptionWidget( {
155 framed: false,
156 data: 'tags',
157 icon: 'tag',
158 title: mw.msg( 'rcfilters-view-tags-tooltip' )
159 } )
160 ]
161 } );
162
163 // Rearrange the UI so the select widget is at the right of the input
164 this.$element.append(
165 $( '<div>' )
166 .addClass( 'mw-rcfilters-ui-table' )
167 .append(
168 $( '<div>' )
169 .addClass( 'mw-rcfilters-ui-row' )
170 .append(
171 $( '<div>' )
172 .addClass( 'mw-rcfilters-ui-cell' )
173 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
174 .append( this.input.$element ),
175 $( '<div>' )
176 .addClass( 'mw-rcfilters-ui-cell' )
177 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
178 .append( this.viewsSelectWidget.$element )
179 )
180 )
181 );
182
183 // Event
184 this.viewsSelectWidget.connect( this, { choose: 'onViewsSelectWidgetChoose' } );
185
186 rcFiltersRow.append(
187 $( '<div>' )
188 .addClass( 'mw-rcfilters-ui-cell' )
189 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
190 .append( this.resetButton.$element )
191 );
192
193 // Build the content
194 $contentWrapper.append(
195 title.$element,
196 this.savedQueryTitle.$element,
197 $( '<div>' )
198 .addClass( 'mw-rcfilters-ui-table' )
199 .append(
200 rcFiltersRow
201 )
202 );
203
204 // Initialize
205 this.$handle.append( $contentWrapper );
206 this.emptyFilterMessage.toggle( this.isEmpty() );
207 this.savedQueryTitle.toggle( false );
208
209 this.$element
210 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
211
212 this.reevaluateResetRestoreState();
213 };
214
215 /* Initialization */
216
217 OO.inheritClass( mw.rcfilters.ui.FilterTagMultiselectWidget, OO.ui.MenuTagMultiselectWidget );
218
219 /* Methods */
220
221 /**
222 * Respond to view select widget choose event
223 *
224 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
225 */
226 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget ) {
227 this.controller.switchView( buttonOptionWidget.getData() );
228 this.viewsSelectWidget.selectItem( null );
229 this.focus();
230 };
231
232 /**
233 * Respond to input change event
234 *
235 * @param {string} value Value of the input
236 */
237 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onInputChange = function ( value ) {
238 var view = this.model.getViewByTrigger( value.substr( 0, 1 ) );
239
240 this.controller.switchView( view );
241 };
242 /**
243 * Respond to query button click
244 */
245 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onSaveQueryButtonClick = function () {
246 this.getMenu().toggle( false );
247 };
248
249 /**
250 * Respond to save query item change. Mainly this is done to update the label in case
251 * a query item has been edited
252 *
253 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
254 */
255 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onSavedQueriesItemUpdate = function ( item ) {
256 if ( this.matchingQuery === item ) {
257 // This means we just edited the item that is currently matched
258 this.savedQueryTitle.setLabel( item.getLabel() );
259 }
260 };
261
262 /**
263 * Respond to menu toggle
264 *
265 * @param {boolean} isVisible Menu is visible
266 */
267 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onMenuToggle = function ( isVisible ) {
268 // Parent
269 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.onMenuToggle.call( this );
270
271 if ( isVisible ) {
272 mw.hook( 'RcFilters.popup.open' ).fire();
273
274 if ( !this.getMenu().getSelectedItem() ) {
275 // If there are no selected items, scroll menu to top
276 // This has to be in a setTimeout so the menu has time
277 // to be positioned and fixed
278 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
279 }
280 } else {
281 // Clear selection
282 this.selectTag( null );
283
284 // Clear input if the only thing in the input is the prefix
285 if (
286 this.input.getValue() === this.model.getViewTrigger( this.model.getCurrentView() )
287 ) {
288 // Clear the input
289 this.input.setValue( '' );
290 }
291
292 // Log filter grouping
293 this.controller.trackFilterGroupings( 'filtermenu' );
294 }
295
296 this.input.setIcon( isVisible ? 'search' : 'menu' );
297 };
298
299 /**
300 * @inheritdoc
301 */
302 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onInputFocus = function () {
303 // Parent
304 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.onInputFocus.call( this );
305
306 // Scroll to top
307 this.scrollToTop( this.$element );
308 };
309
310 /**
311 * @inheritdoc
312 */
313 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.doInputEscape = function () {
314 // Parent
315 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.doInputEscape.call( this );
316
317 // Blur the input
318 this.input.$input.blur();
319 };
320
321 /**
322 * @inheritdoc
323 */
324 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onChangeTags = function () {
325 // Parent method
326 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.onChangeTags.call( this );
327
328 this.emptyFilterMessage.toggle( this.isEmpty() );
329 };
330
331 /**
332 * Respond to model initialize event
333 */
334 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onModelInitialize = function () {
335 this.setSavedQueryVisibility();
336 };
337
338 /**
339 * Respond to model update event
340 */
341 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onModelUpdate = function () {
342 this.updateElementsForView();
343 };
344
345 /**
346 * Update the elements in the widget to the current view
347 */
348 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.updateElementsForView = function () {
349 var view = this.model.getCurrentView(),
350 inputValue = this.input.getValue(),
351 inputView = this.model.getViewByTrigger( inputValue.substr( 0, 1 ) );
352
353 if ( inputView !== 'default' ) {
354 // We have a prefix already, remove it
355 inputValue = inputValue.substr( 1 );
356 }
357
358 if ( inputView !== view ) {
359 // Add the correct prefix
360 inputValue = this.model.getViewTrigger( view ) + inputValue;
361 }
362
363 // Update input
364 this.input.setValue( inputValue );
365 };
366
367 /**
368 * Set the visibility of the saved query button
369 */
370 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.setSavedQueryVisibility = function () {
371 if ( this.areSavedQueriesEnabled ) {
372 this.matchingQuery = this.controller.findQueryMatchingCurrentState();
373
374 this.savedQueryTitle.setLabel(
375 this.matchingQuery ? this.matchingQuery.getLabel() : ''
376 );
377 this.savedQueryTitle.toggle( !!this.matchingQuery );
378 this.saveQueryButton.toggle(
379 !this.isEmpty() &&
380 !this.matchingQuery
381 );
382
383 if ( this.matchingQuery ) {
384 this.emphasize();
385 }
386 }
387 };
388
389 /**
390 * Respond to model itemUpdate event
391 *
392 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
393 */
394 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onModelItemUpdate = function ( item ) {
395 if ( item.getGroupModel().isHidden() ) {
396 return;
397 }
398
399 if (
400 item.isSelected() ||
401 (
402 this.model.isHighlightEnabled() &&
403 item.isHighlightSupported() &&
404 item.getHighlightColor()
405 )
406 ) {
407 this.addTag( item.getName(), item.getLabel() );
408 } else {
409 this.removeTagByData( item.getName() );
410 }
411
412 this.setSavedQueryVisibility();
413
414 // Re-evaluate reset state
415 this.reevaluateResetRestoreState();
416 };
417
418 /**
419 * @inheritdoc
420 */
421 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.isAllowedData = function ( data ) {
422 return (
423 this.model.getItemByName( data ) &&
424 !this.isDuplicateData( data )
425 );
426 };
427
428 /**
429 * @inheritdoc
430 */
431 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onMenuChoose = function ( item ) {
432 this.controller.toggleFilterSelect( item.model.getName() );
433
434 // Select the tag if it exists, or reset selection otherwise
435 this.selectTag( this.getItemFromData( item.model.getName() ) );
436
437 this.focus();
438 };
439
440 /**
441 * Respond to highlightChange event
442 *
443 * @param {boolean} isHighlightEnabled Highlight is enabled
444 */
445 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onModelHighlightChange = function ( isHighlightEnabled ) {
446 var highlightedItems = this.model.getHighlightedItems();
447
448 if ( isHighlightEnabled ) {
449 // Add capsule widgets
450 highlightedItems.forEach( function ( filterItem ) {
451 this.addTag( filterItem.getName(), filterItem.getLabel() );
452 }.bind( this ) );
453 } else {
454 // Remove capsule widgets if they're not selected
455 highlightedItems.forEach( function ( filterItem ) {
456 if ( !filterItem.isSelected() ) {
457 this.removeTagByData( filterItem.getName() );
458 }
459 }.bind( this ) );
460 }
461 };
462
463 /**
464 * @inheritdoc
465 */
466 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onTagSelect = function ( tagItem ) {
467 var widget = this,
468 menuOption = this.menu.getItemFromModel( tagItem.getModel() ),
469 oldInputValue = this.input.getValue();
470
471 this.menu.setUserSelecting( true );
472
473 // Reset input
474 this.input.setValue( '' );
475
476 // Switch view
477 this.controller.switchView( tagItem.getView() );
478
479 // Parent method
480 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.onTagSelect.call( this, tagItem );
481
482 this.menu.selectItem( menuOption );
483 this.selectTag( tagItem );
484
485 // Scroll to the item
486 if ( this.model.removeViewTriggers( oldInputValue ) ) {
487 // We're binding a 'once' to the itemVisibilityChange event
488 // so this happens when the menu is ready after the items
489 // are visible again, in case this is done right after the
490 // user filtered the results
491 this.getMenu().once(
492 'itemVisibilityChange',
493 function () {
494 widget.scrollToTop( menuOption.$element );
495 widget.menu.setUserSelecting( false );
496 }
497 );
498 } else {
499 this.scrollToTop( menuOption.$element );
500 this.menu.setUserSelecting( false );
501 }
502
503 };
504
505 /**
506 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
507 * If no items are given, reset selection from all.
508 *
509 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
510 * omit to deselect all
511 */
512 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.selectTag = function ( item ) {
513 var i, len, selected;
514
515 for ( i = 0, len = this.items.length; i < len; i++ ) {
516 selected = this.items[ i ] === item;
517 if ( this.items[ i ].isSelected() !== selected ) {
518 this.items[ i ].toggleSelected( selected );
519 }
520 }
521 };
522 /**
523 * @inheritdoc
524 */
525 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onTagRemove = function ( tagItem ) {
526 // Parent method
527 mw.rcfilters.ui.FilterTagMultiselectWidget.parent.prototype.onTagRemove.call( this, tagItem );
528
529 this.controller.clearFilter( tagItem.getName() );
530
531 tagItem.destroy();
532 };
533
534 /**
535 * Respond to click event on the reset button
536 */
537 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onResetButtonClick = function () {
538 if ( this.model.areCurrentFiltersEmpty() ) {
539 // Reset to default filters
540 this.controller.resetToDefaults();
541 } else {
542 // Reset to have no filters
543 this.controller.emptyFilters();
544 }
545 };
546
547 /**
548 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
549 */
550 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.reevaluateResetRestoreState = function () {
551 var defaultsAreEmpty = this.model.areDefaultFiltersEmpty(),
552 currFiltersAreEmpty = this.model.areCurrentFiltersEmpty(),
553 hideResetButton = currFiltersAreEmpty && defaultsAreEmpty;
554
555 this.resetButton.setIcon(
556 currFiltersAreEmpty ? 'history' : 'trash'
557 );
558
559 this.resetButton.setLabel(
560 currFiltersAreEmpty ? mw.msg( 'rcfilters-restore-default-filters' ) : ''
561 );
562 this.resetButton.setTitle(
563 currFiltersAreEmpty ? null : mw.msg( 'rcfilters-clear-all-filters' )
564 );
565
566 this.resetButton.toggle( !hideResetButton );
567 this.emptyFilterMessage.toggle( currFiltersAreEmpty );
568 };
569
570 /**
571 * @inheritdoc
572 */
573 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.createMenuWidget = function ( menuConfig ) {
574 return new mw.rcfilters.ui.MenuSelectWidget(
575 this.controller,
576 this.model,
577 $.extend( {
578 filterFromInput: true
579 }, menuConfig )
580 );
581 };
582
583 /**
584 * @inheritdoc
585 */
586 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.createTagItemWidget = function ( data ) {
587 var filterItem = this.model.getItemByName( data );
588
589 if ( filterItem ) {
590 return new mw.rcfilters.ui.FilterTagItemWidget(
591 this.controller,
592 filterItem,
593 {
594 $overlay: this.$overlay
595 }
596 );
597 }
598 };
599
600 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.emphasize = function () {
601 if (
602 !this.$handle.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
603 ) {
604 this.$handle
605 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
606 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
607
608 setTimeout( function () {
609 this.$handle
610 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
611
612 setTimeout( function () {
613 this.$handle
614 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
615 }.bind( this ), 1000 );
616 }.bind( this ), 500 );
617
618 }
619 };
620 /**
621 * Scroll the element to top within its container
622 *
623 * @private
624 * @param {jQuery} $element Element to position
625 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
626 * much space (in pixels) above the widget.
627 */
628 mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.scrollToTop = function ( $element, marginFromTop ) {
629 var container = OO.ui.Element.static.getClosestScrollableContainer( $element[ 0 ], 'y' ),
630 pos = OO.ui.Element.static.getRelativePosition( $element, $( container ) ),
631 containerScrollTop = $( container ).is( 'body, html' ) ? 0 : $( container ).scrollTop();
632
633 // Scroll to item
634 $( container ).animate( {
635 scrollTop: containerScrollTop + pos.top - ( marginFromTop || 0 )
636 } );
637 };
638 }( mediaWiki ) );