@ckeditor/ckeditor5-html-support 47.6.1 → 48.0.0-alpha.0

package/src/integrations/codeblock.js

@@ -1,107 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { updateViewAttributes } from '../utils.js';
-import { DataFilter } from '../datafilter.js';
-/**
- * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
- */
-export class CodeBlockElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'CodeBlockElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        if (!this.editor.plugins.has('CodeBlockEditing')) {
-            return;
-        }
-        const dataFilter = this.editor.plugins.get(DataFilter);
-        dataFilter.on('register:pre', (evt, definition) => {
-            if (definition.model !== 'codeBlock') {
-                return;
-            }
-            const editor = this.editor;
-            const schema = editor.model.schema;
-            const conversion = editor.conversion;
-            // Extend codeBlock to allow attributes required by attribute filtration.
-            schema.extend('codeBlock', {
-                allowAttributes: ['htmlPreAttributes', 'htmlContentAttributes']
-            });
-            conversion.for('upcast').add(viewToModelCodeBlockAttributeConverter(dataFilter));
-            conversion.for('downcast').add(modelToViewCodeBlockAttributeConverter());
-            evt.stop();
-        });
-    }
-}
-/**
- * View-to-model conversion helper preserving allowed attributes on {@link module:code-block/codeblock~CodeBlock Code Block}
- * feature model element.
- *
- * Attributes are preserved as a value of `html*Attributes` model attribute.
- * @param dataFilter
- * @returns Returns a conversion callback.
- */
-function viewToModelCodeBlockAttributeConverter(dataFilter) {
-    return (dispatcher) => {
-        dispatcher.on('element:code', (evt, data, conversionApi) => {
-            const viewCodeElement = data.viewItem;
-            const viewPreElement = viewCodeElement.parent;
-            if (!viewPreElement || !viewPreElement.is('element', 'pre')) {
-                return;
-            }
-            preserveElementAttributes(viewPreElement, 'htmlPreAttributes');
-            preserveElementAttributes(viewCodeElement, 'htmlContentAttributes');
-            function preserveElementAttributes(viewElement, attributeName) {
-                const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
-                if (viewAttributes) {
-                    conversionApi.writer.setAttribute(attributeName, viewAttributes, data.modelRange);
-                }
-            }
-        }, { priority: 'low' });
-    };
-}
-/**
- * Model-to-view conversion helper applying attributes from {@link module:code-block/codeblock~CodeBlock Code Block}
- * feature model element.
- * @returns Returns a conversion callback.
- */
-function modelToViewCodeBlockAttributeConverter() {
-    return (dispatcher) => {
-        dispatcher.on('attribute:htmlPreAttributes:codeBlock', (evt, data, conversionApi) => {
-            if (!conversionApi.consumable.consume(data.item, evt.name)) {
-                return;
-            }
-            const { attributeOldValue, attributeNewValue } = data;
-            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
-            const viewPreElement = viewCodeElement.parent;
-            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewPreElement);
-        });
-        dispatcher.on('attribute:htmlContentAttributes:codeBlock', (evt, data, conversionApi) => {
-            if (!conversionApi.consumable.consume(data.item, evt.name)) {
-                return;
-            }
-            const { attributeOldValue, attributeNewValue } = data;
-            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
-            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewCodeElement);
-        });
-    };
-}

package/src/integrations/customelement.js

