3 * List displaying all filter groups
5 * @extends OO.ui.MenuTagMultiselectWidget
6 * @mixins OO.ui.mixin.PendingElement
9 * @param {mw.rcfilters.Controller} controller Controller
10 * @param {mw.rcfilters.dm.FiltersViewModel} model View model
11 * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
12 * @param {Object} config Configuration object
13 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
15 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
= function MwRcfiltersUiFilterTagMultiselectWidget( controller
, model
, savedQueriesModel
, config
) {
17 areSavedQueriesEnabled
= mw
.config
.get( 'wgStructuredChangeFiltersEnableSaving' ),
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.areSavedQueriesEnabled
= areSavedQueriesEnabled
;
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,
50 disabled
: !mw
.config
.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ),
52 // View select menu, appears on default view only
53 $element
: $( '<div>' )
54 .append( new mw
.rcfilters
.ui
.ViewSwitchWidget( this.controller
, this.model
).$element
),
59 // Feedback footer, appears on all views
60 $element
: $( '<div>' )
62 new OO
.ui
.ButtonWidget( {
65 flags
: [ 'progressive' ],
66 label
: mw
.msg( 'rcfilters-filterlist-feedbacklink' ),
67 href
: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
75 placeholder
: mw
.msg( 'rcfilters-search-placeholder' )
79 this.savedQueryTitle
= new OO
.ui
.LabelWidget( {
81 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
84 this.resetButton
= new OO
.ui
.ButtonWidget( {
86 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
89 if ( areSavedQueriesEnabled
) {
90 this.saveQueryButton
= new mw
.rcfilters
.ui
.SaveFiltersPopupButtonWidget(
95 this.saveQueryButton
.$element
.on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
97 this.saveQueryButton
.connect( this, {
98 click
: 'onSaveQueryButtonClick',
99 saveCurrent
: 'setSavedQueryVisibility'
103 this.emptyFilterMessage
= new OO
.ui
.LabelWidget( {
104 label
: mw
.msg( 'rcfilters-empty-filter' ),
105 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
107 this.$content
.append( this.emptyFilterMessage
.$element
);
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'
120 this.input
.connect( this, { change
: 'onInputChange' } );
121 this.queriesModel
.connect( this, { itemUpdate
: 'onSavedQueriesItemUpdate' } );
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' )
131 .addClass( 'mw-rcfilters-ui-cell' )
132 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
135 if ( areSavedQueriesEnabled
) {
138 .addClass( 'mw-rcfilters-ui-cell' )
139 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
140 .append( this.saveQueryButton
.$element
)
144 if ( mw
.config
.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ) ) {
145 // Add a selector at the right of the input
146 this.viewsSelectWidget
= new OO
.ui
.ButtonSelectWidget( {
147 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
149 new OO
.ui
.ButtonOptionWidget( {
153 title
: mw
.msg( 'rcfilters-view-namespaces-tooltip' )
155 new OO
.ui
.ButtonOptionWidget( {
159 title
: mw
.msg( 'rcfilters-view-tags-tooltip' )
164 // Rearrange the UI so the select widget is at the right of the input
165 this.$element
.append(
167 .addClass( 'mw-rcfilters-ui-table' )
170 .addClass( 'mw-rcfilters-ui-row' )
173 .addClass( 'mw-rcfilters-ui-cell' )
174 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
175 .append( this.input
.$element
),
177 .addClass( 'mw-rcfilters-ui-cell' )
178 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
179 .append( this.viewsSelectWidget
.$element
)
185 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
) {
240 var view
= this.model
.getViewByTrigger( value
.substr( 0, 1 ) );
242 this.controller
.switchView( view
);
245 * Respond to query button click
247 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
248 this.getMenu().toggle( false );
252 * Respond to save query item change. Mainly this is done to update the label in case
253 * a query item has been edited
255 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
257 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
258 if ( this.matchingQuery
=== item
) {
259 // This means we just edited the item that is currently matched
260 this.savedQueryTitle
.setLabel( item
.getLabel() );
265 * Respond to menu toggle
267 * @param {boolean} isVisible Menu is visible
269 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
271 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
274 mw
.hook( 'RcFilters.popup.open' ).fire();
276 if ( !this.getMenu().getSelectedItem() ) {
277 // If there are no selected items, scroll menu to top
278 // This has to be in a setTimeout so the menu has time
279 // to be positioned and fixed
280 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
284 this.selectTag( null );
286 // Clear input if the only thing in the input is the prefix
288 this.input
.getValue() === this.model
.getViewTrigger( this.model
.getCurrentView() )
291 this.input
.setValue( '' );
294 // Log filter grouping
295 this.controller
.trackFilterGroupings( 'filtermenu' );
298 this.input
.setIcon( isVisible
? 'search' : 'menu' );
304 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
306 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
309 this.scrollToTop( this.$element
);
315 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
317 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
320 this.input
.$input
.blur();
326 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
328 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
330 this.emptyFilterMessage
.toggle( this.isEmpty() );
334 * Respond to model initialize event
336 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
337 this.setSavedQueryVisibility();
341 * Respond to model update event
343 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
344 this.updateElementsForView();
348 * Update the elements in the widget to the current view
350 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
351 var view
= this.model
.getCurrentView(),
352 inputValue
= this.input
.getValue(),
353 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
355 if ( inputView
!== 'default' ) {
356 // We have a prefix already, remove it
357 inputValue
= inputValue
.substr( 1 );
360 if ( inputView
!== view
) {
361 // Add the correct prefix
362 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
366 this.input
.setValue( inputValue
);
370 * Set the visibility of the saved query button
372 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
373 if ( this.areSavedQueriesEnabled
) {
374 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
376 this.savedQueryTitle
.setLabel(
377 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
379 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
380 this.saveQueryButton
.toggle(
388 * Respond to model itemUpdate event
390 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
392 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
396 this.model
.isHighlightEnabled() &&
397 item
.isHighlightSupported() &&
398 item
.getHighlightColor()
401 this.addTag( item
.getName(), item
.getLabel() );
403 this.removeTagByData( item
.getName() );
406 this.setSavedQueryVisibility();
408 // Re-evaluate reset state
409 this.reevaluateResetRestoreState();
415 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
417 this.model
.getItemByName( data
) &&
418 !this.isDuplicateData( data
)
425 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
426 this.controller
.toggleFilterSelect( item
.model
.getName() );
428 // Select the tag if it exists, or reset selection otherwise
429 this.selectTag( this.getItemFromData( item
.model
.getName() ) );
435 * Respond to highlightChange event
437 * @param {boolean} isHighlightEnabled Highlight is enabled
439 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
440 var highlightedItems
= this.model
.getHighlightedItems();
442 if ( isHighlightEnabled
) {
443 // Add capsule widgets
444 highlightedItems
.forEach( function ( filterItem
) {
445 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
448 // Remove capsule widgets if they're not selected
449 highlightedItems
.forEach( function ( filterItem
) {
450 if ( !filterItem
.isSelected() ) {
451 this.removeTagByData( filterItem
.getName() );
460 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
462 menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() ),
463 oldInputValue
= this.input
.getValue();
465 this.menu
.setUserSelecting( true );
468 this.input
.setValue( '' );
471 this.controller
.switchView( tagItem
.getView() );
474 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
476 this.menu
.selectItem( menuOption
);
477 this.selectTag( tagItem
);
479 // Scroll to the item
480 if ( this.model
.removeViewTriggers( oldInputValue
) ) {
481 // We're binding a 'once' to the itemVisibilityChange event
482 // so this happens when the menu is ready after the items
483 // are visible again, in case this is done right after the
484 // user filtered the results
486 'itemVisibilityChange',
488 widget
.scrollToTop( menuOption
.$element
);
489 widget
.menu
.setUserSelecting( false );
493 this.scrollToTop( menuOption
.$element
);
494 this.menu
.setUserSelecting( false );
500 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
501 * If no items are given, reset selection from all.
503 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
504 * omit to deselect all
506 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
507 var i
, len
, selected
;
509 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
510 selected
= this.items
[ i
] === item
;
511 if ( this.items
[ i
].isSelected() !== selected
) {
512 this.items
[ i
].toggleSelected( selected
);
519 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
521 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
523 this.controller
.clearFilter( tagItem
.getName() );
529 * Respond to click event on the reset button
531 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
532 if ( this.model
.areCurrentFiltersEmpty() ) {
533 // Reset to default filters
534 this.controller
.resetToDefaults();
536 // Reset to have no filters
537 this.controller
.emptyFilters();
542 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
544 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
545 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
546 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
547 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
549 this.resetButton
.setIcon(
550 currFiltersAreEmpty
? 'history' : 'trash'
553 this.resetButton
.setLabel(
554 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
556 this.resetButton
.setTitle(
557 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
560 this.resetButton
.toggle( !hideResetButton
);
561 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
567 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
568 return new mw
.rcfilters
.ui
.MenuSelectWidget(
572 filterFromInput
: true
580 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
581 var filterItem
= this.model
.getItemByName( data
);
584 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
588 $overlay
: this.$overlay
595 * Scroll the element to top within its container
598 * @param {jQuery} $element Element to position
599 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
600 * much space (in pixels) above the widget.
602 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
) {
603 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
604 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
605 containerScrollTop
= $( container
).is( 'body, html' ) ? 0 : $( container
).scrollTop();
608 $( container
).animate( {
609 scrollTop
: containerScrollTop
+ pos
.top
- ( marginFromTop
|| 0 )