Page MenuHomeWickedGov Phorge
Files F1432031

mw.widgets.UserInputWidget.js
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

mw.widgets.UserInputWidget.js
View Options

/*!
* MediaWiki Widgets - UserInputWidget class.
*
* @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
( function () {
/**
* @classdesc User input widget.
*
* @class
* @extends OO.ui.TextInputWidget
* @mixes OO.ui.mixin.LookupElement
*
* @constructor
* @description Create a mw.widgets.UserInputWidget object.
* @param {Object} [config] Configuration options
* @param {number} [config.limit=10] Number of results to show
* @param {boolean} [config.excludenamed] Whether to exclude named users or not
* @param {boolean} [config.excludetemp] Whether to exclude temporary users or not
* @param {mw.Api} [config.api] API object to use, creates a default mw.Api instance if not specified
*/
mw.widgets.UserInputWidget = function MwWidgetsUserInputWidget( config ) {
// Config initialization
config = config || {};
// Parent constructor
mw.widgets.UserInputWidget.super.call( this, Object.assign( {}, config, { autocomplete: false } ) );
// Mixin constructors
OO.ui.mixin.LookupElement.call( this, config );
// Properties
this.limit = config.limit || 10;
this.excludeNamed = config.excludenamed || false;
this.excludeTemp = config.excludetemp || false;
this.api = config.api || new mw.Api();
// Initialization
this.$element.addClass( 'mw-widget-userInputWidget' );
this.lookupMenu.$element.addClass( 'mw-widget-userInputWidget-menu' );
};
/* Setup */
OO.inheritClass( mw.widgets.UserInputWidget, OO.ui.TextInputWidget );
OO.mixinClass( mw.widgets.UserInputWidget, OO.ui.mixin.LookupElement );
/* Methods */
/**
* Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
*
* @param {OO.ui.MenuOptionWidget} item Selected item
*/
mw.widgets.UserInputWidget.prototype.onLookupMenuChoose = function ( item ) {
this.closeLookupMenu();
this.setLookupsDisabled( true );
this.setValue( item.getData() );
this.setLookupsDisabled( false );
};
/**
* @inheritdoc
*/
mw.widgets.UserInputWidget.prototype.focus = function () {
// Prevent programmatic focus from opening the menu
this.setLookupsDisabled( true );
// Parent method
const retval = mw.widgets.UserInputWidget.super.prototype.focus.apply( this, arguments );
this.setLookupsDisabled( false );
return retval;
};
/**
* @inheritdoc
*/
mw.widgets.UserInputWidget.prototype.getLookupRequest = function () {
return this.api.get( {
action: 'query',
list: 'allusers',
auprefix: this.value,
aulimit: this.limit,
auexcludenamed: this.excludeNamed,
auexcludetemp: this.excludeTemp
} );
};
/**
* Get lookup cache item from server response data.
*
* @method
* @param {any} response Response from server
* @return {Object}
*/
mw.widgets.UserInputWidget.prototype.getLookupCacheDataFromResponse = function ( response ) {
return response.query.allusers || {};
};
/**
* Get list of menu items from a server response.
*
* @param {Object} data Query result
* @return {OO.ui.MenuOptionWidget[]} Menu items
*/
mw.widgets.UserInputWidget.prototype.getLookupMenuOptionsFromData = function ( data ) {
const items = [];
for ( let i = 0, len = data.length; i < len; i++ ) {
const user = data[ i ] || {};
items.push( new OO.ui.MenuOptionWidget( {
label: user.name,
data: user.name
} ) );
}
return items;
};
}() );

File Metadata

Mime Type
text/plain
Expires
Sat, May 16, 21:21 (1 d, 11 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
53/c3/00a59b6589e3663c4fdaaa27ef1e
Default Alt Text
mw.widgets.UserInputWidget.js (3 KB)

Event Timeline