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:Edit_Review_Improvements/RC_filters'
  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                 } );
  71                 this.capsule.connect( this, { capsuleItemClick: 'onCapsuleItemClick' } );
  72                 this.capsule.popup.connect( this, { toggle: 'onCapsulePopupToggle' } );
  73
  74                 // Initialize
  75                 this.$element
  76                         .addClass( 'mw-rcfilters-ui-filterWrapperWidget' )
  77                         .append( this.capsule.$element, this.textInput.$element );
  78         };
  79
  80         /* Initialization */
  81
  82         OO.inheritClass( mw.rcfilters.ui.FilterWrapperWidget, OO.ui.Widget );
  83         OO.mixinClass( mw.rcfilters.ui.FilterWrapperWidget, OO.ui.mixin.PendingElement );
  84
  85         /**
  86          * Respond to capsule item click and make the popup scroll down to the requested item
  87          *
  88          * @param {mw.rcfilters.ui.CapsuleItemWidget} item Clicked item
  89          */
  90         mw.rcfilters.ui.FilterWrapperWidget.prototype.onCapsuleItemClick = function ( item ) {
  91                 var filterName = item.getData(),
  92                         // Find the item in the popup
  93                         filterWidget = this.filterPopup.getItemWidget( filterName );
  94
  95                 // Highlight item
  96                 this.filterPopup.select( filterName );
  97
  98                 this.scrollToTop( filterWidget.$element );
  99         };
 100
 101         /**
 102          * Respond to popup toggle event. Reset selection in the list when the popup is closed.
 103          *
 104          * @param {boolean} isVisible Popup is visible
 105          */
 106         mw.rcfilters.ui.FilterWrapperWidget.prototype.onCapsulePopupToggle = function ( isVisible ) {
 107                 if ( !isVisible ) {
 108                         this.filterPopup.resetSelection();
 109                 } else {
 110                         this.scrollToTop( this.capsule.$element, 10 );
 111                 }
 112         };
 113
 114         /**
 115          * Respond to text input change
 116          *
 117          * @param {string} newValue Current value
 118          */
 119         mw.rcfilters.ui.FilterWrapperWidget.prototype.onTextInputChange = function ( newValue ) {
 120                 this.filterPopup.resetSelection();
 121
 122                 // Filter the results
 123                 this.filterPopup.filter( this.model.findMatches( newValue ) );
 124                 this.capsule.popup.clip();
 125         };
 126
 127         /**
 128          * Respond to model update event and set up the available filters to choose
 129          * from.
 130          */
 131         mw.rcfilters.ui.FilterWrapperWidget.prototype.onModelInitialize = function () {
 132                 var wrapper = this;
 133
 134                 // Add defaults to capsule. We have to do this
 135                 // after we added to the capsule menu, since that's
 136                 // how the capsule multiselect widget knows which
 137                 // object to add
 138                 this.model.getItems().forEach( function ( filterItem ) {
 139                         if ( filterItem.isSelected() ) {
 140                                 wrapper.capsule.addItemByName( filterItem.getName() );
 141                         }
 142                 } );
 143         };
 144
 145         /**
 146          * Respond to item update and reset the selection. This will make it so that
 147          * any actual interaction with the system resets the selection state of any item.
 148          */
 149         mw.rcfilters.ui.FilterWrapperWidget.prototype.onModelItemUpdate = function () {
 150                 this.filterPopup.resetSelection();
 151         };
 152
 153         /**
 154          * Scroll the element to top within its container
 155          *
 156          * @private
 157          * @param {jQuery} $element Element to position
 158          * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
 159          *  much space (in pixels) above the widget.
 160          */
 161         mw.rcfilters.ui.FilterWrapperWidget.prototype.scrollToTop = function ( $element, marginFromTop ) {
 162                 var container = OO.ui.Element.static.getClosestScrollableContainer( $element[ 0 ], 'y' ),
 163                         pos = OO.ui.Element.static.getRelativePosition( $element, $( container ) );
 164
 165                 // Scroll to item
 166                 $( container ).animate( {
 167                         scrollTop: $( container ).scrollTop() + pos.top + ( marginFromTop || 0 )
 168                 } );
 169         };
 170 }( mediaWiki ) );