mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWGalleryGroupWidget.js

/*!
 * VisualEditor user interface MWGalleryGroupWidget class.
 *
 * @copyright See AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Draggable group widget for reordering images in the MWGalleryDialog.
 *
 * @class
 * @extends OO.ui.Widget
 * @mixins OO.ui.mixin.DraggableGroupElement
 *
 * @constructor
 * @param {Object} [config] Configuration options
 * @cfg {string} [orientation='vertical']
 */
ve.ui.MWGalleryGroupWidget = function VeUiMWGalleryGroupWidget( config ) {
	// Configuration initialization
	config = config || {};

	// Parent constructor
	ve.ui.MWGalleryGroupWidget.super.apply( this, arguments );

	// Mixin constructors
	OO.ui.mixin.DraggableGroupElement.call( this, ve.extendObject( {}, config, { $group: this.$element } ) );

	// Events
	this.aggregate( {
		edit: 'editItem'
	} );
};

/* Inheritance */

OO.inheritClass( ve.ui.MWGalleryGroupWidget, OO.ui.Widget );

OO.mixinClass( ve.ui.MWGalleryGroupWidget, OO.ui.mixin.DraggableGroupElement );

/* Events */

/**
 * @event editItem
 */
Make dialog for editing galleries Make new graphical interface for editing existing galleries and adding new galleries. NB The dialog does not yet support rich text in the image captions, nor does it provide separate fields for e.g. link, alt text, etc. These are dependent on parsing the text within the tag, which is yet to be implemented by Parsoid. For now, these attributes should be specified in wikitext in the image-specific caption field. Bug: T45037 Change-Id: I2b4082e991268241a15b9bbd6d85c94cdc2185f2 2016-03-08 21:14:12 +00:00			`/*!`
			`* VisualEditor user interface MWGalleryGroupWidget class.`
			`*`
Move verbose copyright message to AUTHORS.txt Avoids having to update the date in every file every year, which we stopped doing. Change-Id: I7bf7aa0937eef911e00772470091753a7b06fd3d 2023-12-01 16:06:11 +00:00			`* @copyright See AUTHORS.txt`
Make dialog for editing galleries Make new graphical interface for editing existing galleries and adding new galleries. NB The dialog does not yet support rich text in the image captions, nor does it provide separate fields for e.g. link, alt text, etc. These are dependent on parsing the text within the tag, which is yet to be implemented by Parsoid. For now, these attributes should be specified in wikitext in the image-specific caption field. Bug: T45037 Change-Id: I2b4082e991268241a15b9bbd6d85c94cdc2185f2 2016-03-08 21:14:12 +00:00			`* @license The MIT License (MIT); see LICENSE.txt`
			`*/`

			`/**`
			`* Draggable group widget for reordering images in the MWGalleryDialog.`
			`*`
			`* @class`
			`* @extends OO.ui.Widget`
			`* @mixins OO.ui.mixin.DraggableGroupElement`
			`*`
			`* @constructor`
			`* @param {Object} [config] Configuration options`
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-11 08:05:31 +00:00			`* @cfg {string} [orientation='vertical']`
Make dialog for editing galleries Make new graphical interface for editing existing galleries and adding new galleries. NB The dialog does not yet support rich text in the image captions, nor does it provide separate fields for e.g. link, alt text, etc. These are dependent on parsing the text within the tag, which is yet to be implemented by Parsoid. For now, these attributes should be specified in wikitext in the image-specific caption field. Bug: T45037 Change-Id: I2b4082e991268241a15b9bbd6d85c94cdc2185f2 2016-03-08 21:14:12 +00:00			`*/`
			`ve.ui.MWGalleryGroupWidget = function VeUiMWGalleryGroupWidget( config ) {`
			`// Configuration initialization`
			`config = config \|\| {};`

			`// Parent constructor`
			`ve.ui.MWGalleryGroupWidget.super.apply( this, arguments );`

			`// Mixin constructors`
Prefere ve.extendObject over $.extend Change-Id: I37fef45701653cef08de9ec699865aa4fdf477bc 2021-11-15 17:25:51 +00:00			`OO.ui.mixin.DraggableGroupElement.call( this, ve.extendObject( {}, config, { $group: this.$element } ) );`
Make dialog for editing galleries Make new graphical interface for editing existing galleries and adding new galleries. NB The dialog does not yet support rich text in the image captions, nor does it provide separate fields for e.g. link, alt text, etc. These are dependent on parsing the text within the tag, which is yet to be implemented by Parsoid. For now, these attributes should be specified in wikitext in the image-specific caption field. Bug: T45037 Change-Id: I2b4082e991268241a15b9bbd6d85c94cdc2185f2 2016-03-08 21:14:12 +00:00
			`// Events`
			`this.aggregate( {`
			`edit: 'editItem'`
			`} );`
			`};`

			`/* Inheritance */`

			`OO.inheritClass( ve.ui.MWGalleryGroupWidget, OO.ui.Widget );`

			`OO.mixinClass( ve.ui.MWGalleryGroupWidget, OO.ui.mixin.DraggableGroupElement );`

			`/* Events */`

			`/**`
			`* @event editItem`
			`*/`