wikimedia/mediawiki-extensions-VisualEditor

View on GitHub
modules/ve-mw/ui/dialogs/ve.ui.MWFloatingHelpDialog.js

Summary

Maintainability
A
45 mins
Test Coverage
/*!
 * VisualEditor user interface MWFloatingHelpDialog class.
 *
 * @copyright See AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Popup help dialog launched by a {@see ve.ui.MWFloatingHelpElement}
 *
 * @class
 * @extends OO.ui.ProcessDialog
 *
 * @constructor
 * @param {Object} [config] Configuration options
 * @param {string} config.label
 * @param {jQuery} config.$message
 */
ve.ui.MWFloatingHelpDialog = function VeUiMWFloatingHelpDialog( config ) {
    // Parent constructor
    ve.ui.MWFloatingHelpDialog.super.call( this, config );

    this.label = config.label;
    this.$message = config.$message;
};

/* Inheritance */

OO.inheritClass( ve.ui.MWFloatingHelpDialog, OO.ui.ProcessDialog );

/* Static properties */

ve.ui.MWFloatingHelpDialog.static.name = 'floatingHelp';

ve.ui.MWFloatingHelpDialog.static.actions = [
    {
        label: OO.ui.deferMsg( 'visualeditor-dialog-action-cancel' ),
        flags: [ 'safe', 'close' ]
    }
];

/* Methods */

/**
 * @inheritdoc
 */
ve.ui.MWFloatingHelpDialog.prototype.initialize = function () {
    ve.ui.MWFloatingHelpDialog.super.prototype.initialize.call( this );
    const content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
    content.$element.append( this.$message );
    this.$body.append( content.$element );
    this.$foot.remove();
};

/**
 * @inheritdoc
 */
ve.ui.MWFloatingHelpDialog.prototype.getSetupProcess = function ( data ) {
    return ve.ui.MWFloatingHelpDialog.super.prototype.getSetupProcess.call( this, data ).next( () => {
        this.title.setLabel( this.label );
    } );
};

ve.ui.MWFloatingHelpDialog.prototype.getSizeProperties = function () {
    const sizeProps = ve.ui.MWFloatingHelpDialog.super.prototype.getSizeProperties.call( this );
    if ( !OO.ui.isMobile() ) {
        return ve.extendObject( {}, sizeProps, { width: '350px', maxHeight: '50%' } );
    }
    return sizeProps;
};