@ckeditor/ckeditor5-html-support 39.0.2 → 40.0.0

package/src/integrations/dualcontent.js

@@ -1,119 +1,119 @@
-/**
- * @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 { Plugin } from 'ckeditor5/src/core';
-import { priorities } from 'ckeditor5/src/utils';
-import { modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter } from '../converters';
-import DataFilter from '../datafilter';
-import { getHtmlAttributeName } from '../utils';
-/**
- * Provides the General HTML Support integration for elements which can behave like sectioning element (e.g. article) or
- * element accepting only inline content (e.g. paragraph).
- *
- * The distinction between this two content models is important for choosing correct schema model and proper content conversion.
- * As an example, it ensures that:
- *
- * * children elements paragraphing is enabled for sectioning elements only,
- * * element and its content can be correctly handled by editing view (splitting and merging elements),
- * * model element HTML is semantically correct and easier to work with.
- *
- * If element contains any block element, it will be treated as a sectioning element and registered using
- * {@link module:html-support/dataschema~DataSchemaDefinition#model} and
- * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
- * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
- * name with model schema accepting only inline content (inheriting from `$block`).
- */
-export default class DualContentModelElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DualContentModelElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const dataFilter = this.editor.plugins.get(DataFilter);
-        dataFilter.on('register', (evt, definition) => {
-            const blockDefinition = definition;
-            const editor = this.editor;
-            const schema = editor.model.schema;
-            const conversion = editor.conversion;
-            if (!blockDefinition.paragraphLikeModel) {
-                return;
-            }
-            // Can only apply to newly registered features.
-            if (schema.isRegistered(blockDefinition.model) || schema.isRegistered(blockDefinition.paragraphLikeModel)) {
-                return;
-            }
-            const paragraphLikeModelDefinition = {
-                model: blockDefinition.paragraphLikeModel,
-                view: blockDefinition.view
-            };
-            schema.register(blockDefinition.model, blockDefinition.modelSchema);
-            schema.register(paragraphLikeModelDefinition.model, {
-                inheritAllFrom: '$block'
-            });
-            conversion.for('upcast').elementToElement({
-                view: blockDefinition.view,
-                model: (viewElement, { writer }) => {
-                    if (this._hasBlockContent(viewElement)) {
-                        return writer.createElement(blockDefinition.model);
-                    }
-                    return writer.createElement(paragraphLikeModelDefinition.model);
-                },
-                // With a `low` priority, `paragraph` plugin auto-paragraphing mechanism is executed. Make sure
-                // this listener is called before it. If not, some elements will be transformed into a paragraph.
-                converterPriority: priorities.low + 0.5
-            });
-            conversion.for('downcast').elementToElement({
-                view: blockDefinition.view,
-                model: blockDefinition.model
-            });
-            this._addAttributeConversion(blockDefinition);
-            conversion.for('downcast').elementToElement({
-                view: paragraphLikeModelDefinition.view,
-                model: paragraphLikeModelDefinition.model
-            });
-            this._addAttributeConversion(paragraphLikeModelDefinition);
-            evt.stop();
-        });
-    }
-    /**
-     * Checks whether the given view element includes any other block element.
-     */
-    _hasBlockContent(viewElement) {
-        const view = this.editor.editing.view;
-        const blockElements = view.domConverter.blockElements;
-        // Traversing the viewElement subtree looking for block elements.
-        // Especially for the cases like <div><a href="#"><p>foo</p></a></div>.
-        // https://github.com/ckeditor/ckeditor5/issues/11513
-        for (const viewItem of view.createRangeIn(viewElement).getItems()) {
-            if (viewItem.is('element') && blockElements.includes(viewItem.name)) {
-                return true;
-            }
-        }
-        return false;
-    }
-    /**
-     * Adds attribute filtering conversion for the given data schema.
-     */
-    _addAttributeConversion(definition) {
-        const editor = this.editor;
-        const conversion = editor.conversion;
-        const dataFilter = editor.plugins.get(DataFilter);
-        editor.model.schema.extend(definition.model, {
-            allowAttributes: getHtmlAttributeName(definition.view)
-        });
-        conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
-        conversion.for('downcast').add(modelToViewBlockAttributeConverter(definition));
-    }
-}
+/**
+ * @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 { Plugin } from 'ckeditor5/src/core';
+import { priorities } from 'ckeditor5/src/utils';
+import { modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter } from '../converters';
+import DataFilter from '../datafilter';
+import { getHtmlAttributeName } from '../utils';
+/**
+ * Provides the General HTML Support integration for elements which can behave like sectioning element (e.g. article) or
+ * element accepting only inline content (e.g. paragraph).
+ *
+ * The distinction between this two content models is important for choosing correct schema model and proper content conversion.
+ * As an example, it ensures that:
+ *
+ * * children elements paragraphing is enabled for sectioning elements only,
+ * * element and its content can be correctly handled by editing view (splitting and merging elements),
+ * * model element HTML is semantically correct and easier to work with.
+ *
+ * If element contains any block element, it will be treated as a sectioning element and registered using
+ * {@link module:html-support/dataschema~DataSchemaDefinition#model} and
+ * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
+ * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
+ * name with model schema accepting only inline content (inheriting from `$block`).
+ */
+export default class DualContentModelElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DualContentModelElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        dataFilter.on('register', (evt, definition) => {
+            const blockDefinition = definition;
+            const editor = this.editor;
+            const schema = editor.model.schema;
+            const conversion = editor.conversion;
+            if (!blockDefinition.paragraphLikeModel) {
+                return;
+            }
+            // Can only apply to newly registered features.
+            if (schema.isRegistered(blockDefinition.model) || schema.isRegistered(blockDefinition.paragraphLikeModel)) {
+                return;
+            }
+            const paragraphLikeModelDefinition = {
+                model: blockDefinition.paragraphLikeModel,
+                view: blockDefinition.view
+            };
+            schema.register(blockDefinition.model, blockDefinition.modelSchema);
+            schema.register(paragraphLikeModelDefinition.model, {
+                inheritAllFrom: '$block'
+            });
+            conversion.for('upcast').elementToElement({
+                view: blockDefinition.view,
+                model: (viewElement, { writer }) => {
+                    if (this._hasBlockContent(viewElement)) {
+                        return writer.createElement(blockDefinition.model);
+                    }
+                    return writer.createElement(paragraphLikeModelDefinition.model);
+                },
+                // With a `low` priority, `paragraph` plugin auto-paragraphing mechanism is executed. Make sure
+                // this listener is called before it. If not, some elements will be transformed into a paragraph.
+                converterPriority: priorities.low + 0.5
+            });
+            conversion.for('downcast').elementToElement({
+                view: blockDefinition.view,
+                model: blockDefinition.model
+            });
+            this._addAttributeConversion(blockDefinition);
+            conversion.for('downcast').elementToElement({
+                view: paragraphLikeModelDefinition.view,
+                model: paragraphLikeModelDefinition.model
+            });
+            this._addAttributeConversion(paragraphLikeModelDefinition);
+            evt.stop();
+        });
+    }
+    /**
+     * Checks whether the given view element includes any other block element.
+     */
+    _hasBlockContent(viewElement) {
+        const view = this.editor.editing.view;
+        const blockElements = view.domConverter.blockElements;
+        // Traversing the viewElement subtree looking for block elements.
+        // Especially for the cases like <div><a href="#"><p>foo</p></a></div>.
+        // https://github.com/ckeditor/ckeditor5/issues/11513
+        for (const viewItem of view.createRangeIn(viewElement).getItems()) {
+            if (viewItem.is('element') && blockElements.includes(viewItem.name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Adds attribute filtering conversion for the given data schema.
+     */
+    _addAttributeConversion(definition) {
+        const editor = this.editor;
+        const conversion = editor.conversion;
+        const dataFilter = editor.plugins.get(DataFilter);
+        editor.model.schema.extend(definition.model, {
+            allowAttributes: getHtmlAttributeName(definition.view)
+        });
+        conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
+        conversion.for('downcast').add(modelToViewBlockAttributeConverter(definition));
+    }
+}

package/src/integrations/heading.d.ts

@@ -1,31 +1,31 @@
-/**
- * @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/heading
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Enter } from 'ckeditor5/src/enter';
-import DataSchema from '../dataschema';
-/**
- * Provides the General HTML Support integration with {@link module:heading/heading~Heading Heading} feature.
- */
-export default class HeadingElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DataSchema, typeof Enter];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HeadingElementSupport";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Registers all elements supported by HeadingEditing to enable custom attributes for those elements.
-     */
-    private registerHeadingElements;
-}
+/**
+ * @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/heading
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Enter } from 'ckeditor5/src/enter';
+import DataSchema from '../dataschema';
+/**
+ * Provides the General HTML Support integration with {@link module:heading/heading~Heading Heading} feature.
+ */
+export default class HeadingElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DataSchema, typeof Enter];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingElementSupport";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Registers all elements supported by HeadingEditing to enable custom attributes for those elements.
+     */
+    private registerHeadingElements;
+}

