mediawiki-extensions-Visual.../modules/ve-mw/ui/elements/ve.ui.MWFloatingHelpElement.js
Novem Linguae 9ffbfc77cd JSDoc: convert @cfg to @param
Bug: T250843
Change-Id: I53ef4fa4a65b017eec90cc1f2cbb7e7f0681e317
2024-05-26 21:59:02 -07:00

74 lines
2 KiB
JavaScript

/*!
* VisualEditor UserInterface MWFloatingHelpElement class.
*
* @copyright See AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Question-mark button which floats over content, currently used in the
* template dialog. Clicking pops up a help screen.
*
* @class
* @extends OO.ui.Element
*
* @constructor
* @param {Object} config
* @param {string} config.label
* @param {jQuery} config.$message
*/
ve.ui.MWFloatingHelpElement = function VeUiMWFloatingHelpElement( config ) {
// Parent constructor
ve.ui.MWFloatingHelpElement.super.call( this, config );
this.helpDialog = new ve.ui.MWFloatingHelpDialog( config );
this.helpButton = new OO.ui.ButtonWidget( {
icon: 'help',
label: config.label,
title: config.title,
invisibleLabel: true,
flags: 'progressive',
rel: 'help',
classes: [ 've-ui-mwFloatingHelpElement-toggle' ]
} ).connect(
this, { click: 'onClick' }
);
this.windowManager = new OO.ui.WindowManager();
this.windowManager.addWindows( [ this.helpDialog ] );
this.windowManager.$element.addClass( 've-ui-mwFloatingHelpElement-windowManager' );
if ( OO.ui.isMobile() ) {
$( OO.ui.getTeleportTarget() ).append( this.windowManager.$element );
} else {
this.$element.append( this.windowManager.$element );
}
this.$element
.addClass( 've-ui-mwFloatingHelpElement' )
.append( this.helpButton.$element );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWFloatingHelpElement, OO.ui.Element );
/* Methods */
ve.ui.MWFloatingHelpElement.prototype.onClick = function () {
if ( !this.helpButton.hasFlag( 'primary' ) ) {
const window = this.windowManager.openWindow( this.helpDialog );
window.opening.then( this.updateButton.bind( this, true ) );
window.closing.then( this.updateButton.bind( this, false ) );
} else {
this.windowManager.closeWindow( this.helpDialog );
}
};
ve.ui.MWFloatingHelpElement.prototype.updateButton = function ( isOpen ) {
this.helpButton
.setIcon( isOpen ? 'expand' : 'help' )
.setFlags( { primary: isOpen } );
};