mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-05 03:08:37 +00:00
01d8a8c7a4
Bug: T275761 Change-Id: I8d2c1b8ebdc2e20779d0207b1a2ebe6ce36c54e7
204 lines
6.7 KiB
JavaScript
204 lines
6.7 KiB
JavaScript
/*!
|
|
* VisualEditor user interface MWTemplatePlaceholderPage class.
|
|
*
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* MediaWiki transclusion dialog placeholder page.
|
|
*
|
|
* @class
|
|
* @extends OO.ui.PageLayout
|
|
*
|
|
* @constructor
|
|
* @param {ve.dm.MWTemplatePlaceholderModel} placeholder Template placeholder
|
|
* @param {string} name Unique symbolic name of page
|
|
* @param {Object} [config] Configuration options
|
|
* @cfg {jQuery} [$overlay] Overlay to render dropdowns in
|
|
*/
|
|
ve.ui.MWTemplatePlaceholderPage = function VeUiMWTemplatePlaceholderPage( placeholder, name, config ) {
|
|
var veConfig = mw.config.get( 'wgVisualEditorConfig' );
|
|
|
|
// Configuration initialization
|
|
config = ve.extendObject( {
|
|
scrollable: false
|
|
}, config );
|
|
|
|
// Parent constructor
|
|
ve.ui.MWTemplatePlaceholderPage.super.call( this, name, config );
|
|
|
|
// Properties
|
|
this.placeholder = placeholder;
|
|
|
|
this.addTemplateInput = new ve.ui.MWTemplateTitleInputWidget( {
|
|
$overlay: config.$overlay,
|
|
showDescriptions: true,
|
|
api: ve.init.target.getContentApi()
|
|
} )
|
|
.connect( this, {
|
|
change: 'onTemplateInputChange',
|
|
enter: 'onAddTemplate'
|
|
} );
|
|
|
|
this.addTemplateInput.getLookupMenu().connect( this, {
|
|
choose: 'onAddTemplate'
|
|
} );
|
|
|
|
this.addTemplateInput.$input.attr( 'aria-label', ve.msg( 'visualeditor-dialog-transclusion-add-template' ) );
|
|
|
|
this.addTemplateButton = new OO.ui.ButtonWidget( {
|
|
label: ve.msg( 'visualeditor-dialog-transclusion-add-template' ),
|
|
flags: [ 'progressive' ],
|
|
classes: [ 've-ui-mwTransclusionDialog-addButton' ],
|
|
disabled: true
|
|
} )
|
|
.connect( this, { click: 'onAddTemplate' } );
|
|
|
|
var addTemplateActionFieldLayout = new OO.ui.ActionFieldLayout(
|
|
this.addTemplateInput,
|
|
this.addTemplateButton,
|
|
{ align: 'top' }
|
|
);
|
|
|
|
var addTemplateFieldsetConfig = {
|
|
label: ve.msg( 'visualeditor-dialog-transclusion-placeholder' ),
|
|
icon: 'puzzle',
|
|
classes: [ 've-ui-mwTransclusionDialog-addTemplateFieldset' ],
|
|
items: [ addTemplateActionFieldLayout ]
|
|
};
|
|
|
|
// Temporary switch for verbose template search.
|
|
if ( mw.config.get( 'wgVisualEditorConfig' ).templateSearchImprovements ) {
|
|
var dialogTitle = this.placeholder.getTransclusion().parts.length === 1 ?
|
|
'visualeditor-dialog-transclusion-template-search' :
|
|
'visualeditor-dialog-transclusion-add-template';
|
|
|
|
// Temporary feedback message when templateSearchImprovements is true T284560
|
|
// TODO: remove when templateSearchImprovements are out of beta
|
|
var feedbackMessage = new ve.ui.MWDismissibleMessageWidget( {
|
|
message: mw.message( 'visualeditor-dialog-transclusion-feedback-message' )
|
|
} )
|
|
.connect( this, { close: 'focus' } );
|
|
|
|
addTemplateFieldsetConfig = ve.extendObject( addTemplateFieldsetConfig, {
|
|
// The following messages are used here:
|
|
// * visualeditor-dialog-transclusion-template-search
|
|
// * visualeditor-dialog-transclusion-add-template
|
|
label: ve.msg( dialogTitle ),
|
|
help: ve.msg( 'visualeditor-dialog-transclusion-template-search-help' ),
|
|
helpInline: true,
|
|
// TODO: remove this line when templateSearchImprovements are out of beta
|
|
items: [].concat( [ feedbackMessage ], addTemplateFieldsetConfig.items )
|
|
} );
|
|
}
|
|
this.addTemplateFieldset = new OO.ui.FieldsetLayout( addTemplateFieldsetConfig );
|
|
|
|
// Initialization
|
|
this.$element
|
|
.addClass( 've-ui-mwTemplatePlaceholderPage' )
|
|
.append( this.addTemplateFieldset.$element );
|
|
|
|
if ( !veConfig.transclusionDialogNewSidebar ) {
|
|
this.removeButton = new OO.ui.ButtonWidget( {
|
|
framed: false,
|
|
icon: 'trash',
|
|
title: ve.msg( 'visualeditor-dialog-transclusion-remove-template' ),
|
|
flags: [ 'destructive' ],
|
|
classes: [ 've-ui-mwTransclusionDialog-removeButton' ]
|
|
} )
|
|
.connect( this, { click: 'onRemoveButtonClick' } );
|
|
|
|
if ( this.placeholder.getTransclusion().parts.length === 1 ) {
|
|
this.removeButton.toggle( false );
|
|
}
|
|
this.$element.append( this.removeButton.$element );
|
|
}
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ui.MWTemplatePlaceholderPage, OO.ui.PageLayout );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ui.MWTemplatePlaceholderPage.prototype.setOutlineItem = function () {
|
|
// Parent method
|
|
ve.ui.MWTemplatePlaceholderPage.super.prototype.setOutlineItem.apply( this, arguments );
|
|
|
|
var dialogTitle = ( this.placeholder.getTransclusion().parts.length === 1 &&
|
|
mw.config.get( 'wgVisualEditorConfig' ).templateSearchImprovements ) ?
|
|
'visualeditor-dialog-transclusion-template-search' :
|
|
'visualeditor-dialog-transclusion-add-template';
|
|
|
|
if ( this.outlineItem ) {
|
|
this.outlineItem
|
|
.setIcon( 'puzzle' )
|
|
.setMovable( true )
|
|
.setRemovable( true )
|
|
.setFlags( [ 'placeholder' ] )
|
|
// The following messages are used here:
|
|
// * visualeditor-dialog-transclusion-template-search
|
|
// * visualeditor-dialog-transclusion-add-template
|
|
.setLabel( ve.msg( dialogTitle ) );
|
|
}
|
|
};
|
|
|
|
ve.ui.MWTemplatePlaceholderPage.prototype.focus = function () {
|
|
// The parent method would focus the first element, which might be the message widget
|
|
this.addTemplateInput.focus();
|
|
|
|
// HACK: Set the width of the lookupMenu to the width of the input
|
|
// TODO: This should be handled upstream in OOUI
|
|
this.addTemplateInput.lookupMenu.width = this.addTemplateInput.$input[ 0 ].clientWidth;
|
|
};
|
|
|
|
ve.ui.MWTemplatePlaceholderPage.prototype.onAddTemplate = function () {
|
|
var transclusion = this.placeholder.getTransclusion(),
|
|
menu = this.addTemplateInput.getLookupMenu();
|
|
|
|
if ( menu.isVisible() ) {
|
|
menu.chooseItem( menu.findSelectedItem() );
|
|
}
|
|
var name = this.addTemplateInput.getMWTitle();
|
|
if ( !name ) {
|
|
// Invalid titles return null, so abort here.
|
|
return;
|
|
}
|
|
|
|
// TODO tracking will only be implemented temporarily to answer questions on
|
|
// template usage for the Technical Wishes topic area see T258917
|
|
var event = {
|
|
action: 'add-template',
|
|
// eslint-disable-next-line camelcase
|
|
template_names: [ name.getPrefixedText() ]
|
|
};
|
|
var editCountBucket = mw.config.get( 'wgUserEditCountBucket' );
|
|
if ( editCountBucket !== null ) {
|
|
// eslint-disable-next-line camelcase
|
|
event.user_edit_count_bucket = editCountBucket;
|
|
}
|
|
mw.track( 'event.VisualEditorTemplateDialogUse', event );
|
|
|
|
var part = ve.dm.MWTemplateModel.newFromName( transclusion, name );
|
|
transclusion.replacePart( this.placeholder, part );
|
|
this.addTemplateInput.pushPending();
|
|
// abort pending lookups, also, so the menu can't appear after we've left the page
|
|
this.addTemplateInput.closeLookupMenu();
|
|
this.addTemplateButton.setDisabled( true );
|
|
if ( this.removeButton ) {
|
|
this.removeButton.setDisabled( true );
|
|
}
|
|
};
|
|
|
|
ve.ui.MWTemplatePlaceholderPage.prototype.onTemplateInputChange = function () {
|
|
this.addTemplateButton.setDisabled( this.addTemplateInput.getMWTitle() === null );
|
|
};
|
|
|
|
ve.ui.MWTemplatePlaceholderPage.prototype.onRemoveButtonClick = function () {
|
|
this.placeholder.remove();
|
|
};
|