@@ -1,166 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module html-support/integrations/customelement
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { ViewUpcastWriter } from 'ckeditor5/src/engine.js';
-import { DataSchema } from '../dataschema.js';
-import { DataFilter } from '../datafilter.js';
-import { setViewAttributes } from '../utils.js';
-/**
- * Provides the General HTML Support for custom elements (not registered in the {@link module:html-support/dataschema~DataSchema}).
- */
-export class CustomElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter, DataSchema];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'CustomElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const dataFilter = this.editor.plugins.get(DataFilter);
-        const dataSchema = this.editor.plugins.get(DataSchema);
-        dataFilter.on('register:$customElement', (evt, definition) => {
-            evt.stop();
-            const editor = this.editor;
-            const schema = editor.model.schema;
-            const conversion = editor.conversion;
-            const unsafeElements = editor.editing.view.domConverter.unsafeElements;
-            const preLikeElements = editor.data.htmlProcessor.domConverter.preElements;
-            schema.register(definition.model, definition.modelSchema);
-            schema.extend(definition.model, {
-                allowAttributes: ['htmlElementName', 'htmlCustomElementAttributes', 'htmlContent'],
-                isContent: true
-            });
-            // For the `<template>` element we use only raw-content because DOM API exposes its content
-            // only as a document fragment in the `content` property (or innerHTML).
-            editor.data.htmlProcessor.domConverter.registerRawContentMatcher({ name: 'template' });
-            // Being executed on the low priority, it will catch all elements that were not caught by other converters.
-            conversion.for('upcast').elementToElement({
-                view: /.*/,
-                model: (viewElement, conversionApi) => {
-                    // Do not try to convert $comment fake element.
-                    if (viewElement.name == '$comment') {
-                        return null;
-                    }
-                    // It is ignored intentionally because CI runs on latest Chrome.
-                    /* istanbul ignore next -- @preserve */
-                    if (!isValidElementName(viewElement.name)) {
-                        return null;
-                    }
-                    // Allow for fallback only if this element is not defined in data schema to make sure
-                    // that this will handle only custom elements not registered in the data schema.
-                    if (dataSchema.getDefinitionsForView(viewElement.name).size) {
-                        return null;
-                    }
-                    // Make sure that this element will not render in the editing view.
-                    if (!unsafeElements.includes(viewElement.name)) {
-                        unsafeElements.push(viewElement.name);
-                    }
-                    // Make sure that whitespaces will not be trimmed or replaced by nbsps while stringify content.
-                    if (!preLikeElements.includes(viewElement.name)) {
-                        preLikeElements.push(viewElement.name);
-                    }
-                    const modelElement = conversionApi.writer.createElement(definition.model, {
-                        htmlElementName: viewElement.name
-                    });
-                    const htmlAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
-                    if (htmlAttributes) {
-                        conversionApi.writer.setAttribute('htmlCustomElementAttributes', htmlAttributes, modelElement);
-                    }
-                    let htmlContent;
-                    // For the `<template>` element we use only raw-content because DOM API exposes its content
-                    // only as a document fragment in the `content` property.
-                    if (viewElement.is('element', 'template') && viewElement.getCustomProperty('$rawContent')) {
-                        htmlContent = viewElement.getCustomProperty('$rawContent');
-                    }
-                    else {
-                        // Store the whole element in the attribute so that ViewDomConverter
-                        // will be able to use the pre like element context.
-                        const viewWriter = new ViewUpcastWriter(viewElement.document);
-                        const documentFragment = viewWriter.createDocumentFragment(viewElement);
-                        const domFragment = editor.data.htmlProcessor.domConverter.viewToDom(documentFragment);
-                        const domElement = domFragment.firstChild;
-                        while (domElement.firstChild) {
-                            domFragment.appendChild(domElement.firstChild);
-                        }
-                        domElement.remove();
-                        htmlContent = editor.data.htmlProcessor.htmlWriter.getHtml(domFragment);
-                    }
-                    conversionApi.writer.setAttribute('htmlContent', htmlContent, modelElement);
-                    // Consume the content of the element.
-                    for (const { item } of editor.editing.view.createRangeIn(viewElement)) {
-                        conversionApi.consumable.consume(item, { name: true });
-                    }
-                    return modelElement;
-                },
-                converterPriority: 'low'
-            });
-            // Because this element is unsafe (DomConverter#unsafeElements), it will render as a transparent <span> but it must
-            // be rendered anyway for the mapping between the model and the view to exist.
-            conversion.for('editingDowncast').elementToElement({
-                model: {
-                    name: definition.model,
-                    attributes: ['htmlElementName', 'htmlCustomElementAttributes', 'htmlContent']
-                },
-                view: (modelElement, { writer }) => {
-                    const viewName = modelElement.getAttribute('htmlElementName');
-                    const viewElement = writer.createRawElement(viewName);
-                    if (modelElement.hasAttribute('htmlCustomElementAttributes')) {
-                        setViewAttributes(writer, modelElement.getAttribute('htmlCustomElementAttributes'), viewElement);
-                    }
-                    return viewElement;
-                }
-            });
-            conversion.for('dataDowncast').elementToElement({
-                model: {
-                    name: definition.model,
-                    attributes: ['htmlElementName', 'htmlCustomElementAttributes', 'htmlContent']
-                },
-                view: (modelElement, { writer }) => {
-                    const viewName = modelElement.getAttribute('htmlElementName');
-                    const htmlContent = modelElement.getAttribute('htmlContent');
-                    const viewElement = writer.createRawElement(viewName, null, (domElement, domConverter) => {
-                        domConverter.setContentOf(domElement, htmlContent);
-                    });
-                    if (modelElement.hasAttribute('htmlCustomElementAttributes')) {
-                        setViewAttributes(writer, modelElement.getAttribute('htmlCustomElementAttributes'), viewElement);
-                    }
-                    return viewElement;
-                }
-            });
-        });
-    }
-}
-/**
- * Returns true if name is valid for a DOM element name.
- */
-function isValidElementName(name) {
-    try {
-        document.createElement(name);
-    }
-    catch {
-        // It is ignored intentionally because CI runs on latest Chrome.
-        /* istanbul ignore next -- @preserve */
-        return false;
-    }
-    return true;
-}

package/src/integrations/dualcontent.js

@@ -1,126 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { priorities } from 'ckeditor5/src/utils.js';
-import { modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter } from '../converters.js';
-import { DataFilter } from '../datafilter.js';
-import { getHtmlAttributeName } from '../utils.js';
-/**
- * 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~HtmlSupportDataSchemaDefinition#model} and
- * {@link module:html-support/dataschema~HtmlSupportDataSchemaDefinition#modelSchema} in editor schema.
- * Otherwise, it will be registered under
- * {@link module:html-support/dataschema~HtmlSupportDataSchemaBlockElementDefinition#paragraphLikeModel} model
- * name with model schema accepting only inline content (inheriting from `$block`).
- */
-export class DualContentModelElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DualContentModelElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @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.js

@@ -1,72 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module html-support/integrations/heading
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { Enter } from 'ckeditor5/src/enter.js';
-import { DataSchema } from '../dataschema.js';
-/**
- * Provides the General HTML Support integration with {@link module:heading/heading~Heading Heading} feature.
- */
-export class HeadingElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataSchema, Enter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HeadingElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @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
-            }
-        });
-        dataSchema.extendBlockElement({
-            model: 'htmlSummary',
-            modelSchema: {
-                allowChildren: headerModels
-            }
-        });
-    }
-}

package/src/integrations/horizontalline.js

@@ -1,80 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module html-support/integrations/horizontalline
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { DataFilter } from '../datafilter.js';
-import { updateViewAttributes } from '../utils.js';
-import { getDescendantElement } from './integrationutils.js';
-import { viewToModelBlockAttributeConverter } from '../converters.js';
-/**
- * Provides the General HTML Support integration with the {@link module:horizontal-line/horizontalline~HorizontalLine} feature.
- */
-export class HorizontalLineElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HorizontalLineElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        if (!editor.plugins.has('HorizontalLineEditing')) {
-            return;
-        }
-        const schema = editor.model.schema;
-        const conversion = editor.conversion;
-        const dataFilter = editor.plugins.get(DataFilter);
-        dataFilter.on('register:hr', (evt, definition) => {
-            if (definition.model !== 'horizontalLine') {
-                return;
-            }
-            schema.extend('horizontalLine', {
-                allowAttributes: ['htmlHrAttributes']
-            });
-            conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
-            conversion.for('downcast').add(modelToViewHorizontalLineAttributeConverter());
-            evt.stop();
-        });
-    }
-}
-/**
- * A model-to-view conversion helper applying attributes from the
- * {@link module:horizontal-line/horizontalline~HorizontalLine HorizontalLine} feature.
- *
- * @returns Returns a conversion callback.
- */
-function modelToViewHorizontalLineAttributeConverter() {
-    return (dispatcher) => {
-        dispatcher.on('attribute:htmlHrAttributes:horizontalLine', (evt, data, conversionApi) => {
-            if (!conversionApi.consumable.test(data.item, evt.name)) {
-                return;
-            }
-            const { attributeOldValue, attributeNewValue } = data;
-            const containerElement = conversionApi.mapper.toViewElement(data.item);
-            const viewElement = getDescendantElement(conversionApi.writer, containerElement, 'hr');
-            if (viewElement) {
-                updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewElement);
-                conversionApi.consumable.consume(data.item, evt.name);
-            }
-        }, { priority: 'low' });
-    };
-}

package/src/integrations/iframe.js

@@ -1,76 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { DataFilter } from '../datafilter.js';
-/**
- * Provides the General HTML Support integration for `iframe` elements with a mandatory sandbox attribute.
- */
-export class IframeElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'IframeElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        this.editor.config.define('htmlSupport.htmlIframeSandbox', true);
-        this._setupSandboxConversion();
-    }
-    /**
-     * Sets up the conversion to enforce the sandbox attribute on `iframe` elements.
-     */
-    _setupSandboxConversion() {
-        const { plugins, config, conversion } = this.editor;
-        const dataFilter = plugins.get(DataFilter);
-        const iframeSandboxConfig = config.get('htmlSupport.htmlIframeSandbox');
-        if (iframeSandboxConfig === false) {
-            return;
-        }
-        const allowedSandboxFlags = Array.isArray(iframeSandboxConfig) ? Array.from(iframeSandboxConfig) : [];
-        dataFilter.on('register:iframe', (_, definition) => {
-            conversion.for('editingDowncast').add((dispatcher) => {
-                dispatcher.on(`insert:${definition.model}`, (_, data, conversionApi) => {
-                    const { mapper, writer } = conversionApi;
-                    const viewElement = mapper.toViewElement(data.item);
-                    for (const { item } of writer.createRangeOn(viewElement)) {
-                        if (!item.is('element', 'iframe')) {
-                            continue;
-                        }
-                        if (item.hasAttribute('sandbox')) {
-                            // If there is an existing sandbox attribute, read and filter out disallowed values.
-                            const sandboxValues = new Set();
-                            const existingSandbox = item.getAttribute('sandbox');
-                            for (const value of existingSandbox.trim().split(/\s+/)) {
-                                if (allowedSandboxFlags.includes(value)) {
-                                    sandboxValues.add(value);
-                                }
-                            }
-                            writer.setAttribute('sandbox', Array.from(sandboxValues).join(' '), item);
-                        }
-                        else {
-                            // If there was no existing sandbox attribute, just use the configured one.
-                            writer.setAttribute('sandbox', allowedSandboxFlags.join(' '), item);
-                        }
-                    }
-                }, { priority: 'lowest' });
-            });
-        });
-    }
-}