2 var FilterMenuHeaderWidget
= require( './FilterMenuHeaderWidget.js' ),
3 HighlightPopupWidget
= require( './HighlightPopupWidget.js' ),
4 FilterMenuSectionOptionWidget
= require( './FilterMenuSectionOptionWidget.js' ),
5 FilterMenuOptionWidget
= require( './FilterMenuOptionWidget.js' ),
9 * A floating menu widget for the filter list
11 * @class mw.rcfilters.ui.MenuSelectWidget
12 * @extends OO.ui.MenuSelectWidget
15 * @param {mw.rcfilters.Controller} controller Controller
16 * @param {mw.rcfilters.dm.FiltersViewModel} model View model
17 * @param {Object} [config] Configuration object
18 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
19 * @cfg {Object[]} [footers] An array of objects defining the footers for
20 * this menu, with a definition whether they appear per specific views.
21 * The expected structure is:
24 * name: {string} A unique name for the footer object
25 * $element: {jQuery} A jQuery object for the content of the footer
26 * views: {string[]} Optional. An array stating which views this footer is
27 * active on. Use null or omit to display this on all views.
31 MenuSelectWidget
= function MwRcfiltersUiMenuSelectWidget( controller
, model
, config
) {
34 config
= config
|| {};
36 this.controller
= controller
;
38 this.currentView
= '';
40 this.userSelecting
= false;
42 this.menuInitialized
= false;
43 this.$overlay
= config
.$overlay
|| this.$element
;
44 this.$body
= $( '<div>' ).addClass( 'mw-rcfilters-ui-menuSelectWidget-body' );
48 MenuSelectWidget
.parent
.call( this, $.extend( config
, {
49 $autoCloseIgnore
: this.$overlay
,
51 // Our filtering is done through the model
52 filterFromInput
: false
56 .addClass( 'mw-rcfilters-ui-menuSelectWidget-group' )
58 this.setClippableElement( this.$body
);
59 this.setClippableContainer( this.$element
);
61 header
= new FilterMenuHeaderWidget(
65 $overlay
: this.$overlay
69 this.noResults
= new OO
.ui
.LabelWidget( {
70 label
: mw
.msg( 'rcfilters-filterlist-noresults' ),
71 classes
: [ 'mw-rcfilters-ui-menuSelectWidget-noresults' ]
75 this.model
.connect( this, {
76 initialize
: 'onModelInitialize',
77 searchChange
: 'onModelSearchChange'
82 .addClass( 'mw-rcfilters-ui-menuSelectWidget' )
83 .append( header
.$element
)
86 .append( this.$group
, this.noResults
.$element
)
89 // Append all footers; we will control their visibility
91 config
.footers
= config
.footers
|| [];
92 config
.footers
.forEach( function ( footerData
) {
93 var isSticky
= footerData
.sticky
=== undefined ? true : !!footerData
.sticky
,
95 // Wrap the element with our own footer wrapper
96 $element
: $( '<div>' )
97 .addClass( 'mw-rcfilters-ui-menuSelectWidget-footer' )
98 .addClass( 'mw-rcfilters-ui-menuSelectWidget-footer-' + footerData
.name
)
99 .append( footerData
.$element
),
100 views
: footerData
.views
103 if ( !footerData
.disabled
) {
104 this.footers
.push( adjustedData
);
107 this.$element
.append( adjustedData
.$element
);
109 this.$body
.append( adjustedData
.$element
);
114 // Switch to the correct view
120 OO
.inheritClass( MenuSelectWidget
, OO
.ui
.MenuSelectWidget
);
125 MenuSelectWidget
.prototype.onModelSearchChange = function () {
132 MenuSelectWidget
.prototype.toggle = function ( show
) {
133 this.lazyMenuCreation();
134 MenuSelectWidget
.parent
.prototype.toggle
.call( this, show
);
135 // Always open this menu downwards. FilterTagMultiselectWidget scrolls it into view.
136 this.setVerticalPosition( 'below' );
140 * lazy creation of the menu
142 MenuSelectWidget
.prototype.lazyMenuCreation = function () {
146 groups
= this.model
.getFilterGroups();
148 if ( this.menuInitialized
) {
152 this.menuInitialized
= true;
154 // Create shared popup for highlight buttons
155 this.highlightPopup
= new HighlightPopupWidget( this.controller
);
156 this.$overlay
.append( this.highlightPopup
.$element
);
158 // Count groups per view
159 // eslint-disable-next-line no-jquery/no-each-util
160 $.each( groups
, function ( groupName
, groupModel
) {
161 if ( !groupModel
.isHidden() ) {
162 viewGroupCount
[ groupModel
.getView() ] = viewGroupCount
[ groupModel
.getView() ] || 0;
163 viewGroupCount
[ groupModel
.getView() ]++;
167 // eslint-disable-next-line no-jquery/no-each-util
168 $.each( groups
, function ( groupName
, groupModel
) {
169 var currentItems
= [],
170 view
= groupModel
.getView();
172 if ( !groupModel
.isHidden() ) {
173 if ( viewGroupCount
[ view
] > 1 ) {
174 // Only add a section header if there is more than
178 new FilterMenuSectionOptionWidget(
182 $overlay
: widget
.$overlay
189 widget
.model
.getGroupFilters( groupName
).forEach( function ( filterItem
) {
191 new FilterMenuOptionWidget(
194 widget
.model
.getInvertModel(),
196 widget
.highlightPopup
,
198 $overlay
: widget
.$overlay
204 // Cache the items per view, so we can switch between them
205 // without rebuilding the widgets each time
206 widget
.views
[ view
] = widget
.views
[ view
] || [];
207 widget
.views
[ view
] = widget
.views
[ view
].concat( currentItems
);
208 items
= items
.concat( currentItems
);
212 this.addItems( items
);
217 * Respond to model initialize event. Populate the menu from the model
219 MenuSelectWidget
.prototype.onModelInitialize = function () {
220 this.menuInitialized
= false;
221 // Set timeout for the menu to lazy build.
222 setTimeout( this.lazyMenuCreation
.bind( this ) );
228 MenuSelectWidget
.prototype.updateView = function () {
229 var viewName
= this.model
.getCurrentView();
231 if ( this.views
[ viewName
] && this.currentView
!== viewName
) {
232 this.updateFooterVisibility( viewName
);
235 .data( 'view', viewName
)
236 .removeClass( 'mw-rcfilters-ui-menuSelectWidget-view-' + this.currentView
)
237 .addClass( 'mw-rcfilters-ui-menuSelectWidget-view-' + viewName
);
239 this.currentView
= viewName
;
243 this.postProcessItems();
248 * Go over the available footers and decide which should be visible
251 * @param {string} [currentView] Current view
253 MenuSelectWidget
.prototype.updateFooterVisibility = function ( currentView
) {
254 currentView
= currentView
|| this.model
.getCurrentView();
256 this.footers
.forEach( function ( data
) {
257 data
.$element
.toggle(
258 // This footer should only be shown if it is configured
259 // for all views or for this specific view
260 !data
.views
|| data
.views
.length
=== 0 || data
.views
.indexOf( currentView
) > -1
266 * Post-process items after the visibility changed. Make sure
267 * that we always have an item selected, and that the no-results
268 * widget appears if the menu is empty.
270 MenuSelectWidget
.prototype.postProcessItems = function () {
272 itemWasSelected
= false,
273 items
= this.getItems();
275 // If we are not already selecting an item, always make sure
276 // that the top item is selected
277 if ( !this.userSelecting
) {
278 // Select the first item in the list
279 for ( i
= 0; i
< items
.length
; i
++ ) {
281 !( items
[ i
] instanceof OO
.ui
.MenuSectionOptionWidget
) &&
282 items
[ i
].isVisible()
284 itemWasSelected
= true;
285 this.selectItem( items
[ i
] );
290 if ( !itemWasSelected
) {
291 this.selectItem( null );
295 this.noResults
.toggle( !this.getItems().some( function ( item
) {
296 return item
.isVisible();
301 * Get the option widget that matches the model given
303 * @param {mw.rcfilters.dm.ItemModel} model Item model
304 * @return {mw.rcfilters.ui.ItemMenuOptionWidget} Option widget
306 MenuSelectWidget
.prototype.getItemFromModel = function ( model
) {
307 this.lazyMenuCreation();
308 return this.views
[ model
.getGroupModel().getView() ].filter( function ( item
) {
309 return item
.getName() === model
.getName();
316 MenuSelectWidget
.prototype.onDocumentKeyDown = function ( e
) {
318 currentItem
= this.findHighlightedItem() || this.findSelectedItem();
321 MenuSelectWidget
.parent
.prototype.onDocumentKeyDown
.call( this, e
);
323 // We want to select the item on arrow movement
324 // rather than just highlight it, like the menu
326 if ( !this.isDisabled() && this.isVisible() ) {
327 switch ( e
.keyCode
) {
329 case OO
.ui
.Keys
.LEFT
:
331 nextItem
= this.findRelativeSelectableItem( currentItem
, -1 );
333 case OO
.ui
.Keys
.DOWN
:
334 case OO
.ui
.Keys
.RIGHT
:
336 nextItem
= this.findRelativeSelectableItem( currentItem
, 1 );
340 nextItem
= nextItem
&& nextItem
.constructor.static.selectable
?
343 // Select the next item
344 this.selectItem( nextItem
);
349 * Scroll to the top of the menu
351 MenuSelectWidget
.prototype.scrollToTop = function () {
352 this.$body
.scrollTop( 0 );
356 * Set whether the user is currently selecting an item.
357 * This is important when the user selects an item that is in between
358 * different views, and makes sure we do not re-select a different
359 * item (like the item on top) when this is happening.
361 * @param {boolean} isSelecting User is selecting
363 MenuSelectWidget
.prototype.setUserSelecting = function ( isSelecting
) {
364 this.userSelecting
= !!isSelecting
;
367 module
.exports
= MenuSelectWidget
;