@ckeditor/ckeditor5-special-characters 0.0.0-nightly-next-20260125.0 → 0.0.0-nightly-20260126.0

package/package.json

@@ -1,41 +1,65 @@
 {
   "name": "@ckeditor/ckeditor5-special-characters",
-  "version": "0.0.0-nightly-next-20260125.0",
+  "version": "0.0.0-nightly-20260126.0",
   "description": "Special characters feature for CKEditor 5.",
-  "license": "SEE LICENSE IN LICENSE.md",
-  "author": "CKSource (http://cksource.com/)",
-  "homepage": "https://ckeditor.com/ckeditor-5",
-  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ckeditor/ckeditor5.git",
-    "directory": "packages/ckeditor5-special-characters"
-  },
   "keywords": [
     "ckeditor",
     "ckeditor5",
     "ckeditor 5",
     "ckeditor5-feature",
-    "ckeditor5-plugin"
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
   ],
   "type": "module",
-  "main": "./dist/index.js",
-  "exports": {
-    ".": "./dist/index.js",
-    "./dist/*": "./dist/*",
-    "./package.json": "./package.json"
-  },
+  "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "0.0.0-nightly-next-20260125.0",
-    "@ckeditor/ckeditor5-icons": "0.0.0-nightly-next-20260125.0",
-    "@ckeditor/ckeditor5-typing": "0.0.0-nightly-next-20260125.0",
-    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-next-20260125.0",
-    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-next-20260125.0"
+    "ckeditor5": "0.0.0-nightly-20260126.0",
+    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20260126.0",
+    "@ckeditor/ckeditor5-icons": "0.0.0-nightly-20260126.0",
+    "@ckeditor/ckeditor5-typing": "0.0.0-nightly-20260126.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20260126.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20260126.0"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-special-characters"
   },
   "files": [
     "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
-  "types": "./dist/index.d.ts"
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./dist/*": {
+      "types": "./src/index.d.ts",
+      "import": "./dist/*",
+      "default": "./dist/*"
+    },
+    "./src/*": {
+      "types": "./src/*.d.ts",
+      "import": "./src/*",
+      "default": "./src/*"
+    },
+    "./build/*": "./build/*",
+    "./lang/*": "./lang/*",
+    "./theme/*": "./theme/*",
+    "./ckeditor5-metadata.json": "./ckeditor5-metadata.json",
+    "./package.json": "./package.json"
+  }
 }

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/index.js

@@ -0,0 +1,19 @@
+/**
+ * @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
+ */
+export { SpecialCharacters } from './specialcharacters.js';
+export { SpecialCharactersArrows } from './specialcharactersarrows.js';
+export { SpecialCharactersText } from './specialcharacterstext.js';
+export { SpecialCharactersMathematical } from './specialcharactersmathematical.js';
+export { SpecialCharactersLatin } from './specialcharacterslatin.js';
+export { SpecialCharactersEssentials } from './specialcharactersessentials.js';
+export { SpecialCharactersCurrency } from './specialcharacterscurrency.js';
+export { CharacterGridView as _SpecialCharactersGridView } from './ui/charactergridview.js';
+export { CharacterInfoView as _SpecialCharactersInfoView } from './ui/characterinfoview.js';
+export { SpecialCharactersCategoriesView as _SpecialCharactersCategoriesView } from './ui/specialcharacterscategoriesview.js';
+export { SpecialCharactersView as _SpecialCharactersView } from './ui/specialcharactersview.js';
+import './augmentation.js';

package/{dist → src}/specialcharacters.d.ts

@@ -5,9 +5,9 @@
 /**
  * @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 { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Typing } from 'ckeditor5/src/typing.js';
+import { Dialog } from 'ckeditor5/src/ui.js';
 import '../theme/specialcharacters.css';
 /**
  * The special characters feature.

package/src/specialcharacters.js

@@ -0,0 +1,260 @@
+/**
+ * @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 } from 'ckeditor5/src/core.js';
+import { Typing } from 'ckeditor5/src/typing.js';
+import { IconSpecialCharacters } from 'ckeditor5/src/icons.js';
+import { ButtonView, MenuBarMenuListItemButtonView, DialogViewPosition, Dialog } from 'ckeditor5/src/ui.js';
+import { CKEditorError } from 'ckeditor5/src/utils.js';
+import { CharacterGridView } from './ui/charactergridview.js';
+import { CharacterInfoView } from './ui/characterinfoview.js';
+import { SpecialCharactersView } from './ui/specialcharactersview.js';
+import '../theme/specialcharacters.css';
+import { SpecialCharactersCategoriesView } from './ui/specialcharacterscategoriesview.js';
+const ALL_SPECIAL_CHARACTERS_GROUP = 'All';
+/**
+ * The special characters feature.
+ *
+ * Introduces the `'specialCharacters'` dropdown.
+ */
+export class SpecialCharacters extends Plugin {
+    /**
+     * Registered characters. A pair of a character name and its symbol.
+     */
+    _characters;
+    /**
+     * Registered groups. Each group contains a displayed label and a collection with symbol names.
+     */
+    _groups;
+    /**
+     * A label describing the "All" special characters category.
+     */
+    _allSpecialCharactersGroupLabel;
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Typing, Dialog];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SpecialCharacters';
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    static get licenseFeatureCode() {
+        return 'SCH';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isPremiumPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        const t = editor.t;
+        this._characters = new Map();
+        this._groups = new Map();
+        this._allSpecialCharactersGroupLabel = t('All');
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.ui.componentFactory.add('specialCharacters', () => {
+            const button = this._createDialogButton(ButtonView);
+            button.set({
+                tooltip: true
+            });
+            return button;
+        });
+        editor.ui.componentFactory.add('menuBar:specialCharacters', () => {
+            return this._createDialogButton(MenuBarMenuListItemButtonView);
+        });
+    }
+    /**
+     * 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, items, options = { label: groupName }) {
+        if (groupName === ALL_SPECIAL_CHARACTERS_GROUP) {
+            /**
+             * The name "All" for a special category group cannot be used because it is a special category that displays all
+             * available special characters.
+             *
+             * @error special-character-invalid-group-name
+             */
+            throw new CKEditorError('special-character-invalid-group-name', null);
+        }
+        const group = this._getGroup(groupName, options.label);
+        for (const item of items) {
+            group.items.add(item.title);
+            this._characters.set(item.title, item.character);
+        }
+    }
+    /**
+     * Returns special character groups in an order determined based on configuration and registration sequence.
+     */
+    getGroups() {
+        const groups = Array.from(this._groups.keys());
+        const order = this.editor.config.get('specialCharacters.order') || [];
+        const invalidGroup = order.find(item => !groups.includes(item));
+        if (invalidGroup) {
+            /**
+             * One of the special character groups in the "specialCharacters.order" configuration doesn't exist.
+             *
+             * @error special-character-invalid-order-group-name
+             */
+            throw new CKEditorError('special-character-invalid-order-group-name', null, { invalidGroup });
+        }
+        return new Set([
+            ...order,
+            ...groups
+        ]);
+    }
+    /**
+     * Returns a collection of special characters symbol names (titles).
+     */
+    getCharactersForGroup(groupName) {
+        if (groupName === ALL_SPECIAL_CHARACTERS_GROUP) {
+            return new Set(this._characters.keys());
+        }
+        const group = this._groups.get(groupName);
+        if (group) {
+            return group.items;
+        }
+    }
+    /**
+     * 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) {
+        return this._characters.get(title);
+    }
+    /**
+     * 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.
+     */
+    _getGroup(groupName, label) {
+        if (!this._groups.has(groupName)) {
+            this._groups.set(groupName, {
+                items: new Set(),
+                label
+            });
+        }
+        return this._groups.get(groupName);
+    }
+    /**
+     * Updates the symbol grid depending on the currently selected character group.
+     */
+    _updateGrid(currentGroupName, gridView) {
+        // Updating the grid starts with removing all tiles belonging to the old group.
+        gridView.tiles.clear();
+        const characterTitles = this.getCharactersForGroup(currentGroupName);
+        for (const title of characterTitles) {
+            const character = this.getCharacter(title);
+            gridView.tiles.add(gridView.createTile(character, title));
+        }
+    }
+    /**
+     * Initializes the dropdown, used for lazy loading.
+     *
+     * @returns An object with `categoriesView`, `gridView` and `infoView` properties, containing UI parts.
+     */
+    _createDropdownPanelContent(locale) {
+        const groupEntries = Array
+            .from(this.getGroups())
+            .map(name => ([name, this._groups.get(name).label]));
+        // The map contains a name of category (an identifier) and its label (a translational string).
+        const specialCharsGroups = new Map([
+            // Add a special group that shows all available special characters.
+            [ALL_SPECIAL_CHARACTERS_GROUP, this._allSpecialCharactersGroupLabel],
+            ...groupEntries
+        ]);
+        const categoriesView = new SpecialCharactersCategoriesView(locale, specialCharsGroups);
+        const gridView = new CharacterGridView(locale);
+        const infoView = new CharacterInfoView(locale);
+        gridView.on('tileHover', (evt, data) => {
+            infoView.set(data);
+        });
+        gridView.on('tileFocus', (evt, data) => {
+            infoView.set(data);
+        });
+        // Update the grid of special characters when a user changed the character group.
+        categoriesView.on('change:currentGroupName', (evt, propertyName, newValue) => {
+            this._updateGrid(newValue, gridView);
+        });
+        // Set the initial content of the special characters grid.
+        this._updateGrid(categoriesView.currentGroupName, gridView);
+        return { categoriesView, gridView, infoView };
+    }
+    /**
+     * Creates a button for toolbar and menu bar that will show special characters dialog.
+     */
+    _createDialogButton(ButtonClass) {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const buttonView = new ButtonClass(editor.locale);
+        const command = editor.commands.get('insertText');
+        const t = locale.t;
+        const dialogPlugin = this.editor.plugins.get('Dialog');
+        buttonView.set({
+            label: t('Special characters'),
+            icon: IconSpecialCharacters,
+            isToggleable: true
+        });
+        buttonView.bind('isOn').to(dialogPlugin, 'id', id => id === 'specialCharacters');
+        buttonView.bind('isEnabled').to(command, 'isEnabled');
+        buttonView.on('execute', () => {
+            if (dialogPlugin.id === 'specialCharacters') {
+                dialogPlugin.hide();
+                return;
+            }
+            this._showDialog();
+        });
+        return buttonView;
+    }
+    _showDialog() {
+        const editor = this.editor;
+        const dialog = editor.plugins.get('Dialog');
+        const locale = editor.locale;
+        const t = locale.t;
+        const { categoriesView, gridView, infoView } = this._createDropdownPanelContent(locale);
+        const content = new SpecialCharactersView(locale, categoriesView, gridView, infoView);
+        gridView.on('execute', (evt, data) => {
+            editor.execute('insertText', { text: data.character });
+        });
+        dialog.show({
+            id: 'specialCharacters',
+            title: t('Special characters'),
+            className: 'ck-special-characters',
+            content,
+            position: DialogViewPosition.EDITOR_TOP_SIDE
+        });
+    }
+}

package/{dist → src}/specialcharactersarrows.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module special-characters/specialcharactersarrows
  */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+import { Plugin } from 'ckeditor5/src/core.js';
 /**
  * A plugin that provides special characters for the "Arrows" category.
  *

package/src/specialcharactersarrows.js

@@ -0,0 +1,66 @@
+/**
+ * @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 'ckeditor5/src/core.js';
+/**
+ * A plugin that provides special characters for the "Arrows" category.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., SpecialCharacters, SpecialCharactersArrows ],
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ */
+export class SpecialCharactersArrows extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SpecialCharactersArrows';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const plugin = editor.plugins.get('SpecialCharacters');
+        plugin.addItems('Arrows', [
+            { title: t('leftwards simple arrow'), character: '←' },
+            { title: t('rightwards simple arrow'), character: '→' },
+            { title: t('upwards simple arrow'), character: '↑' },
+            { title: t('downwards simple arrow'), character: '↓' },
+            { title: t('leftwards double arrow'), character: '⇐' },
+            { title: t('rightwards double arrow'), character: '⇒' },
+            { title: t('upwards double arrow'), character: '⇑' },
+            { title: t('downwards double arrow'), character: '⇓' },
+            { title: t('leftwards dashed arrow'), character: '⇠' },
+            { title: t('rightwards dashed arrow'), character: '⇢' },
+            { title: t('upwards dashed arrow'), character: '⇡' },
+            { title: t('downwards dashed arrow'), character: '⇣' },
+            { title: t('leftwards arrow to bar'), character: '⇤' },
+            { title: t('rightwards arrow to bar'), character: '⇥' },
+            { title: t('upwards arrow to bar'), character: '⤒' },
+            { title: t('downwards arrow to bar'), character: '⤓' },
+            { title: t('up down arrow with base'), character: '↨' },
+            { title: t('back with leftwards arrow above'), character: '🔙' },
+            { title: t('end with leftwards arrow above'), character: '🔚' },
+            { title: t('on with exclamation mark with left right arrow above'), character: '🔛' },
+            { title: t('soon with rightwards arrow above'), character: '🔜' },
+            { title: t('top with upwards arrow above'), character: '🔝' }
+        ], { label: t('Arrows') });
+    }
+}

