@ckeditor/ckeditor5-special-characters 40.0.0 → 40.1.0

package/src/ui/characterinfoview.js

@@ -1,71 +1,71 @@
-/**
- * @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
- */
-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 {
-    constructor(locale) {
-        super(locale);
-        const bind = this.bindTemplate;
-        this.set('character', null);
-        this.set('name', null);
-        this.bind('code').to(this, 'character', characterToUnicodeString);
-        this.setTemplate({
-            tag: 'div',
-            children: [
-                {
-                    tag: 'span',
-                    attributes: {
-                        class: [
-                            'ck-character-info__name'
-                        ]
-                    },
-                    children: [
-                        {
-                            // Note: ZWSP to prevent vertical collapsing.
-                            text: bind.to('name', name => name ? name : '\u200B')
-                        }
-                    ]
-                },
-                {
-                    tag: 'span',
-                    attributes: {
-                        class: [
-                            'ck-character-info__code'
-                        ]
-                    },
-                    children: [
-                        {
-                            text: bind.to('code')
-                        }
-                    ]
-                }
-            ],
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-character-info'
-                ]
-            }
-        });
-    }
-}
-/**
- * Converts a character into a "Unicode string", for instance:
- *
- * "$" -> "U+0024"
- *
- * Returns an empty string when the character is `null`.
- */
-function characterToUnicodeString(character) {
-    if (character === null) {
-        return '';
-    }
-    const hexCode = character.codePointAt(0).toString(16);
-    return 'U+' + ('0000' + hexCode).slice(-4);
-}
+/**
+ * @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
+ */
+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 {
+    constructor(locale) {
+        super(locale);
+        const bind = this.bindTemplate;
+        this.set('character', null);
+        this.set('name', null);
+        this.bind('code').to(this, 'character', characterToUnicodeString);
+        this.setTemplate({
+            tag: 'div',
+            children: [
+                {
+                    tag: 'span',
+                    attributes: {
+                        class: [
+                            'ck-character-info__name'
+                        ]
+                    },
+                    children: [
+                        {
+                            // Note: ZWSP to prevent vertical collapsing.
+                            text: bind.to('name', name => name ? name : '\u200B')
+                        }
+                    ]
+                },
+                {
+                    tag: 'span',
+                    attributes: {
+                        class: [
+                            'ck-character-info__code'
+                        ]
+                    },
+                    children: [
+                        {
+                            text: bind.to('code')
+                        }
+                    ]
+                }
+            ],
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-character-info'
+                ]
+            }
+        });
+    }
+}
+/**
+ * Converts a character into a "Unicode string", for instance:
+ *
+ * "$" -> "U+0024"
+ *
+ * Returns an empty string when the character is `null`.
+ */
+function characterToUnicodeString(character) {
+    if (character === null) {
+        return '';
+    }
+    const hexCode = character.codePointAt(0).toString(16);
+    return 'U+' + ('0000' + hexCode).slice(-4);
+}

package/src/ui/specialcharactersnavigationview.d.ts

