@ckeditor/ckeditor5-highlight 48.2.0 → 48.3.0-alpha.1

package/dist/augmentation.d.ts

@@ -1,23 +1,23 @@
 /**
- * @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 type { Highlight, HighlightCommand, HighlightConfig, HighlightEditing, HighlightUI } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:highlight/highlight~Highlight} feature.
-         *
-         * Read more in {@link module:highlight/highlightconfig~HighlightConfig}.
-         */
-        highlight?: HighlightConfig;
-    }
-    interface PluginsMap {
-        [Highlight.pluginName]: Highlight;
-        [HighlightEditing.pluginName]: HighlightEditing;
-        [HighlightUI.pluginName]: HighlightUI;
-    }
-    interface CommandsMap {
-        highlight: HighlightCommand;
-    }
+* @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 type { Highlight, HighlightCommand, HighlightConfig, HighlightEditing, HighlightUI } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		/**
+		* The configuration of the {@link module:highlight/highlight~Highlight} feature.
+		*
+		* Read more in {@link module:highlight/highlightconfig~HighlightConfig}.
+		*/
+		highlight?: HighlightConfig;
+	}
+	interface PluginsMap {
+		[Highlight.pluginName]: Highlight;
+		[HighlightEditing.pluginName]: HighlightEditing;
+		[HighlightUI.pluginName]: HighlightUI;
+	}
+	interface CommandsMap {
+		highlight: HighlightCommand;
+	}
 }

package/dist/highlight.d.ts

@@ -1,32 +1,32 @@
 /**
- * @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 highlight/highlight
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { HighlightEditing } from './highlightediting.js';
-import { HighlightUI } from './highlightui.js';
+* @module highlight/highlight
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { HighlightEditing } from "./highlightediting.js";
+import { HighlightUI } from "./highlightui.js";
 /**
- * The highlight plugin.
- *
- * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
- *
- * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
- * {@link module:highlight/highlightui~HighlightUI} plugins.
- */
+* The highlight plugin.
+*
+* For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
+*
+* This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
+* {@link module:highlight/highlightui~HighlightUI} plugins.
+*/
 export declare class Highlight extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof HighlightEditing, typeof HighlightUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Highlight";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[HighlightEditing, HighlightUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Highlight";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }

package/dist/highlightcommand.d.ts

@@ -1,45 +1,45 @@
 /**
- * @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 highlight/highlightcommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
+* @module highlight/highlightcommand
+*/
+import { Command } from "@ckeditor/ckeditor5-core";
 /**
- * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
- * to apply the text highlighting.
- *
- * ```ts
- * editor.execute( 'highlight', { value: 'greenMarker' } );
- * ```
- *
- * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
- * inside a text with the highlight attribute, the command will remove the attribute from the entire range
- * of that text.
- */
+* The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
+* to apply the text highlighting.
+*
+* ```ts
+* editor.execute( 'highlight', { value: 'greenMarker' } );
+* ```
+*
+* **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
+* inside a text with the highlight attribute, the command will remove the attribute from the entire range
+* of that text.
+*/
 export declare class HighlightCommand extends Command {
-    /**
-     * A value indicating whether the command is active. If the selection has some highlight attribute,
-     * it corresponds to the value of that attribute.
-     *
-     * @observable
-     * @readonly
-     */
-    value: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     *
-     * @fires execute
-     */
-    execute(options?: {
-        value?: string | null;
-    }): void;
+	/**
+	* A value indicating whether the command is active. If the selection has some highlight attribute,
+	* it corresponds to the value of that attribute.
+	*
+	* @observable
+	* @readonly
+	*/
+	value: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @param options Options for the executed command.
+	* @param options.value The value to apply.
+	*
+	* @fires execute
+	*/
+	override execute(options?: {
+		value?: string | null;
+	}): void;
 }

package/dist/highlightconfig.d.ts

