/** * @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 'ckeditor5/src/engine.js'; /** * 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; /** * 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; /** * 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; /** * Whether a filler text (non-breaking space entity — ` `) 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; } /** * The configuration of the Full page editing feature. */ export interface GHSFullPageConfig { /** * Whether the feature should allow the editor to render styles from the `` section of editor data content. * * When set to `true`, the editor will render styles from the `` 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( editorElement, { * 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; }