mediawiki-extensions-Cite/modules/ve-cite/ve.ui.MWReferenceGroupInputWidget.js
Adam Wight 73c90a0e7d Clean up and fix some jsdoc annotations
Some of the annotations were used in a way that confused jsdoc.  This
cleans up redundant annotations and uses more canonical tags.

These changes cause all classes to now appear in the generated pages.

Includes linking to external docs.

Bug: T358641
Change-Id: Iaee1dadcc19a70c27839d0d27dfa6a07a70fb46b
2024-02-29 13:05:42 +01:00

57 lines
1.5 KiB
JavaScript

'use strict';
/*!
* VisualEditor UserInterface MWReferenceGroupInput class.
*
* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
* @license MIT
*/
/**
* Creates an ve.ui.MWReferenceGroupInput object.
*
* @constructor
* @extends OO.ui.ComboBoxInputWidget
* @param {Object} [config] Configuration options
* @cfg {string} emptyGroupName Label of the placeholder item
*/
ve.ui.MWReferenceGroupInputWidget = function VeUiMWReferenceGroupInputWidget( config ) {
config = config || {};
this.emptyGroupName = config.emptyGroupName;
// Parent constructor
ve.ui.MWReferenceGroupInputWidget.super.call(
this,
ve.extendObject( { placeholder: config.emptyGroupName }, config )
);
this.$element.addClass( 've-ui-mwReferenceGroupInputWidget' );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWReferenceGroupInputWidget, OO.ui.ComboBoxInputWidget );
/* Methods */
/**
* Populate the reference group menu
*
* @param {ve.dm.InternalList} internalList Internal list with which to populate the menu
*/
ve.ui.MWReferenceGroupInputWidget.prototype.populateMenu = function ( internalList ) {
const items = [ new OO.ui.MenuOptionWidget( {
data: '',
label: this.emptyGroupName,
flags: 'emptyGroupPlaceholder'
} ) ];
for ( const groupName in internalList.getNodeGroups() ) {
const match = groupName.match( /^mwReference\/(.+)/ );
if ( match ) {
items.push( new OO.ui.MenuOptionWidget( { data: match[ 1 ], label: match[ 1 ] } ) );
}
}
this.menu.clearItems().addItems( items ).toggle( false );
};