3 * List displaying all filter groups
6 * @extends OO.ui.MenuTagMultiselectWidget
7 * @mixins OO.ui.mixin.PendingElement
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
16 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
= function MwRcfiltersUiFilterTagMultiselectWidget( controller
, model
, savedQueriesModel
, config
) {
18 title
= new OO
.ui
.LabelWidget( {
19 label
: mw
.msg( 'rcfilters-activefilters' ),
20 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-title' ]
22 $contentWrapper
= $( '<div>' )
23 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
25 config
= config
|| {};
27 this.controller
= controller
;
29 this.queriesModel
= savedQueriesModel
;
30 this.$overlay
= config
.$overlay
|| this.$element
;
31 this.matchingQuery
= null;
32 this.currentView
= this.model
.getCurrentView();
35 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.call( this, $.extend( true, {
36 label
: mw
.msg( 'rcfilters-filterlist-title' ),
37 placeholder
: mw
.msg( 'rcfilters-empty-filter' ),
38 inputPosition
: 'outline',
39 allowArbitrary
: false,
40 allowDisplayInvalidTags
: false,
41 allowReordering
: false,
42 $overlay
: this.$overlay
,
44 hideWhenOutOfView
: false,
51 // View select menu, appears on default view only
52 $element
: $( '<div>' )
53 .append( new mw
.rcfilters
.ui
.ViewSwitchWidget( this.controller
, this.model
).$element
),
58 // Feedback footer, appears on all views
59 $element
: $( '<div>' )
61 new OO
.ui
.ButtonWidget( {
64 flags
: [ 'progressive' ],
65 label
: mw
.msg( 'rcfilters-filterlist-feedbacklink' ),
66 href
: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
74 placeholder
: mw
.msg( 'rcfilters-search-placeholder' )
78 this.savedQueryTitle
= new OO
.ui
.LabelWidget( {
80 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
83 this.resetButton
= new OO
.ui
.ButtonWidget( {
85 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
88 this.saveQueryButton
= new mw
.rcfilters
.ui
.SaveFiltersPopupButtonWidget(
93 this.saveQueryButton
.$element
.on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
95 this.saveQueryButton
.connect( this, {
96 click
: 'onSaveQueryButtonClick',
97 saveCurrent
: 'setSavedQueryVisibility'
100 this.emptyFilterMessage
= new OO
.ui
.LabelWidget( {
101 label
: mw
.msg( 'rcfilters-empty-filter' ),
102 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
104 this.$content
.append( this.emptyFilterMessage
.$element
);
107 this.resetButton
.connect( this, { click
: 'onResetButtonClick' } );
108 // Stop propagation for mousedown, so that the widget doesn't
109 // trigger the focus on the input and scrolls up when we click the reset button
110 this.resetButton
.$element
.on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
111 this.model
.connect( this, {
112 initialize
: 'onModelInitialize',
113 update
: 'onModelUpdate',
114 itemUpdate
: 'onModelItemUpdate',
115 highlightChange
: 'onModelHighlightChange'
117 this.input
.connect( this, { change
: 'onInputChange' } );
118 this.queriesModel
.connect( this, { itemUpdate
: 'onSavedQueriesItemUpdate' } );
120 // The filter list and button should appear side by side regardless of how
121 // wide the button is; the button also changes its width depending
122 // on language and its state, so the safest way to present both side
123 // by side is with a table layout
124 rcFiltersRow
= $( '<div>' )
125 .addClass( 'mw-rcfilters-ui-row' )
128 .addClass( 'mw-rcfilters-ui-cell' )
129 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
134 .addClass( 'mw-rcfilters-ui-cell' )
135 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
136 .append( this.saveQueryButton
.$element
)
139 // Add a selector at the right of the input
140 this.viewsSelectWidget
= new OO
.ui
.ButtonSelectWidget( {
141 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
143 new OO
.ui
.ButtonOptionWidget( {
147 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget-label' ],
148 label
: mw
.msg( 'rcfilters-view-advanced-filters-label' )
150 new OO
.ui
.ButtonOptionWidget( {
154 title
: mw
.msg( 'rcfilters-view-namespaces-tooltip' )
156 new OO
.ui
.ButtonOptionWidget( {
160 title
: mw
.msg( 'rcfilters-view-tags-tooltip' )
165 // Rearrange the UI so the select widget is at the right of the input
166 this.$element
.append(
168 .addClass( 'mw-rcfilters-ui-table' )
171 .addClass( 'mw-rcfilters-ui-row' )
174 .addClass( 'mw-rcfilters-ui-cell' )
175 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
176 .append( this.input
.$element
),
178 .addClass( 'mw-rcfilters-ui-cell' )
179 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
180 .append( this.viewsSelectWidget
.$element
)
186 this.viewsSelectWidget
.connect( this, { choose
: 'onViewsSelectWidgetChoose' } );
190 .addClass( 'mw-rcfilters-ui-cell' )
191 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
192 .append( this.resetButton
.$element
)
196 $contentWrapper
.append(
198 this.savedQueryTitle
.$element
,
200 .addClass( 'mw-rcfilters-ui-table' )
207 this.$handle
.append( $contentWrapper
);
208 this.emptyFilterMessage
.toggle( this.isEmpty() );
209 this.savedQueryTitle
.toggle( false );
212 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
214 this.reevaluateResetRestoreState();
219 OO
.inheritClass( mw
.rcfilters
.ui
.FilterTagMultiselectWidget
, OO
.ui
.MenuTagMultiselectWidget
);
224 * Respond to view select widget choose event
226 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
228 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget
) {
229 this.controller
.switchView( buttonOptionWidget
.getData() );
230 this.viewsSelectWidget
.selectItem( null );
235 * Respond to input change event
237 * @param {string} value Value of the input
239 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputChange = function ( value
) {
242 value
= value
.trim();
244 view
= this.model
.getViewByTrigger( value
.substr( 0, 1 ) );
246 this.controller
.switchView( view
);
249 * Respond to query button click
251 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
252 this.getMenu().toggle( false );
256 * Respond to save query item change. Mainly this is done to update the label in case
257 * a query item has been edited
259 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
261 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
262 if ( this.matchingQuery
=== item
) {
263 // This means we just edited the item that is currently matched
264 this.savedQueryTitle
.setLabel( item
.getLabel() );
269 * Respond to menu toggle
271 * @param {boolean} isVisible Menu is visible
273 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
275 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
278 mw
.hook( 'RcFilters.popup.open' ).fire();
280 if ( !this.getMenu().getSelectedItem() ) {
281 // If there are no selected items, scroll menu to top
282 // This has to be in a setTimeout so the menu has time
283 // to be positioned and fixed
284 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
288 this.selectTag( null );
290 // Clear input if the only thing in the input is the prefix
292 this.input
.getValue().trim() === this.model
.getViewTrigger( this.model
.getCurrentView() )
295 this.input
.setValue( '' );
298 // Log filter grouping
299 this.controller
.trackFilterGroupings( 'filtermenu' );
302 this.input
.setIcon( isVisible
? 'search' : 'menu' );
308 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
310 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
313 this.scrollToTop( this.$element
);
319 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
321 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
324 this.input
.$input
.blur();
330 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
332 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
334 this.emptyFilterMessage
.toggle( this.isEmpty() );
338 * Respond to model initialize event
340 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
341 this.setSavedQueryVisibility();
345 * Respond to model update event
347 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
348 this.updateElementsForView();
352 * Update the elements in the widget to the current view
354 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
355 var view
= this.model
.getCurrentView(),
356 inputValue
= this.input
.getValue().trim(),
357 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
359 if ( inputView
!== 'default' ) {
360 // We have a prefix already, remove it
361 inputValue
= inputValue
.substr( 1 );
364 if ( inputView
!== view
) {
365 // Add the correct prefix
366 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
370 this.input
.setValue( inputValue
);
372 if ( this.currentView
!== view
) {
373 this.scrollToTop( this.$element
);
374 this.currentView
= view
;
379 * Set the visibility of the saved query button
381 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
382 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
384 this.savedQueryTitle
.setLabel(
385 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
387 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
388 this.saveQueryButton
.toggle(
393 if ( this.matchingQuery
) {
399 * Respond to model itemUpdate event
401 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
403 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
404 if ( item
.getGroupModel().isHidden() ) {
411 this.model
.isHighlightEnabled() &&
412 item
.isHighlightSupported() &&
413 item
.getHighlightColor()
416 this.addTag( item
.getName(), item
.getLabel() );
418 this.removeTagByData( item
.getName() );
421 this.setSavedQueryVisibility();
423 // Re-evaluate reset state
424 this.reevaluateResetRestoreState();
430 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
432 this.model
.getItemByName( data
) &&
433 !this.isDuplicateData( data
)
440 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
441 this.controller
.toggleFilterSelect( item
.model
.getName() );
443 // Select the tag if it exists, or reset selection otherwise
444 this.selectTag( this.getItemFromData( item
.model
.getName() ) );
450 * Respond to highlightChange event
452 * @param {boolean} isHighlightEnabled Highlight is enabled
454 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
455 var highlightedItems
= this.model
.getHighlightedItems();
457 if ( isHighlightEnabled
) {
458 // Add capsule widgets
459 highlightedItems
.forEach( function ( filterItem
) {
460 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
463 // Remove capsule widgets if they're not selected
464 highlightedItems
.forEach( function ( filterItem
) {
465 if ( !filterItem
.isSelected() ) {
466 this.removeTagByData( filterItem
.getName() );
475 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
477 menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() ),
478 oldInputValue
= this.input
.getValue().trim();
480 this.menu
.setUserSelecting( true );
483 this.input
.setValue( '' );
486 this.controller
.switchView( tagItem
.getView() );
489 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
491 this.menu
.selectItem( menuOption
);
492 this.selectTag( tagItem
);
494 // Scroll to the item
495 if ( this.model
.removeViewTriggers( oldInputValue
) ) {
496 // We're binding a 'once' to the itemVisibilityChange event
497 // so this happens when the menu is ready after the items
498 // are visible again, in case this is done right after the
499 // user filtered the results
501 'itemVisibilityChange',
503 widget
.scrollToTop( menuOption
.$element
);
504 widget
.menu
.setUserSelecting( false );
508 this.scrollToTop( menuOption
.$element
);
509 this.menu
.setUserSelecting( false );
515 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
516 * If no items are given, reset selection from all.
518 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
519 * omit to deselect all
521 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
522 var i
, len
, selected
;
524 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
525 selected
= this.items
[ i
] === item
;
526 if ( this.items
[ i
].isSelected() !== selected
) {
527 this.items
[ i
].toggleSelected( selected
);
534 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
536 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
538 this.controller
.clearFilter( tagItem
.getName() );
544 * Respond to click event on the reset button
546 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
547 if ( this.model
.areCurrentFiltersEmpty() ) {
548 // Reset to default filters
549 this.controller
.resetToDefaults();
551 // Reset to have no filters
552 this.controller
.emptyFilters();
557 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
559 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
560 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
561 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
562 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
564 this.resetButton
.setIcon(
565 currFiltersAreEmpty
? 'history' : 'trash'
568 this.resetButton
.setLabel(
569 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
571 this.resetButton
.setTitle(
572 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
575 this.resetButton
.toggle( !hideResetButton
);
576 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
582 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
583 return new mw
.rcfilters
.ui
.MenuSelectWidget(
587 filterFromInput
: true
595 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
596 var filterItem
= this.model
.getItemByName( data
);
599 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
603 $overlay
: this.$overlay
609 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.emphasize = function () {
611 !this.$handle
.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
614 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
615 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
617 setTimeout( function () {
619 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
621 setTimeout( function () {
623 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
624 }.bind( this ), 1000 );
625 }.bind( this ), 500 );
630 * Scroll the element to top within its container
633 * @param {jQuery} $element Element to position
634 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
635 * much space (in pixels) above the widget.
637 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
) {
638 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
639 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
640 containerScrollTop
= $( container
).is( 'body, html' ) ? 0 : $( container
).scrollTop();
643 $( container
).animate( {
644 scrollTop
: containerScrollTop
+ pos
.top
- ( marginFromTop
|| 0 )