/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* Contains downcast (model-to-view) converters for {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}.
*
* @module engine/conversion/downcasthelpers
*/
import ModelRange from '../model/range';
import ModelSelection from '../model/selection';
import ModelElement from '../model/element';
import ViewAttributeElement from '../view/attributeelement';
import DocumentSelection from '../model/documentselection';
import ConversionHelpers from './conversionhelpers';
import { cloneDeep } from 'lodash-es';
import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
/**
* Downcast conversion helper functions.
*
* @extends module:engine/conversion/conversionhelpers~ConversionHelpers
*/
export default class DowncastHelpers extends ConversionHelpers {
/**
* Model element to view element conversion helper.
*
* This conversion results in creating a view element. For example, model `
Foo
` in the view. * * editor.conversion.for( 'downcast' ).elementToElement( { * model: 'paragraph', * view: 'p' * } ); * * editor.conversion.for( 'downcast' ).elementToElement( { * model: 'paragraph', * view: 'div', * converterPriority: 'high' * } ); * * editor.conversion.for( 'downcast' ).elementToElement( { * model: 'fancyParagraph', * view: { * name: 'p', * classes: 'fancy' * } * } ); * * editor.conversion.for( 'downcast' ).elementToElement( { * model: 'heading', * view: ( modelElement, conversionApi ) => { * const { writer } = conversionApi; * * return writer.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) ); * } * } ); * * The element-to-element conversion supports a reconversion mechanism. This is helpful in conversion to complex view structures where * multiple atomic element-to-element and attribute-to-attribute or attribute-to-element could be used. By specifying `triggerBy` * events you can trigger reconverting model to a full view tree structures at once. * * editor.conversion.for( 'downcast' ).elementToElement( { * model: 'complex', * view: ( modelElement, conversionApi ) => createComplexViewFromModel( modelElement, conversionApi ), * triggerBy: { * attributes: [ 'foo', 'bar' ], * children: [ 'slot' ] * } * } ); * * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter * to the conversion process. * * You can read more about element-to-element conversion in the * {@glink framework/guides/deep-dive/conversion/custom-element-conversion Custom element conversion} guide. * * @method #elementToElement * @param {Object} config Conversion configuration. * @param {String} config.model The name of the model element to convert. * @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view A view element definition or a function * that takes the model element and {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API} * as parameters and returns a view container element. * @param {Object} [config.triggerBy] Re-conversion triggers. At least one trigger must be defined. * @param {Array.
`.
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: 'source',
* view: 'src'
* } );
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: 'source',
* view: 'href',
* converterPriority: 'high'
* } );
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: {
* name: 'image',
* key: 'source'
* },
* view: 'src'
* } );
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: {
* name: 'styled',
* values: [ 'dark', 'light' ]
* },
* view: {
* dark: {
* key: 'class',
* value: [ 'styled', 'styled-dark' ]
* },
* light: {
* key: 'class',
* value: [ 'styled', 'styled-light' ]
* }
* }
* } );
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: 'styled',
* view: modelAttributeValue => ( {
* key: 'class',
* value: 'styled-' + modelAttributeValue
* } )
* } );
*
* **Note**: Downcasting to a style property requires providing `value` as an object:
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: 'lineHeight',
* view: modelAttributeValue => ( {
* key: 'style',
* value: {
* 'line-height': modelAttributeValue,
* 'border-bottom': '1px dotted #ba2'
* }
* } )
* } );
*
* See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
* to the conversion process.
*
* @method #attributeToAttribute
* @param {Object} config Conversion configuration.
* @param {String|Object} config.model The key of the attribute to convert from or a `{ key, values, [ name ] }` object describing
* the attribute key, possible values and, optionally, an element name to convert from.
* @param {String|Object|Function} config.view A view attribute key, or a `{ key, value }` object or a function that takes
* the model attribute value and {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API}
* as parameters and returns a `{ key, value }` object. If `key` is `'class'`, `value` can be a `String` or an
* array of `String`s. If `key` is `'style'`, `value` is an object with key-value pairs. In other cases, `value` is a `String`.
* If `config.model.values` is set, `config.view` should be an object assigning values from `config.model.values` to
* `{ key, value }` objects or a functions.
* @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
* @returns {module:engine/conversion/downcasthelpers~DowncastHelpers}
*/
attributeToAttribute( config ) {
return this.add( downcastAttributeToAttribute( config ) );
}
/**
* Model marker to view element conversion helper.
*
* **Note**: This method should be used only for editing downcast. For data downcast, use
* {@link #markerToData `#markerToData()`} that produces valid HTML data.
*
* This conversion results in creating a view element on the boundaries of the converted marker. If the converted marker
* is collapsed, only one element is created. For example, model marker set like this: `Foo bar
` in the view. * * editor.conversion.for( 'editingDowncast' ).markerToElement( { * model: 'search', * view: 'marker-search' * } ); * * editor.conversion.for( 'editingDowncast' ).markerToElement( { * model: 'search', * view: 'search-result', * converterPriority: 'high' * } ); * * editor.conversion.for( 'editingDowncast' ).markerToElement( { * model: 'search', * view: { * name: 'span', * attributes: { * 'data-marker': 'search' * } * } * } ); * * editor.conversion.for( 'editingDowncast' ).markerToElement( { * model: 'search', * view: ( markerData, conversionApi ) => { * const { writer } = conversionApi; * * return writer.createUIElement( 'span', { * 'data-marker': 'search', * 'data-start': markerData.isOpening * } ); * } * } ); * * If a function is passed as the `config.view` parameter, it will be used to generate both boundary elements. The function * receives the `data` object and {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API} * as a parameters and should return an instance of the * {@link module:engine/view/uielement~UIElement view UI element}. The `data` object and * {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi `conversionApi`} are passed from * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker}. Additionally, * the `data.isOpening` parameter is passed, which is set to `true` for the marker start boundary element, and `false` to * the marker end boundary element. * * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter * to the conversion process. * * @method #markerToElement * @param {Object} config Conversion configuration. * @param {String} config.model The name of the model marker (or model marker group) to convert. * @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view A view element definition or a function that * takes the model marker data and {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API} * as a parameters and returns a view UI element. * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority. * @returns {module:engine/conversion/downcasthelpers~DowncastHelpers} */ markerToElement( config ) { return this.add( downcastMarkerToElement( config ) ); } /** * Model marker to highlight conversion helper. * * This conversion results in creating a highlight on view nodes. For this kind of conversion, * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor} should be provided. * * For text nodes, a `` {@link module:engine/view/attributeelement~AttributeElement} is created and it wraps all text nodes * in the converted marker range. For example, a model marker set like this: `Foo bar
` in the view. * * {@link module:engine/view/containerelement~ContainerElement} may provide a custom way of handling highlight. Most often, * the element itself is given classes and attributes described in the highlight descriptor (instead of being wrapped in ``). * For example, a model marker set like this: `[
`
* in the view.
*
* For container elements, the conversion is two-step. While the converter processes the highlight descriptor and passes it
* to a container element, it is the container element instance itself that applies values from the highlight descriptor.
* So, in a sense, the converter takes care of stating what should be applied on what, while the element decides how to apply that.
*
* editor.conversion.for( 'downcast' ).markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
*
* editor.conversion.for( 'downcast' ).markerToHighlight( {
* model: 'comment',
* view: { classes: 'new-comment' },
* converterPriority: 'high'
* } );
*
* editor.conversion.for( 'downcast' ).markerToHighlight( {
* model: 'comment',
* view: ( data, converstionApi ) => {
* // Assuming that the marker name is in a form of comment:commentType.
* const commentType = data.markerName.split( ':' )[ 1 ];
*
* return {
* classes: [ 'comment', 'comment-' + commentType ]
* };
* }
* } );
*
* If a function is passed as the `config.view` parameter, it will be used to generate the highlight descriptor. The function
* receives the `data` object and {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API}
* as a parameters and should return a
* {@link module:engine/conversion/downcasthelpers~HighlightDescriptor highlight descriptor}.
* The `data` object properties are passed from {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker}.
*
* See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
* to the conversion process.
*
* @method #markerToHighlight
* @param {Object} config Conversion configuration.
* @param {String} config.model The name of the model marker (or model marker group) to convert.
* @param {module:engine/conversion/downcasthelpers~HighlightDescriptor|Function} config.view A highlight descriptor
* that will be used for highlighting or a function that takes the model marker data and
* {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API} as a parameters
* and returns a highlight descriptor.
* @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
* @returns {module:engine/conversion/downcasthelpers~DowncastHelpers}
*/
markerToHighlight( config ) {
return this.add( downcastMarkerToHighlight( config ) );
}
/**
* Model marker converter for data downcast.
*
* This conversion creates a representation for model marker boundaries in the view:
*
* * If the marker boundary is at a position where text nodes are allowed, then a view element with the specified tag name
* and `name` attribute is added at this position.
* * In other cases, a specified attribute is set on a view element that is before or after the marker boundary.
*
* Typically, marker names use the `group:uniqueId:otherData` convention. For example: `comment:e34zfk9k2n459df53sjl34:zx32c`.
* The default configuration for this conversion is that the first part is the `group` part and the rest of
* the marker name becomes the `name` part.
*
* Tag and attribute names and values are generated from the marker name:
*
* * Templates for attributes are `data-[group]-start-before="[name]"`, `data-[group]-start-after="[name]"`,
* `data-[group]-end-before="[name]"` and `data-[group]-end-after="[name]"`.
* * Templates for view elements are `<[group]-start name="[name]">` and `<[group]-end name="[name]">`.
*
* Attributes mark whether the given marker's start or end boundary is before or after the given element.
* Attributes `data-[group]-start-before` and `data-[group]-end-after` are favored.
* The other two are used when the former two cannot be used.
*
* The conversion configuration can take a function that will generate different group and name parts.
* If such function is set as the `config.view` parameter, it is passed a marker name and it is expected to return an object with two
* properties: `group` and `name`. If the function returns a falsy value, the conversion will not take place.
*
* Basic usage:
*
* // Using the default conversion.
* // In this case, all markers whose name starts with 'comment:' will be converted.
* // The `group` parameter will be set to `comment`.
* // The `name` parameter will be the rest of the marker name (without `:`).
* editor.conversion.for( 'dataDowncast' ).markerToData( {
* model: 'comment'
* } );
*
* An example of a view that may be generated by this conversion (assuming a marker with the name `comment:commentId:uid` marked
* by `[]`):
*
* // Model:
* Foo

Foo

[]* * // View: *Foo
* * Similarly, when a marker is collapsed after the last element: * * // Model: *Foo
* * // View: *Foo []
* * When there are multiple markers from the same group stored in the same attribute of the same element, their * name parts are put together in the attribute value, for example: `data-group-start-before="name1,name2,name3"`. * * Other examples of usage: * * // Using a custom function which is the same as the default conversion: * editor.conversion.for( 'dataDowncast' ).markerToData( { * model: 'comment' * view: markerName => ( { * group: 'comment', * name: markerName.substr( 8 ) // Removes 'comment:' part. * } ) * } ); * * // Using the converter priority: * editor.conversion.for( 'dataDowncast' ).markerToData( { * model: 'comment' * view: markerName => ( { * group: 'comment', * name: markerName.substr( 8 ) // Removes 'comment:' part. * } ), * converterPriority: 'high' * } ); * * This kind of conversion is useful for saving data into the database, so it should be used in the data conversion pipeline. * * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter * to the conversion process. * * @method #markerToData * @param {Object} config Conversion configuration. * @param {String} config.model The name of the model marker (or model marker group) to convert. * @param {Function} [config.view] A function that takes the model marker name and * {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi downcast conversion API} as a parameters * and returns an object with the `group` and `name` properties. * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority. * @returns {module:engine/conversion/downcasthelpers~DowncastHelpers} */ markerToData( config ) { return this.add( downcastMarkerToData( config ) ); } } /** * Function factory that creates a default downcast converter for text insertion changes. * * The converter automatically consumes the corresponding value from the consumables list and stops the event (see * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}). * * modelDispatcher.on( 'insert:$text', insertText() ); * * @returns {Function} Insert text event converter. */ export function insertText() { return ( evt, data, conversionApi ) => { if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) { return; } const viewWriter = conversionApi.writer; const viewPosition = conversionApi.mapper.toViewPosition( data.range.start ); const viewText = viewWriter.createText( data.item.data ); viewWriter.insert( viewPosition, viewText ); }; } /** * Function factory that creates a default downcast converter for node remove changes. * * modelDispatcher.on( 'remove', remove() ); * * @returns {Function} Remove event converter. */ export function remove() { return ( evt, data, conversionApi ) => { // Find view range start position by mapping model position at which the remove happened. const viewStart = conversionApi.mapper.toViewPosition( data.position ); const modelEnd = data.position.getShiftedBy( data.length ); const viewEnd = conversionApi.mapper.toViewPosition( modelEnd, { isPhantom: true } ); const viewRange = conversionApi.writer.createRange( viewStart, viewEnd ); // Trim the range to remove in case some UI elements are on the view range boundaries. const removed = conversionApi.writer.remove( viewRange.getTrimmed() ); // After the range is removed, unbind all view elements from the model. // Range inside view document fragment is used to unbind deeply. for ( const child of conversionApi.writer.createRangeIn( removed ).getItems() ) { conversionApi.mapper.unbindViewElement( child ); } }; } /** * Creates a `` {@link module:engine/view/attributeelement~AttributeElement view attribute element} from the information * provided by the {@link module:engine/conversion/downcasthelpers~HighlightDescriptor highlight descriptor} object. If a priority * is not provided in the descriptor, the default priority will be used. * * @param {module:engine/view/downcastwriter~DowncastWriter} writer * @param {module:engine/conversion/downcasthelpers~HighlightDescriptor} descriptor * @returns {module:engine/view/attributeelement~AttributeElement} */ export function createViewElementFromHighlightDescriptor( writer, descriptor ) { const viewElement = writer.createAttributeElement( 'span', descriptor.attributes ); if ( descriptor.classes ) { viewElement._addClass( descriptor.classes ); } if ( descriptor.priority ) { viewElement._priority = descriptor.priority; } viewElement._id = descriptor.id; return viewElement; } /** * Function factory that creates a converter which converts a non-collapsed {@link module:engine/model/selection~Selection model selection} * to a {@link module:engine/view/documentselection~DocumentSelection view selection}. The converter consumes appropriate * value from the `consumable` object and maps model positions from the selection to view positions. * * modelDispatcher.on( 'selection', convertRangeSelection() ); * * @returns {Function} Selection converter. */ export function convertRangeSelection() { return ( evt, data, conversionApi ) => { const selection = data.selection; if ( selection.isCollapsed ) { return; } if ( !conversionApi.consumable.consume( selection, 'selection' ) ) { return; } const viewRanges = []; for ( const range of selection.getRanges() ) { const viewRange = conversionApi.mapper.toViewRange( range ); viewRanges.push( viewRange ); } conversionApi.writer.setSelection( viewRanges, { backward: selection.isBackward } ); }; } /** * Function factory that creates a converter which converts a collapsed {@link module:engine/model/selection~Selection model selection} to * a {@link module:engine/view/documentselection~DocumentSelection view selection}. The converter consumes appropriate * value from the `consumable` object, maps the model selection position to the view position and breaks * {@link module:engine/view/attributeelement~AttributeElement attribute elements} at the selection position. * * modelDispatcher.on( 'selection', convertCollapsedSelection() ); * * An example of the view state before and after converting the collapsed selection: * *Foo
f^oobar
* ->f^oobar
* * By breaking attribute elements like ``, the selection is in a correct element. Then, when the selection attribute is * converted, broken attributes might be merged again, or the position where the selection is may be wrapped * with different, appropriate attribute elements. * * See also {@link module:engine/conversion/downcasthelpers~clearAttributes} which does a clean-up * by merging attributes. * * @returns {Function} Selection converter. */ export function convertCollapsedSelection() { return ( evt, data, conversionApi ) => { const selection = data.selection; if ( !selection.isCollapsed ) { return; } if ( !conversionApi.consumable.consume( selection, 'selection' ) ) { return; } const viewWriter = conversionApi.writer; const modelPosition = selection.getFirstPosition(); const viewPosition = conversionApi.mapper.toViewPosition( modelPosition ); const brokenPosition = viewWriter.breakAttributes( viewPosition ); viewWriter.setSelection( brokenPosition ); }; } /** * Function factory that creates a converter which clears artifacts after the previous * {@link module:engine/model/selection~Selection model selection} conversion. It removes all empty * {@link module:engine/view/attributeelement~AttributeElement view attribute elements} and merges sibling attributes at all start and end * positions of all ranges. * *^
* ->^
* *foo^barbar
* ->foo^barbar
* *foo^barbar
* ->foo^barbar
* * This listener should be assigned before any converter for the new selection: * * modelDispatcher.on( 'selection', clearAttributes() ); * * See {@link module:engine/conversion/downcasthelpers~convertCollapsedSelection} * which does the opposite by breaking attributes in the selection position. * * @returns {Function} Selection converter. */ export function clearAttributes() { return ( evt, data, conversionApi ) => { const viewWriter = conversionApi.writer; const viewSelection = viewWriter.document.selection; for ( const range of viewSelection.getRanges() ) { // Not collapsed selection should not have artifacts. if ( range.isCollapsed ) { // Position might be in the node removed by the view writer. if ( range.end.parent.isAttached() ) { conversionApi.writer.mergeAttributes( range.start ); } } } viewWriter.setSelection( null ); }; } /** * Function factory that creates a converter which converts set/change/remove attribute changes from the model to the view. * It can also be used to convert selection attributes. In that case, an empty attribute element will be created and the * selection will be put inside it. * * Attributes from the model are converted to a view element that will be wrapping these view nodes that are bound to * model elements having the given attribute. This is useful for attributes like `bold` that may be set on text nodes in the model * but are represented as an element in the view: * * [paragraph] MODEL ====> VIEW
* |- a {bold: true} |-
* |- b {bold: true} | |- ab
* |- c |- c
*
* Passed `Function` will be provided with the attribute value and then all the parameters of the
* {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute` event}.
* It is expected that the function returns an {@link module:engine/view/element~Element}.
* The result of the function will be the wrapping element.
* When the provided `Function` does not return any element, no conversion will take place.
*
* The converter automatically consumes the corresponding value from the consumables list and stops the event (see
* {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}).
*
* modelDispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, { writer } ) => {
* return writer.createAttributeElement( 'strong' );
* } );
*
* @protected
* @param {Function} elementCreator Function returning a view element that will be used for wrapping.
* @returns {Function} Set/change attribute converter.
*/
export function wrap( elementCreator ) {
return ( evt, data, conversionApi ) => {
// Recreate current wrapping node. It will be used to unwrap view range if the attribute value has changed
// or the attribute was removed.
const oldViewElement = elementCreator( data.attributeOldValue, conversionApi );
// Create node to wrap with.
const newViewElement = elementCreator( data.attributeNewValue, conversionApi );
if ( !oldViewElement && !newViewElement ) {
return;
}
if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
return;
}
const viewWriter = conversionApi.writer;
const viewSelection = viewWriter.document.selection;
if ( data.item instanceof ModelSelection || data.item instanceof DocumentSelection ) {
// Selection attribute conversion.
viewWriter.wrap( viewSelection.getFirstRange(), newViewElement );
} else {
// Node attribute conversion.
let viewRange = conversionApi.mapper.toViewRange( data.range );
// First, unwrap the range from current wrapper.
if ( data.attributeOldValue !== null && oldViewElement ) {
viewRange = viewWriter.unwrap( viewRange, oldViewElement );
}
if ( data.attributeNewValue !== null && newViewElement ) {
viewWriter.wrap( viewRange, newViewElement );
}
}
};
}
/**
* Function factory that creates a converter which converts node insertion changes from the model to the view.
* The function passed will be provided with all the parameters of the dispatcher's
* {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert `insert` event}.
* It is expected that the function returns an {@link module:engine/view/element~Element}.
* The result of the function will be inserted into the view.
*
* The converter automatically consumes the corresponding value from the consumables list, stops the event (see
* {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}) and binds the model and view elements.
*
* downcastDispatcher.on(
* 'insert:myElem',
* insertElement( ( modelItem, { writer } ) => {
* const text = writer.createText( 'myText' );
* const myElem = writer.createElement( 'myElem', { myAttr: 'my-' + modelItem.getAttribute( 'myAttr' ) }, text );
*
* // Do something fancy with `myElem` using `modelItem` or other parameters.
*
* return myElem;
* }
* ) );
*
* @protected
* @param {Function} elementCreator Function returning a view element, which will be inserted.
* @returns {Function} Insert element event converter.
*/
export function insertElement( elementCreator ) {
return ( evt, data, conversionApi ) => {
const viewElement = elementCreator( data.item, conversionApi );
if ( !viewElement ) {
return;
}
if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) {
return;
}
const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
conversionApi.mapper.bindElements( data.item, viewElement );
conversionApi.writer.insert( viewPosition, viewElement );
};
}
/**
* Function factory that creates a converter which converts marker adding change to the
* {@link module:engine/view/uielement~UIElement view UI element}.
*
* The view UI element that will be added to the view depends on the passed parameter. See {@link ~insertElement}.
* In case of a non-collapsed range, the UI element will not wrap nodes but separate elements will be placed at the beginning
* and at the end of the range.
*
* This converter binds created UI elements with the marker name using {@link module:engine/conversion/mapper~Mapper#bindElementToMarker}.
*
* @protected
* @param {module:engine/view/uielement~UIElement|Function} elementCreator A view UI element or a function returning the view element
* that will be inserted.
* @returns {Function} Insert element event converter.
*/
export function insertUIElement( elementCreator ) {
return ( evt, data, conversionApi ) => {
// Create two view elements. One will be inserted at the beginning of marker, one at the end.
// If marker is collapsed, only "opening" element will be inserted.
data.isOpening = true;
const viewStartElement = elementCreator( data, conversionApi );
data.isOpening = false;
const viewEndElement = elementCreator( data, conversionApi );
if ( !viewStartElement || !viewEndElement ) {
return;
}
const markerRange = data.markerRange;
// Marker that is collapsed has consumable build differently that non-collapsed one.
// For more information see `addMarker` event description.
// If marker's range is collapsed - check if it can be consumed.
if ( markerRange.isCollapsed && !conversionApi.consumable.consume( markerRange, evt.name ) ) {
return;
}
// If marker's range is not collapsed - consume all items inside.
for ( const value of markerRange ) {
if ( !conversionApi.consumable.consume( value.item, evt.name ) ) {
return;
}
}
const mapper = conversionApi.mapper;
const viewWriter = conversionApi.writer;
// Add "opening" element.
viewWriter.insert( mapper.toViewPosition( markerRange.start ), viewStartElement );
conversionApi.mapper.bindElementToMarker( viewStartElement, data.markerName );
// Add "closing" element only if range is not collapsed.
if ( !markerRange.isCollapsed ) {
viewWriter.insert( mapper.toViewPosition( markerRange.end ), viewEndElement );
conversionApi.mapper.bindElementToMarker( viewEndElement, data.markerName );
}
evt.stop();
};
}
// Function factory that returns a default downcast converter for removing a {@link module:engine/view/uielement~UIElement UI element}
// based on marker remove change.
//
// This converter unbinds elements from the marker name.
//
// @returns {Function} Removed UI element converter.
function removeUIElement() {
return ( evt, data, conversionApi ) => {
const elements = conversionApi.mapper.markerNameToElements( data.markerName );
if ( !elements ) {
return;
}
for ( const element of elements ) {
conversionApi.mapper.unbindElementFromMarkerName( element, data.markerName );
conversionApi.writer.clear( conversionApi.writer.createRangeOn( element ), element );
}
conversionApi.writer.clearClonedElementsGroup( data.markerName );
evt.stop();
};
}
// Function factory that creates a default converter for model markers.
//
// See {@link DowncastHelpers#markerToData} for more information what type of view is generated.
//
// This converter binds created UI elements and affected view elements with the marker name
// using {@link module:engine/conversion/mapper~Mapper#bindElementToMarker}.
//
// @returns {Function} Add marker converter.
function insertMarkerData( viewCreator ) {
return ( evt, data, conversionApi ) => {
const viewMarkerData = viewCreator( data.markerName, conversionApi );
if ( !viewMarkerData ) {
return;
}
const markerRange = data.markerRange;
if ( !conversionApi.consumable.consume( markerRange, evt.name ) ) {
return;
}
// Adding closing data first to keep the proper order in the view.
handleMarkerBoundary( markerRange, false, conversionApi, data, viewMarkerData );
handleMarkerBoundary( markerRange, true, conversionApi, data, viewMarkerData );
evt.stop();
};
}
// Helper function for `insertMarkerData()` that marks a marker boundary at the beginning or end of given `range`.
function handleMarkerBoundary( range, isStart, conversionApi, data, viewMarkerData ) {
const modelPosition = isStart ? range.start : range.end;
const canInsertElement = conversionApi.schema.checkChild( modelPosition, '$text' );
if ( canInsertElement ) {
const viewPosition = conversionApi.mapper.toViewPosition( modelPosition );
insertMarkerAsElement( viewPosition, isStart, conversionApi, data, viewMarkerData );
} else {
let modelElement;
let isBefore;
// If possible, we want to add `data-group-start-before` and `data-group-end-after` attributes.
// Below `if` is constructed in a way that will favor adding these attributes.
//
// Also, I assume that there will be always an element either after or before the position.
// If not, then it is a case when we are not in a position where text is allowed and also there are no elements around...
if ( isStart && modelPosition.nodeAfter || !isStart && !modelPosition.nodeBefore ) {
modelElement = modelPosition.nodeAfter;
isBefore = true;
} else {
modelElement = modelPosition.nodeBefore;
isBefore = false;
}
const viewElement = conversionApi.mapper.toViewElement( modelElement );
insertMarkerAsAttribute( viewElement, isStart, isBefore, conversionApi, data, viewMarkerData );
}
}
// Helper function for `insertMarkerData()` that marks a marker boundary in the view as an attribute on a view element.
function insertMarkerAsAttribute( viewElement, isStart, isBefore, conversionApi, data, viewMarkerData ) {
const attributeName = `data-${ viewMarkerData.group }-${ isStart ? 'start' : 'end' }-${ isBefore ? 'before' : 'after' }`;
const markerNames = viewElement.hasAttribute( attributeName ) ? viewElement.getAttribute( attributeName ).split( ',' ) : [];
// Adding marker name at the beginning to have the same order in the attribute as there is with marker elements.
markerNames.unshift( viewMarkerData.name );
conversionApi.writer.setAttribute( attributeName, markerNames.join( ',' ), viewElement );
conversionApi.mapper.bindElementToMarker( viewElement, data.markerName );
}
// Helper function for `insertMarkerData()` that marks a marker boundary in the view as a separate view ui element.
function insertMarkerAsElement( position, isStart, conversionApi, data, viewMarkerData ) {
const viewElementName = `${ viewMarkerData.group }-${ isStart ? 'start' : 'end' }`;
const attrs = viewMarkerData.name ? { 'name': viewMarkerData.name } : null;
const viewElement = conversionApi.writer.createUIElement( viewElementName, attrs );
conversionApi.writer.insert( position, viewElement );
conversionApi.mapper.bindElementToMarker( viewElement, data.markerName );
}
// Function factory that creates a converter for removing a model marker data added by the {@link #insertMarkerData} converter.
//
// @returns {Function} Remove marker converter.
function removeMarkerData( viewCreator ) {
return ( evt, data, conversionApi ) => {
const viewData = viewCreator( data.markerName, conversionApi );
if ( !viewData ) {
return;
}
const elements = conversionApi.mapper.markerNameToElements( data.markerName );
if ( !elements ) {
return;
}
for ( const element of elements ) {
conversionApi.mapper.unbindElementFromMarkerName( element, data.markerName );
if ( element.is( 'containerElement' ) ) {
removeMarkerFromAttribute( `data-${ viewData.group }-start-before`, element );
removeMarkerFromAttribute( `data-${ viewData.group }-start-after`, element );
removeMarkerFromAttribute( `data-${ viewData.group }-end-before`, element );
removeMarkerFromAttribute( `data-${ viewData.group }-end-after`, element );
} else {
conversionApi.writer.clear( conversionApi.writer.createRangeOn( element ), element );
}
}
conversionApi.writer.clearClonedElementsGroup( data.markerName );
evt.stop();
function removeMarkerFromAttribute( attributeName, element ) {
if ( element.hasAttribute( attributeName ) ) {
const markerNames = new Set( element.getAttribute( attributeName ).split( ',' ) );
markerNames.delete( viewData.name );
if ( markerNames.size == 0 ) {
conversionApi.writer.removeAttribute( attributeName, element );
} else {
conversionApi.writer.setAttribute( attributeName, Array.from( markerNames ).join( ',' ), element );
}
}
}
};
}
// Function factory that creates a converter which converts set/change/remove attribute changes from the model to the view.
//
// Attributes from the model are converted to the view element attributes in the view. You may provide a custom function to generate
// a key-value attribute pair to add/change/remove. If not provided, model attributes will be converted to view element
// attributes on a one-to-one basis.
//
// *Note:** The provided attribute creator should always return the same `key` for a given attribute from the model.
//
// The converter automatically consumes the corresponding value from the consumables list and stops the event (see
// {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}).
//
// modelDispatcher.on( 'attribute:customAttr:myElem', changeAttribute( ( value, data ) => {
// // Change attribute key from `customAttr` to `class` in the view.
// const key = 'class';
// let value = data.attributeNewValue;
//
// // Force attribute value to 'empty' if the model element is empty.
// if ( data.item.childCount === 0 ) {
// value = 'empty';
// }
//
// // Return the key-value pair.
// return { key, value };
// } ) );
//
// @param {Function} [attributeCreator] Function returning an object with two properties: `key` and `value`, which
// represent the attribute key and attribute value to be set on a {@link module:engine/view/element~Element view element}.
// The function is passed the model attribute value as the first parameter and additional data about the change as the second parameter.
// @returns {Function} Set/change attribute converter.
function changeAttribute( attributeCreator ) {
return ( evt, data, conversionApi ) => {
const oldAttribute = attributeCreator( data.attributeOldValue, conversionApi );
const newAttribute = attributeCreator( data.attributeNewValue, conversionApi );
if ( !oldAttribute && !newAttribute ) {
return;
}
if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
return;
}
const viewElement = conversionApi.mapper.toViewElement( data.item );
const viewWriter = conversionApi.writer;
// If model item cannot be mapped to a view element, it means item is not an `Element` instance but a `TextProxy` node.
// Only elements can have attributes in a view so do not proceed for anything else (#1587).
if ( !viewElement ) {
/**
* This error occurs when a {@link module:engine/model/textproxy~TextProxy text node's} attribute is to be downcasted
* by {@link module:engine/conversion/conversion~Conversion#attributeToAttribute `Attribute to Attribute converter`}.
* In most cases it is caused by converters misconfiguration when only "generic" converter is defined:
*
* editor.conversion.for( 'downcast' ).attributeToAttribute( {
* model: 'attribute-name',
* view: 'attribute-name'
* } ) );
*
* and given attribute is used on text node, for example:
*
* model.change( writer => {
* writer.insertText( 'Foo', { 'attribute-name': 'bar' }, parent, 0 );
* } );
*
* In such cases, to convert the same attribute for both {@link module:engine/model/element~Element}
* and {@link module:engine/model/textproxy~TextProxy `Text`} nodes, text specific
* {@link module:engine/conversion/conversion~Conversion#attributeToElement `Attribute to Element converter`}
* with higher {@link module:utils/priorities~PriorityString priority} must also be defined:
*
* editor.conversion.for( 'downcast' ).attributeToElement( {
* model: {
* key: 'attribute-name',
* name: '$text'
* },
* view: ( value, { writer } ) => {
* return writer.createAttributeElement( 'span', { 'attribute-name': value } );
* },
* converterPriority: 'high'
* } ) );
*
* @error conversion-attribute-to-attribute-on-text
*/
throw new CKEditorError(
'conversion-attribute-to-attribute-on-text',
[ data, conversionApi ]
);
}
// First remove the old attribute if there was one.
if ( data.attributeOldValue !== null && oldAttribute ) {
if ( oldAttribute.key == 'class' ) {
const classes = Array.isArray( oldAttribute.value ) ? oldAttribute.value : [ oldAttribute.value ];
for ( const className of classes ) {
viewWriter.removeClass( className, viewElement );
}
} else if ( oldAttribute.key == 'style' ) {
const keys = Object.keys( oldAttribute.value );
for ( const key of keys ) {
viewWriter.removeStyle( key, viewElement );
}
} else {
viewWriter.removeAttribute( oldAttribute.key, viewElement );
}
}
// Then set the new attribute.
if ( data.attributeNewValue !== null && newAttribute ) {
if ( newAttribute.key == 'class' ) {
const classes = Array.isArray( newAttribute.value ) ? newAttribute.value : [ newAttribute.value ];
for ( const className of classes ) {
viewWriter.addClass( className, viewElement );
}
} else if ( newAttribute.key == 'style' ) {
const keys = Object.keys( newAttribute.value );
for ( const key of keys ) {
viewWriter.setStyle( key, newAttribute.value[ key ], viewElement );
}
} else {
viewWriter.setAttribute( newAttribute.key, newAttribute.value, viewElement );
}
}
};
}
// Function factory that creates a converter which converts the text inside marker's range. The converter wraps the text with
// {@link module:engine/view/attributeelement~AttributeElement} created from the provided descriptor.
// See {link module:engine/conversion/downcasthelpers~createViewElementFromHighlightDescriptor}.
//
// It can also be used to convert the selection that is inside a marker. In that case, an empty attribute element will be
// created and the selection will be put inside it.
//
// If the highlight descriptor does not provide the `priority` property, `10` will be used.
//
// If the highlight descriptor does not provide the `id` property, the name of the marker will be used.
//
// This converter binds the created {@link module:engine/view/attributeelement~AttributeElement attribute elemens} with the marker name
// using the {@link module:engine/conversion/mapper~Mapper#bindElementToMarker} method.
//
// @param {module:engine/conversion/downcasthelpers~HighlightDescriptor|Function} highlightDescriptor
// @returns {Function}
function highlightText( highlightDescriptor ) {
return ( evt, data, conversionApi ) => {
if ( !data.item ) {
return;
}
if ( !( data.item instanceof ModelSelection || data.item instanceof DocumentSelection ) && !data.item.is( '$textProxy' ) ) {
return;
}
const descriptor = prepareDescriptor( highlightDescriptor, data, conversionApi );
if ( !descriptor ) {
return;
}
if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
return;
}
const viewWriter = conversionApi.writer;
const viewElement = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
const viewSelection = viewWriter.document.selection;
if ( data.item instanceof ModelSelection || data.item instanceof DocumentSelection ) {
viewWriter.wrap( viewSelection.getFirstRange(), viewElement, viewSelection );
} else {
const viewRange = conversionApi.mapper.toViewRange( data.range );
const rangeAfterWrap = viewWriter.wrap( viewRange, viewElement );
for ( const element of rangeAfterWrap.getItems() ) {
if ( element.is( 'attributeElement' ) && element.isSimilar( viewElement ) ) {
conversionApi.mapper.bindElementToMarker( element, data.markerName );
// One attribute element is enough, because all of them are bound together by the view writer.
// Mapper uses this binding to get all the elements no matter how many of them are registered in the mapper.
break;
}
}
}
};
}
// Converter function factory. It creates a function which applies the marker's highlight to an element inside the marker's range.
//
// The converter checks if an element has the `addHighlight` function stored as a
// {@link module:engine/view/element~Element#_setCustomProperty custom property} and, if so, uses it to apply the highlight.
// In such case the converter will consume all element's children, assuming that they were handled by the element itself.
//
// When the `addHighlight` custom property is not present, the element is not converted in any special way.
// This means that converters will proceed to convert the element's child nodes.
//
// If the highlight descriptor does not provide the `priority` property, `10` will be used.
//
// If the highlight descriptor does not provide the `id` property, the name of the marker will be used.
//
// This converter binds altered {@link module:engine/view/containerelement~ContainerElement container elements} with the marker name using
// the {@link module:engine/conversion/mapper~Mapper#bindElementToMarker} method.
//
// @param {module:engine/conversion/downcasthelpers~HighlightDescriptor|Function} highlightDescriptor
// @returns {Function}
function highlightElement( highlightDescriptor ) {
return ( evt, data, conversionApi ) => {
if ( !data.item ) {
return;
}
if ( !( data.item instanceof ModelElement ) ) {
return;
}
const descriptor = prepareDescriptor( highlightDescriptor, data, conversionApi );
if ( !descriptor ) {
return;
}
if ( !conversionApi.consumable.test( data.item, evt.name ) ) {
return;
}
const viewElement = conversionApi.mapper.toViewElement( data.item );
if ( viewElement && viewElement.getCustomProperty( 'addHighlight' ) ) {
// Consume element itself.
conversionApi.consumable.consume( data.item, evt.name );
// Consume all children nodes.
for ( const value of ModelRange._createIn( data.item ) ) {
conversionApi.consumable.consume( value.item, evt.name );
}
viewElement.getCustomProperty( 'addHighlight' )( viewElement, descriptor, conversionApi.writer );
conversionApi.mapper.bindElementToMarker( viewElement, data.markerName );
}
};
}
// Function factory that creates a converter which converts the removing model marker to the view.
//
// Both text nodes and elements are handled by this converter but they are handled a bit differently.
//
// Text nodes are unwrapped using the {@link module:engine/view/attributeelement~AttributeElement attribute element} created from the
// provided highlight descriptor. See {link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
//
// For elements, the converter checks if an element has the `removeHighlight` function stored as a
// {@link module:engine/view/element~Element#_setCustomProperty custom property}. If so, it uses it to remove the highlight.
// In such case, the children of that element will not be converted.
//
// When `removeHighlight` is not present, the element is not converted in any special way.
// The converter will proceed to convert the element's child nodes instead.
//
// If the highlight descriptor does not provide the `priority` property, `10` will be used.
//
// If the highlight descriptor does not provide the `id` property, the name of the marker will be used.
//
// This converter unbinds elements from the marker name.
//
// @param {module:engine/conversion/downcasthelpers~HighlightDescriptor|Function} highlightDescriptor
// @returns {Function}
function removeHighlight( highlightDescriptor ) {
return ( evt, data, conversionApi ) => {
// This conversion makes sense only for non-collapsed range.
if ( data.markerRange.isCollapsed ) {
return;
}
const descriptor = prepareDescriptor( highlightDescriptor, data, conversionApi );
if ( !descriptor ) {
return;
}
// View element that will be used to unwrap `AttributeElement`s.
const viewHighlightElement = createViewElementFromHighlightDescriptor( conversionApi.writer, descriptor );
// Get all elements bound with given marker name.
const elements = conversionApi.mapper.markerNameToElements( data.markerName );
if ( !elements ) {
return;
}
for ( const element of elements ) {
conversionApi.mapper.unbindElementFromMarkerName( element, data.markerName );
if ( element.is( 'attributeElement' ) ) {
conversionApi.writer.unwrap( conversionApi.writer.createRangeOn( element ), viewHighlightElement );
} else {
// if element.is( 'containerElement' ).
element.getCustomProperty( 'removeHighlight' )( element, descriptor.id, conversionApi.writer );
}
}
conversionApi.writer.clearClonedElementsGroup( data.markerName );
evt.stop();
};
}
// Model element to view element conversion helper.
//
// See {@link ~DowncastHelpers#elementToElement `.elementToElement()` downcast helper} for examples and config params description.
//
// @param {Object} config Conversion configuration.
// @param {String} config.model
// @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view
// @param {Object} [config.triggerBy]
// @param {Array.