package/src/integrations/heading.js

@@ -1,60 +1,60 @@
-/**
- * @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/heading
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Enter } from 'ckeditor5/src/enter';
-import DataSchema from '../dataschema';
-/**
- * Provides the General HTML Support integration with {@link module:heading/heading~Heading Heading} feature.
- */
-export default class HeadingElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataSchema, Enter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HeadingElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        if (!editor.plugins.has('HeadingEditing')) {
-            return;
-        }
-        const options = editor.config.get('heading.options');
-        this.registerHeadingElements(editor, options);
-    }
-    /**
-     * Registers all elements supported by HeadingEditing to enable custom attributes for those elements.
-     */
-    registerHeadingElements(editor, options) {
-        const dataSchema = editor.plugins.get(DataSchema);
-        const headerModels = [];
-        for (const option of options) {
-            if ('model' in option && 'view' in option) {
-                dataSchema.registerBlockElement({
-                    view: option.view,
-                    model: option.model
-                });
-                headerModels.push(option.model);
-            }
-        }
-        dataSchema.extendBlockElement({
-            model: 'htmlHgroup',
-            modelSchema: {
-                allowChildren: headerModels
-            }
-        });
-    }
-}
+/**
+ * @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/heading
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Enter } from 'ckeditor5/src/enter';
+import DataSchema from '../dataschema';
+/**
+ * Provides the General HTML Support integration with {@link module:heading/heading~Heading Heading} feature.
+ */
+export default class HeadingElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataSchema, Enter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HeadingElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        if (!editor.plugins.has('HeadingEditing')) {
+            return;
+        }
+        const options = editor.config.get('heading.options');
+        this.registerHeadingElements(editor, options);
+    }
+    /**
+     * Registers all elements supported by HeadingEditing to enable custom attributes for those elements.
+     */
+    registerHeadingElements(editor, options) {
+        const dataSchema = editor.plugins.get(DataSchema);
+        const headerModels = [];
+        for (const option of options) {
+            if ('model' in option && 'view' in option) {
+                dataSchema.registerBlockElement({
+                    view: option.view,
+                    model: option.model
+                });
+                headerModels.push(option.model);
+            }
+        }
+        dataSchema.extendBlockElement({
+            model: 'htmlHgroup',
+            modelSchema: {
+                allowChildren: headerModels
+            }
+        });
+    }
+}

package/src/integrations/image.d.ts

@@ -1,26 +1,26 @@
-/**
- * @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/image
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DataFilter from '../datafilter';
-/**
- * Provides the General HTML Support integration with the {@link module:image/image~Image Image} feature.
- */
-export default class ImageElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DataFilter];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageElementSupport";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @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/image
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import DataFilter from '../datafilter';
+/**
+ * Provides the General HTML Support integration with the {@link module:image/image~Image Image} feature.
+ */
+export default class ImageElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DataFilter];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageElementSupport";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}