@ckeditor/ckeditor5-special-characters 44.1.0 → 44.2.0-alpha.0

package/dist/ui/charactergridview.d.ts

@@ -1,98 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/ui/charactergridview
- */
-import { View, ButtonView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { KeystrokeHandler, FocusTracker, type Locale } from 'ckeditor5/src/utils.js';
-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/dist/ui/characterinfoview.d.ts

@@ -1,39 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/ui/characterinfoview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { View } from 'ckeditor5/src/ui.js';
-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);
-}

package/dist/ui/specialcharacterscategoriesview.d.ts

@@ -1,45 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/ui/specialcharacterscategoriesview
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { View } from 'ckeditor5/src/ui.js';
-/**
- * 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 SpecialCharactersCategoriesView extends View {
-    /**
-     * Currently selected special characters group's name.
-     */
-    currentGroupName: string;
-    private _groupNames;
-    private _dropdownView;
-    /**
-     * Creates an instance of the {@link module:special-characters/ui/specialcharacterscategoriesview~SpecialCharactersCategoriesView}
-     * class.
-     *
-     * @param locale The localization services instance.
-     * @param groupNames The names of the character groups.
-     */
-    constructor(locale: Locale, groupNames: Map<string, string>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * Creates dropdown item list, sets up bindings and fills properties.
-     */
-    private _setupDropdown;
-}

package/dist/ui/specialcharactersview.d.ts

@@ -1,69 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/ui/specialcharactersview
- */
-import { View, FocusCycler, type ViewCollection, type FocusableView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import type CharacterGridView from './charactergridview.js';
-import type CharacterInfoView from './characterinfoview.js';
-import type SpecialCharactersCategoriesView from './specialcharacterscategoriesview.js';
-/**
- * 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<FocusableView>;
-    /**
-     * 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 `SpecialCharactersCategoriesView`.
-     */
-    categoriesView: SpecialCharactersCategoriesView;
-    /**
-     * An instance of the `CharacterGridView`.
-     */
-    gridView: CharacterGridView;
-    /**
-     * An instance of the `CharacterInfoView`.
-     */
-    infoView: CharacterInfoView;
-    /**
-     * Creates an instance of the `SpecialCharactersView`.
-     */
-    constructor(locale: Locale, categoriesView: SpecialCharactersCategoriesView, gridView: CharacterGridView, infoView: CharacterInfoView);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focus(): void;
-}