@@ -1,59 +1,59 @@
-/**
- * @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/specialcharactersnavigationview
- */
-import { type Locale } from 'ckeditor5/src/utils';
-import { FormHeaderView, type DropdownView } from 'ckeditor5/src/ui';
-/**
- * A class representing the navigation part of the special characters UI. It is responsible
- * for describing the feature and allowing the user to select a particular character group.
- */
-export default class SpecialCharactersNavigationView extends FormHeaderView {
-    /**
-     * A dropdown that allows selecting a group of special characters to be displayed.
-     */
-    groupDropdownView: GroupDropdownView;
-    /**
-     * Creates an instance of the {@link module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView}
-     * class.
-     *
-     * @param locale The localization services instance.
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    constructor(locale: Locale, groupNames: GroupNames);
-    /**
-     * Returns the name of the character group currently selected in the {@link #groupDropdownView}.
-     */
-    get currentGroupName(): string;
-    /**
-     * Focuses the character categories dropdown.
-     */
-    focus(): void;
-    /**
-     * Returns a dropdown that allows selecting character groups.
-     *
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    private _createGroupDropdown;
-    /**
-     * Returns list item definitions to be used in the character group dropdown
-     * representing specific character groups.
-     *
-     * @param dropdown Dropdown view element
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    private _getCharacterGroupListItemDefinitions;
-}
-/**
- * The names of the character groups and their displayed labels.
- */
-export type GroupNames = Map<string, string>;
-/**
- * `DropdownView` with additional field for the name of the currectly selected character group.
- */
-export type GroupDropdownView = DropdownView & {
-    value: 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/specialcharactersnavigationview
+ */
+import { type Locale } from 'ckeditor5/src/utils';
+import { FormHeaderView, type DropdownView } from 'ckeditor5/src/ui';
+/**
+ * A class representing the navigation part of the special characters UI. It is responsible
+ * for describing the feature and allowing the user to select a particular character group.
+ */
+export default class SpecialCharactersNavigationView extends FormHeaderView {
+    /**
+     * A dropdown that allows selecting a group of special characters to be displayed.
+     */
+    groupDropdownView: GroupDropdownView;
+    /**
+     * Creates an instance of the {@link module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView}
+     * class.
+     *
+     * @param locale The localization services instance.
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    constructor(locale: Locale, groupNames: GroupNames);
+    /**
+     * Returns the name of the character group currently selected in the {@link #groupDropdownView}.
+     */
+    get currentGroupName(): string;
+    /**
+     * Focuses the character categories dropdown.
+     */
+    focus(): void;
+    /**
+     * Returns a dropdown that allows selecting character groups.
+     *
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    private _createGroupDropdown;
+    /**
+     * Returns list item definitions to be used in the character group dropdown
+     * representing specific character groups.
+     *
+     * @param dropdown Dropdown view element
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    private _getCharacterGroupListItemDefinitions;
+}
+/**
+ * The names of the character groups and their displayed labels.
+ */
+export type GroupNames = Map<string, string>;
+/**
+ * `DropdownView` with additional field for the name of the currectly selected character group.
+ */
+export type GroupDropdownView = DropdownView & {
+    value: string;
+};

package/src/ui/specialcharactersnavigationview.js

@@ -1,95 +1,95 @@
-/**
- * @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/specialcharactersnavigationview
- */
-import { Collection } from 'ckeditor5/src/utils';
-import { addListToDropdown, createDropdown, Model, FormHeaderView } from 'ckeditor5/src/ui';
-/**
- * A class representing the navigation part of the special characters UI. It is responsible
- * for describing the feature and allowing the user to select a particular character group.
- */
-export default class SpecialCharactersNavigationView extends FormHeaderView {
-    /**
-     * Creates an instance of the {@link module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView}
-     * class.
-     *
-     * @param locale The localization services instance.
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    constructor(locale, groupNames) {
-        super(locale);
-        const t = locale.t;
-        this.set('class', 'ck-special-characters-navigation');
-        this.groupDropdownView = this._createGroupDropdown(groupNames);
-        this.groupDropdownView.panelPosition = locale.uiLanguageDirection === 'rtl' ? 'se' : 'sw';
-        this.label = t('Special characters');
-        this.children.add(this.groupDropdownView);
-    }
-    /**
-     * Returns the name of the character group currently selected in the {@link #groupDropdownView}.
-     */
-    get currentGroupName() {
-        return this.groupDropdownView.value;
-    }
-    /**
-     * Focuses the character categories dropdown.
-     */
-    focus() {
-        this.groupDropdownView.focus();
-    }
-    /**
-     * Returns a dropdown that allows selecting character groups.
-     *
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    _createGroupDropdown(groupNames) {
-        const locale = this.locale;
-        const t = locale.t;
-        const dropdown = createDropdown(locale);
-        const groupDefinitions = this._getCharacterGroupListItemDefinitions(dropdown, groupNames);
-        const accessibleLabel = t('Character categories');
-        dropdown.set('value', groupDefinitions.first.model.name);
-        dropdown.buttonView.bind('label').to(dropdown, 'value', value => groupNames.get(value));
-        dropdown.buttonView.set({
-            isOn: false,
-            withText: true,
-            tooltip: accessibleLabel,
-            class: ['ck-dropdown__button_label-width_auto'],
-            ariaLabel: accessibleLabel,
-            ariaLabelledBy: undefined
-        });
-        dropdown.on('execute', evt => {
-            dropdown.value = evt.source.name;
-        });
-        dropdown.delegate('execute').to(this);
-        addListToDropdown(dropdown, groupDefinitions, {
-            ariaLabel: accessibleLabel,
-            role: 'menu'
-        });
-        return dropdown;
-    }
-    /**
-     * Returns list item definitions to be used in the character group dropdown
-     * representing specific character groups.
-     *
-     * @param dropdown Dropdown view element
-     * @param groupNames The names of the character groups and their displayed labels.
-     */
-    _getCharacterGroupListItemDefinitions(dropdown, groupNames) {
-        const groupDefs = new Collection();
-        for (const [name, label] of groupNames) {
-            const model = new Model({
-                name,
-                label,
-                withText: true,
-                role: 'menuitemradio'
-            });
-            model.bind('isOn').to(dropdown, 'value', value => value === model.name);
-            groupDefs.add({ type: 'button', model });
-        }
-        return groupDefs;
-    }
-}
+/**
+ * @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/specialcharactersnavigationview
+ */
+import { Collection } from 'ckeditor5/src/utils';
+import { addListToDropdown, createDropdown, Model, FormHeaderView } from 'ckeditor5/src/ui';
+/**
+ * A class representing the navigation part of the special characters UI. It is responsible
+ * for describing the feature and allowing the user to select a particular character group.
+ */
+export default class SpecialCharactersNavigationView extends FormHeaderView {
+    /**
+     * Creates an instance of the {@link module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView}
+     * class.
+     *
+     * @param locale The localization services instance.
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    constructor(locale, groupNames) {
+        super(locale);
+        const t = locale.t;
+        this.set('class', 'ck-special-characters-navigation');
+        this.groupDropdownView = this._createGroupDropdown(groupNames);
+        this.groupDropdownView.panelPosition = locale.uiLanguageDirection === 'rtl' ? 'se' : 'sw';
+        this.label = t('Special characters');
+        this.children.add(this.groupDropdownView);
+    }
+    /**
+     * Returns the name of the character group currently selected in the {@link #groupDropdownView}.
+     */
+    get currentGroupName() {
+        return this.groupDropdownView.value;
+    }
+    /**
+     * Focuses the character categories dropdown.
+     */
+    focus() {
+        this.groupDropdownView.focus();
+    }
+    /**
+     * Returns a dropdown that allows selecting character groups.
+     *
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    _createGroupDropdown(groupNames) {
+        const locale = this.locale;
+        const t = locale.t;
+        const dropdown = createDropdown(locale);
+        const groupDefinitions = this._getCharacterGroupListItemDefinitions(dropdown, groupNames);
+        const accessibleLabel = t('Character categories');
+        dropdown.set('value', groupDefinitions.first.model.name);
+        dropdown.buttonView.bind('label').to(dropdown, 'value', value => groupNames.get(value));
+        dropdown.buttonView.set({
+            isOn: false,
+            withText: true,
+            tooltip: accessibleLabel,
+            class: ['ck-dropdown__button_label-width_auto'],
+            ariaLabel: accessibleLabel,
+            ariaLabelledBy: undefined
+        });
+        dropdown.on('execute', evt => {
+            dropdown.value = evt.source.name;
+        });
+        dropdown.delegate('execute').to(this);
+        addListToDropdown(dropdown, groupDefinitions, {
+            ariaLabel: accessibleLabel,
+            role: 'menu'
+        });
+        return dropdown;
+    }
+    /**
+     * Returns list item definitions to be used in the character group dropdown
+     * representing specific character groups.
+     *
+     * @param dropdown Dropdown view element
+     * @param groupNames The names of the character groups and their displayed labels.
+     */
+    _getCharacterGroupListItemDefinitions(dropdown, groupNames) {
+        const groupDefs = new Collection();
+        for (const [name, label] of groupNames) {
+            const model = new Model({
+                name,
+                label,
+                withText: true,
+                role: 'menuitemradio'
+            });
+            model.bind('isOn').to(dropdown, 'value', value => value === model.name);
+            groupDefs.add({ type: 'button', model });
+        }
+        return groupDefs;
+    }
+}

package/src/ui/specialcharactersview.d.ts

@@ -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/ui/specialcharactersview
- */
-import { View, FocusCycler, type ViewCollection } from 'ckeditor5/src/ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils';
-import type CharacterGridView from './charactergridview';
-import type CharacterInfoView from './characterinfoview';
-import type SpecialCharactersNavigationView from './specialcharactersnavigationview';
-/**
- * A view that glues pieces of the special characters dropdown panel together:
- *
- * * the navigation view (allows selecting the category),
- * * the grid view (displays characters as a grid),
- * * and the info view (displays detailed info about a specific character).
- */
-export default class SpecialCharactersView extends View<HTMLDivElement> {
-    /**
-     * A collection of the focusable children of the view.
-     */
-    readonly items: ViewCollection;
-    /**
-     * Tracks information about the DOM focus in the view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #items} in the view.
-     */
-    protected readonly _focusCycler: FocusCycler;
-    /**
-     * An instance of the `SpecialCharactersNavigationView`.
-     */
-    navigationView: SpecialCharactersNavigationView;
-    /**
-     * An instance of the `CharacterGridView`.
-     */
-    gridView: CharacterGridView;
-    /**
-     * An instance of the `CharacterInfoView`.
-     */
-    infoView: CharacterInfoView;
-    /**
-     * Creates an instance of the `SpecialCharactersView`.
-     */
-    constructor(locale: Locale, navigationView: SpecialCharactersNavigationView, gridView: CharacterGridView, infoView: CharacterInfoView);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focus(): void;
-}
+/**
+ * @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/specialcharactersview
+ */
+import { View, FocusCycler, type ViewCollection } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils';
+import type CharacterGridView from './charactergridview';
+import type CharacterInfoView from './characterinfoview';
+import type SpecialCharactersNavigationView from './specialcharactersnavigationview';
+/**
+ * A view that glues pieces of the special characters dropdown panel together:
+ *
+ * * the navigation view (allows selecting the category),
+ * * the grid view (displays characters as a grid),
+ * * and the info view (displays detailed info about a specific character).
+ */
+export default class SpecialCharactersView extends View<HTMLDivElement> {
+    /**
+     * A collection of the focusable children of the view.
+     */
+    readonly items: ViewCollection;
+    /**
+     * Tracks information about the DOM focus in the view.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Helps cycling over focusable {@link #items} in the view.
+     */
+    protected readonly _focusCycler: FocusCycler;
+    /**
+     * An instance of the `SpecialCharactersNavigationView`.
+     */
+    navigationView: SpecialCharactersNavigationView;
+    /**
+     * An instance of the `CharacterGridView`.
+     */
+    gridView: CharacterGridView;
+    /**
+     * An instance of the `CharacterInfoView`.
+     */
+    infoView: CharacterInfoView;
+    /**
+     * Creates an instance of the `SpecialCharactersView`.
+     */
+    constructor(locale: Locale, navigationView: SpecialCharactersNavigationView, gridView: CharacterGridView, infoView: CharacterInfoView);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the first focusable in {@link #items}.
+     */
+    focus(): void;
+}