/** * @module mermaid/mermaidediting */ import { Plugin } from 'ckeditor5/src/core'; import { toWidget } from 'ckeditor5/src/widget'; import mermaid from 'mermaid/dist/mermaid'; import { debounce } from 'lodash-es'; import MermaidPreviewCommand from './commands/mermaidPreviewCommand'; import MermaidSourceViewCommand from './commands/mermaidSourceViewCommand'; import MermaidSplitViewCommand from './commands/mermaidSplitViewCommand'; import InsertMermaidCommand from './commands/insertMermaidCommand'; // Time in milliseconds. const DEBOUNCE_TIME = 300; /* global window */ export default class MermaidEditing extends Plugin { /** * @inheritDoc */ static get pluginName() { return 'MermaidEditing'; } /** * @inheritDoc */ init() { this._registerCommands(); this._defineConverters(); } /** * @inheritDoc */ afterInit() { this.editor.model.schema.register( 'mermaid', { allowAttributes: [ 'displayMode', 'source' ], allowWhere: '$block', isObject: true } ); } /** * @inheritDoc */ _registerCommands() { const editor = this.editor; editor.commands.add( 'mermaidPreviewCommand', new MermaidPreviewCommand( editor ) ); editor.commands.add( 'mermaidSplitViewCommand', new MermaidSplitViewCommand( editor ) ); editor.commands.add( 'mermaidSourceViewCommand', new MermaidSourceViewCommand( editor ) ); editor.commands.add( 'insertMermaidCommand', new InsertMermaidCommand( editor ) ); } /** * Adds converters. * * @private */ _defineConverters() { const editor = this.editor; editor.data.downcastDispatcher.on( 'insert:mermaid', this._mermaidDataDowncast.bind( this ) ); editor.editing.downcastDispatcher.on( 'insert:mermaid', this._mermaidDowncast.bind( this ) ); editor.editing.downcastDispatcher.on( 'attribute:source:mermaid', this._sourceAttributeDowncast.bind( this ) ); editor.data.upcastDispatcher.on( 'element:code', this._mermaidUpcast.bind( this ), { priority: 'high' } ); editor.conversion.for( 'editingDowncast' ).attributeToAttribute( { model: { name: 'mermaid', key: 'displayMode' }, view: modelAttributeValue => ( { key: 'class', value: 'ck-mermaid__' + modelAttributeValue + '-mode' } ) } ); } /** * * @private * @param {*} evt * @param {*} data * @param {*} conversionApi */ _mermaidDataDowncast( evt, data, conversionApi ) { const model = this.editor.model; const { writer, mapper } = conversionApi; if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) { return; } const targetViewPosition = mapper.toViewPosition( model.createPositionBefore( data.item ) ); // For downcast we're using only language-mermaid class. We don't set class to `mermaid language-mermaid` as // multiple markdown converters that we have seen are using only `language-mermaid` class and not `mermaid` alone. const code = writer.createContainerElement( 'code', { class: 'language-mermaid' } ); const pre = writer.createContainerElement( 'pre', { spellcheck: 'false' } ); const sourceTextNode = writer.createText( data.item.getAttribute( 'source' ) ); writer.insert( model.createPositionAt( code, 'end' ), sourceTextNode ); writer.insert( model.createPositionAt( pre, 'end' ), code ); writer.insert( targetViewPosition, pre ); mapper.bindElements( data.item, code ); } /** * * @private * @param {*} evt * @param {*} data * @param {*} conversionApi */ _mermaidDowncast( evt, data, conversionApi ) { const { writer, mapper, consumable } = conversionApi; const { editor } = this; const { model, t } = editor; const that = this; if ( !consumable.consume( data.item, 'insert' ) ) { return; } const targetViewPosition = mapper.toViewPosition( model.createPositionBefore( data.item ) ); const wrapperAttributes = { class: [ 'ck-mermaid__wrapper' ] }; const textareaAttributes = { class: [ 'ck-mermaid__editing-view' ], placeholder: t( 'Insert mermaid source code' ), 'data-cke-ignore-events': true }; const wrapper = writer.createContainerElement( 'div', wrapperAttributes ); const editingContainer = writer.createUIElement( 'textarea', textareaAttributes, createEditingTextarea ); const previewContainer = writer.createUIElement( 'div', { class: [ 'ck-mermaid__preview' ] }, createMermaidPreview ); writer.insert( writer.createPositionAt( wrapper, 'start' ), previewContainer ); writer.insert( writer.createPositionAt( wrapper, 'start' ), editingContainer ); writer.insert( targetViewPosition, wrapper ); mapper.bindElements( data.item, wrapper ); return toWidget( wrapper, writer, { widgetLabel: t( 'Mermaid widget' ), hasSelectionHandle: true } ); function createEditingTextarea( domDocument ) { const domElement = this.toDomElement( domDocument ); domElement.value = data.item.getAttribute( 'source' ); const debouncedListener = debounce( event => { editor.model.change( writer => { writer.setAttribute( 'source', event.target.value, data.item ); } ); }, DEBOUNCE_TIME ); domElement.addEventListener( 'input', debouncedListener ); domElement.addEventListener( 'focus', () => { const model = editor.model; const selectedElement = model.document.selection.getSelectedElement(); // Move the selection onto the mermaid widget if it's currently not selected. if ( selectedElement !== data.item ) { model.change( writer => writer.setSelection( data.item, 'on' ) ); } }, true ); return domElement; } function createMermaidPreview( domDocument ) { // Taking the text from the wrapper container element for now const mermaidSource = data.item.getAttribute( 'source' ); const domElement = this.toDomElement( domDocument ); domElement.innerHTML = mermaidSource; window.setTimeout( () => { // @todo: by the looks of it the domElement needs to be hooked to tree in order to allow for rendering. that._renderMermaid( domElement ); }, 100 ); return domElement; } } /** * * @param {*} evt * @param {*} data * @param {*} conversionApi * @returns */ _sourceAttributeDowncast( evt, data, conversionApi ) { // @todo: test whether the attribute was consumed. const newSource = data.attributeNewValue; const domConverter = this.editor.editing.view.domConverter; if ( newSource ) { const mermaidView = conversionApi.mapper.toViewElement( data.item ); for ( const child of mermaidView.getChildren() ) { if ( child.name === 'textarea' && child.hasClass( 'ck-mermaid__editing-view' ) ) { const domEditingTextarea = domConverter.viewToDom( child, window.document ); if ( domEditingTextarea.value != newSource ) { domEditingTextarea.value = newSource; } } else if ( child.name === 'div' && child.hasClass( 'ck-mermaid__preview' ) ) { // @todo: we could optimize this and not refresh mermaid if widget is in source mode. const domPreviewWrapper = domConverter.viewToDom( child, window.document ); // console.log( child, domPreviewWrapper ); if ( domPreviewWrapper ) { domPreviewWrapper.innerHTML = newSource; domPreviewWrapper.removeAttribute( 'data-processed' ); this._renderMermaid( domPreviewWrapper ); } } } } } /** * * @private * @param {*} evt * @param {*} data * @param {*} conversionApi */ _mermaidUpcast( evt, data, conversionApi ) { const viewCodeElement = data.viewItem; const hasPreElementParent = !viewCodeElement.parent || !viewCodeElement.parent.is( 'element', 'pre' ); const hasCodeAncestors = data.modelCursor.findAncestor( 'code' ); const { consumable, writer } = conversionApi; if ( !viewCodeElement.hasClass( 'language-mermaid' ) || hasPreElementParent || hasCodeAncestors ) { return; } if ( !consumable.test( viewCodeElement, { name: true } ) ) { return; } const mermaidSource = Array.from( viewCodeElement.getChildren() ) .filter( item => item.is( '$text' ) ) .map( item => item.data ) .join( '' ); const mermaidElement = writer.createElement( 'mermaid', { source: mermaidSource, displayMode: 'split' } ); // Let's try to insert mermaid element. if ( !conversionApi.safeInsert( mermaidElement, data.modelCursor ) ) { return; } consumable.consume( viewCodeElement, { name: true } ); conversionApi.updateConversionResult( mermaidElement, data ); } /** * Renders Mermaid in a given `domElement`. Expect this domElement to have mermaid * source set as text content. * * @param {HTMLElement} domElement */ _renderMermaid( domElement ) { mermaid.init( undefined, domElement ); } }