@ckeditor/ckeditor5-special-characters 48.2.0 → 48.3.0-alpha.0

package/dist/specialcharacters.d.ts

@@ -1,115 +1,115 @@
 /**
- * @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 special-characters/specialcharacters
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { Typing } from '@ckeditor/ckeditor5-typing';
-import { Dialog } from '@ckeditor/ckeditor5-ui';
-import '../theme/specialcharacters.css';
+* @module special-characters/specialcharacters
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Typing } from "@ckeditor/ckeditor5-typing";
+import { Dialog } from "@ckeditor/ckeditor5-ui";
+import "../theme/specialcharacters.css";
 /**
- * The special characters feature.
- *
- * Introduces the `'specialCharacters'` dropdown.
- */
+* The special characters feature.
+*
+* Introduces the `'specialCharacters'` dropdown.
+*/
 export declare class SpecialCharacters extends Plugin {
-    /**
-     * Registered characters. A pair of a character name and its symbol.
-     */
-    private _characters;
-    /**
-     * Registered groups. Each group contains a displayed label and a collection with symbol names.
-     */
-    private _groups;
-    /**
-     * A label describing the "All" special characters category.
-     */
-    private _allSpecialCharactersGroupLabel;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Typing, typeof Dialog];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharacters";
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get licenseFeatureCode(): string;
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Adds a collection of special characters to the specified group. The title of a special character must be unique.
-     *
-     * **Note:** The "All" category name is reserved by the plugin and cannot be used as a new name for a special
-     * characters category.
-     */
-    addItems(groupName: string, items: Array<SpecialCharacterDefinition>, options?: {
-        label: string;
-    }): void;
-    /**
-     * Returns special character groups in an order determined based on configuration and registration sequence.
-     */
-    getGroups(): Set<string>;
-    /**
-     * Returns a collection of special characters symbol names (titles).
-     */
-    getCharactersForGroup(groupName: string): Set<string> | undefined;
-    /**
-     * Returns the symbol of a special character for the specified name. If the special character could not be found, `undefined`
-     * is returned.
-     *
-     * @param title The title of a special character.
-     */
-    getCharacter(title: string): string | undefined;
-    /**
-     * Returns a group of special characters. If the group with the specified name does not exist, it will be created.
-     *
-     * @param groupName The name of the group to create.
-     * @param label The label describing the new group.
-     */
-    private _getGroup;
-    /**
-     * Updates the symbol grid depending on the currently selected character group.
-     */
-    private _updateGrid;
-    /**
-     * Initializes the dropdown, used for lazy loading.
-     *
-     * @returns An object with `categoriesView`, `gridView` and `infoView` properties, containing UI parts.
-     */
-    private _createDropdownPanelContent;
-    /**
-     * Creates a button for toolbar and menu bar that will show special characters dialog.
-     */
-    private _createDialogButton;
-    private _showDialog;
+	/**
+	* Registered characters. A pair of a character name and its symbol.
+	*/
+	private _characters;
+	/**
+	* Registered groups. Each group contains a displayed label and a collection with symbol names.
+	*/
+	private _groups;
+	/**
+	* A label describing the "All" special characters category.
+	*/
+	private _allSpecialCharactersGroupLabel;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Typing, Dialog]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharacters";
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	static get licenseFeatureCode(): string;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Adds a collection of special characters to the specified group. The title of a special character must be unique.
+	*
+	* **Note:** The "All" category name is reserved by the plugin and cannot be used as a new name for a special
+	* characters category.
+	*/
+	addItems(groupName: string, items: Array<SpecialCharacterDefinition>, options?: {
+		label: string;
+	}): void;
+	/**
+	* Returns special character groups in an order determined based on configuration and registration sequence.
+	*/
+	getGroups(): Set<string>;
+	/**
+	* Returns a collection of special characters symbol names (titles).
+	*/
+	getCharactersForGroup(groupName: string): Set<string> | undefined;
+	/**
+	* Returns the symbol of a special character for the specified name. If the special character could not be found, `undefined`
+	* is returned.
+	*
+	* @param title The title of a special character.
+	*/
+	getCharacter(title: string): string | undefined;
+	/**
+	* Returns a group of special characters. If the group with the specified name does not exist, it will be created.
+	*
+	* @param groupName The name of the group to create.
+	* @param label The label describing the new group.
+	*/
+	private _getGroup;
+	/**
+	* Updates the symbol grid depending on the currently selected character group.
+	*/
+	private _updateGrid;
+	/**
+	* Initializes the dropdown, used for lazy loading.
+	*
+	* @returns An object with `categoriesView`, `gridView` and `infoView` properties, containing UI parts.
+	*/
+	private _createDropdownPanelContent;
+	/**
+	* Creates a button for toolbar and menu bar that will show special characters dialog.
+	*/
+	private _createDialogButton;
+	private _showDialog;
 }
 export interface SpecialCharacterDefinition {
-    /**
-     * A unique name of the character (e.g. "greek small letter epsilon").
-     */
-    title: string;
-    /**
-     * A human-readable character displayed as the label (e.g. "ε").
-     */
-    character: string;
+	/**
+	* A unique name of the character (e.g. "greek small letter epsilon").
+	*/
+	title: string;
+	/**
+	* A human-readable character displayed as the label (e.g. "ε").
+	*/
+	character: string;
 }

package/dist/specialcharactersarrows.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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 special-characters/specialcharactersarrows
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module special-characters/specialcharactersarrows
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * A plugin that provides special characters for the "Arrows" category.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersArrows ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
+* A plugin that provides special characters for the "Arrows" category.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     plugins: [ ..., SpecialCharacters, SpecialCharactersArrows ],
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*/
 export declare class SpecialCharactersArrows extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharactersArrows";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharactersArrows";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/specialcharactersconfig.d.ts

