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 title
: mw
.msg( 'rcfilters-view-namespaces-tooltip' )
149 new OO
.ui
.ButtonOptionWidget( {
153 title
: mw
.msg( 'rcfilters-view-tags-tooltip' )
158 // Rearrange the UI so the select widget is at the right of the input
159 this.$element
.append(
161 .addClass( 'mw-rcfilters-ui-table' )
164 .addClass( 'mw-rcfilters-ui-row' )
167 .addClass( 'mw-rcfilters-ui-cell' )
168 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
169 .append( this.input
.$element
),
171 .addClass( 'mw-rcfilters-ui-cell' )
172 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
173 .append( this.viewsSelectWidget
.$element
)
179 this.viewsSelectWidget
.connect( this, { choose
: 'onViewsSelectWidgetChoose' } );
183 .addClass( 'mw-rcfilters-ui-cell' )
184 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
185 .append( this.resetButton
.$element
)
189 $contentWrapper
.append(
191 this.savedQueryTitle
.$element
,
193 .addClass( 'mw-rcfilters-ui-table' )
200 this.$handle
.append( $contentWrapper
);
201 this.emptyFilterMessage
.toggle( this.isEmpty() );
202 this.savedQueryTitle
.toggle( false );
205 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
207 this.reevaluateResetRestoreState();
212 OO
.inheritClass( mw
.rcfilters
.ui
.FilterTagMultiselectWidget
, OO
.ui
.MenuTagMultiselectWidget
);
217 * Respond to view select widget choose event
219 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
221 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget
) {
222 this.controller
.switchView( buttonOptionWidget
.getData() );
223 this.viewsSelectWidget
.selectItem( null );
228 * Respond to input change event
230 * @param {string} value Value of the input
232 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputChange = function ( value
) {
235 value
= value
.trim();
237 view
= this.model
.getViewByTrigger( value
.substr( 0, 1 ) );
239 this.controller
.switchView( view
);
242 * Respond to query button click
244 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
245 this.getMenu().toggle( false );
249 * Respond to save query item change. Mainly this is done to update the label in case
250 * a query item has been edited
252 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
254 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
255 if ( this.matchingQuery
=== item
) {
256 // This means we just edited the item that is currently matched
257 this.savedQueryTitle
.setLabel( item
.getLabel() );
262 * Respond to menu toggle
264 * @param {boolean} isVisible Menu is visible
266 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
268 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
271 mw
.hook( 'RcFilters.popup.open' ).fire();
273 if ( !this.getMenu().getSelectedItem() ) {
274 // If there are no selected items, scroll menu to top
275 // This has to be in a setTimeout so the menu has time
276 // to be positioned and fixed
277 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
281 this.selectTag( null );
283 // Clear input if the only thing in the input is the prefix
285 this.input
.getValue().trim() === this.model
.getViewTrigger( this.model
.getCurrentView() )
288 this.input
.setValue( '' );
291 // Log filter grouping
292 this.controller
.trackFilterGroupings( 'filtermenu' );
295 this.input
.setIcon( isVisible
? 'search' : 'menu' );
301 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
303 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
306 this.scrollToTop( this.$element
);
312 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
314 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
317 this.input
.$input
.blur();
323 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
325 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
327 this.emptyFilterMessage
.toggle( this.isEmpty() );
331 * Respond to model initialize event
333 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
334 this.setSavedQueryVisibility();
338 * Respond to model update event
340 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
341 this.updateElementsForView();
345 * Update the elements in the widget to the current view
347 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
348 var view
= this.model
.getCurrentView(),
349 inputValue
= this.input
.getValue().trim(),
350 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
352 if ( inputView
!== 'default' ) {
353 // We have a prefix already, remove it
354 inputValue
= inputValue
.substr( 1 );
357 if ( inputView
!== view
) {
358 // Add the correct prefix
359 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
363 this.input
.setValue( inputValue
);
365 if ( this.currentView
!== view
) {
366 this.scrollToTop( this.$element
);
367 this.currentView
= view
;
372 * Set the visibility of the saved query button
374 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
375 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
377 this.savedQueryTitle
.setLabel(
378 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
380 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
381 this.saveQueryButton
.toggle(
386 if ( this.matchingQuery
) {
392 * Respond to model itemUpdate event
394 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
396 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
397 if ( item
.getGroupModel().isHidden() ) {
404 this.model
.isHighlightEnabled() &&
405 item
.isHighlightSupported() &&
406 item
.getHighlightColor()
409 this.addTag( item
.getName(), item
.getLabel() );
411 this.removeTagByData( item
.getName() );
414 this.setSavedQueryVisibility();
416 // Re-evaluate reset state
417 this.reevaluateResetRestoreState();
423 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
425 this.model
.getItemByName( data
) &&
426 !this.isDuplicateData( data
)
433 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
434 this.controller
.toggleFilterSelect( item
.model
.getName() );
436 // Select the tag if it exists, or reset selection otherwise
437 this.selectTag( this.getItemFromData( item
.model
.getName() ) );
443 * Respond to highlightChange event
445 * @param {boolean} isHighlightEnabled Highlight is enabled
447 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
448 var highlightedItems
= this.model
.getHighlightedItems();
450 if ( isHighlightEnabled
) {
451 // Add capsule widgets
452 highlightedItems
.forEach( function ( filterItem
) {
453 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
456 // Remove capsule widgets if they're not selected
457 highlightedItems
.forEach( function ( filterItem
) {
458 if ( !filterItem
.isSelected() ) {
459 this.removeTagByData( filterItem
.getName() );
468 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
470 menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() ),
471 oldInputValue
= this.input
.getValue().trim();
473 this.menu
.setUserSelecting( true );
476 this.input
.setValue( '' );
479 this.controller
.switchView( tagItem
.getView() );
482 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
484 this.menu
.selectItem( menuOption
);
485 this.selectTag( tagItem
);
487 // Scroll to the item
488 if ( this.model
.removeViewTriggers( oldInputValue
) ) {
489 // We're binding a 'once' to the itemVisibilityChange event
490 // so this happens when the menu is ready after the items
491 // are visible again, in case this is done right after the
492 // user filtered the results
494 'itemVisibilityChange',
496 widget
.scrollToTop( menuOption
.$element
);
497 widget
.menu
.setUserSelecting( false );
501 this.scrollToTop( menuOption
.$element
);
502 this.menu
.setUserSelecting( false );
508 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
509 * If no items are given, reset selection from all.
511 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
512 * omit to deselect all
514 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
515 var i
, len
, selected
;
517 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
518 selected
= this.items
[ i
] === item
;
519 if ( this.items
[ i
].isSelected() !== selected
) {
520 this.items
[ i
].toggleSelected( selected
);
527 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
529 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
531 this.controller
.clearFilter( tagItem
.getName() );
537 * Respond to click event on the reset button
539 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
540 if ( this.model
.areCurrentFiltersEmpty() ) {
541 // Reset to default filters
542 this.controller
.resetToDefaults();
544 // Reset to have no filters
545 this.controller
.emptyFilters();
550 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
552 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
553 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
554 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
555 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
557 this.resetButton
.setIcon(
558 currFiltersAreEmpty
? 'history' : 'trash'
561 this.resetButton
.setLabel(
562 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
564 this.resetButton
.setTitle(
565 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
568 this.resetButton
.toggle( !hideResetButton
);
569 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
575 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
576 return new mw
.rcfilters
.ui
.MenuSelectWidget(
580 filterFromInput
: true
588 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
589 var filterItem
= this.model
.getItemByName( data
);
592 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
596 $overlay
: this.$overlay
602 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.emphasize = function () {
604 !this.$handle
.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
607 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
608 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
610 setTimeout( function () {
612 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
614 setTimeout( function () {
616 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
617 }.bind( this ), 1000 );
618 }.bind( this ), 500 );
623 * Scroll the element to top within its container
626 * @param {jQuery} $element Element to position
627 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
628 * much space (in pixels) above the widget.
630 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
) {
631 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
632 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
633 containerScrollTop
= $( container
).is( 'body, html' ) ? 0 : $( container
).scrollTop();
636 $( container
).animate( {
637 scrollTop
: containerScrollTop
+ pos
.top
- ( marginFromTop
|| 0 )