@ckeditor/ckeditor5-html-support 29.1.0 → 31.1.0

package/src/integrations/mediaembed.js

@@ -0,0 +1,128 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module html-support/integrations/mediaembed
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+
+import { setViewAttributes } from '../conversionutils.js';
+import DataFilter from '../datafilter';
+import DataSchema from '../dataschema';
+
+/**
+ * Provides the General HTML Support integration with {@link module:media-embed/mediaembed~MediaEmbed Media Embed} feature.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class MediaEmbedElementSupport extends Plugin {
+	static get requires() {
+		return [ DataFilter ];
+	}
+
+	init() {
+		const editor = this.editor;
+
+		// Stop here if MediaEmbed plugin is not provided or the integrator wants to output markup with previews as
+		// we do not support filtering previews.
+		if ( !editor.plugins.has( 'MediaEmbed' ) || editor.config.get( 'mediaEmbed.previewsInData' ) ) {
+			return;
+		}
+
+		const schema = editor.model.schema;
+		const conversion = editor.conversion;
+		const dataFilter = this.editor.plugins.get( DataFilter );
+		const dataSchema = this.editor.plugins.get( DataSchema );
+		const mediaElementName = editor.config.get( 'mediaEmbed.elementName' );
+
+		// Overwrite GHS schema definition for a given elementName.
+		dataSchema.registerBlockElement( {
+			model: 'media',
+			view: mediaElementName
+		} );
+
+		dataFilter.on( `register:${ mediaElementName }`, ( evt, definition ) => {
+			if ( definition.model !== 'media' ) {
+				return;
+			}
+
+			schema.extend( 'media', {
+				allowAttributes: [
+					'htmlAttributes',
+					'htmlFigureAttributes'
+				]
+			} );
+
+			conversion.for( 'upcast' ).add( viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) );
+			conversion.for( 'dataDowncast' ).add( modelToViewMediaAttributeConverter( mediaElementName ) );
+
+			evt.stop();
+		} );
+	}
+}
+
+function viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) {
+	return dispatcher => {
+		dispatcher.on( `element:${ mediaElementName }`, upcastMedia );
+	};
+
+	function upcastMedia( evt, data, conversionApi ) {
+		const viewMediaElement = data.viewItem;
+		const viewParent = viewMediaElement.parent;
+
+		preserveElementAttributes( viewMediaElement, 'htmlAttributes' );
+
+		if ( viewParent.is( 'element', 'figure' ) && viewParent.hasClass( 'media' ) ) {
+			preserveElementAttributes( viewParent, 'htmlFigureAttributes' );
+		}
+
+		function preserveElementAttributes( viewElement, attributeName ) {
+			const viewAttributes = dataFilter._consumeAllowedAttributes( viewElement, conversionApi );
+
+			if ( viewAttributes ) {
+				conversionApi.writer.setAttribute( attributeName, viewAttributes, data.modelRange );
+			}
+		}
+	}
+}
+
+function modelToViewMediaAttributeConverter( mediaElementName ) {
+	return dispatcher => {
+		addAttributeConversionDispatcherHandler( mediaElementName, 'htmlAttributes' );
+		addAttributeConversionDispatcherHandler( 'figure', 'htmlFigureAttributes' );
+
+		function addAttributeConversionDispatcherHandler( elementName, attributeName ) {
+			dispatcher.on( `attribute:${ attributeName }:media`, ( evt, data, conversionApi ) => {
+				if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
+					return;
+				}
+
+				const containerElement = conversionApi.mapper.toViewElement( data.item );
+				const viewElement = getDescendantElement( conversionApi.writer, containerElement, elementName );
+
+				setViewAttributes( conversionApi.writer, data.attributeNewValue, viewElement );
+			} );
+		}
+	};
+}
+
+// Returns the first view element descendant matching the given view name.
+// Includes view element itself.
+//
+// @private
+// @param {module:engine/view/downcastwriter~DowncastWriter} writer
+// @param {module:engine/view/element~Element} containerElement
+// @param {String} elementName
+// @returns {module:engine/view/element~Element|null}
+function getDescendantElement( writer, containerElement, elementName ) {
+	const range = writer.createRangeOn( containerElement );
+
+	for ( const { item } of range.getWalker() ) {
+		if ( item.is( 'element', elementName ) ) {
+			return item;
+		}
+	}
+}

package/src/integrations/table.js

@@ -8,7 +8,6 @@
  */
 
 import { Plugin } from 'ckeditor5/src/core';
-import { disallowedAttributesConverter } from '../converters';
 import { setViewAttributes } from '../conversionutils.js';
 
 import DataFilter from '../datafilter';
@@ -54,16 +53,11 @@ export default class TableElementSupport extends Plugin {
 				]
 			} );
 
-			conversion.for( 'upcast' ).add( disallowedAttributesConverter( definition, dataFilter ) );
 			conversion.for( 'upcast' ).add( viewToModelTableAttributeConverter( dataFilter ) );
 			conversion.for( 'downcast' ).add( modelToViewTableAttributeConverter() );
 
 			evt.stop();
 		} );
