mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 10:35:48 +00:00
2644c84cda
250ms gaps are pretty common when typing at a normal speed, resulting in a lot of (often expensive) API requests (e.g. T312319). For most use cases this level of responsiveness in the preview is not necessary. Change-Id: I6504567d4da02a66171ee35a9c4fd35c85136909
100 lines
2.7 KiB
JavaScript
100 lines
2.7 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface MWExtensionPreviewDialog class.
|
|
*
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Dialog for editing generic MediaWiki extensions with a preview.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends ve.ui.MWExtensionDialog
|
|
*
|
|
* @constructor
|
|
* @param {Object} [config] Configuration options
|
|
*/
|
|
ve.ui.MWExtensionPreviewDialog = function VeUiMWExtensionPreviewDialog() {
|
|
// Parent constructor
|
|
ve.ui.MWExtensionPreviewDialog.super.apply( this, arguments );
|
|
|
|
this.updatePreviewDebounced = ve.debounce( this.updatePreview.bind( this ), 1000 );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ui.MWExtensionPreviewDialog, ve.ui.MWExtensionDialog );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ui.MWExtensionPreviewDialog.prototype.initialize = function () {
|
|
// Parent method
|
|
ve.ui.MWExtensionPreviewDialog.super.prototype.initialize.call( this );
|
|
|
|
// Properties
|
|
this.previewNode = null;
|
|
this.previewElement = new ve.ui.MWPreviewElement();
|
|
|
|
// Initialization
|
|
this.$element.addClass( 've-ui-mwExtensionPreviewDialog' );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ui.MWExtensionPreviewDialog.prototype.getSetupProcess = function ( data ) {
|
|
return ve.ui.MWExtensionPreviewDialog.super.prototype.getSetupProcess.call( this, data )
|
|
.next( function () {
|
|
var element;
|
|
if ( this.selectedNode ) {
|
|
element = this.selectedNode.getClonedElement();
|
|
} else {
|
|
element = this.getNewElement();
|
|
}
|
|
var linearData = [ element, { type: '/' + element.type } ];
|
|
if ( ve.dm.nodeFactory.isNodeContent( element.type ) ) {
|
|
linearData = [ { type: 'paragraph' } ].concat( linearData, { type: '/paragraph' } );
|
|
}
|
|
// We assume that WindowAction pass
|
|
var doc = data.fragment.getDocument().cloneWithData( linearData.concat( [
|
|
{ type: 'internalList' },
|
|
{ type: '/internalList' }
|
|
] ) );
|
|
|
|
var rootNode = doc.getDocumentNode().children[ 0 ];
|
|
this.previewNode = doc.getNodesByType( element.type )[ 0 ];
|
|
this.previewElement.setModel( rootNode );
|
|
}, this );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ui.MWExtensionPreviewDialog.prototype.onChange = function () {
|
|
// Parent method
|
|
ve.ui.MWExtensionPreviewDialog.super.prototype.onChange.call( this );
|
|
|
|
this.updatePreviewDebounced();
|
|
};
|
|
|
|
/**
|
|
* Update the node rendering to reflect the current content in the dialog.
|
|
*/
|
|
ve.ui.MWExtensionPreviewDialog.prototype.updatePreview = function () {
|
|
var mwData = ve.copy( this.previewNode.getAttribute( 'mw' ) ),
|
|
doc = this.previewNode.getDocument();
|
|
|
|
this.updateMwData( mwData );
|
|
|
|
doc.commit(
|
|
ve.dm.TransactionBuilder.static.newFromAttributeChanges(
|
|
doc, this.previewNode.getOuterRange().start, { mw: mwData }
|
|
)
|
|
);
|
|
this.previewElement.updatePreview();
|
|
};
|