@ckeditor/ckeditor5-html-support 36.0.0 → 37.0.0-alpha.0

package/src/integrations/table.js

@@ -2,174 +2,127 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module html-support/integrations/table
- */
-
 import { Plugin } from 'ckeditor5/src/core';
-import { setViewAttributes } from '../conversionutils.js';
+import { setViewAttributes } from '../conversionutils';
 import DataFilter from '../datafilter';
-
+import { getDescendantElement } from './integrationutils';
 /**
  * Provides the General HTML Support integration with {@link module:table/table~Table Table} feature.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class TableElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'TableElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		if ( !editor.plugins.has( 'TableEditing' ) ) {
-			return;
-		}
-
-		const schema = editor.model.schema;
-		const conversion = editor.conversion;
-		const dataFilter = editor.plugins.get( DataFilter );
-
-		dataFilter.on( 'register:figure', ( ) => {
-			conversion.for( 'upcast' ).add( viewToModelFigureAttributeConverter( dataFilter ) );
-		} );
-
-		dataFilter.on( 'register:table', ( evt, definition ) => {
-			if ( definition.model !== 'table' ) {
-				return;
-			}
-
-			schema.extend( 'table', {
-				allowAttributes: [
-					'htmlAttributes',
-					// Figure, thead and tbody elements don't have model counterparts.
-					// We will be preserving attributes on table element using these attribute keys.
-					'htmlFigureAttributes', 'htmlTheadAttributes', 'htmlTbodyAttributes'
-				]
-			} );
-
-			conversion.for( 'upcast' ).add( viewToModelTableAttributeConverter( dataFilter ) );
-			conversion.for( 'downcast' ).add( modelToViewTableAttributeConverter() );
-
-			evt.stop();
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        if (!editor.plugins.has('TableEditing')) {
+            return;
+        }
+        const schema = editor.model.schema;
+        const conversion = editor.conversion;
+        const dataFilter = editor.plugins.get(DataFilter);
+        dataFilter.on('register:figure', () => {
+            conversion.for('upcast').add(viewToModelFigureAttributeConverter(dataFilter));
+        });
+        dataFilter.on('register:table', (evt, definition) => {
+            if (definition.model !== 'table') {
+                return;
+            }
+            schema.extend('table', {
+                allowAttributes: [
+                    'htmlAttributes',
+                    // Figure, thead and tbody elements don't have model counterparts.
+                    // We will be preserving attributes on table element using these attribute keys.
+                    'htmlFigureAttributes', 'htmlTheadAttributes', 'htmlTbodyAttributes'
+                ]
+            });
+            conversion.for('upcast').add(viewToModelTableAttributeConverter(dataFilter));
+            conversion.for('downcast').add(modelToViewTableAttributeConverter());
+            evt.stop();
+        });
+    }
 }
-
-// View-to-model conversion helper preserving allowed attributes on {@link module:table/table~Table Table}
-// feature model element.
-//
-// @private
-// @param {module:html-support/datafilter~DataFilter} dataFilter
-// @returns {Function} Returns a conversion callback.
-function viewToModelTableAttributeConverter( dataFilter ) {
-	return dispatcher => {
-		dispatcher.on( 'element:table', ( evt, data, conversionApi ) => {
-			const viewTableElement = data.viewItem;
-
-			preserveElementAttributes( viewTableElement, 'htmlAttributes' );
-
-			for ( const childNode of viewTableElement.getChildren() ) {
-				if ( childNode.is( 'element', 'thead' ) ) {
-					preserveElementAttributes( childNode, 'htmlTheadAttributes' );
-				}
-
-				if ( childNode.is( 'element', 'tbody' ) ) {
-					preserveElementAttributes( childNode, 'htmlTbodyAttributes' );
-				}
-			}
-
-			function preserveElementAttributes( viewElement, attributeName ) {
-				const viewAttributes = dataFilter.processViewAttributes( viewElement, conversionApi );
-
-				if ( viewAttributes ) {
-					conversionApi.writer.setAttribute( attributeName, viewAttributes, data.modelRange );
-				}
-			}
-		}, { priority: 'low' } );
-	};
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link module:table/table~Table Table}
+ * feature model element.
+ *
+ * @returns Returns a conversion callback.
+ */
+function viewToModelTableAttributeConverter(dataFilter) {
+    return (dispatcher) => {
+        dispatcher.on('element:table', (evt, data, conversionApi) => {
+            const viewTableElement = data.viewItem;
+            preserveElementAttributes(viewTableElement, 'htmlAttributes');
+            for (const childNode of viewTableElement.getChildren()) {
+                if (childNode.is('element', 'thead')) {
+                    preserveElementAttributes(childNode, 'htmlTheadAttributes');
+                }
+                if (childNode.is('element', 'tbody')) {
+                    preserveElementAttributes(childNode, 'htmlTbodyAttributes');
+                }
+            }
+            function preserveElementAttributes(viewElement, attributeName) {
+                const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
+                if (viewAttributes) {
+                    conversionApi.writer.setAttribute(attributeName, viewAttributes, data.modelRange);
+                }
+            }
+        }, { priority: 'low' });
+    };
 }
