@ckeditor/ckeditor5-paste-from-office
Version:
Paste from Office feature for CKEditor 5.
72 lines (71 loc) • 3 kB
JavaScript
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module paste-from-office/pastefromoffice
*/
import { Plugin } from 'ckeditor5/src/core.js';
import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
import MSWordNormalizer from './normalizers/mswordnormalizer.js';
import GoogleDocsNormalizer from './normalizers/googledocsnormalizer.js';
import GoogleSheetsNormalizer from './normalizers/googlesheetsnormalizer.js';
import { parseHtml } from './filters/parse.js';
/**
* The Paste from Office plugin.
*
* This plugin handles content pasted from Office apps and transforms it (if necessary)
* to a valid structure which can then be understood by the editor features.
*
* Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~Normalizer normalizers}.
* This plugin includes following normalizers:
* * {@link module:paste-from-office/normalizers/mswordnormalizer~MSWordNormalizer Microsoft Word normalizer}
* * {@link module:paste-from-office/normalizers/googledocsnormalizer~GoogleDocsNormalizer Google Docs normalizer}
*
* For more information about this feature check the {@glink api/paste-from-office package page}.
*/
export default class PasteFromOffice extends Plugin {
/**
* @inheritDoc
*/
static get pluginName() {
return 'PasteFromOffice';
}
/**
* @inheritDoc
*/
static get requires() {
return [ClipboardPipeline];
}
/**
* @inheritDoc
*/
init() {
const editor = this.editor;
const clipboardPipeline = editor.plugins.get('ClipboardPipeline');
const viewDocument = editor.editing.view.document;
const normalizers = [];
const hasMultiLevelListPlugin = this.editor.plugins.has('MultiLevelList');
normalizers.push(new MSWordNormalizer(viewDocument, hasMultiLevelListPlugin));
normalizers.push(new GoogleDocsNormalizer(viewDocument));
normalizers.push(new GoogleSheetsNormalizer(viewDocument));
clipboardPipeline.on('inputTransformation', (evt, data) => {
if (data._isTransformedWithPasteFromOffice) {
return;
}
const codeBlock = editor.model.document.selection.getFirstPosition().parent;
if (codeBlock.is('element', 'codeBlock')) {
return;
}
const htmlString = data.dataTransfer.getData('text/html');
const activeNormalizer = normalizers.find(normalizer => normalizer.isActive(htmlString));
if (activeNormalizer) {
if (!data._parsedData) {
data._parsedData = parseHtml(htmlString, viewDocument.stylesProcessor);
}
activeNormalizer.execute(data);
data._isTransformedWithPasteFromOffice = true;
}
}, { priority: 'high' });
}
}