mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWMoreParametersResultWidget.js
Thiemo Kreuz aa556e3ef8 Update and fix all @param config and @cfg documentation
I tried to review all of them. Some of the changes I did:
* Make sure the `config` parameter is not marked as optional
  when it is not.
* Make sure default values are mentioned.
* List individual `@cfg` options when it makes sense.

Note I don't list all options a class could accept (e.g. via all
its parent classes and mixins). That's too much. Instead I checked
how a class is actually used and list only these options.

Even then I don't list everything, e.g. unspecific options
like "classes" that can be used pretty much everywhere.

Change-Id: Idf4fbe1dc3608ace277df9e385f2f140df3a2f50
2021-09-12 12:35:27 +00:00

47 lines
1.2 KiB
JavaScript

/*!
* VisualEditor UserInterface MWMoreParametersResultWidget class.
*
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWMoreParametersResultWidget object.
*
* @class
* @extends OO.ui.DecoratedOptionWidget
*
* @constructor
* @param {Object} config
* @cfg {Object} data
* @cfg {number} data.remainder Number of remaining items currently not shown
*/
ve.ui.MWMoreParametersResultWidget = function VeUiMWMoreParametersResultWidget( config ) {
// Configuration initialization
config = ve.extendObject( { icon: 'parameter-set' }, config );
// Parent constructor
ve.ui.MWMoreParametersResultWidget.super.call( this, config );
// Initialization
this.$element.addClass( 've-ui-mwMoreParametersResultWidget' );
this.setLabel( this.buildLabel() );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWMoreParametersResultWidget, OO.ui.DecoratedOptionWidget );
/* Methods */
/**
* Build the label element
*
* @return {jQuery}
*/
ve.ui.MWMoreParametersResultWidget.prototype.buildLabel = function () {
return $( '<div>' )
.addClass( 've-ui-mwMoreParametersResultWidget-label' )
.text( ve.msg( 'visualeditor-parameter-search-more', this.data.remainder ) );
};