resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterWrapperWidget.js

   1 ( function ( mw ) {
   2         /**
   3          * List displaying all filter groups
   4          *
   5          * @extends OO.ui.Widget
   6          * @mixins OO.ui.mixin.PendingElement
   7          *
   8          * @constructor
   9          * @param {mw.rcfilters.Controller} controller Controller
  10          * @param {mw.rcfilters.dm.FiltersViewModel} model View model
  11          * @param {Object} [config] Configuration object
  12          * @cfg {Object} [filters] A definition of the filter groups in this list
  13          * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
  14          */
  15         mw.rcfilters.ui.FilterWrapperWidget = function MwRcfiltersUiFilterWrapperWidget( controller, model, config ) {
  16                 var $footer = $( '<div>' );
  17                 config = config || {};
  18
  19                 // Parent
  20                 mw.rcfilters.ui.FilterWrapperWidget.parent.call( this, config );
  21                 // Mixin constructors
  22                 OO.ui.mixin.PendingElement.call( this, config );
  23
  24                 this.controller = controller;
  25                 this.model = model;
  26                 this.$overlay = config.$overlay || this.$element;
  27
  28                 this.filterPopup = new mw.rcfilters.ui.FiltersListWidget(
  29                         this.controller,
  30                         this.model,
  31                         {
  32                                 label: mw.msg( 'rcfilters-filterlist-title' ),
  33                                 $overlay: this.$overlay
  34                         }
  35                 );
  36
  37                 $footer.append(
  38                         new OO.ui.ButtonWidget( {
  39                                 framed: false,
  40                                 icon: 'feedback',
  41                                 flags: [ 'progressive' ],
  42                                 label: mw.msg( 'rcfilters-filterlist-feedbacklink' ),
  43                                 href: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
  44                         } ).$element
  45                 );
  46
  47                 this.textInput = new OO.ui.TextInputWidget( {
  48                         classes: [ 'mw-rcfilters-ui-filterWrapperWidget-search' ],
  49                         icon: 'search',
  50                         placeholder: mw.msg( 'rcfilters-search-placeholder' )
  51                 } );
  52
  53                 this.capsule = new mw.rcfilters.ui.FilterCapsuleMultiselectWidget( controller, this.model, this.textInput, {
  54                         $overlay: this.$overlay,
  55                         popup: {
  56                                 $content: this.filterPopup.$element,
  57                                 $footer: $footer,
  58                                 classes: [ 'mw-rcfilters-ui-filterWrapperWidget-popup' ],
  59                                 width: 650
  60                         }
  61                 } );
  62
  63                 // Events
  64                 this.model.connect( this, {
  65                         initialize: 'onModelInitialize',
  66                         itemUpdate: 'onModelItemUpdate'
  67                 } );
  68                 this.textInput.connect( this, {
  69                         change: 'onTextInputChange',
  70                         enter: 'onTextInputEnter'
  71                 } );
  72                 this.capsule.connect( this, { capsuleItemClick: 'onCapsuleItemClick' } );
  73                 this.capsule.popup.connect( this, { toggle: 'onCapsulePopupToggle' } );
  74
  75                 // Initialize
  76                 this.$element
  77                         .addClass( 'mw-rcfilters-ui-filterWrapperWidget' )
  78                         .addClass( 'mw-rcfilters-ui-ready' )
  79                         .append( this.capsule.$element, this.textInput.$element );
  80         };
  81
  82         /* Initialization */
  83
  84         OO.inheritClass( mw.rcfilters.ui.FilterWrapperWidget, OO.ui.Widget );
  85         OO.mixinClass( mw.rcfilters.ui.FilterWrapperWidget, OO.ui.mixin.PendingElement );
  86
  87         /**
  88          * Respond to capsule item click and make the popup scroll down to the requested item
  89          *
  90          * @param {mw.rcfilters.ui.CapsuleItemWidget} item Clicked item
  91          */
  92         mw.rcfilters.ui.FilterWrapperWidget.prototype.onCapsuleItemClick = function ( item ) {
  93                 var filterName = item.getData(),
  94                         // Find the item in the popup
  95                         filterWidget = this.filterPopup.getItemWidget( filterName );
  96
  97                 // Highlight item
  98                 this.filterPopup.select( filterName );
  99                 this.capsule.select( item );
 100
 101                 this.scrollToTop( filterWidget.$element );
 102         };
 103
 104         /**
 105          * Respond to popup toggle event. Reset selection in the list when the popup is closed.
 106          *
 107          * @param {boolean} isVisible Popup is visible
 108          */
 109         mw.rcfilters.ui.FilterWrapperWidget.prototype.onCapsulePopupToggle = function ( isVisible ) {
 110                 if ( !isVisible ) {
 111                         if ( !this.textInput.getValue() ) {
 112                                 // Only reset selection if we are not filtering
 113                                 this.filterPopup.resetSelection();
 114                                 this.capsule.resetSelection();
 115                         }
 116                 } else {
 117                         this.scrollToTop( this.capsule.$element, 10 );
 118                 }
 119         };
 120
 121         /**
 122          * Respond to text input change
 123          *
 124          * @param {string} newValue Current value
 125          */
 126         mw.rcfilters.ui.FilterWrapperWidget.prototype.onTextInputChange = function ( newValue ) {
 127                 // Filter the results
 128                 this.filterPopup.filter( this.model.findMatches( newValue ) );
 129
 130                 if ( !newValue ) {
 131                         // If the value is empty, we didn't actually
 132                         // filter anything. the filter method will run
 133                         // and show all, but then will select the
 134                         // top item - but in this case, no selection
 135                         // should be made.
 136                         this.filterPopup.resetSelection();
 137                 }
 138                 this.capsule.popup.clip();
 139         };
 140
 141         /**
 142          * Respond to text input enter event
 143          */
 144         mw.rcfilters.ui.FilterWrapperWidget.prototype.onTextInputEnter = function () {
 145                 var filter = this.filterPopup.getSelectedFilter();
 146
 147                 // Toggle the filter
 148                 this.controller.toggleFilterSelect( filter );
 149         };
 150
 151         /**
 152          * Respond to model update event and set up the available filters to choose
 153          * from.
 154          */
 155         mw.rcfilters.ui.FilterWrapperWidget.prototype.onModelInitialize = function () {
 156                 var wrapper = this;
 157
 158                 // Add defaults to capsule. We have to do this
 159                 // after we added to the capsule menu, since that's
 160                 // how the capsule multiselect widget knows which
 161                 // object to add
 162                 this.model.getItems().forEach( function ( filterItem ) {
 163                         if ( filterItem.isSelected() ) {
 164                                 wrapper.capsule.addItemByName( filterItem.getName() );
 165                         }
 166                 } );
 167         };
 168
 169         /**
 170          * Respond to item update and reset the selection. This will make it so that
 171          * any actual interaction with the system resets the selection state of any item.
 172          */
 173         mw.rcfilters.ui.FilterWrapperWidget.prototype.onModelItemUpdate = function () {
 174                 if ( !this.textInput.getValue() ) {
 175                         this.filterPopup.resetSelection();
 176                 }
 177         };
 178
 179         /**
 180          * Scroll the element to top within its container
 181          *
 182          * @private
 183          * @param {jQuery} $element Element to position
 184          * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
 185          *  much space (in pixels) above the widget.
 186          */
 187         mw.rcfilters.ui.FilterWrapperWidget.prototype.scrollToTop = function ( $element, marginFromTop ) {
 188                 var container = OO.ui.Element.static.getClosestScrollableContainer( $element[ 0 ], 'y' ),
 189                         pos = OO.ui.Element.static.getRelativePosition( $element, $( container ) );
 190
 191                 // Scroll to item
 192                 $( container ).animate( {
 193                         scrollTop: $( container ).scrollTop() + pos.top + ( marginFromTop || 0 )
 194                 } );
 195         };
 196 }( mediaWiki ) );