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

package/src/fullpage.js

@@ -2,100 +2,79 @@
  * @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/fullpage
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { UpcastWriter } from 'ckeditor5/src/engine';
 import HtmlPageDataProcessor from './htmlpagedataprocessor';
-
 /**
  * The full page editing feature. It preserves the whole HTML page in the editor data.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class FullPage extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'FullPage';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const properties = [ '$fullPageDocument', '$fullPageDocType', '$fullPageXmlDeclaration' ];
-
-		editor.data.processor = new HtmlPageDataProcessor( editor.data.viewDocument );
-
-		editor.model.schema.extend( '$root', {
-			allowAttributes: properties
-		} );
-
-		// Apply custom properties from view document fragment to the model root attributes.
-		editor.data.on( 'toModel', ( evt, [ viewElementOrFragment ] ) => {
-			const root = editor.model.document.getRoot();
-
-			editor.model.change( writer => {
-				for ( const name of properties ) {
-					const value = viewElementOrFragment.getCustomProperty( name );
-
-					if ( value ) {
-						writer.setAttribute( name, value, root );
-					}
-				}
-			} );
-		}, { priority: 'low' } );
-
-		// Apply root attributes to the view document fragment.
-		editor.data.on( 'toView', ( evt, [ modelElementOrFragment ] ) => {
-			if ( !modelElementOrFragment.is( 'rootElement' ) ) {
-				return;
-			}
-
-			const root = modelElementOrFragment;
-			const viewFragment = evt.return;
-
-			if ( !root.hasAttribute( '$fullPageDocument' ) ) {
-				return;
-			}
-
-			const writer = new UpcastWriter( viewFragment.document );
-
-			for ( const name of properties ) {
-				const value = root.getAttribute( name );
-
-				if ( value ) {
-					writer.setCustomProperty( name, value, viewFragment );
-				}
-			}
-		}, { priority: 'low' } );
-
-		// Clear root attributes related to full page editing on editor content reset.
-		editor.data.on( 'set', () => {
-			const root = editor.model.document.getRoot();
-
-			editor.model.change( writer => {
-				for ( const name of properties ) {
-					if ( root.hasAttribute( name ) ) {
-						writer.removeAttribute( name, root );
-					}
-				}
-			} );
-		}, { priority: 'high' } );
-
-		// Make sure that document is returned even if there is no content in the page body.
-		editor.data.on( 'get', ( evt, args ) => {
-			if ( !args[ 0 ] ) {
-				args[ 0 ] = {};
-			}
-
-			args[ 0 ].trim = false;
-		}, { priority: 'high' } );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FullPage';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const properties = ['$fullPageDocument', '$fullPageDocType', '$fullPageXmlDeclaration'];
+        editor.data.processor = new HtmlPageDataProcessor(editor.data.viewDocument);
+        editor.model.schema.extend('$root', {
+            allowAttributes: properties
+        });
+        // Apply custom properties from view document fragment to the model root attributes.
+        editor.data.on('toModel', (evt, [viewElementOrFragment]) => {
+            const root = editor.model.document.getRoot();
+            editor.model.change(writer => {
+                for (const name of properties) {
+                    const value = viewElementOrFragment.getCustomProperty(name);
+                    if (value) {
+                        writer.setAttribute(name, value, root);
+                    }
+                }
+            });
+        }, { priority: 'low' });
+        // Apply root attributes to the view document fragment.
+        editor.data.on('toView', (evt, [modelElementOrFragment]) => {
+            if (!modelElementOrFragment.is('rootElement')) {
+                return;
+            }
+            const root = modelElementOrFragment;
+            const viewFragment = evt.return;
+            if (!root.hasAttribute('$fullPageDocument')) {
+                return;
+            }
+            const writer = new UpcastWriter(viewFragment.document);
+            for (const name of properties) {
+                const value = root.getAttribute(name);
+                if (value) {
+                    writer.setCustomProperty(name, value, viewFragment);
+                }
+            }
+        }, { priority: 'low' });
+        // Clear root attributes related to full page editing on editor content reset.
+        editor.data.on('set', () => {
+            const root = editor.model.document.getRoot();
+            editor.model.change(writer => {
+                for (const name of properties) {
+                    if (root.hasAttribute(name)) {
+                        writer.removeAttribute(name, root);
+                    }
+                }
+            });
+        }, { priority: 'high' });
+        // Make sure that document is returned even if there is no content in the page body.
+        editor.data.on('get', (evt, args) => {
+            if (!args[0]) {
+                args[0] = {};
+            }
+            args[0].trim = false;
+        }, { priority: 'high' });
+    }
 }

package/src/generalhtmlsupport.d.ts

@@ -0,0 +1,93 @@
+/**
+ * @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/generalhtmlsupport
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import { type ArrayOrItem } from 'ckeditor5/src/utils';
+import type { Range, Selectable } from 'ckeditor5/src/engine';
+type LimitedSelectable = Exclude<Selectable, Iterable<Range> | null>;
+/**
+ * The General HTML Support feature.
+ *
+ * This is a "glue" plugin which initializes the {@link module:html-support/datafilter~DataFilter data filter} configuration
+ * and features integration with the General HTML Support.
+ */
+export default class GeneralHtmlSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'GeneralHtmlSupport';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Returns a GHS model attribute name related to a given view element name.
+     *
+     * @param viewElementName A view element name.
+     */
+    private getGhsAttributeNameForElement;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it includes the given class name.
+     *
+     * @internal
+     * @param viewElementName A view element name.
+     * @param className The css class to add.
+     * @param selectable The selection or element to update.
+     */
+    addModelHtmlClass(viewElementName: string, className: ArrayOrItem<string>, selectable: LimitedSelectable): void;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it does not include the given class name.
+     *
+     * @internal
+     * @param viewElementName A view element name.
+     * @param className The css class to remove.
+     * @param selectable The selection or element to update.
+     */
+    removeModelHtmlClass(viewElementName: string, className: ArrayOrItem<string>, selectable: LimitedSelectable): void;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it includes the given attribute.
+     *
+     * @param viewElementName A view element name.
+     * @param attributes The object with attributes to set.
+     * @param selectable The selection or element to update.
+     */
+    private setModelHtmlAttributes;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it does not include the given attribute.
+     *
+     * @param viewElementName A view element name.
+     * @param attributeName The attribute name (or names) to remove.
+     * @param selectable The selection or element to update.
+     */
+    private removeModelHtmlAttributes;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it includes a given style.
+     *
+     * @param viewElementName A view element name.
+     * @param styles The object with styles to set.
+     * @param selectable The selection or element to update.
+     */
+    private setModelHtmlStyles;
+    /**
+     * Updates GHS model attribute for a specified view element name, so it does not include a given style.
+     *
+     * @param viewElementName A view element name.
+     * @param properties The style (or styles list) to remove.
+     * @param selectable The selection or element to update.
+     */
+    private removeModelHtmlStyles;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [GeneralHtmlSupport.pluginName]: GeneralHtmlSupport;
+    }
+}
+export {};