@@ -1,51 +1,51 @@
 /**
- * @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 special-characters/specialcharactersconfig
- */
+* @module special-characters/specialcharactersconfig
+*/
 /**
- * The configuration of the special characters feature.
- *
- * Read more about {@glink features/special-characters#configuration configuring the special characters feature}.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     specialCharacters: ... // Special characters feature options.
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
+* The configuration of the special characters feature.
+*
+* Read more about {@glink features/special-characters#configuration configuring the special characters feature}.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     specialCharacters: ... // Special characters feature options.
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+*/
 export interface SpecialCharactersConfig {
-    /**
-     * The configuration of the special characters category order.
-     *
-     * Special characters categories are displayed in the UI in the order in which they were registered. Using the `order` property
-     * allows to override this behaviour and enforce specific order. Categories not listed in the `order` property will be displayed
-     * in the default order below categories listed in the configuration.
-     *
-     * ```ts
-     * ClassicEditor
-     *   .create( {
-     *     plugins: [ SpecialCharacters, SpecialCharactersEssentials, ... ],
-     *     specialCharacters: {
-     *       order: [
-     *         'Text',
-     *         'Latin',
-     *         'Mathematical',
-     *         'Currency',
-     *         'Arrows'
-     *       ]
-     *     }
-     *   } )
-     *   .then( ... )
-     *   .catch( ... );
-     * ```
-     */
-    order?: Array<string>;
+	/**
+	* The configuration of the special characters category order.
+	*
+	* Special characters categories are displayed in the UI in the order in which they were registered. Using the `order` property
+	* allows to override this behaviour and enforce specific order. Categories not listed in the `order` property will be displayed
+	* in the default order below categories listed in the configuration.
+	*
+	* ```ts
+	* ClassicEditor
+	*   .create( {
+	*     plugins: [ SpecialCharacters, SpecialCharactersEssentials, ... ],
+	*     specialCharacters: {
+	*       order: [
+	*         'Text',
+	*         'Latin',
+	*         'Mathematical',
+	*         'Currency',
+	*         'Arrows'
+	*       ]
+	*     }
+	*   } )
+	*   .then( ... )
+	*   .catch( ... );
+	* ```
+	*/
+	order?: Array<string>;
 }

package/dist/specialcharacterscurrency.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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 special-characters/specialcharacterscurrency
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module special-characters/specialcharacterscurrency
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * A plugin that provides special characters for the "Currency" category.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersCurrency ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
+* A plugin that provides special characters for the "Currency" category.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     plugins: [ ..., SpecialCharacters, SpecialCharactersCurrency ],
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*/
 export declare class SpecialCharactersCurrency extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharactersCurrency";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharactersCurrency";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/specialcharactersessentials.d.ts

@@ -1,39 +1,39 @@
 /**
- * @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 special-characters/specialcharactersessentials
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { SpecialCharactersCurrency } from './specialcharacterscurrency.js';
-import { SpecialCharactersMathematical } from './specialcharactersmathematical.js';
-import { SpecialCharactersArrows } from './specialcharactersarrows.js';
-import { SpecialCharactersLatin } from './specialcharacterslatin.js';
-import { SpecialCharactersText } from './specialcharacterstext.js';
+* @module special-characters/specialcharactersessentials
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { SpecialCharactersCurrency } from "./specialcharacterscurrency.js";
+import { SpecialCharactersMathematical } from "./specialcharactersmathematical.js";
+import { SpecialCharactersArrows } from "./specialcharactersarrows.js";
+import { SpecialCharactersLatin } from "./specialcharacterslatin.js";
+import { SpecialCharactersText } from "./specialcharacterstext.js";
 /**
- * A plugin combining a basic set of characters for the special characters plugin.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersEssentials ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
+* A plugin combining a basic set of characters for the special characters plugin.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     plugins: [ ..., SpecialCharacters, SpecialCharactersEssentials ],
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*/
 export declare class SpecialCharactersEssentials extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharactersEssentials";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof SpecialCharactersCurrency, typeof SpecialCharactersText, typeof SpecialCharactersMathematical, typeof SpecialCharactersArrows, typeof SpecialCharactersLatin];
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharactersEssentials";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[SpecialCharactersCurrency, SpecialCharactersText, SpecialCharactersMathematical, SpecialCharactersArrows, SpecialCharactersLatin]>;
 }

package/dist/specialcharacterslatin.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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 special-characters/specialcharacterslatin
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module special-characters/specialcharacterslatin
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * A plugin that provides special characters for the "Latin" category.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersLatin ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
+* A plugin that provides special characters for the "Latin" category.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     plugins: [ ..., SpecialCharacters, SpecialCharactersLatin ],
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*/
 export declare class SpecialCharactersLatin extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharactersLatin";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharactersLatin";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/specialcharactersmathematical.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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 special-characters/specialcharactersmathematical
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module special-characters/specialcharactersmathematical
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * A plugin that provides special characters for the "Mathematical" category.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersMathematical ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
+* A plugin that provides special characters for the "Mathematical" category.
+*
+* ```ts
+* ClassicEditor
+*   .create( {
+*     plugins: [ ..., SpecialCharacters, SpecialCharactersMathematical ],
+*   } )
+*   .then( ... )
+*   .catch( ... );
+* ```
+*/
 export declare class SpecialCharactersMathematical extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SpecialCharactersMathematical";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "SpecialCharactersMathematical";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }