1 var FilterMenuHeaderWidget
= require( './FilterMenuHeaderWidget.js' ),
2 HighlightPopupWidget
= require( './HighlightPopupWidget.js' ),
3 FilterMenuSectionOptionWidget
= require( './FilterMenuSectionOptionWidget.js' ),
4 FilterMenuOptionWidget
= require( './FilterMenuOptionWidget.js' ),
8 * A floating menu widget for the filter list
10 * @class mw.rcfilters.ui.MenuSelectWidget
11 * @extends OO.ui.MenuSelectWidget
14 * @param {mw.rcfilters.Controller} controller Controller
15 * @param {mw.rcfilters.dm.FiltersViewModel} model View model
16 * @param {Object} [config] Configuration object
17 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
18 * @cfg {Object[]} [footers] An array of objects defining the footers for
19 * this menu, with a definition whether they appear per specific views.
20 * The expected structure is:
23 * name: {string} A unique name for the footer object
24 * $element: {jQuery} A jQuery object for the content of the footer
25 * views: {string[]} Optional. An array stating which views this footer is
26 * active on. Use null or omit to display this on all views.
30 MenuSelectWidget
= function MwRcfiltersUiMenuSelectWidget( controller
, model
, config
) {
33 config
= config
|| {};
35 this.controller
= controller
;
37 this.currentView
= '';
39 this.userSelecting
= false;
41 this.menuInitialized
= false;
42 this.$overlay
= config
.$overlay
|| this.$element
;
43 this.$body
= $( '<div>' ).addClass( 'mw-rcfilters-ui-menuSelectWidget-body' );
47 MenuSelectWidget
.parent
.call( this, $.extend( config
, {
48 $autoCloseIgnore
: this.$overlay
,
50 // Our filtering is done through the model
51 filterFromInput
: false
55 .addClass( 'mw-rcfilters-ui-menuSelectWidget-group' )
57 this.setClippableElement( this.$body
);
58 this.setClippableContainer( this.$element
);
60 header
= new FilterMenuHeaderWidget(
64 $overlay
: this.$overlay
68 this.noResults
= new OO
.ui
.LabelWidget( {
69 label
: mw
.msg( 'rcfilters-filterlist-noresults' ),
70 classes
: [ 'mw-rcfilters-ui-menuSelectWidget-noresults' ]
74 this.model
.connect( this, {
75 initialize
: 'onModelInitialize',
76 searchChange
: 'onModelSearchChange'
81 .addClass( 'mw-rcfilters-ui-menuSelectWidget' )
82 .append( header
.$element
)
85 .append( this.$group
, this.noResults
.$element
)
88 // Append all footers; we will control their visibility
90 config
.footers
= config
.footers
|| [];
91 config
.footers
.forEach( function ( footerData
) {
92 var isSticky
= footerData
.sticky
=== undefined ? true : !!footerData
.sticky
,
94 // Wrap the element with our own footer wrapper
95 $element
: $( '<div>' )
96 .addClass( 'mw-rcfilters-ui-menuSelectWidget-footer' )
97 .addClass( 'mw-rcfilters-ui-menuSelectWidget-footer-' + footerData
.name
)
98 .append( footerData
.$element
),
99 views
: footerData
.views
102 if ( !footerData
.disabled
) {
103 this.footers
.push( adjustedData
);
106 this.$element
.append( adjustedData
.$element
);
108 this.$body
.append( adjustedData
.$element
);
113 // Switch to the correct view
119 OO
.inheritClass( MenuSelectWidget
, OO
.ui
.MenuSelectWidget
);
124 MenuSelectWidget
.prototype.onModelSearchChange = function () {
131 MenuSelectWidget
.prototype.toggle = function ( show
) {
132 this.lazyMenuCreation();
133 MenuSelectWidget
.parent
.prototype.toggle
.call( this, show
);
134 // Always open this menu downwards. FilterTagMultiselectWidget scrolls it into view.
135 this.setVerticalPosition( 'below' );
139 * lazy creation of the menu
141 MenuSelectWidget
.prototype.lazyMenuCreation = function () {
145 groups
= this.model
.getFilterGroups();
147 if ( this.menuInitialized
) {
151 this.menuInitialized
= true;
153 // Create shared popup for highlight buttons
154 this.highlightPopup
= new HighlightPopupWidget( this.controller
);
155 this.$overlay
.append( this.highlightPopup
.$element
);
157 // Count groups per view
158 // eslint-disable-next-line no-jquery/no-each-util
159 $.each( groups
, function ( groupName
, groupModel
) {
160 if ( !groupModel
.isHidden() ) {
161 viewGroupCount
[ groupModel
.getView() ] = viewGroupCount
[ groupModel
.getView() ] || 0;
162 viewGroupCount
[ groupModel
.getView() ]++;
166 // eslint-disable-next-line no-jquery/no-each-util
167 $.each( groups
, function ( groupName
, groupModel
) {
168 var currentItems
= [],
169 view
= groupModel
.getView();
171 if ( !groupModel
.isHidden() ) {
172 if ( viewGroupCount
[ view
] > 1 ) {
173 // Only add a section header if there is more than
177 new FilterMenuSectionOptionWidget(
181 $overlay
: widget
.$overlay
188 widget
.model
.getGroupFilters( groupName
).forEach( function ( filterItem
) {
190 new FilterMenuOptionWidget(
193 widget
.model
.getInvertModel(),
195 widget
.highlightPopup
,
197 $overlay
: widget
.$overlay
203 // Cache the items per view, so we can switch between them
204 // without rebuilding the widgets each time
205 widget
.views
[ view
] = widget
.views
[ view
] || [];
206 widget
.views
[ view
] = widget
.views
[ view
].concat( currentItems
);
207 items
= items
.concat( currentItems
);
211 this.addItems( items
);
216 * Respond to model initialize event. Populate the menu from the model
218 MenuSelectWidget
.prototype.onModelInitialize = function () {
219 this.menuInitialized
= false;
220 // Set timeout for the menu to lazy build.
221 setTimeout( this.lazyMenuCreation
.bind( this ) );
227 MenuSelectWidget
.prototype.updateView = function () {
228 var viewName
= this.model
.getCurrentView();
230 if ( this.views
[ viewName
] && this.currentView
!== viewName
) {
231 this.updateFooterVisibility( viewName
);
234 .data( 'view', viewName
)
235 .removeClass( 'mw-rcfilters-ui-menuSelectWidget-view-' + this.currentView
)
236 .addClass( 'mw-rcfilters-ui-menuSelectWidget-view-' + viewName
);
238 this.currentView
= viewName
;
242 this.postProcessItems();
247 * Go over the available footers and decide which should be visible
250 * @param {string} [currentView] Current view
252 MenuSelectWidget
.prototype.updateFooterVisibility = function ( currentView
) {
253 currentView
= currentView
|| this.model
.getCurrentView();
255 this.footers
.forEach( function ( data
) {
256 data
.$element
.toggle(
257 // This footer should only be shown if it is configured
258 // for all views or for this specific view
259 !data
.views
|| data
.views
.length
=== 0 || data
.views
.indexOf( currentView
) > -1
265 * Post-process items after the visibility changed. Make sure
266 * that we always have an item selected, and that the no-results
267 * widget appears if the menu is empty.
269 MenuSelectWidget
.prototype.postProcessItems = function () {
271 itemWasSelected
= false,
272 items
= this.getItems();
274 // If we are not already selecting an item, always make sure
275 // that the top item is selected
276 if ( !this.userSelecting
) {
277 // Select the first item in the list
278 for ( i
= 0; i
< items
.length
; i
++ ) {
280 !( items
[ i
] instanceof OO
.ui
.MenuSectionOptionWidget
) &&
281 items
[ i
].isVisible()
283 itemWasSelected
= true;
284 this.selectItem( items
[ i
] );
289 if ( !itemWasSelected
) {
290 this.selectItem( null );
294 this.noResults
.toggle( !this.getItems().some( function ( item
) {
295 return item
.isVisible();
300 * Get the option widget that matches the model given
302 * @param {mw.rcfilters.dm.ItemModel} model Item model
303 * @return {mw.rcfilters.ui.ItemMenuOptionWidget} Option widget
305 MenuSelectWidget
.prototype.getItemFromModel = function ( model
) {
306 this.lazyMenuCreation();
307 return this.views
[ model
.getGroupModel().getView() ].filter( function ( item
) {
308 return item
.getName() === model
.getName();
315 MenuSelectWidget
.prototype.onDocumentKeyDown = function ( e
) {
317 currentItem
= this.findHighlightedItem() || this.findSelectedItem();
320 MenuSelectWidget
.parent
.prototype.onDocumentKeyDown
.call( this, e
);
322 // We want to select the item on arrow movement
323 // rather than just highlight it, like the menu
325 if ( !this.isDisabled() && this.isVisible() ) {
326 switch ( e
.keyCode
) {
328 case OO
.ui
.Keys
.LEFT
:
330 nextItem
= this.findRelativeSelectableItem( currentItem
, -1 );
332 case OO
.ui
.Keys
.DOWN
:
333 case OO
.ui
.Keys
.RIGHT
:
335 nextItem
= this.findRelativeSelectableItem( currentItem
, 1 );
339 nextItem
= nextItem
&& nextItem
.constructor.static.selectable
?
342 // Select the next item
343 this.selectItem( nextItem
);
348 * Scroll to the top of the menu
350 MenuSelectWidget
.prototype.scrollToTop = function () {
351 this.$body
.scrollTop( 0 );
355 * Set whether the user is currently selecting an item.
356 * This is important when the user selects an item that is in between
357 * different views, and makes sure we do not re-select a different
358 * item (like the item on top) when this is happening.
360 * @param {boolean} isSelecting User is selecting
362 MenuSelectWidget
.prototype.setUserSelecting = function ( isSelecting
) {
363 this.userSelecting
= !!isSelecting
;
366 module
.exports
= MenuSelectWidget
;