-
-// View-to-model conversion helper preserving allowed attributes on {@link module:table/table~Table Table}
-// feature model element from figure view element.
-//
-// @private
-// @param {module:html-support/datafilter~DataFilter} dataFilter
-// @returns {Function} Returns a conversion callback.
-function viewToModelFigureAttributeConverter( dataFilter ) {
-	return dispatcher => {
-		dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
-			const viewFigureElement = data.viewItem;
-
-			if ( !data.modelRange || !viewFigureElement.hasClass( 'table' ) ) {
-				return;
-			}
-
-			const viewAttributes = dataFilter.processViewAttributes( viewFigureElement, conversionApi );
-
-			if ( viewAttributes ) {
-				conversionApi.writer.setAttribute( 'htmlFigureAttributes', viewAttributes, data.modelRange );
-			}
-		}, { priority: 'low' } );
-	};
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link module:table/table~Table Table}
+ * feature model element from figure view element.
+ *
+ * @returns Returns a conversion callback.
+ */
+function viewToModelFigureAttributeConverter(dataFilter) {
+    return (dispatcher) => {
+        dispatcher.on('element:figure', (evt, data, conversionApi) => {
+            const viewFigureElement = data.viewItem;
+            if (!data.modelRange || !viewFigureElement.hasClass('table')) {
+                return;
+            }
+            const viewAttributes = dataFilter.processViewAttributes(viewFigureElement, conversionApi);
+            if (viewAttributes) {
+                conversionApi.writer.setAttribute('htmlFigureAttributes', viewAttributes, data.modelRange);
+            }
+        }, { priority: 'low' });
+    };
 }
-
-// Model-to-view conversion helper applying attributes from {@link module:table/table~Table Table}
-// feature.
-//
-// @private
-// @returns {Function} Returns a conversion callback.
+/**
+ * Model-to-view conversion helper applying attributes from {@link module:table/table~Table Table}
+ * feature.
+ *
+ * @returns Returns a conversion callback.
+ */
 function modelToViewTableAttributeConverter() {
-	return dispatcher => {
-		addAttributeConversionDispatcherHandler( 'table', 'htmlAttributes' );
-		addAttributeConversionDispatcherHandler( 'figure', 'htmlFigureAttributes' );
-		addAttributeConversionDispatcherHandler( 'thead', 'htmlTheadAttributes' );
-		addAttributeConversionDispatcherHandler( 'tbody', 'htmlTbodyAttributes' );
-
-		function addAttributeConversionDispatcherHandler( elementName, attributeName ) {
-			dispatcher.on( `attribute:${ attributeName }:table`, ( 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;
-		}
-	}
+    return (dispatcher) => {
+        addAttributeConversionDispatcherHandler('table', 'htmlAttributes');
+        addAttributeConversionDispatcherHandler('figure', 'htmlFigureAttributes');
+        addAttributeConversionDispatcherHandler('thead', 'htmlTheadAttributes');
+        addAttributeConversionDispatcherHandler('tbody', 'htmlTbodyAttributes');
+        function addAttributeConversionDispatcherHandler(elementName, attributeName) {
+            dispatcher.on(`attribute:${attributeName}:table`, (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);
+            });
+        }
+    };
 }

package/src/schemadefinitions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { DataSchemaBlockElementDefinition, DataSchemaInlineElementDefinition } from './dataschema';
+/**
+ * @module html-support/schemadefinitions
+ */
+declare const _default: {
+    block: DataSchemaBlockElementDefinition[];
+    inline: DataSchemaInlineElementDefinition[];
+};
+export default _default;