@ckeditor/ckeditor5-html-support 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/generalhtmlsupport.d.ts

@@ -1,108 +1,108 @@
 /**
- * @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
- */
+* @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/generalhtmlsupport
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
-import { DataFilter } from './datafilter.js';
-import { CodeBlockElementSupport } from './integrations/codeblock.js';
-import { DualContentModelElementSupport } from './integrations/dualcontent.js';
-import { HeadingElementSupport } from './integrations/heading.js';
-import { ImageElementSupport } from './integrations/image.js';
-import { MediaEmbedElementSupport } from './integrations/mediaembed.js';
-import { ScriptElementSupport } from './integrations/script.js';
-import { TableElementSupport } from './integrations/table.js';
-import { StyleElementSupport } from './integrations/style.js';
-import { ListElementSupport } from './integrations/list.js';
-import { HorizontalLineElementSupport } from './integrations/horizontalline.js';
-import { IframeElementSupport } from './integrations/iframe.js';
-import { CustomElementSupport } from './integrations/customelement.js';
-import type { ModelSelectable } from '@ckeditor/ckeditor5-engine';
+* @module html-support/generalhtmlsupport
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type ArrayOrItem } from "@ckeditor/ckeditor5-utils";
+import { DataFilter } from "./datafilter.js";
+import { CodeBlockElementSupport } from "./integrations/codeblock.js";
+import { DualContentModelElementSupport } from "./integrations/dualcontent.js";
+import { HeadingElementSupport } from "./integrations/heading.js";
+import { ImageElementSupport } from "./integrations/image.js";
+import { MediaEmbedElementSupport } from "./integrations/mediaembed.js";
+import { ScriptElementSupport } from "./integrations/script.js";
+import { TableElementSupport } from "./integrations/table.js";
+import { StyleElementSupport } from "./integrations/style.js";
+import { ListElementSupport } from "./integrations/list.js";
+import { HorizontalLineElementSupport } from "./integrations/horizontalline.js";
+import { IframeElementSupport } from "./integrations/iframe.js";
+import { CustomElementSupport } from "./integrations/customelement.js";
+import type { ModelSelectable } from "@ckeditor/ckeditor5-engine";
 /**
- * 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.
- */
+* 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 declare class GeneralHtmlSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "GeneralHtmlSupport";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DataFilter, typeof CodeBlockElementSupport, typeof DualContentModelElementSupport, typeof HeadingElementSupport, typeof ImageElementSupport, typeof MediaEmbedElementSupport, typeof ScriptElementSupport, typeof TableElementSupport, typeof StyleElementSupport, typeof ListElementSupport, typeof HorizontalLineElementSupport, typeof IframeElementSupport, typeof CustomElementSupport];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Returns a GHS model attribute name related to a given view element name.
-     *
-     * @internal
-     * @param viewElementName A view element name.
-     */
-    getGhsAttributeNameForElement(viewElementName: string): string;
-    /**
-     * 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: ModelSelectable): 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: ModelSelectable): 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;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "GeneralHtmlSupport";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[DataFilter, CodeBlockElementSupport, DualContentModelElementSupport, HeadingElementSupport, ImageElementSupport, MediaEmbedElementSupport, ScriptElementSupport, TableElementSupport, StyleElementSupport, ListElementSupport, HorizontalLineElementSupport, IframeElementSupport, CustomElementSupport]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* Returns a GHS model attribute name related to a given view element name.
+	*
+	* @internal
+	* @param viewElementName A view element name.
+	*/
+	getGhsAttributeNameForElement(viewElementName: string): string;
+	/**
+	* 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: ModelSelectable): 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: ModelSelectable): 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;
 }

package/dist/generalhtmlsupportconfig.d.ts

@@ -1,209 +1,209 @@
 /**
- * @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
- */
+* @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/generalhtmlsupportconfig
- */
-import type { MatcherObjectPattern } from '@ckeditor/ckeditor5-engine';
+* @module html-support/generalhtmlsupportconfig
+*/
+import type { MatcherObjectPattern } from "@ckeditor/ckeditor5-engine";
 /**
- * The configuration of the General HTML Support feature.
- * The option is used by the {@link module:html-support/generalhtmlsupport~GeneralHtmlSupport} feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		htmlSupport: ... // General HTML Support feature config.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the General HTML Support feature.
+* The option is used by the {@link module:html-support/generalhtmlsupport~GeneralHtmlSupport} feature.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		htmlSupport: ... // General HTML Support feature config.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface GeneralHtmlSupportConfig {
-    /**
-     * The configuration of allowed content rules used by General HTML Support.
-     *
-     * Setting this configuration option will enable HTML features that are not explicitly supported by any other
-     * dedicated CKEditor 5 features.
-     *
-     * ```ts
-     * const htmlSupportConfig.allow = [
-     * 	{
-     * 		name: 'div',                      // Enable 'div' element support,
-     * 		classes: [ 'special-container' ], // allow 'special-container' class,
-     * 		styles: 'background',             // allow 'background' style,
-     * 		attributes: true                  // allow any attribute (can be empty).
-     * 	},
-     * 	{
-     * 		name: 'p',                                   // Extend existing Paragraph feature,
-     * 		classes: 'highlighted'                       // with 'highlighted' class,
-     * 		attributes: [
-     * 			{ key: 'data-i18n-context, value: true } // and i18n attribute.
-     * 		]
-     * 	}
-     * ];
-     * ```
-     */
-    allow?: Array<MatcherObjectPattern>;
-    /**
-     * The configuration of disallowed content rules used by General HTML Support.
-     *
-     * Setting this configuration option will disable listed HTML features.
-     *
-     * ```ts
-     * const htmlSupportConfig.disallow = [
-     * 	{
-     * 		name: /[\s\S]+/    // For every HTML feature,
-     * 		attributes: {
-     * 			key: /^on.*$/ // disable 'on*' attributes, like 'onClick', 'onError' etc.
-     * 		}
-     * 	}
-     * ];
-     * ```
-     */
-    disallow?: Array<MatcherObjectPattern>;
-    /**
-     * The configuration of allowed empty inline elements that should not be removed.
-     *
-     * Note that you should also add an appropriate entry to {@link #allow} list.
-     *
-     * ```ts
-     * const htmlSupportConfig.allowEmpty = [ 'i', 'span' ];
-     * ```
-     */
-    allowEmpty?: Array<string>;
-    /**
-     * Whether a filler text (non-breaking space entity — `&nbsp;`) will be inserted into empty block elements in HTML output.
-     * This is used to render block elements properly with line-height.
-     *
-     * When set to `true`, empty blocks will be preserved in the editing view.
-     * When `false` (default), empty blocks are only preserved in the data output.
-     *
-     * The option is used by the {@link module:html-support/emptyblock~EmptyBlock} feature.
-     *
-     * @default false
-     */
-    preserveEmptyBlocksInEditingView?: boolean;
-    /**
-     * The configuration of the Full page editing feature.
-     * The option is used by the {@link module:html-support/fullpage~FullPage} feature.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		htmlSupport: {
-     * 			fullPage: ... // Full page feature config.
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    fullPage?: GHSFullPageConfig;
-    /**
-     * Controls the `sandbox` attribute on iframe elements by specifying allowed sandbox flags.
-     *
-     * **Note:** This option only affects the editing view and does not modify the data output.
-     *
-     * When set to `false`:
-     *
-     * * The sandbox attribute will not be modified or added to iframe elements.
-     *
-     * When set to `true`:
-     *
-     * * All restrictions are enforced by adding an empty `sandbox` attribute to iframe elements.
-     *
-     * When set to an array of strings:
-     *
-     * * Only the specified sandbox flags will be preserved on iframe elements.
-     * * Any sandbox flags not in the list will be automatically removed.
-     * * If an empty array is provided, the `sandbox` attribute will be added with no flags (enforcing all restrictions).
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		htmlSupport: {
-     * 			// All restrictions are enforced (empty sandbox attribute).
-     * 			htmlIframeSandbox: true
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * @default true
-     */
-    htmlIframeSandbox?: boolean | Array<string>;
+	/**
+	* The configuration of allowed content rules used by General HTML Support.
+	*
+	* Setting this configuration option will enable HTML features that are not explicitly supported by any other
+	* dedicated CKEditor 5 features.
+	*
+	* ```ts
+	* const htmlSupportConfig.allow = [
+	* 	{
+	* 		name: 'div',                      // Enable 'div' element support,
+	* 		classes: [ 'special-container' ], // allow 'special-container' class,
+	* 		styles: 'background',             // allow 'background' style,
+	* 		attributes: true                  // allow any attribute (can be empty).
+	* 	},
+	* 	{
+	* 		name: 'p',                                   // Extend existing Paragraph feature,
+	* 		classes: 'highlighted'                       // with 'highlighted' class,
+	* 		attributes: [
+	* 			{ key: 'data-i18n-context, value: true } // and i18n attribute.
+	* 		]
+	* 	}
+	* ];
+	* ```
+	*/
+	allow?: Array<MatcherObjectPattern>;
+	/**
+	* The configuration of disallowed content rules used by General HTML Support.
+	*
+	* Setting this configuration option will disable listed HTML features.
+	*
+	* ```ts
+	* const htmlSupportConfig.disallow = [
+	* 	{
+	* 		name: /[\s\S]+/    // For every HTML feature,
+	* 		attributes: {
+	* 			key: /^on.*$/ // disable 'on*' attributes, like 'onClick', 'onError' etc.
+	* 		}
+	* 	}
+	* ];
+	* ```
+	*/
+	disallow?: Array<MatcherObjectPattern>;
+	/**
+	* The configuration of allowed empty inline elements that should not be removed.
+	*
+	* Note that you should also add an appropriate entry to {@link #allow} list.
+	*
+	* ```ts
+	* const htmlSupportConfig.allowEmpty = [ 'i', 'span' ];
+	* ```
+	*/
+	allowEmpty?: Array<string>;
+	/**
+	* Whether a filler text (non-breaking space entity — `&nbsp;`) will be inserted into empty block elements in HTML output.
+	* This is used to render block elements properly with line-height.
+	*
+	* When set to `true`, empty blocks will be preserved in the editing view.
+	* When `false` (default), empty blocks are only preserved in the data output.
+	*
+	* The option is used by the {@link module:html-support/emptyblock~EmptyBlock} feature.
+	*
+	* @default false
+	*/
+	preserveEmptyBlocksInEditingView?: boolean;
+	/**
+	* The configuration of the Full page editing feature.
+	* The option is used by the {@link module:html-support/fullpage~FullPage} feature.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		htmlSupport: {
+	* 			fullPage: ... // Full page feature config.
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*/
+	fullPage?: GHSFullPageConfig;
+	/**
+	* Controls the `sandbox` attribute on iframe elements by specifying allowed sandbox flags.
+	*
+	* **Note:** This option only affects the editing view and does not modify the data output.
+	*
+	* When set to `false`:
+	*
+	* * The sandbox attribute will not be modified or added to iframe elements.
+	*
+	* When set to `true`:
+	*
+	* * All restrictions are enforced by adding an empty `sandbox` attribute to iframe elements.
+	*
+	* When set to an array of strings:
+	*
+	* * Only the specified sandbox flags will be preserved on iframe elements.
+	* * Any sandbox flags not in the list will be automatically removed.
+	* * If an empty array is provided, the `sandbox` attribute will be added with no flags (enforcing all restrictions).
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		htmlSupport: {
+	* 			// All restrictions are enforced (empty sandbox attribute).
+	* 			htmlIframeSandbox: true
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* @default true
+	*/
+	htmlIframeSandbox?: boolean | Array<string>;
 }
 /**
- * The configuration of the Full page editing feature.
- */
+* The configuration of the Full page editing feature.
+*/
 export interface GHSFullPageConfig {
-    /**
-     * Whether the feature should allow the editor to render styles from the `<head>` section of editor data content.
-     *
-     * When set to `true`, the editor will render styles from the `<head>` section of editor data content.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		htmlSupport: {
-     * 			fullPage: {
-     * 				allowRenderStylesFromHead: true
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * @default false
-     */
-    allowRenderStylesFromHead?: boolean;
-    /**
-     * Callback used to sanitize the CSS provided by the user in editor content
-     * when option `htmlSupport.fullPage.allowRenderStylesFromHead` is set to `true`.
-     *
-     * We strongly recommend overwriting the default function to avoid XSS vulnerabilities.
-     *
-     * The function receives the CSS (as a string), and should return an object
-     * that matches the {@link module:html-support/generalhtmlsupportconfig~GHSCssSanitizeOutput} interface.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		htmlSupport: {
-     * 			fullPage: {
-     * 				allowRenderStylesFromHead: true,
-     *
-     * 				sanitizeCss( CssString ) {
-     * 					const sanitizedCss = sanitize( CssString );
-     *
-     * 					return {
-     * 						css: sanitizedCss,
-     * 						// true or false depending on whether the sanitizer stripped anything.
-     * 						hasChanged: ...
-     * 					};
-     * 				}
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     */
-    sanitizeCss?: (css: string) => GHSCssSanitizeOutput;
+	/**
+	* Whether the feature should allow the editor to render styles from the `<head>` section of editor data content.
+	*
+	* When set to `true`, the editor will render styles from the `<head>` section of editor data content.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		htmlSupport: {
+	* 			fullPage: {
+	* 				allowRenderStylesFromHead: true
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* @default false
+	*/
+	allowRenderStylesFromHead?: boolean;
+	/**
+	* Callback used to sanitize the CSS provided by the user in editor content
+	* when option `htmlSupport.fullPage.allowRenderStylesFromHead` is set to `true`.
+	*
+	* We strongly recommend overwriting the default function to avoid XSS vulnerabilities.
+	*
+	* The function receives the CSS (as a string), and should return an object
+	* that matches the {@link module:html-support/generalhtmlsupportconfig~GHSCssSanitizeOutput} interface.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		htmlSupport: {
+	* 			fullPage: {
+	* 				allowRenderStylesFromHead: true,
+	*
+	* 				sanitizeCss( CssString ) {
+	* 					const sanitizedCss = sanitize( CssString );
+	*
+	* 					return {
+	* 						css: sanitizedCss,
+	* 						// true or false depending on whether the sanitizer stripped anything.
+	* 						hasChanged: ...
+	* 					};
+	* 				}
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	*/
+	sanitizeCss?: (css: string) => GHSCssSanitizeOutput;
 }
 export interface GHSCssSanitizeOutput {
-    /**
-     * An output (safe) CSS that will be inserted into the document.
-     */
-    css: string;
-    /**
-     * A flag that indicates whether the output CSS is different than the input value.
-     */
-    hasChanged: boolean;
+	/**
+	* An output (safe) CSS that will be inserted into the document.
+	*/
+	css: string;
+	/**
+	* A flag that indicates whether the output CSS is different than the input value.
+	*/
+	hasChanged: boolean;
 }