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 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' ]
23 $contentWrapper
= $( '<div>' )
24 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
26 config
= config
|| {};
28 this.controller
= controller
;
30 this.queriesModel
= savedQueriesModel
;
31 this.$overlay
= config
.$overlay
|| this.$element
;
32 this.matchingQuery
= null;
33 this.areSavedQueriesEnabled
= areSavedQueriesEnabled
;
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
,
45 hideWhenOutOfView
: 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
),
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 // 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' ],
148 new OO
.ui
.ButtonOptionWidget( {
152 title
: mw
.msg( 'rcfilters-view-namespaces-tooltip' )
154 new OO
.ui
.ButtonOptionWidget( {
158 title
: mw
.msg( 'rcfilters-view-tags-tooltip' )
163 // Rearrange the UI so the select widget is at the right of the input
164 this.$element
.append(
166 .addClass( 'mw-rcfilters-ui-table' )
169 .addClass( 'mw-rcfilters-ui-row' )
172 .addClass( 'mw-rcfilters-ui-cell' )
173 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
174 .append( this.input
.$element
),
176 .addClass( 'mw-rcfilters-ui-cell' )
177 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
178 .append( this.viewsSelectWidget
.$element
)
184 this.viewsSelectWidget
.connect( this, { choose
: 'onViewsSelectWidgetChoose' } );
188 .addClass( 'mw-rcfilters-ui-cell' )
189 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
190 .append( this.resetButton
.$element
)
194 $contentWrapper
.append(
196 this.savedQueryTitle
.$element
,
198 .addClass( 'mw-rcfilters-ui-table' )
205 this.$handle
.append( $contentWrapper
);
206 this.emptyFilterMessage
.toggle( this.isEmpty() );
207 this.savedQueryTitle
.toggle( false );
210 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
212 this.reevaluateResetRestoreState();
217 OO
.inheritClass( mw
.rcfilters
.ui
.FilterTagMultiselectWidget
, OO
.ui
.MenuTagMultiselectWidget
);
222 * Respond to view select widget choose event
224 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
226 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget
) {
227 this.controller
.switchView( buttonOptionWidget
.getData() );
228 this.viewsSelectWidget
.selectItem( null );
233 * Respond to input change event
235 * @param {string} value Value of the input
237 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputChange = function ( value
) {
240 value
= value
.trim();
242 view
= this.model
.getViewByTrigger( value
.substr( 0, 1 ) );
244 this.controller
.switchView( view
);
247 * Respond to query button click
249 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
250 this.getMenu().toggle( false );
254 * Respond to save query item change. Mainly this is done to update the label in case
255 * a query item has been edited
257 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
259 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
260 if ( this.matchingQuery
=== item
) {
261 // This means we just edited the item that is currently matched
262 this.savedQueryTitle
.setLabel( item
.getLabel() );
267 * Respond to menu toggle
269 * @param {boolean} isVisible Menu is visible
271 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
273 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
276 mw
.hook( 'RcFilters.popup.open' ).fire();
278 if ( !this.getMenu().getSelectedItem() ) {
279 // If there are no selected items, scroll menu to top
280 // This has to be in a setTimeout so the menu has time
281 // to be positioned and fixed
282 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
286 this.selectTag( null );
288 // Clear input if the only thing in the input is the prefix
290 this.input
.getValue().trim() === this.model
.getViewTrigger( this.model
.getCurrentView() )
293 this.input
.setValue( '' );
296 // Log filter grouping
297 this.controller
.trackFilterGroupings( 'filtermenu' );
300 this.input
.setIcon( isVisible
? 'search' : 'menu' );
306 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
308 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
311 this.scrollToTop( this.$element
);
317 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
319 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
322 this.input
.$input
.blur();
328 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
330 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
332 this.emptyFilterMessage
.toggle( this.isEmpty() );
336 * Respond to model initialize event
338 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
339 this.setSavedQueryVisibility();
343 * Respond to model update event
345 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
346 this.updateElementsForView();
350 * Update the elements in the widget to the current view
352 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
353 var view
= this.model
.getCurrentView(),
354 inputValue
= this.input
.getValue().trim(),
355 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
357 if ( inputView
!== 'default' ) {
358 // We have a prefix already, remove it
359 inputValue
= inputValue
.substr( 1 );
362 if ( inputView
!== view
) {
363 // Add the correct prefix
364 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
368 this.input
.setValue( inputValue
);
372 * Set the visibility of the saved query button
374 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
375 if ( this.areSavedQueriesEnabled
) {
376 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
378 this.savedQueryTitle
.setLabel(
379 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
381 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
382 this.saveQueryButton
.toggle(
387 if ( this.matchingQuery
) {
394 * Respond to model itemUpdate event
396 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
398 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
399 if ( item
.getGroupModel().isHidden() ) {
406 this.model
.isHighlightEnabled() &&
407 item
.isHighlightSupported() &&
408 item
.getHighlightColor()
411 this.addTag( item
.getName(), item
.getLabel() );
413 this.removeTagByData( item
.getName() );
416 this.setSavedQueryVisibility();
418 // Re-evaluate reset state
419 this.reevaluateResetRestoreState();
425 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
427 this.model
.getItemByName( data
) &&
428 !this.isDuplicateData( data
)
435 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
436 this.controller
.toggleFilterSelect( item
.model
.getName() );
438 // Select the tag if it exists, or reset selection otherwise
439 this.selectTag( this.getItemFromData( item
.model
.getName() ) );
445 * Respond to highlightChange event
447 * @param {boolean} isHighlightEnabled Highlight is enabled
449 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
450 var highlightedItems
= this.model
.getHighlightedItems();
452 if ( isHighlightEnabled
) {
453 // Add capsule widgets
454 highlightedItems
.forEach( function ( filterItem
) {
455 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
458 // Remove capsule widgets if they're not selected
459 highlightedItems
.forEach( function ( filterItem
) {
460 if ( !filterItem
.isSelected() ) {
461 this.removeTagByData( filterItem
.getName() );
470 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
472 menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() ),
473 oldInputValue
= this.input
.getValue().trim();
475 this.menu
.setUserSelecting( true );
478 this.input
.setValue( '' );
481 this.controller
.switchView( tagItem
.getView() );
484 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
486 this.menu
.selectItem( menuOption
);
487 this.selectTag( tagItem
);
489 // Scroll to the item
490 if ( this.model
.removeViewTriggers( oldInputValue
) ) {
491 // We're binding a 'once' to the itemVisibilityChange event
492 // so this happens when the menu is ready after the items
493 // are visible again, in case this is done right after the
494 // user filtered the results
496 'itemVisibilityChange',
498 widget
.scrollToTop( menuOption
.$element
);
499 widget
.menu
.setUserSelecting( false );
503 this.scrollToTop( menuOption
.$element
);
504 this.menu
.setUserSelecting( false );
510 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
511 * If no items are given, reset selection from all.
513 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
514 * omit to deselect all
516 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
517 var i
, len
, selected
;
519 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
520 selected
= this.items
[ i
] === item
;
521 if ( this.items
[ i
].isSelected() !== selected
) {
522 this.items
[ i
].toggleSelected( selected
);
529 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
531 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
533 this.controller
.clearFilter( tagItem
.getName() );
539 * Respond to click event on the reset button
541 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
542 if ( this.model
.areCurrentFiltersEmpty() ) {
543 // Reset to default filters
544 this.controller
.resetToDefaults();
546 // Reset to have no filters
547 this.controller
.emptyFilters();
552 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
554 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
555 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
556 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
557 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
559 this.resetButton
.setIcon(
560 currFiltersAreEmpty
? 'history' : 'trash'
563 this.resetButton
.setLabel(
564 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
566 this.resetButton
.setTitle(
567 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
570 this.resetButton
.toggle( !hideResetButton
);
571 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
577 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
578 return new mw
.rcfilters
.ui
.MenuSelectWidget(
582 filterFromInput
: true
590 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
591 var filterItem
= this.model
.getItemByName( data
);
594 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
598 $overlay
: this.$overlay
604 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.emphasize = function () {
606 !this.$handle
.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
609 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
610 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
612 setTimeout( function () {
614 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
616 setTimeout( function () {
618 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
619 }.bind( this ), 1000 );
620 }.bind( this ), 500 );
625 * Scroll the element to top within its container
628 * @param {jQuery} $element Element to position
629 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
630 * much space (in pixels) above the widget.
632 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
) {
633 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
634 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
635 containerScrollTop
= $( container
).is( 'body, html' ) ? 0 : $( container
).scrollTop();
638 $( container
).animate( {
639 scrollTop
: containerScrollTop
+ pos
.top
- ( marginFromTop
|| 0 )