@ckeditor/ckeditor5-highlight 44.1.0 → 44.2.0-alpha.0

package/dist/highlightconfig.d.ts

@@ -1,175 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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
- */
-/**
- * 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-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 configuration of the {@link module:highlight/highlight~Highlight highlight feature}.
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		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-highlight-marker-yellow)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'greenMarker',
-     * 		class: 'marker-green',
-     * 		title: 'Green marker',
-     * 		color: 'var(--ck-highlight-marker-green)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'pinkMarker',
-     * 		class: 'marker-pink',
-     * 		title: 'Pink marker',
-     * 		color: 'var(--ck-highlight-marker-pink)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'blueMarker',
-     * 		class: 'marker-blue',
-     * 		title: 'Blue marker',
-     * 		color: 'var(--ck-highlight-marker-blue)',
-     * 		type: 'marker'
-     * 	},
-     * 	{
-     * 		model: 'redPen',
-     * 		class: 'pen-red',
-     * 		title: 'Red pen',
-     * 		color: 'var(--ck-highlight-pen-red)',
-     * 		type: 'pen'
-     * 	},
-     * 	{
-     * 		model: 'greenPen',
-     * 		class: 'pen-green',
-     * 		title: 'Green pen',
-     * 		color: 'var(--ck-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-highlight-marker-yellow: #fdfd77;
-     * 	--ck-highlight-marker-green: #63f963;
-     * 	--ck-highlight-marker-pink: #fc7999;
-     * 	--ck-highlight-marker-blue: #72cdfd;
-     * 	--ck-highlight-pen-red: #e91313;
-     * 	--ck-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( editorElement, {
-     * 		highlight: {
-     * 			options: [
-     * 				{
-     * 					model: 'pinkMarker',
-     * 					class: 'marker-pink',
-     * 					title: 'Pink Marker',
-     * 					color: 'var(--ck-highlight-marker-pink)',
-     * 					type: 'marker'
-     * 				},
-     * 				{
-     * 					model: 'redPen',
-     * 					class: 'pen-red',
-     * 					title: 'Red Pen',
-     * 					color: 'var(--ck-highlight-pen-red)',
-     * 					type: 'pen'
-     * 				},
-     * 			]
-     * 		}
-     * } )
-     * .then( ... )
-     * .catch( ... );
-     * ```
-     */
-    options: Array<HighlightOption>;
-}

package/dist/highlightediting.d.ts

@@ -1,36 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-/**
- * 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 default class HighlightEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HighlightEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/highlightui.d.ts

@@ -1,85 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module highlight/highlightui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import './../theme/highlight.css';
-/**
- * The default highlight UI plugin. It introduces:
- *
- * * The `'highlight'` dropdown,
- * * The `'removeHighlight'` and `'highlight:*'` buttons.
- *
- * The default configuration includes the following buttons:
- *
- * * `'highlight:yellowMarker'`
- * * `'highlight:greenMarker'`
- * * `'highlight:pinkMarker'`
- * * `'highlight:blueMarker'`
- * * `'highlight:redPen'`
- * * `'highlight:greenPen'`
- *
- * See the {@link module:highlight/highlightconfig~HighlightConfig#options configuration} to learn more
- * about the defaults.
- */
-export default class HighlightUI extends Plugin {
-    /**
-     * Returns the localized option titles provided by the plugin.
-     *
-     * The following localized titles corresponding with default
-     * {@link module:highlight/highlightconfig~HighlightConfig#options} are available:
-     *
-     * * `'Yellow marker'`,
-     * * `'Green marker'`,
-     * * `'Pink marker'`,
-     * * `'Blue marker'`,
-     * * `'Red pen'`,
-     * * `'Green pen'`.
-     */
-    get localizedOptionTitles(): Record<string, string>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HighlightUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates the "Remove highlight" button.
-     */
-    private _addRemoveHighlightButton;
-    /**
-     * Creates a toolbar button from the provided highlight option.
-     */
-    private _addHighlighterButton;
-    /**
-     * Internal method for creating highlight buttons.
-     *
-     * @param name The name of the button.
-     * @param label The label for the button.
-     * @param icon The button icon.
-     * @param value The `value` property passed to the executed command.
-     * @param decorateButton A callback getting ButtonView instance so that it can be further customized.
-     */
-    private _addButton;
-    /**
-     * Creates the split button dropdown UI from the provided highlight options.
-     */
-    private _addDropdown;
-    /**
-     * Creates the menu bar button for highlight including submenu with available options.
-     */
-    private _addMenuBarButton;
-}

package/dist/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module highlight
- */
-export { default as Highlight } from './highlight.js';
-export { default as HighlightEditing } from './highlightediting.js';
-export { default as HighlightUI } from './highlightui.js';
-export type { default as HighlightCommand } from './highlightcommand.js';
-export type { HighlightOption, HighlightConfig } from './highlightconfig.js';
-import './augmentation.js';