package/src/specialcharactersconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/{dist → src}/specialcharacterscurrency.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module special-characters/specialcharacterscurrency
  */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+import { Plugin } from 'ckeditor5/src/core.js';
 /**
  * A plugin that provides special characters for the "Currency" category.
  *

package/src/specialcharacterscurrency.js

@@ -0,0 +1,80 @@
+/**
+ * @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 'ckeditor5/src/core.js';
+/**
+ * A plugin that provides special characters for the "Currency" category.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., SpecialCharacters, SpecialCharactersCurrency ],
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ */
+export class SpecialCharactersCurrency extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SpecialCharactersCurrency';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const plugin = editor.plugins.get('SpecialCharacters');
+        plugin.addItems('Currency', [
+            { character: '$', title: t('Dollar sign') },
+            { character: '€', title: t('Euro sign') },
+            { character: '¥', title: t('Yen sign') },
+            { character: '£', title: t('Pound sign') },
+            { character: '¢', title: t('Cent sign') },
+            { character: '₠', title: t('Euro-currency sign') },
+            { character: '₡', title: t('Colon sign') },
+            { character: '₢', title: t('Cruzeiro sign') },
+            { character: '₣', title: t('French franc sign') },
+            { character: '₤', title: t('Lira sign') },
+            { character: '¤', title: t('Currency sign') },
+            { character: '₿', title: t('Bitcoin sign') },
+            { character: '₥', title: t('Mill sign') },
+            { character: '₦', title: t('Naira sign') },
+            { character: '₧', title: t('Peseta sign') },
+            { character: '₨', title: t('Rupee sign') },
+            { character: '₩', title: t('Won sign') },
+            { character: '₪', title: t('New sheqel sign') },
+            { character: '₫', title: t('Dong sign') },
+            { character: '₭', title: t('Kip sign') },
+            { character: '₮', title: t('Tugrik sign') },
+            { character: '₯', title: t('Drachma sign') },
+            { character: '₰', title: t('German penny sign') },
+            { character: '₱', title: t('Peso sign') },
+            { character: '₲', title: t('Guarani sign') },
+            { character: '₳', title: t('Austral sign') },
+            { character: '₴', title: t('Hryvnia sign') },
+            { character: '₵', title: t('Cedi sign') },
+            { character: '₶', title: t('Livre tournois sign') },
+            { character: '₷', title: t('Spesmilo sign') },
+            { character: '₸', title: t('Tenge sign') },
+            { character: '₹', title: t('Indian rupee sign') },
+            { character: '₺', title: t('Turkish lira sign') },
+            { character: '₻', title: t('Nordic mark sign') },
+            { character: '₼', title: t('Manat sign') },
+            { character: '₽', title: t('Ruble sign') }
+        ], { label: t('Currency') });
+    }
+}

package/{dist → src}/specialcharactersessentials.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module special-characters/specialcharactersessentials
  */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+import { Plugin } from 'ckeditor5/src/core.js';
 import { SpecialCharactersCurrency } from './specialcharacterscurrency.js';
 import { SpecialCharactersMathematical } from './specialcharactersmathematical.js';
 import { SpecialCharactersArrows } from './specialcharactersarrows.js';

package/src/specialcharactersessentials.js

@@ -0,0 +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
+ */
+/**
+ * @module special-characters/specialcharactersessentials
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+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( ... );
+ * ```
+ */
+export class SpecialCharactersEssentials extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SpecialCharactersEssentials';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [
+            SpecialCharactersCurrency,
+            SpecialCharactersText,
+            SpecialCharactersMathematical,
+            SpecialCharactersArrows,
+            SpecialCharactersLatin
+        ];
+    }
+}

package/{dist → src}/specialcharacterslatin.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module special-characters/specialcharacterslatin
  */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+import { Plugin } from 'ckeditor5/src/core.js';
 /**
  * A plugin that provides special characters for the "Latin" category.
  *