Page MenuHomeWickedGov Phorge
Files F4154199

mw.widgets.SearchInputWidget.js
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

mw.widgets.SearchInputWidget.js
View Options

/*!
* MediaWiki Widgets - SearchInputWidget class.
*
* @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
( function () {
/**
* @classdesc Search input widget.
*
* @class
* @extends mw.widgets.TitleInputWidget
*
* @constructor
* @description Create a mw.widgets.SearchInputWidget object.
* @param {Object} [config] Configuration options
* @param {boolean} [config.performSearchOnClick=true] If true, the script will start a search when-
* ever a user hits a suggestion. If false, the text of the suggestion is inserted into the
* text field only.
* @param {string} [config.dataLocation='header'] Where the search input field will be
* used (header or content).
*/
mw.widgets.SearchInputWidget = function MwWidgetsSearchInputWidget( config ) {
// The parent constructors will detach this from the DOM, and won't
// be reattached until after this function is completed. As such
// grab a handle here. If no config.$input is passed tracking of
// form submissions won't work.
const $form = config.$input ? config.$input.closest( 'form' ) : $();
config = Object.assign( {
icon: 'search',
maxLength: undefined,
showPendingRequest: false,
performSearchOnClick: true,
dataLocation: 'header'
}, config );
// Parent constructor
mw.widgets.SearchInputWidget.super.call( this, config );
// Initialization
this.$element.addClass( 'mw-widget-searchInputWidget' );
this.lookupMenu.$element.addClass( 'mw-widget-searchWidget-menu' );
this.lastLookupItems = [];
if ( config.dataLocation ) {
this.dataLocation = config.dataLocation;
}
if ( config.performSearchOnClick ) {
this.performSearchOnClick = config.performSearchOnClick;
}
this.setLookupsDisabled( !this.suggestions );
$form.on( 'submit', () => {
mw.track( 'mw.widgets.SearchInputWidget', {
action: 'submit-form',
numberOfResults: this.lastLookupItems.length,
$form: $form,
inputLocation: this.dataLocation || 'header',
index: this.lastLookupItems.indexOf(
this.$input.val()
)
} );
} );
this.connect( this, {
change: 'onChange'
} );
this.$element.addClass( 'oo-ui-textInputWidget-type-search' );
this.updateSearchIndicator();
this.connect( this, {
disable: 'onDisable'
} );
};
/* Setup */
OO.inheritClass( mw.widgets.SearchInputWidget, mw.widgets.TitleInputWidget );
/* Methods */
/**
* @inheritdoc
* @protected
*/
mw.widgets.SearchInputWidget.prototype.getInputElement = function () {
return $( '<input>' ).attr( 'type', 'search' );
};
/**
* @inheritdoc
*/
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' );
}
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.onChange = function () {
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.super.prototype.setReadOnly.call( this, state );
this.updateSearchIndicator();
return this;
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getSuggestionsPromise = function () {
const api = this.getApi();
// While the name is, for historical reasons, 'session-start', this indicates
// a new backend request is being performed.
mw.track( 'mw.widgets.SearchInputWidget', {
action: 'session-start'
} );
// reuse the searchSuggest function from mw.searchSuggest
const promise = mw.searchSuggest.request( api, this.getQueryValue(), () => {}, this.limit, this.getNamespace() );
// tracking purposes
promise.done( ( data, jqXHR ) => {
this.requestType = jqXHR.getResponseHeader( 'X-OpenSearch-Type' );
this.searchId = jqXHR.getResponseHeader( 'X-Search-ID' );
} );
return promise;
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getLookupCacheDataFromResponse = function ( response ) {
// mw.widgets.TitleInputWidget uses response.query, which doesn't exist for opensearch,
// so return the whole response (titles only, and links)
const resp = {
data: response || {},
metadata: {
type: this.requestType || 'unknown',
searchId: this.searchId || null,
query: this.getQueryValue()
}
};
this.requestType = undefined;
this.searchId = undefined;
return resp;
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getOptionsFromData = function ( data ) {
const items = [],
titles = data.data[ 1 ],
descriptions = data.data[ 2 ],
urls = data.data[ 3 ];
// eslint-disable-next-line no-jquery/no-each-util
$.each( titles, ( i, result ) => {
items.push( new mw.widgets.TitleOptionWidget(
this.getOptionWidgetData(
result,
// Create a result object that looks like the one from
// the parent's API query.
{
data: result,
url: urls[ i ],
imageUrl: null, // The JSON 'opensearch' API doesn't have images
description: descriptions[ i ],
missing: false,
redirect: false,
disambiguation: false
}
)
) );
} );
mw.track( 'mw.widgets.SearchInputWidget', {
action: 'impression-results',
numberOfResults: items.length,
resultSetType: data.metadata.type,
searchId: data.metadata.searchId,
query: data.metadata.query,
inputLocation: this.dataLocation || 'header'
} );
return items;
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.onLookupMenuChoose = function () {
mw.widgets.SearchInputWidget.super.prototype.onLookupMenuChoose.apply( this, arguments );
if ( this.performSearchOnClick ) {
this.$element.closest( 'form' ).trigger( 'submit' );
}
};
/**
* @inheritdoc
*/
mw.widgets.SearchInputWidget.prototype.getLookupMenuOptionsFromData = function () {
const items = mw.widgets.SearchInputWidget.super.prototype.getLookupMenuOptionsFromData.apply(
this, arguments
);
this.lastLookupItems = items.map( ( item ) => item.data );
return items;
};
}() );

File Metadata

Mime Type
text/plain
Expires
Aug 19 2026, 21:04 (7 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ad/ea/908cb54d36351c408a14a4f18312
Default Alt Text
mw.widgets.SearchInputWidget.js (6 KB)

Event Timeline