@ckeditor/ckeditor5-html-support 45.2.1 → 46.0.0-alpha.1

package/src/schemadefinitions.d.ts

@@ -2,12 +2,56 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-import type { DataSchemaBlockElementDefinition, DataSchemaInlineElementDefinition } from './dataschema.js';
+import type { HtmlSupportDataSchemaBlockElementDefinition, HtmlSupportDataSchemaInlineElementDefinition } from './dataschema.js';
 /**
  * @module html-support/schemadefinitions
  */
-declare const _default: {
-    block: DataSchemaBlockElementDefinition[];
-    inline: DataSchemaInlineElementDefinition[];
+/**
+ * Skipped elements due to HTML deprecation:
+ * * noframes (not sure if we should provide support for this element. CKE4 is not supporting frameset and frame,
+ *   but it will unpack <frameset><noframes>foobar</noframes></frameset> to <noframes>foobar</noframes>, so there
+ *   may be some content loss. Although using noframes as a standalone element seems invalid)
+ * * keygen (this one is also empty)
+ * * applet (support is limited mostly to old IE)
+ * * basefont (this one is also empty)
+ * * isindex (basically no support for modern browsers at all)
+ *
+ * Skipped elements due to lack empty element support:
+ * * hr
+ * * area
+ * * br
+ * * command
+ * * map
+ * * wbr
+ * * colgroup -> col
+ *
+ * Skipped elements due to complexity:
+ * * datalist with option elements used as a data source for input[list] element
+ *
+ * Skipped elements as they are handled as an object content:
+ * * track
+ * * source
+ * * option
+ * * param
+ * * optgroup
+ *
+ * Skipped full page HTML elements:
+ * * body
+ * * html
+ * * title
+ * * head
+ * * meta
+ * * link
+ * * etc...
+ *
+ * Skipped hidden elements:
+ * noscript
+ *
+ * When adding elements to this list, update the feature guide listing, too.
+ *
+ * @internal
+ */
+export declare const defaultConfig: {
+    block: HtmlSupportDataSchemaBlockElementDefinition[];
+    inline: HtmlSupportDataSchemaInlineElementDefinition[];
 };
-export default _default;

package/src/schemadefinitions.js

@@ -5,48 +5,52 @@
 /**
  * @module html-support/schemadefinitions
  */
-// Skipped elements due to HTML deprecation:
-// * noframes (not sure if we should provide support for this element. CKE4 is not supporting frameset and frame,
-//   but it will unpack <frameset><noframes>foobar</noframes></frameset> to <noframes>foobar</noframes>, so there
-//   may be some content loss. Although using noframes as a standalone element seems invalid)
-// * keygen (this one is also empty)
-// * applet (support is limited mostly to old IE)
-// * basefont (this one is also empty)
-// * isindex (basically no support for modern browsers at all)
-//
-// Skipped elements due to lack empty element support:
-// * hr
-// * area
-// * br
-// * command
-// * map
-// * wbr
-// * colgroup -> col
-//
-// Skipped elements due to complexity:
-// * datalist with option elements used as a data source for input[list] element
-//
-// Skipped elements as they are handled as an object content:
-// * track
-// * source
-// * option
-// * param
-// * optgroup
-//
-// Skipped full page HTML elements:
-// * body
-// * html
-// * title
-// * head
-// * meta
-// * link
-// * etc...
-//
-// Skipped hidden elements:
-// noscript
-//
-// When adding elements to this list, update the feature guide listing, too.
-export default {
+/**
+ * Skipped elements due to HTML deprecation:
+ * * noframes (not sure if we should provide support for this element. CKE4 is not supporting frameset and frame,
+ *   but it will unpack <frameset><noframes>foobar</noframes></frameset> to <noframes>foobar</noframes>, so there
+ *   may be some content loss. Although using noframes as a standalone element seems invalid)
+ * * keygen (this one is also empty)
+ * * applet (support is limited mostly to old IE)
+ * * basefont (this one is also empty)
+ * * isindex (basically no support for modern browsers at all)
+ *
+ * Skipped elements due to lack empty element support:
+ * * hr
+ * * area
+ * * br
+ * * command
+ * * map
+ * * wbr
+ * * colgroup -> col
+ *
+ * Skipped elements due to complexity:
+ * * datalist with option elements used as a data source for input[list] element
+ *
+ * Skipped elements as they are handled as an object content:
+ * * track
+ * * source
+ * * option
+ * * param
+ * * optgroup
+ *
+ * Skipped full page HTML elements:
+ * * body
+ * * html
+ * * title
+ * * head
+ * * meta
+ * * link
+ * * etc...
+ *
+ * Skipped hidden elements:
+ * noscript
+ *
+ * When adding elements to this list, update the feature guide listing, too.
+ *
+ * @internal
+ */
+export const defaultConfig = {
     block: [
         // Existing features.
         {
@@ -690,7 +694,10 @@ export default {
             model: 'htmlA',
             view: 'a',
             priority: 5,
-            coupledAttribute: 'linkHref'
+            coupledAttribute: 'linkHref',
+            attributeProperties: {
+                isFormatting: true
+            }
         },
         {
             model: 'htmlStrong',

package/src/utils.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module html-support/utils
  */
-import type { DocumentSelection, DowncastWriter, Item, ViewElement, Writer } from 'ckeditor5/src/engine.js';
+import type { ModelDocumentSelection, ViewDowncastWriter, ModelItem, ModelRange, ViewElement, ModelWriter } from 'ckeditor5/src/engine.js';
 export interface GHSViewAttributes {
     attributes?: Record<string, unknown>;
     classes?: Array<string>;
@@ -18,26 +18,31 @@ export interface GHSViewAttributes {
 * @param oldViewAttributes The previous GHS attribute value.
 * @param newViewAttributes The current GHS attribute value.
 * @param viewElement The view element to update.
+* @internal
 */
-export declare function updateViewAttributes(writer: DowncastWriter, oldViewAttributes: GHSViewAttributes, newViewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
+export declare function updateViewAttributes(writer: ViewDowncastWriter, oldViewAttributes: GHSViewAttributes, newViewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
 /**
  * Helper function for the downcast converter. Sets attributes on the given view element.
  *
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */
-export declare function setViewAttributes(writer: DowncastWriter, viewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
+export declare function setViewAttributes(writer: ViewDowncastWriter, viewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
 /**
  * Helper function for the downcast converter. Removes attributes on the given view element.
  *
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */
-export declare function removeViewAttributes(writer: DowncastWriter, viewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
+export declare function removeViewAttributes(writer: ViewDowncastWriter, viewAttributes: GHSViewAttributes, viewElement: ViewElement): void;
 /**
 * Merges view element attribute objects.
+*
+* @internal
 */
 export declare function mergeViewElementAttributes(target: GHSViewAttributes, source: GHSViewAttributes): GHSViewAttributes;
 type ModifyGhsAttributesCallback = (t: Map<string, unknown>) => void;
@@ -45,28 +50,42 @@ type ModifyGhsClassesCallback = (t: Set<string>) => void;
 type ModifyGhsStylesCallback = (t: Map<string, string>) => void;
 /**
  * Updates a GHS attribute on a specified item.
+ *
  * @param callback That receives a map as an argument and should modify it (add or remove entries).
+ * @internal
  */
-export declare function modifyGhsAttribute(writer: Writer, item: Item | DocumentSelection, ghsAttributeName: string, subject: 'attributes', callback: ModifyGhsAttributesCallback): void;
+export declare function modifyGhsAttribute(writer: ModelWriter, item: ModelItem | ModelDocumentSelection, ghsAttributeName: string, subject: 'attributes', callback: ModifyGhsAttributesCallback): void;
 /**
  * Updates a GHS attribute on a specified item.
+ *
  * @param callback That receives a set as an argument and should modify it (add or remove entries).
+ * @internal
  */
-export declare function modifyGhsAttribute(writer: Writer, item: Item | DocumentSelection, ghsAttributeName: string, subject: 'classes', callback: ModifyGhsClassesCallback): void;
+export declare function modifyGhsAttribute(writer: ModelWriter, item: ModelItem | ModelDocumentSelection, ghsAttributeName: string, subject: 'classes', callback: ModifyGhsClassesCallback): void;
 /**
  * Updates a GHS attribute on a specified item.
  * @param callback That receives a map as an argument and should modify it (add or remove entries).
  */
-export declare function modifyGhsAttribute(writer: Writer, item: Item | DocumentSelection, ghsAttributeName: string, subject: 'styles', callback: ModifyGhsStylesCallback): void;
+export declare function modifyGhsAttribute(writer: ModelWriter, item: ModelItem | ModelDocumentSelection, ghsAttributeName: string, subject: 'styles', callback: ModifyGhsStylesCallback): void;
+/**
+ * Strips the `styles`, and `classes` keys from the GHS attribute value on the given item.
+ *
+ * @internal
+ */
+export declare function removeFormatting(ghsAttributeName: string, itemRange: ModelRange, writer: ModelWriter): void;
 /**
  * Transforms passed string to PascalCase format. Examples:
  * * `div` => `Div`
  * * `h1` => `H1`
  * * `table` => `Table`
+ *
+ * @internal
  */
 export declare function toPascalCase(data: string): string;
 /**
  * Returns the attribute name of the model element that holds raw HTML attributes.
+ *
+ * @internal
  */
 export declare function getHtmlAttributeName(viewElementName: string): string;
 export {};

package/src/utils.js

@@ -10,6 +10,7 @@ import { startCase, cloneDeep } from 'es-toolkit/compat';
 * @param oldViewAttributes The previous GHS attribute value.
 * @param newViewAttributes The current GHS attribute value.
 * @param viewElement The view element to update.
+* @internal
 */
 export function updateViewAttributes(writer, oldViewAttributes, newViewAttributes, viewElement) {
     if (oldViewAttributes) {
@@ -25,6 +26,7 @@ export function updateViewAttributes(writer, oldViewAttributes, newViewAttribute
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */
 export function setViewAttributes(writer, viewAttributes, viewElement) {
     if (viewAttributes.attributes) {
@@ -45,6 +47,7 @@ export function setViewAttributes(writer, viewAttributes, viewElement) {
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */
 export function removeViewAttributes(writer, viewAttributes, viewElement) {
     if (viewAttributes.attributes) {
@@ -63,6 +66,8 @@ export function removeViewAttributes(writer, viewAttributes, viewElement) {
 }
 /**
 * Merges view element attribute objects.
+*
+* @internal
 */
 export function mergeViewElementAttributes(target, source) {
     const result = cloneDeep(target);
@@ -122,17 +127,42 @@ export function modifyGhsAttribute(writer, item, ghsAttributeName, subject, call
         }
     }
 }
+/**
+ * Strips the `styles`, and `classes` keys from the GHS attribute value on the given item.
+ *
+ * @internal
+ */
+export function removeFormatting(ghsAttributeName, itemRange, writer) {
+    for (const item of itemRange.getItems({ shallow: true })) {
+        const value = item.getAttribute(ghsAttributeName);
+        // Copy only attributes to the new attribute value.
+        if (value && value.attributes && Object.keys(value.attributes).length) {
+            // But reset the GHS attribute only when there is anything more than just attributes.
+            if (Object.keys(value).length > 1) {
+                writer.setAttribute(ghsAttributeName, { attributes: value.attributes }, item);
+            }
+        }
+        else {
+            // There are no attributes, so remove the GHS attribute completely.
+            writer.removeAttribute(ghsAttributeName, item);
+        }
+    }
+}
 /**
  * Transforms passed string to PascalCase format. Examples:
  * * `div` => `Div`
  * * `h1` => `H1`
  * * `table` => `Table`
+ *
+ * @internal
  */
 export function toPascalCase(data) {
     return startCase(data).replace(/ /g, '');
 }
 /**
  * Returns the attribute name of the model element that holds raw HTML attributes.
+ *
+ * @internal
  */
 export function getHtmlAttributeName(viewElementName) {
     return `html${toPascalCase(viewElementName)}Attributes`;