@@ -1,171 +1,171 @@
 /**
- * @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 highlight/highlightconfig
- */
+* @module highlight/highlightconfig
+*/
 /**
- * The highlight option descriptor. See {@link module:highlight/highlightconfig~HighlightConfig} to learn more.
- *
- * ```ts
- * {
- * 	model: 'pinkMarker',
- * 	class: 'marker-pink',
- * 	title: 'Pink Marker',
- * 	color: 'var(--ck-content-highlight-marker-pink)',
- * 	type: 'marker'
- * }
- * ```
- */
+* The highlight option descriptor. See {@link module:highlight/highlightconfig~HighlightConfig} to learn more.
+*
+* ```ts
+* {
+* 	model: 'pinkMarker',
+* 	class: 'marker-pink',
+* 	title: 'Pink Marker',
+* 	color: 'var(--ck-content-highlight-marker-pink)',
+* 	type: 'marker'
+* }
+* ```
+*/
 export interface HighlightOption {
-    /**
-     * The user-readable title of the option.
-     */
-    title: string;
-    /**
-     * The unique attribute value in the model.
-     */
-    model: string;
-    /**
-     * The CSS `var()` used for the highlighter. The color is used in the user interface to represent the highlighter.
-     * There is a possibility to use the default color format like rgb, hex or hsl, but you need to care about the color of `<mark>`
-     * by adding CSS classes definition.
-     */
-    color: string;
-    /**
-     * The CSS class used on the `<mark>` element in the view. It should match the `color` setting.
-     */
-    class: string;
-    /**
-     * The type of highlighter:
-     *
-     * * `'marker'` &ndash; Uses the `color` as the `background-color` style,
-     * * `'pen'` &ndash; Uses the `color` as the font `color` style.
-     */
-    type: 'marker' | 'pen';
+	/**
+	* The user-readable title of the option.
+	*/
+	title: string;
+	/**
+	* The unique attribute value in the model.
+	*/
+	model: string;
+	/**
+	* The CSS `var()` used for the highlighter. The color is used in the user interface to represent the highlighter.
+	* There is a possibility to use the default color format like rgb, hex or hsl, but you need to care about the color of `<mark>`
+	* by adding CSS classes definition.
+	*/
+	color: string;
+	/**
+	* The CSS class used on the `<mark>` element in the view. It should match the `color` setting.
+	*/
+	class: string;
+	/**
+	* The type of highlighter:
+	*
+	* * `'marker'` &ndash; Uses the `color` as the `background-color` style,
+	* * `'pen'` &ndash; Uses the `color` as the font `color` style.
+	*/
+	type: "marker" | "pen";
 }
 /**
- * The configuration of the {@link module:highlight/highlight~Highlight highlight feature}.
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		highlight:  ... // Highlight feature configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the {@link module:highlight/highlight~Highlight highlight feature}.
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		highlight:  ... // Highlight feature configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface HighlightConfig {
-    /**
-     * The available highlight options. The default value is:
-     * ```ts
-     * options: [
-     * 	{
-     * 		model: 'yellowMarker',
-     * 		class: 'marker-yellow',
-     * 		title: 'Yellow marker',
-     * 		color: 'var(--ck-content-highlight-marker-yellow)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'greenMarker',
-     * 		class: 'marker-green',
-     * 		title: 'Green marker',
-     * 		color: 'var(--ck-content-highlight-marker-green)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'pinkMarker',
-     * 		class: 'marker-pink',
-     * 		title: 'Pink marker',
-     * 		color: 'var(--ck-content-highlight-marker-pink)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'blueMarker',
-     * 		class: 'marker-blue',
-     * 		title: 'Blue marker',
-     * 		color: 'var(--ck-content-highlight-marker-blue)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'redPen',
-     * 		class: 'pen-red',
-     * 		title: 'Red pen',
-     * 		color: 'var(--ck-content-highlight-pen-red)',
-     * 		type: 'pen'
-     * 	},
-     * 	{
-     * 		model: 'greenPen',
-     * 		class: 'pen-green',
-     * 		title: 'Green pen',
-     * 		color: 'var(--ck-content-highlight-pen-green)',
-     * 		type: 'pen'
-     * 	}
-     * ]
-     * ```
-     *
-     * There are two types of highlighters available:
-     *
-     * * `'marker'` &ndash; Rendered as a `<mark>` element, styled with the `background-color`.
-     * * `'pen'` &ndash; Rendered as a `<mark>` element, styled with the font `color`.
-     *
-     * **Note**: The highlight feature provides a stylesheet with the CSS classes and corresponding colors defined
-     * as CSS variables.
-     *
-     * ```css
-     * :root {
-     * 	--ck-content-highlight-marker-yellow: #fdfd77;
-     * 	--ck-content-highlight-marker-green: #63f963;
-     * 	--ck-content-highlight-marker-pink: #fc7999;
-     * 	--ck-content-highlight-marker-blue: #72cdfd;
-     * 	--ck-content-highlight-pen-red: #e91313;
-     * 	--ck-content-highlight-pen-green: #118800;
-     * }
-     *
-     * .marker-yellow { ... }
-     * .marker-green { ... }
-     * .marker-pink { ... }
-     * .marker-blue { ... }
-     * .pen-red { ... }
-     * .pen-green { ... }
-     * ```
-     *
-     * It is possible to define the `color` property directly as `rgba(R, G, B, A)`,
-     * `#RRGGBB[AA]` or `hsla(H, S, L, A)`. In such situation, the color will **only** apply to the UI of
-     * the editor and the `<mark>` elements in the content must be styled by custom classes provided by
-     * a dedicated stylesheet.
-     *
-     * **Note**: It is recommended for the `color` property to correspond to the class in the content
-     * stylesheet because it represents the highlighter in the user interface of the editor.
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		highlight: {
-     * 			options: [
-     * 				{
-     * 					model: 'pinkMarker',
-     * 					class: 'marker-pink',
-     * 					title: 'Pink Marker',
-     * 					color: 'var(--ck-content-highlight-marker-pink)',
-     * 					type: 'marker'
-     * 				},
-     * 				{
-     * 					model: 'redPen',
-     * 					class: 'pen-red',
-     * 					title: 'Red Pen',
-     * 					color: 'var(--ck-content-highlight-pen-red)',
-     * 					type: 'pen'
-     * 				},
-     * 			]
-     * 		}
-     * } )
-     * .then( ... )
-     * .catch( ... );
-     * ```
-     */
-    options: Array<HighlightOption>;
+	/**
+	* The available highlight options. The default value is:
+	* ```ts
+	* options: [
+	* 	{
+	* 		model: 'yellowMarker',
+	* 		class: 'marker-yellow',
+	* 		title: 'Yellow marker',
+	* 		color: 'var(--ck-content-highlight-marker-yellow)',
+	* 		type: 'marker'
+	* 	},
+	* 	{
+	* 		model: 'greenMarker',
+	* 		class: 'marker-green',
+	* 		title: 'Green marker',
+	* 		color: 'var(--ck-content-highlight-marker-green)',
+	* 		type: 'marker'
+	* 	},
+	* 	{
+	* 		model: 'pinkMarker',
+	* 		class: 'marker-pink',
+	* 		title: 'Pink marker',
+	* 		color: 'var(--ck-content-highlight-marker-pink)',
+	* 		type: 'marker'
+	* 	},
+	* 	{
+	* 		model: 'blueMarker',
+	* 		class: 'marker-blue',
+	* 		title: 'Blue marker',
+	* 		color: 'var(--ck-content-highlight-marker-blue)',
+	* 		type: 'marker'
+	* 	},
+	* 	{
+	* 		model: 'redPen',
+	* 		class: 'pen-red',
+	* 		title: 'Red pen',
+	* 		color: 'var(--ck-content-highlight-pen-red)',
+	* 		type: 'pen'
+	* 	},
+	* 	{
+	* 		model: 'greenPen',
+	* 		class: 'pen-green',
+	* 		title: 'Green pen',
+	* 		color: 'var(--ck-content-highlight-pen-green)',
+	* 		type: 'pen'
+	* 	}
+	* ]
+	* ```
+	*
+	* There are two types of highlighters available:
+	*
+	* * `'marker'` &ndash; Rendered as a `<mark>` element, styled with the `background-color`.
+	* * `'pen'` &ndash; Rendered as a `<mark>` element, styled with the font `color`.
+	*
+	* **Note**: The highlight feature provides a stylesheet with the CSS classes and corresponding colors defined
+	* as CSS variables.
+	*
+	* ```css
+	* :root {
+	* 	--ck-content-highlight-marker-yellow: #fdfd77;
+	* 	--ck-content-highlight-marker-green: #63f963;
+	* 	--ck-content-highlight-marker-pink: #fc7999;
+	* 	--ck-content-highlight-marker-blue: #72cdfd;
+	* 	--ck-content-highlight-pen-red: #e91313;
+	* 	--ck-content-highlight-pen-green: #118800;
+	* }
+	*
+	* .marker-yellow { ... }
+	* .marker-green { ... }
+	* .marker-pink { ... }
+	* .marker-blue { ... }
+	* .pen-red { ... }
+	* .pen-green { ... }
+	* ```
+	*
+	* It is possible to define the `color` property directly as `rgba(R, G, B, A)`,
+	* `#RRGGBB[AA]` or `hsla(H, S, L, A)`. In such situation, the color will **only** apply to the UI of
+	* the editor and the `<mark>` elements in the content must be styled by custom classes provided by
+	* a dedicated stylesheet.
+	*
+	* **Note**: It is recommended for the `color` property to correspond to the class in the content
+	* stylesheet because it represents the highlighter in the user interface of the editor.
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		highlight: {
+	* 			options: [
+	* 				{
+	* 					model: 'pinkMarker',
+	* 					class: 'marker-pink',
+	* 					title: 'Pink Marker',
+	* 					color: 'var(--ck-content-highlight-marker-pink)',
+	* 					type: 'marker'
+	* 				},
+	* 				{
+	* 					model: 'redPen',
+	* 					class: 'pen-red',
+	* 					title: 'Red Pen',
+	* 					color: 'var(--ck-content-highlight-pen-red)',
+	* 					type: 'pen'
+	* 				},
+	* 			]
+	* 		}
+	* } )
+	* .then( ... )
+	* .catch( ... );
+	* ```
+	*/
+	options: Array<HighlightOption>;
 }

package/dist/highlightediting.d.ts

@@ -1,32 +1,32 @@
 /**
- * @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 highlight/highlightediting
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
+* @module highlight/highlightediting
+*/
+import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The highlight editing feature. It introduces the {@link module:highlight/highlightcommand~HighlightCommand command} and the `highlight`
- * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
- * as a `<mark>` element with a `class` attribute (`<mark class="marker-green">...</mark>`) depending
- * on the {@link module:highlight/highlightconfig~HighlightConfig configuration}.
- */
+* The highlight editing feature. It introduces the {@link module:highlight/highlightcommand~HighlightCommand command} and the `highlight`
+* attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
+* as a `<mark>` element with a `class` attribute (`<mark class="marker-green">...</mark>`) depending
+* on the {@link module:highlight/highlightconfig~HighlightConfig configuration}.
+*/
 export declare class HighlightEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HighlightEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "HighlightEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }