@ckeditor/ckeditor5-special-characters 39.0.1 → 40.0.0

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;
+}

package/src/ui/specialcharactersview.js

@@ -1,78 +1,78 @@
-/**
- * @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 } from 'ckeditor5/src/ui';
-import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils';
-/**
- * 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 {
-    /**
-     * Creates an instance of the `SpecialCharactersView`.
-     */
-    constructor(locale, navigationView, gridView, infoView) {
-        super(locale);
-        this.navigationView = navigationView;
-        this.gridView = gridView;
-        this.infoView = infoView;
-        this.items = this.createCollection();
-        this.focusTracker = new FocusTracker();
-        this.keystrokes = new KeystrokeHandler();
-        this._focusCycler = new FocusCycler({
-            focusables: this.items,
-            focusTracker: this.focusTracker,
-            keystrokeHandler: this.keystrokes,
-            actions: {
-                focusPrevious: 'shift + tab',
-                focusNext: 'tab'
-            }
-        });
-        this.setTemplate({
-            tag: 'div',
-            children: [
-                this.navigationView,
-                this.gridView,
-                this.infoView
-            ],
-            attributes: {
-                // Avoid focus loss when the user clicks the area of the grid that is not a button.
-                // https://github.com/ckeditor/ckeditor5/pull/12319#issuecomment-1231779819
-                tabindex: '-1'
-            }
-        });
-        this.items.add(this.navigationView.groupDropdownView.buttonView);
-        this.items.add(this.gridView);
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        this.focusTracker.add(this.navigationView.groupDropdownView.buttonView.element);
-        this.focusTracker.add(this.gridView.element);
-        // Start listening for the keystrokes coming from #element.
-        this.keystrokes.listenTo(this.element);
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.focusTracker.destroy();
-        this.keystrokes.destroy();
-    }
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focus() {
-        this.navigationView.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/specialcharactersview
+ */
+import { View, FocusCycler } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils';
+/**
+ * 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 {
+    /**
+     * Creates an instance of the `SpecialCharactersView`.
+     */
+    constructor(locale, navigationView, gridView, infoView) {
+        super(locale);
+        this.navigationView = navigationView;
+        this.gridView = gridView;
+        this.infoView = infoView;
+        this.items = this.createCollection();
+        this.focusTracker = new FocusTracker();
+        this.keystrokes = new KeystrokeHandler();
+        this._focusCycler = new FocusCycler({
+            focusables: this.items,
+            focusTracker: this.focusTracker,
+            keystrokeHandler: this.keystrokes,
+            actions: {
+                focusPrevious: 'shift + tab',
+                focusNext: 'tab'
+            }
+        });
+        this.setTemplate({
+            tag: 'div',
+            children: [
+                this.navigationView,
+                this.gridView,
+                this.infoView
+            ],
+            attributes: {
+                // Avoid focus loss when the user clicks the area of the grid that is not a button.
+                // https://github.com/ckeditor/ckeditor5/pull/12319#issuecomment-1231779819
+                tabindex: '-1'
+            }
+        });
+        this.items.add(this.navigationView.groupDropdownView.buttonView);
+        this.items.add(this.gridView);
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        this.focusTracker.add(this.navigationView.groupDropdownView.buttonView.element);
+        this.focusTracker.add(this.gridView.element);
+        // Start listening for the keystrokes coming from #element.
+        this.keystrokes.listenTo(this.element);
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.focusTracker.destroy();
+        this.keystrokes.destroy();
+    }
+    /**
+     * Focuses the first focusable in {@link #items}.
+     */
+    focus() {
+        this.navigationView.focus();
+    }
+}