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
15 * @cfg {jQuery} [$wrapper] A jQuery object for the wrapper of the general
16 * system. If not given, falls back to this widget's $element
17 * @cfg {boolean} [collapsed] Filter area is collapsed
19 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
= function MwRcfiltersUiFilterTagMultiselectWidget( controller
, model
, savedQueriesModel
, config
) {
21 title
= new OO
.ui
.LabelWidget( {
22 label
: mw
.msg( 'rcfilters-activefilters' ),
23 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-title' ]
25 $contentWrapper
= $( '<div>' )
26 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
28 config
= config
|| {};
30 this.controller
= controller
;
32 this.queriesModel
= savedQueriesModel
;
33 this.$overlay
= config
.$overlay
|| this.$element
;
34 this.$wrapper
= config
.$wrapper
|| this.$element
;
35 this.matchingQuery
= null;
36 this.currentView
= this.model
.getCurrentView();
37 this.collapsed
= false;
40 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.call( this, $.extend( true, {
41 label
: mw
.msg( 'rcfilters-filterlist-title' ),
42 placeholder
: mw
.msg( 'rcfilters-empty-filter' ),
43 inputPosition
: 'outline',
44 allowArbitrary
: false,
45 allowDisplayInvalidTags
: false,
46 allowReordering
: false,
47 $overlay
: this.$overlay
,
49 // Our filtering is done through the model
50 filterFromInput
: false,
51 hideWhenOutOfView
: false,
58 // View select menu, appears on default view only
59 $element
: $( '<div>' )
60 .append( new mw
.rcfilters
.ui
.ViewSwitchWidget( this.controller
, this.model
).$element
),
65 // Feedback footer, appears on all views
66 $element
: $( '<div>' )
68 new OO
.ui
.ButtonWidget( {
71 flags
: [ 'progressive' ],
72 label
: mw
.msg( 'rcfilters-filterlist-feedbacklink' ),
73 href
: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
81 placeholder
: mw
.msg( 'rcfilters-search-placeholder' )
85 this.savedQueryTitle
= new OO
.ui
.LabelWidget( {
87 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
90 this.resetButton
= new OO
.ui
.ButtonWidget( {
92 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
95 this.hideShowButton
= new OO
.ui
.ButtonWidget( {
97 flags
: [ 'progressive' ],
98 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-hideshowButton' ]
100 this.toggleCollapsed( !!config
.collapsed
);
102 if ( !mw
.user
.isAnon() ) {
103 this.saveQueryButton
= new mw
.rcfilters
.ui
.SaveFiltersPopupButtonWidget(
107 $overlay
: this.$overlay
111 this.saveQueryButton
.$element
.on( 'mousedown', function ( e
) {
115 this.saveQueryButton
.connect( this, {
116 click
: 'onSaveQueryButtonClick',
117 saveCurrent
: 'setSavedQueryVisibility'
119 this.queriesModel
.connect( this, {
120 itemUpdate
: 'onSavedQueriesItemUpdate',
121 initialize
: 'onSavedQueriesInitialize',
122 'default': 'reevaluateResetRestoreState'
126 this.emptyFilterMessage
= new OO
.ui
.LabelWidget( {
127 label
: mw
.msg( 'rcfilters-empty-filter' ),
128 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
130 this.$content
.append( this.emptyFilterMessage
.$element
);
133 this.resetButton
.connect( this, { click
: 'onResetButtonClick' } );
134 this.hideShowButton
.connect( this, { click
: 'onHideShowButtonClick' } );
135 // Stop propagation for mousedown, so that the widget doesn't
136 // trigger the focus on the input and scrolls up when we click the reset button
137 this.resetButton
.$element
.on( 'mousedown', function ( e
) {
140 this.hideShowButton
.$element
.on( 'mousedown', function ( e
) {
143 this.model
.connect( this, {
144 initialize
: 'onModelInitialize',
145 update
: 'onModelUpdate',
146 searchChange
: 'onModelSearchChange',
147 itemUpdate
: 'onModelItemUpdate',
148 highlightChange
: 'onModelHighlightChange'
150 this.input
.connect( this, { change
: 'onInputChange' } );
152 // The filter list and button should appear side by side regardless of how
153 // wide the button is; the button also changes its width depending
154 // on language and its state, so the safest way to present both side
155 // by side is with a table layout
156 rcFiltersRow
= $( '<div>' )
157 .addClass( 'mw-rcfilters-ui-row' )
160 .addClass( 'mw-rcfilters-ui-cell' )
161 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
164 if ( !mw
.user
.isAnon() ) {
167 .addClass( 'mw-rcfilters-ui-cell' )
168 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
169 .append( this.saveQueryButton
.$element
)
173 // Add a selector at the right of the input
174 this.viewsSelectWidget
= new OO
.ui
.ButtonSelectWidget( {
175 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
177 new OO
.ui
.ButtonOptionWidget( {
181 label
: mw
.msg( 'namespaces' ),
182 title
: mw
.msg( 'rcfilters-view-namespaces-tooltip' )
184 new OO
.ui
.ButtonOptionWidget( {
188 label
: mw
.msg( 'tags-title' ),
189 title
: mw
.msg( 'rcfilters-view-tags-tooltip' )
194 // Rearrange the UI so the select widget is at the right of the input
195 this.$element
.append(
197 .addClass( 'mw-rcfilters-ui-table' )
200 .addClass( 'mw-rcfilters-ui-row' )
201 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views' )
204 .addClass( 'mw-rcfilters-ui-cell' )
205 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
206 .append( this.input
.$element
),
208 .addClass( 'mw-rcfilters-ui-cell' )
209 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
210 .append( this.viewsSelectWidget
.$element
)
216 this.viewsSelectWidget
.connect( this, { choose
: 'onViewsSelectWidgetChoose' } );
220 .addClass( 'mw-rcfilters-ui-cell' )
221 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
222 .append( this.resetButton
.$element
)
226 $contentWrapper
.append(
228 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top' )
231 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-title' )
232 .append( title
.$element
),
234 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-queryName' )
235 .append( this.savedQueryTitle
.$element
),
237 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-hideshow' )
239 this.hideShowButton
.$element
243 .addClass( 'mw-rcfilters-ui-table' )
244 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-filters' )
245 .append( rcFiltersRow
)
249 this.$handle
.append( $contentWrapper
);
250 this.emptyFilterMessage
.toggle( this.isEmpty() );
251 this.savedQueryTitle
.toggle( false );
254 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
256 this.reevaluateResetRestoreState();
261 OO
.inheritClass( mw
.rcfilters
.ui
.FilterTagMultiselectWidget
, OO
.ui
.MenuTagMultiselectWidget
);
266 * Override parent method to avoid unnecessary resize events.
268 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateIfHeightChanged = function () { };
271 * Respond to view select widget choose event
273 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
275 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget
) {
276 this.controller
.switchView( buttonOptionWidget
.getData() );
277 this.viewsSelectWidget
.selectItem( null );
282 * Respond to model search change event
284 * @param {string} value Search value
286 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelSearchChange = function ( value
) {
287 this.input
.setValue( value
);
291 * Respond to input change event
293 * @param {string} value Value of the input
295 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputChange = function ( value
) {
296 this.controller
.setSearch( value
);
300 * Respond to query button click
302 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
303 this.getMenu().toggle( false );
307 * Respond to save query model initialization
309 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesInitialize = function () {
310 this.setSavedQueryVisibility();
314 * Respond to save query item change. Mainly this is done to update the label in case
315 * a query item has been edited
317 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
319 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
320 if ( this.matchingQuery
=== item
) {
321 // This means we just edited the item that is currently matched
322 this.savedQueryTitle
.setLabel( item
.getLabel() );
327 * Respond to menu toggle
329 * @param {boolean} isVisible Menu is visible
331 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
333 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
338 mw
.hook( 'RcFilters.popup.open' ).fire();
340 if ( !this.getMenu().findSelectedItem() ) {
341 // If there are no selected items, scroll menu to top
342 // This has to be in a setTimeout so the menu has time
343 // to be positioned and fixed
346 this.getMenu().scrollToTop();
352 this.selectTag( null );
355 this.controller
.setSearch( '' );
357 // Log filter grouping
358 this.controller
.trackFilterGroupings( 'filtermenu' );
363 this.input
.setIcon( isVisible
? 'search' : 'menu' );
369 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
371 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
373 // Only scroll to top of the viewport if:
374 // - The widget is more than 20px from the top
375 // - The widget is not above the top of the viewport (do not scroll downwards)
376 // (This isn't represented because >20 is, anyways and always, bigger than 0)
377 this.scrollToTop( this.$element
, 0, { min
: 20, max
: Infinity
} );
383 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
385 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
388 this.input
.$input
.blur();
394 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
395 if ( !this.collapsed
&& !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
405 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
406 // If initialized, call parent method.
407 if ( this.controller
.isInitialized() ) {
408 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
411 this.emptyFilterMessage
.toggle( this.isEmpty() );
415 * Respond to model initialize event
417 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
418 this.setSavedQueryVisibility();
422 * Respond to model update event
424 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
425 this.updateElementsForView();
429 * Update the elements in the widget to the current view
431 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
432 var view
= this.model
.getCurrentView(),
433 inputValue
= this.input
.getValue().trim(),
434 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
436 if ( inputView
!== 'default' ) {
437 // We have a prefix already, remove it
438 inputValue
= inputValue
.substr( 1 );
441 if ( inputView
!== view
) {
442 // Add the correct prefix
443 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
447 this.input
.setValue( inputValue
);
449 if ( this.currentView
!== view
) {
450 this.scrollToTop( this.$element
);
451 this.currentView
= view
;
456 * Set the visibility of the saved query button
458 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
459 if ( mw
.user
.isAnon() ) {
463 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
465 this.savedQueryTitle
.setLabel(
466 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
468 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
469 this.saveQueryButton
.setDisabled( !!this.matchingQuery
);
470 this.saveQueryButton
.setTitle( !this.matchingQuery
?
471 mw
.msg( 'rcfilters-savedqueries-add-new-title' ) :
472 mw
.msg( 'rcfilters-savedqueries-already-saved' ) );
474 if ( this.matchingQuery
) {
480 * Respond to model itemUpdate event
481 * fixme: when a new state is applied to the model this function is called 60+ times in a row
483 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
485 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
486 if ( !item
.getGroupModel().isHidden() ) {
490 this.model
.isHighlightEnabled() &&
491 item
.getHighlightColor()
494 this.addTag( item
.getName(), item
.getLabel() );
496 // Only attempt to remove the tag if we can find an item for it (T198140, T198231)
497 if ( this.findItemFromData( item
.getName() ) !== null ) {
498 this.removeTagByData( item
.getName() );
503 this.setSavedQueryVisibility();
505 // Re-evaluate reset state
506 this.reevaluateResetRestoreState();
512 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
514 this.model
.getItemByName( data
) &&
515 !this.isDuplicateData( data
)
522 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
523 this.controller
.toggleFilterSelect( item
.model
.getName() );
525 // Select the tag if it exists, or reset selection otherwise
526 this.selectTag( this.findItemFromData( item
.model
.getName() ) );
532 * Respond to highlightChange event
534 * @param {boolean} isHighlightEnabled Highlight is enabled
536 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
537 var highlightedItems
= this.model
.getHighlightedItems();
539 if ( isHighlightEnabled
) {
540 // Add capsule widgets
541 highlightedItems
.forEach( function ( filterItem
) {
542 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
545 // Remove capsule widgets if they're not selected
546 highlightedItems
.forEach( function ( filterItem
) {
547 if ( !filterItem
.isSelected() ) {
548 // Only attempt to remove the tag if we can find an item for it (T198140, T198231)
549 if ( this.findItemFromData( filterItem
.getName() ) !== null ) {
550 this.removeTagByData( filterItem
.getName() );
556 this.setSavedQueryVisibility();
562 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
563 var menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() );
565 this.menu
.setUserSelecting( true );
567 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
570 this.controller
.resetSearchForView( tagItem
.getView() );
572 this.selectTag( tagItem
);
573 this.scrollToTop( menuOption
.$element
);
575 this.menu
.setUserSelecting( false );
579 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
580 * If no items are given, reset selection from all.
582 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
583 * omit to deselect all
585 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
586 var i
, len
, selected
;
588 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
589 selected
= this.items
[ i
] === item
;
590 if ( this.items
[ i
].isSelected() !== selected
) {
591 this.items
[ i
].toggleSelected( selected
);
598 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
600 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
602 this.controller
.clearFilter( tagItem
.getName() );
608 * Respond to click event on the reset button
610 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
611 if ( this.model
.areVisibleFiltersEmpty() ) {
612 // Reset to default filters
613 this.controller
.resetToDefaults();
615 // Reset to have no filters
616 this.controller
.emptyFilters();
621 * Respond to hide/show button click
623 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onHideShowButtonClick = function () {
624 this.toggleCollapsed();
628 * Toggle the collapsed state of the filters widget
630 * @param {boolean} isCollapsed Widget is collapsed
632 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.toggleCollapsed = function ( isCollapsed
) {
633 isCollapsed
= isCollapsed
=== undefined ? !this.collapsed
: !!isCollapsed
;
635 this.collapsed
= isCollapsed
;
638 // If we are collapsing, close the menu, in case it was open
639 // We should make sure the menu closes before the rest of the elements
640 // are hidden, otherwise there is an unknown error in jQuery as ooui
641 // sets and unsets properties on the input (which is hidden at that point)
642 this.menu
.toggle( false );
644 this.input
.setDisabled( isCollapsed
);
645 this.hideShowButton
.setLabel( mw
.msg(
646 isCollapsed
? 'rcfilters-activefilters-show' : 'rcfilters-activefilters-hide'
648 this.hideShowButton
.setTitle( mw
.msg(
649 isCollapsed
? 'rcfilters-activefilters-show-tooltip' : 'rcfilters-activefilters-hide-tooltip'
652 // Toggle the wrapper class, so we have min height values correctly throughout
653 this.$wrapper
.toggleClass( 'mw-rcfilters-collapsed', isCollapsed
);
656 this.controller
.updateCollapsedState( isCollapsed
);
660 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
662 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
663 var defaultsAreEmpty
= this.controller
.areDefaultsEmpty(),
664 currFiltersAreEmpty
= this.model
.areVisibleFiltersEmpty(),
665 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
667 this.resetButton
.setIcon(
668 currFiltersAreEmpty
? 'history' : 'trash'
671 this.resetButton
.setLabel(
672 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
674 this.resetButton
.setTitle(
675 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
678 this.resetButton
.toggle( !hideResetButton
);
679 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
685 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
686 return new mw
.rcfilters
.ui
.MenuSelectWidget(
696 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
697 var filterItem
= this.model
.getItemByName( data
);
700 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
703 this.model
.getInvertModel(),
706 $overlay
: this.$overlay
712 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.emphasize = function () {
714 !this.$handle
.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
717 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
718 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
720 setTimeout( function () {
722 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
724 setTimeout( function () {
726 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
727 }.bind( this ), 1000 );
728 }.bind( this ), 500 );
733 * Scroll the element to top within its container
736 * @param {jQuery} $element Element to position
737 * @param {number} [marginFromTop=0] When scrolling the entire widget to the top, leave this
738 * much space (in pixels) above the widget.
739 * @param {Object} [threshold] Minimum distance from the top of the element to scroll at all
740 * @param {number} [threshold.min] Minimum distance above the element
741 * @param {number} [threshold.max] Minimum distance below the element
743 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
, threshold
) {
744 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
745 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
746 containerScrollTop
= $( container
).scrollTop(),
747 effectiveScrollTop
= $( container
).is( 'body, html' ) ? 0 : containerScrollTop
,
748 newScrollTop
= effectiveScrollTop
+ pos
.top
- ( marginFromTop
|| 0 );
752 threshold
=== undefined ||
755 threshold
.min
=== undefined ||
756 newScrollTop
- containerScrollTop
>= threshold
.min
759 threshold
.max
=== undefined ||
760 newScrollTop
- containerScrollTop
<= threshold
.max
764 $( container
).animate( {
765 scrollTop
: newScrollTop