Merge "Revert "Make mw.widgets.SearchInputWidget extend OO.ui.SearchInputWidget""

This commit is contained in:
Tjones 2017-07-19 21:51:17 +00:00 committed by Gerrit Code Review
commit af420fe8b5
3 changed files with 82 additions and 51 deletions

View file

@ -10,10 +10,12 @@ namespace MediaWiki\Widget;
/**
* Search input widget.
*/
class SearchInputWidget extends \OOUI\TextInputWidget {
class SearchInputWidget extends TitleInputWidget {
protected $pushPending = false;
protected $performSearchOnClick = true;
protected $validateTitle = false;
protected $highlightFirst = false;
protected $dataLocation = 'header';
/**
@ -28,6 +30,7 @@ class SearchInputWidget extends \OOUI\TextInputWidget {
*/
public function __construct( array $config = [] ) {
$config = array_merge( [
'maxLength' => null,
'icon' => 'search',
], $config );

View file

@ -2559,9 +2559,9 @@ return [
],
'dependencies' => [
'mediawiki.searchSuggest',
// FIXME: Needs TitleWidget only
'oojs-ui.styles.icons-interactions',
// FIXME: Needs TitleInputWidget only
'mediawiki.widgets',
'oojs-ui-widgets',
],
],
'mediawiki.widgets.SearchInputWidget.styles' => [

View file

@ -10,9 +10,7 @@
* Creates a mw.widgets.SearchInputWidget object.
*
* @class
* @extends OO.ui.SearchInputWidget
* @mixins mw.widgets.TitleWidget
* @mixins OO.ui.mixin.LookupElement
* @extends mw.widgets.TitleInputWidget
*
* @constructor
* @param {Object} [config] Configuration options
@ -32,25 +30,21 @@
var $form = config.$input ? config.$input.closest( 'form' ) : $();
config = $.extend( {
icon: 'search',
maxLength: undefined,
performSearchOnClick: true,
dataLocation: 'header'
dataLocation: 'header',
namespace: 0
}, config );
// Parent constructor
mw.widgets.SearchInputWidget.parent.call( this, $.extend( {}, config, {
autocomplete: false
} ) );
// Mixin constructors
mw.widgets.TitleWidget.call( this, config );
OO.ui.mixin.LookupElement.call( this, config );
mw.widgets.SearchInputWidget.parent.call( this, config );
// Initialization
this.$element.addClass( 'mw-widget-searchInputWidget' );
this.lookupMenu.$element.addClass( 'mw-widget-searchWidget-menu' );
this.lastLookupItems = [];
if ( !config.pushPending ) {
// TODO This actually overrides a method, that's pretty crazy. Surely there's a better way?
this.pushPending = false;
}
if ( config.dataLocation ) {
@ -72,28 +66,78 @@
)
} );
}.bind( this ) );
this.$element.addClass( 'oo-ui-textInputWidget-type-search' );
this.updateSearchIndicator();
this.connect( this, {
disable: 'onDisable'
} );
};
/* Setup */
OO.inheritClass( mw.widgets.SearchInputWidget, OO.ui.SearchInputWidget );
OO.mixinClass( mw.widgets.SearchInputWidget, mw.widgets.TitleWidget );
OO.mixinClass( mw.widgets.SearchInputWidget, OO.ui.mixin.LookupElement );
OO.inheritClass( mw.widgets.SearchInputWidget, mw.widgets.TitleInputWidget );
/* Methods */
/**
* @inheritdoc mw.widgets.TitleWidget
* @inheritdoc
* @protected
*/
mw.widgets.SearchInputWidget.prototype.getQueryValue = function () {
return this.getValue();
mw.widgets.SearchInputWidget.prototype.getInputElement = function () {
return $( '<input>' ).attr( 'type', 'search' );
};
/**
* @inheritdoc OO.ui.mixin.LookupElement
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getLookupRequest = function () {
return this.getSuggestionsPromise();
mw.widgets.SearchInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
if ( e.which === OO.ui.MouseButtons.LEFT ) {
// Clear the text field
this.setValue( '' );
this.$input[ 0 ].focus();
return false;
}
};
/**
* Update the 'clear' indicator displayed on type: 'search' text
* fields, hiding it when the field is already empty or when it's not
* editable.
*/
mw.widgets.SearchInputWidget.prototype.updateSearchIndicator = function () {
if ( this.getValue() === '' || this.isDisabled() || this.isReadOnly() ) {
this.setIndicator( null );
} else {
this.setIndicator( 'clear' );
}
};
/**
* @see OO.ui.SearchInputWidget#onChange
*/
mw.widgets.SearchInputWidget.prototype.onChange = function () {
mw.widgets.SearchInputWidget.parent.prototype.onChange.call( this );
this.updateSearchIndicator();
};
/**
* Handle disable events.
*
* @param {boolean} disabled Element is disabled
* @private
*/
mw.widgets.SearchInputWidget.prototype.onDisable = function () {
this.updateSearchIndicator();
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.setReadOnly = function ( state ) {
mw.widgets.SearchInputWidget.parent.prototype.setReadOnly.call( this, state );
this.updateSearchIndicator();
return this;
};
/**
@ -116,11 +160,13 @@
};
/**
* @inheritdoc OO.ui.mixin.LookupElement
* @inheritdoc mw.widgets.TitleInputWidget
*/
mw.widgets.SearchInputWidget.prototype.getLookupCacheDataFromResponse = function ( response ) {
var resp;
// mw.widgets.TitleInputWidget uses response.query, which doesn't exist for opensearch,
// so return the whole response (titles only, and links)
resp = {
data: response || {},
metadata: {
@ -184,13 +230,10 @@
};
/**
* @inheritdoc OO.ui.mixin.LookupElement
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.onLookupMenuItemChoose = function ( item ) {
this.closeLookupMenu();
this.setLookupsDisabled( true );
this.setValue( item.getData() );
this.setLookupsDisabled( !this.suggestions );
mw.widgets.SearchInputWidget.prototype.onLookupMenuItemChoose = function () {
mw.widgets.SearchInputWidget.parent.prototype.onLookupMenuItemChoose.apply( this, arguments );
if ( this.performSearchOnClick ) {
this.$element.closest( 'form' ).submit();
@ -198,10 +241,12 @@
};
/**
* @inheritdoc OO.ui.mixin.LookupElement
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getLookupMenuOptionsFromData = function ( response ) {
var items = this.getOptionsFromData( response );
mw.widgets.SearchInputWidget.prototype.getLookupMenuOptionsFromData = function () {
var items = mw.widgets.SearchInputWidget.parent.prototype.getLookupMenuOptionsFromData.apply(
this, arguments
);
this.lastLookupItems = items.map( function ( item ) {
return item.data;
@ -210,21 +255,4 @@
return items;
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.focus = function () {
var retval;
// Prevent programmatic focus from opening the menu
this.setLookupsDisabled( true );
// Parent method
retval = mw.widgets.SearchInputWidget.parent.prototype.focus.apply( this, arguments );
this.setLookupsDisabled( !this.suggestions );
return retval;
};
}( jQuery, mediaWiki ) );