-
-		dataFilter.on( 'register:figure', () => {
-			conversion.for( 'upcast' ).add( consumeTableFigureConverter() );
-		} );
 	}
 }
 
@@ -125,7 +119,7 @@ function modelToViewTableAttributeConverter() {
 				}
 
 				const containerElement = conversionApi.mapper.toViewElement( data.item );
-				const viewElement = getDescendantElement( conversionApi, containerElement, elementName );
+				const viewElement = getDescendantElement( conversionApi.writer, containerElement, elementName );
 
 				setViewAttributes( conversionApi.writer, data.attributeNewValue, viewElement );
 			} );
@@ -137,12 +131,12 @@ function modelToViewTableAttributeConverter() {
 // Includes view element itself.
 //
 // @private
-// @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi
+// @param {module:engine/view/downcastwriter~DowncastWriter} writer
 // @param {module:engine/view/element~Element} containerElement
 // @param {String} elementName
 // @returns {module:engine/view/element~Element|null}
-function getDescendantElement( conversionApi, containerElement, elementName ) {
-	const range = conversionApi.writer.createRangeOn( containerElement );
+function getDescendantElement( writer, containerElement, elementName ) {
+	const range = writer.createRangeOn( containerElement );
 
 	for ( const { item } of range.getWalker() ) {
 		if ( item.is( 'element', elementName ) ) {
@@ -150,21 +144,3 @@ function getDescendantElement( conversionApi, containerElement, elementName ) {
 		}
 	}
 }
-
-// Conversion helper consuming figure element if it's a part of the Table feature
-// to avoid elementToElement conversion for figure with that context.
-//
-// @private
-// @returns {Function} Returns a conversion callback.
-function consumeTableFigureConverter() {
-	return dispatcher => {
-		dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
-			for ( const childNode of data.viewItem.getChildren() ) {
-				if ( childNode.is( 'element', 'table' ) ) {
-					conversionApi.consumable.consume( data.viewItem, { name: true } );
-					return;
-				}
-			}
-		} );
-	};
-}

package/src/schemadefinitions.js

@@ -51,18 +51,6 @@
 export default {
 	block: [
 		// Existing features
-		{
-			model: 'heading1',
-			view: 'h2'
-		},
-		{
-			model: 'heading2',
-			view: 'h3'
-		},
-		{
-			model: 'heading3',
-			view: 'h4'
-		},
 		{
 			model: 'codeBlock',
 			view: 'pre'
@@ -111,6 +99,14 @@ export default {
 			model: 'caption',
 			view: 'figcaption'
 		},
+		{
+			model: 'imageBlock',
+			view: 'img'
+		},
+		{
+			model: 'imageInline',
+			view: 'img'
+		},
 
 		// Compatibility features
 		{
@@ -256,7 +252,7 @@ export default {
 			}
 		},
 		{
-			model: 'htmlSumary',
+			model: 'htmlSummary',
 			view: 'summary',
 			modelSchema: {
 				allowChildren: '$text',
@@ -318,15 +314,12 @@ export default {
 			view: 'hgroup',
 			modelSchema: {
 				allowChildren: [
-					'htmlHeading1',
-					'htmlHeading2',
-					'htmlHeading3',
-					'htmlHeading4',
-					'htmlHeading5',
-					'htmlHeading6',
-					'heading1',
-					'heading2',
-					'heading3'
+					'htmlH1',
+					'htmlH2',
+					'htmlH3',
+					'htmlH4',
+					'htmlH5',
+					'htmlH6'
 				],
 				isBlock: true
 			}
@@ -633,7 +626,7 @@ export default {
 				copyOnEnter: true
 			}
 		},
-		// TODO According to HTML-spec can behave as div-like element, althouth CKE4 only handles it as an inline element.
+		// TODO According to HTML-spec can behave as div-like element, although CKE4 only handles it as an inline element.
 		{
 			model: 'htmlDel',
 			view: 'del',
@@ -641,7 +634,7 @@ export default {
 				copyOnEnter: true
 			}
 		},
-		// TODO According to HTML-spec can behave as div-like element, althouth CKE4 only handles it as an inline element.
+		// TODO According to HTML-spec can behave as div-like element, although CKE4 only handles it as an inline element.
 		{
 			model: 'htmlIns',
 			view: 'ins',
@@ -788,6 +781,14 @@ export default {
 				inheritAllFrom: '$htmlObjectInline'
 			}
 		},
+		{
+			model: 'htmlOembed',
+			view: 'oembed',
+			isObject: true,
+			modelSchema: {
+				inheritAllFrom: '$htmlObjectInline'
+			}
+		},
 		{
 			model: 'htmlAudio',
 			view: 'audio',

package/CHANGELOG.md

@@ -1,4 +0,0 @@
-Changelog
-=========
-
-All changes in the package are documented in the main repository. See: https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md.