mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-12 22:46:34 +00:00
aa556e3ef8
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
85 lines
2.3 KiB
JavaScript
85 lines
2.3 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface MWCategoryItemWidget class.
|
|
*
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Creates an ve.ui.MWCategoryItemWidget object.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends OO.ui.ButtonWidget
|
|
* @mixins OO.ui.mixin.DraggableElement
|
|
*
|
|
* @constructor
|
|
* @param {Object} config
|
|
* @cfg {Object} item Category item
|
|
* @cfg {string} item.name Category name
|
|
* @cfg {string} item.value
|
|
* @cfg {string} [item.sortKey='']
|
|
* @cfg {ve.dm.MWCategoryMetaItem} item.metaItem
|
|
* @cfg {boolean} [hidden] Whether the category is hidden or not
|
|
* @cfg {boolean} [missing] Whether the category's description page is missing
|
|
* @cfg {string} [redirectTo] The name of the category this category's page redirects to.
|
|
*/
|
|
ve.ui.MWCategoryItemWidget = function VeUiMWCategoryItemWidget( config ) {
|
|
// Config initialization
|
|
config = ve.extendObject( { indicator: 'down' }, config );
|
|
|
|
// Parent constructor
|
|
ve.ui.MWCategoryItemWidget.super.call( this, config );
|
|
|
|
// Mixin constructors
|
|
OO.ui.mixin.DraggableElement.call( this, config );
|
|
|
|
// Properties
|
|
this.name = config.item.name;
|
|
this.value = config.item.value;
|
|
this.sortKey = config.item.sortKey || '';
|
|
this.metaItem = config.item.metaItem;
|
|
this.isHidden = config.hidden;
|
|
this.isMissing = config.missing;
|
|
|
|
// Initialization
|
|
this.setLabel( config.redirectTo || this.value );
|
|
if ( config.redirectTo ) {
|
|
ve.init.platform.linkCache.styleElement( mw.Title.newFromText(
|
|
config.redirectTo,
|
|
mw.config.get( 'wgNamespaceIds' ).category
|
|
).getPrefixedText(), this.$label );
|
|
} else {
|
|
ve.init.platform.linkCache.styleElement( this.name, this.$label );
|
|
}
|
|
|
|
// Events
|
|
this.on( 'click', this.onButtonClick.bind( this ) );
|
|
|
|
this.$element.addClass( 've-ui-mwCategoryItemWidget' );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ui.MWCategoryItemWidget, OO.ui.ButtonWidget );
|
|
|
|
OO.mixinClass( ve.ui.MWCategoryItemWidget, OO.ui.mixin.DraggableElement );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event togglePopupMenu
|
|
* @param {ve.ui.MWCategoryItemWidget} item Item to load into popup
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle button widget click events.
|
|
*
|
|
* @fires togglePopupMenu on click.
|
|
*/
|
|
ve.ui.MWCategoryItemWidget.prototype.onButtonClick = function () {
|
|
this.emit( 'togglePopupMenu', this );
|
|
};
|