@ckeditor/ckeditor5-special-characters 39.0.2 → 40.0.0

package/src/specialcharacterstext.js

@@ -1,65 +1,65 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module special-characters/specialcharacterstext
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * A plugin that provides special characters for the "Text" category.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., SpecialCharacters, SpecialCharactersText ],
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
-export default class SpecialCharactersText extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'SpecialCharactersText';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const plugin = editor.plugins.get('SpecialCharacters');
-        plugin.addItems('Text', [
-            { character: '‹', title: t('Single left-pointing angle quotation mark') },
-            { character: '›', title: t('Single right-pointing angle quotation mark') },
-            { character: '«', title: t('Left-pointing double angle quotation mark') },
-            { character: '»', title: t('Right-pointing double angle quotation mark') },
-            { character: '‘', title: t('Left single quotation mark') },
-            { character: '’', title: t('Right single quotation mark') },
-            { character: '“', title: t('Left double quotation mark') },
-            { character: '”', title: t('Right double quotation mark') },
-            { character: '‚', title: t('Single low-9 quotation mark') },
-            { character: '„', title: t('Double low-9 quotation mark') },
-            { character: '¡', title: t('Inverted exclamation mark') },
-            { character: '¿', title: t('Inverted question mark') },
-            { character: '‥', title: t('Two dot leader') },
-            { character: '…', title: t('Horizontal ellipsis') },
-            { character: '‡', title: t('Double dagger') },
-            { character: '‰', title: t('Per mille sign') },
-            { character: '‱', title: t('Per ten thousand sign') },
-            { character: '‼', title: t('Double exclamation mark') },
-            { character: '⁈', title: t('Question exclamation mark') },
-            { character: '⁉', title: t('Exclamation question mark') },
-            { character: '⁇', title: t('Double question mark') },
-            { character: '©', title: t('Copyright sign') },
-            { character: '®', title: t('Registered sign') },
-            { character: '™', title: t('Trade mark sign') },
-            { character: '§', title: t('Section sign') },
-            { character: '¶', title: t('Paragraph sign') },
-            { character: '⁋', title: t('Reversed paragraph sign') }
-        ], { label: t('Text') });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module special-characters/specialcharacterstext
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * A plugin that provides special characters for the "Text" category.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., SpecialCharacters, SpecialCharactersText ],
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ */
+export default class SpecialCharactersText extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SpecialCharactersText';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const plugin = editor.plugins.get('SpecialCharacters');
+        plugin.addItems('Text', [
+            { character: '‹', title: t('Single left-pointing angle quotation mark') },
+            { character: '›', title: t('Single right-pointing angle quotation mark') },
+            { character: '«', title: t('Left-pointing double angle quotation mark') },
+            { character: '»', title: t('Right-pointing double angle quotation mark') },
+            { character: '‘', title: t('Left single quotation mark') },
+            { character: '’', title: t('Right single quotation mark') },
+            { character: '“', title: t('Left double quotation mark') },
+            { character: '”', title: t('Right double quotation mark') },
+            { character: '‚', title: t('Single low-9 quotation mark') },
+            { character: '„', title: t('Double low-9 quotation mark') },
+            { character: '¡', title: t('Inverted exclamation mark') },
+            { character: '¿', title: t('Inverted question mark') },
+            { character: '‥', title: t('Two dot leader') },
+            { character: '…', title: t('Horizontal ellipsis') },
+            { character: '‡', title: t('Double dagger') },
+            { character: '‰', title: t('Per mille sign') },
+            { character: '‱', title: t('Per ten thousand sign') },
+            { character: '‼', title: t('Double exclamation mark') },
+            { character: '⁈', title: t('Question exclamation mark') },
+            { character: '⁉', title: t('Exclamation question mark') },
+            { character: '⁇', title: t('Double question mark') },
+            { character: '©', title: t('Copyright sign') },
+            { character: '®', title: t('Registered sign') },
+            { character: '™', title: t('Trade mark sign') },
+            { character: '§', title: t('Section sign') },
+            { character: '¶', title: t('Paragraph sign') },
+            { character: '⁋', title: t('Reversed paragraph sign') }
+        ], { label: t('Text') });
+    }
+}

package/src/ui/charactergridview.d.ts

@@ -1,94 +1,94 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module special-characters/ui/charactergridview
- */
-import { View, ButtonView, type ViewCollection } from 'ckeditor5/src/ui';
-import { KeystrokeHandler, FocusTracker, type Locale } from 'ckeditor5/src/utils';
-import '../../theme/charactergrid.css';
-/**
- * A grid of character tiles. It allows browsing special characters and selecting the character to
- * be inserted into the content.
- */
-export default class CharacterGridView extends View<HTMLDivElement> {
-    /**
-     * A collection of the child tile views. Each tile represents a particular character.
-     */
-    readonly tiles: ViewCollection<ButtonView>;
-    /**
-     * Tracks information about the DOM focus in the grid.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Creates an instance of a character grid containing tiles representing special characters.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale: Locale);
-    /**
-     * Creates a new tile for the grid.
-     *
-     * @param character A human-readable character displayed as the label (e.g. "ε").
-     * @param name The name of the character (e.g. "greek small letter epsilon").
-     */
-    createTile(character: string, name: string): ButtonView;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the first focusable in {@link ~CharacterGridView#tiles}.
-     */
-    focus(): void;
-}
-/**
- * Fired when any of {@link ~CharacterGridView#tiles grid tiles} is clicked.
- *
- * @eventName ~CharacterGridView#execute
- * @param data Additional information about the event.
- */
-export type CharacterGridViewExecuteEvent = {
-    name: 'execute';
-    args: [data: CharacterGridViewEventData];
-};
-/**
- * Fired when a mouse or another pointing device caused the cursor to move onto any {@link ~CharacterGridView#tiles grid tile}
- * (similar to the native `mouseover` DOM event).
- *
- * @eventName ~CharacterGridView#tileHover
- * @param data Additional information about the event.
- */
-export type CharacterGridViewTileHoverEvent = {
-    name: 'tileHover';
-    args: [data: CharacterGridViewEventData];
-};
-/**
- * Fired when {@link ~CharacterGridView#tiles grid tile} is focused (e.g. by navigating with arrow keys).
- *
- * @eventName ~CharacterGridView#tileFocus
- * @param data Additional information about the event.
- */
-export type CharacterGridViewTileFocusEvent = {
-    name: 'tileFocus';
-    args: [data: CharacterGridViewEventData];
-};
-export interface CharacterGridViewEventData {
-    /**
-     * The name of the tile that caused the event (e.g. "greek small letter epsilon").
-     */
-    name: string;
-    /**
-     * A human-readable character displayed as the label (e.g. "ε").
-     */
-    character: string;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module special-characters/ui/charactergridview
+ */
+import { View, ButtonView, type ViewCollection } from 'ckeditor5/src/ui';
+import { KeystrokeHandler, FocusTracker, type Locale } from 'ckeditor5/src/utils';
+import '../../theme/charactergrid.css';
+/**
+ * A grid of character tiles. It allows browsing special characters and selecting the character to
+ * be inserted into the content.
+ */
+export default class CharacterGridView extends View<HTMLDivElement> {
+    /**
+     * A collection of the child tile views. Each tile represents a particular character.
+     */
+    readonly tiles: ViewCollection<ButtonView>;
+    /**
+     * Tracks information about the DOM focus in the grid.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Creates an instance of a character grid containing tiles representing special characters.
+     *
+     * @param locale The localization services instance.
+     */
+    constructor(locale: Locale);
+    /**
+     * Creates a new tile for the grid.
+     *
+     * @param character A human-readable character displayed as the label (e.g. "ε").
+     * @param name The name of the character (e.g. "greek small letter epsilon").
+     */
+    createTile(character: string, name: string): ButtonView;
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the first focusable in {@link ~CharacterGridView#tiles}.
+     */
+    focus(): void;
+}
+/**
+ * Fired when any of {@link ~CharacterGridView#tiles grid tiles} is clicked.
+ *
+ * @eventName ~CharacterGridView#execute
+ * @param data Additional information about the event.
+ */
+export type CharacterGridViewExecuteEvent = {
+    name: 'execute';
+    args: [data: CharacterGridViewEventData];
+};
+/**
+ * Fired when a mouse or another pointing device caused the cursor to move onto any {@link ~CharacterGridView#tiles grid tile}
+ * (similar to the native `mouseover` DOM event).
+ *
+ * @eventName ~CharacterGridView#tileHover
+ * @param data Additional information about the event.
+ */
+export type CharacterGridViewTileHoverEvent = {
+    name: 'tileHover';
+    args: [data: CharacterGridViewEventData];
+};
+/**
+ * Fired when {@link ~CharacterGridView#tiles grid tile} is focused (e.g. by navigating with arrow keys).
+ *
+ * @eventName ~CharacterGridView#tileFocus
+ * @param data Additional information about the event.
+ */
+export type CharacterGridViewTileFocusEvent = {
+    name: 'tileFocus';
+    args: [data: CharacterGridViewEventData];
+};
+export interface CharacterGridViewEventData {
+    /**
+     * The name of the tile that caused the event (e.g. "greek small letter epsilon").
+     */
+    name: string;
+    /**
+     * A human-readable character displayed as the label (e.g. "ε").
+     */
+    character: string;
+}

package/src/ui/charactergridview.js

@@ -1,129 +1,129 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module special-characters/ui/charactergridview
- */
-import { View, ButtonView, addKeyboardHandlingForGrid } from 'ckeditor5/src/ui';
-import { KeystrokeHandler, FocusTracker, global } from 'ckeditor5/src/utils';
-import '../../theme/charactergrid.css';
-/**
- * A grid of character tiles. It allows browsing special characters and selecting the character to
- * be inserted into the content.
- */
-export default class CharacterGridView extends View {
-    /**
-     * Creates an instance of a character grid containing tiles representing special characters.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale) {
-        super(locale);
-        this.tiles = this.createCollection();
-        this.setTemplate({
-            tag: 'div',
-            children: [
-                {
-                    tag: 'div',
-                    attributes: {
-                        class: [
-                            'ck',
-                            'ck-character-grid__tiles'
-                        ]
-                    },
-                    children: this.tiles
-                }
-            ],
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-character-grid'
-                ]
-            }
-        });
-        this.focusTracker = new FocusTracker();
-        this.keystrokes = new KeystrokeHandler();
-        addKeyboardHandlingForGrid({
-            keystrokeHandler: this.keystrokes,
-            focusTracker: this.focusTracker,
-            gridItems: this.tiles,
-            numberOfColumns: () => global.window
-                .getComputedStyle(this.element.firstChild) // Responsive .ck-character-grid__tiles
-                .getPropertyValue('grid-template-columns')
-                .split(' ')
-                .length,
-            uiLanguageDirection: this.locale && this.locale.uiLanguageDirection
-        });
-    }
-    /**
-     * Creates a new tile for the grid.
-     *
-     * @param character A human-readable character displayed as the label (e.g. "ε").
-     * @param name The name of the character (e.g. "greek small letter epsilon").
-     */
-    createTile(character, name) {
-        const tile = new ButtonView(this.locale);
-        tile.set({
-            label: character,
-            withText: true,
-            class: 'ck-character-grid__tile'
-        });
-        // Labels are vital for the users to understand what character they're looking at.
-        // For now we're using native title attribute for that, see #5817.
-        tile.extendTemplate({
-            attributes: {
-                title: name
-            },
-            on: {
-                mouseover: tile.bindTemplate.to('mouseover'),
-                focus: tile.bindTemplate.to('focus')
-            }
-        });
-        tile.on('mouseover', () => {
-            this.fire('tileHover', { name, character });
-        });
-        tile.on('focus', () => {
-            this.fire('tileFocus', { name, character });
-        });
-        tile.on('execute', () => {
-            this.fire('execute', { name, character });
-        });
-        return tile;
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        for (const item of this.tiles) {
-            this.focusTracker.add(item.element);
-        }
-        this.tiles.on('change', (eventInfo, { added, removed }) => {
-            if (added.length > 0) {
-                for (const item of added) {
-                    this.focusTracker.add(item.element);
-                }
-            }
-            if (removed.length > 0) {
-                for (const item of removed) {
-                    this.focusTracker.remove(item.element);
-                }
-            }
-        });
-        this.keystrokes.listenTo(this.element);
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.keystrokes.destroy();
-    }
-    /**
-     * Focuses the first focusable in {@link ~CharacterGridView#tiles}.
-     */
-    focus() {
-        this.tiles.first.focus();
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module special-characters/ui/charactergridview
+ */
+import { View, ButtonView, addKeyboardHandlingForGrid } from 'ckeditor5/src/ui';
+import { KeystrokeHandler, FocusTracker, global } from 'ckeditor5/src/utils';
+import '../../theme/charactergrid.css';
+/**
+ * A grid of character tiles. It allows browsing special characters and selecting the character to
+ * be inserted into the content.
+ */
+export default class CharacterGridView extends View {
+    /**
+     * Creates an instance of a character grid containing tiles representing special characters.
+     *
+     * @param locale The localization services instance.
+     */
+    constructor(locale) {
+        super(locale);
+        this.tiles = this.createCollection();
+        this.setTemplate({
+            tag: 'div',
+            children: [
+                {
+                    tag: 'div',
+                    attributes: {
+                        class: [
+                            'ck',
+                            'ck-character-grid__tiles'
+                        ]
+                    },
+                    children: this.tiles
+                }
+            ],
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-character-grid'
+                ]
+            }
+        });
+        this.focusTracker = new FocusTracker();
+        this.keystrokes = new KeystrokeHandler();
+        addKeyboardHandlingForGrid({
+            keystrokeHandler: this.keystrokes,
+            focusTracker: this.focusTracker,
+            gridItems: this.tiles,
+            numberOfColumns: () => global.window
+                .getComputedStyle(this.element.firstChild) // Responsive .ck-character-grid__tiles
+                .getPropertyValue('grid-template-columns')
+                .split(' ')
+                .length,
+            uiLanguageDirection: this.locale && this.locale.uiLanguageDirection
+        });
+    }
+    /**
+     * Creates a new tile for the grid.
+     *
+     * @param character A human-readable character displayed as the label (e.g. "ε").
+     * @param name The name of the character (e.g. "greek small letter epsilon").
+     */
+    createTile(character, name) {
+        const tile = new ButtonView(this.locale);
+        tile.set({
+            label: character,
+            withText: true,
+            class: 'ck-character-grid__tile'
+        });
+        // Labels are vital for the users to understand what character they're looking at.
+        // For now we're using native title attribute for that, see #5817.
+        tile.extendTemplate({
+            attributes: {
+                title: name
+            },
+            on: {
+                mouseover: tile.bindTemplate.to('mouseover'),
+                focus: tile.bindTemplate.to('focus')
+            }
+        });
+        tile.on('mouseover', () => {
+            this.fire('tileHover', { name, character });
+        });
+        tile.on('focus', () => {
+            this.fire('tileFocus', { name, character });
+        });
+        tile.on('execute', () => {
+            this.fire('execute', { name, character });
+        });
+        return tile;
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        for (const item of this.tiles) {
+            this.focusTracker.add(item.element);
+        }
+        this.tiles.on('change', (eventInfo, { added, removed }) => {
+            if (added.length > 0) {
+                for (const item of added) {
+                    this.focusTracker.add(item.element);
+                }
+            }
+            if (removed.length > 0) {
+                for (const item of removed) {
+                    this.focusTracker.remove(item.element);
+                }
+            }
+        });
+        this.keystrokes.listenTo(this.element);
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.keystrokes.destroy();
+    }
+    /**
+     * Focuses the first focusable in {@link ~CharacterGridView#tiles}.
+     */
+    focus() {
+        this.tiles.first.focus();
+    }
+}

package/src/ui/characterinfoview.d.ts

@@ -1,35 +1,35 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module special-characters/ui/characterinfoview
- */
-import type { Locale } from 'ckeditor5/src/utils';
-import { View } from 'ckeditor5/src/ui';
-import '../../theme/characterinfo.css';
-/**
- * The view displaying detailed information about a special character glyph, e.g. upon
- * hovering it with a mouse.
- */
-export default class CharacterInfoView extends View<HTMLDivElement> {
-    /**
-     * The character whose information is displayed by the view. For instance, "∑" or "¿".
-     *
-     * @observable
-     */
-    character: string | null;
-    /**
-     * The name of the {@link #character}. For instance, "N-ary summation" or "Inverted question mark".
-     *
-     * @observable
-     */
-    name: string | null;
-    /**
-     * The "Unicode string" of the {@link #character}. For instance "U+0061".
-     *
-     * @observable
-     */
-    readonly code: string;
-    constructor(locale: Locale);
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module special-characters/ui/characterinfoview
+ */
+import type { Locale } from 'ckeditor5/src/utils';
+import { View } from 'ckeditor5/src/ui';
+import '../../theme/characterinfo.css';
+/**
+ * The view displaying detailed information about a special character glyph, e.g. upon
+ * hovering it with a mouse.
+ */
+export default class CharacterInfoView extends View<HTMLDivElement> {
+    /**
+     * The character whose information is displayed by the view. For instance, "∑" or "¿".
+     *
+     * @observable
+     */
+    character: string | null;
+    /**
+     * The name of the {@link #character}. For instance, "N-ary summation" or "Inverted question mark".
+     *
+     * @observable
+     */
+    name: string | null;
+    /**
+     * The "Unicode string" of the {@link #character}. For instance "U+0061".
+     *
+     * @observable
+     */
+    readonly code: string;
+    constructor(locale: Locale);
+}