@ckeditor/ckeditor5-ui 40.0.0 → 40.2.0

package/src/editorui/editorui.d.ts

@@ -1,282 +1,288 @@
-/**
- * @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 ui/editorui/editorui
- */
-import ComponentFactory from '../componentfactory';
-import TooltipManager from '../tooltipmanager';
-import PoweredBy from './poweredby';
-import type EditorUIView from './editoruiview';
-import type ToolbarView from '../toolbar/toolbarview';
-import { FocusTracker } from '@ckeditor/ckeditor5-utils';
-import type { Editor } from '@ckeditor/ckeditor5-core';
-declare const EditorUI_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
-/**
- * A class providing the minimal interface that is required to successfully bootstrap any editor UI.
- */
-export default abstract class EditorUI extends EditorUI_base {
-    /**
-     * The editor that the UI belongs to.
-     */
-    readonly editor: Editor;
-    /**
-     * An instance of the {@link module:ui/componentfactory~ComponentFactory}, a registry used by plugins
-     * to register factories of specific UI components.
-     */
-    readonly componentFactory: ComponentFactory;
-    /**
-     * Stores the information about the editor UI focus and propagates it so various plugins and components
-     * are unified as a focus group.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Manages the tooltips displayed on mouseover and focus across the UI.
-     */
-    readonly tooltipManager: TooltipManager;
-    /**
-     * A helper that enables the "powered by" feature in the editor and renders a link to the project's webpage.
-     */
-    readonly poweredBy: PoweredBy;
-    /**
-     * Indicates the UI is ready. Set `true` after {@link #event:ready} event is fired.
-     *
-     * @readonly
-     * @default false
-     */
-    isReady: boolean;
-    abstract get view(): EditorUIView;
-    /**
-     * Stores viewport offsets from every direction.
-     *
-     * Viewport offset can be used to constrain balloons or other UI elements into an element smaller than the viewport.
-     * This can be useful if there are any other absolutely positioned elements that may interfere with editor UI.
-     *
-     * Example `editor.ui.viewportOffset` returns:
-     *
-     * ```js
-     * {
-     * 	top: 50,
-     * 	right: 50,
-     * 	bottom: 50,
-     * 	left: 50
-     * }
-     * ```
-     *
-     * This property can be overriden after editor already being initialized:
-     *
-     * ```js
-     * editor.ui.viewportOffset = {
-     * 	top: 100,
-     * 	right: 0,
-     * 	bottom: 0,
-     * 	left: 0
-     * };
-     * ```
-     *
-     * @observable
-     */
-    viewportOffset: {
-        left?: number;
-        right?: number;
-        top?: number;
-        bottom?: number;
-    };
-    /**
-     * Stores all editable elements used by the editor instance.
-     */
-    private _editableElementsMap;
-    /**
-     * All available & focusable toolbars.
-     */
-    private _focusableToolbarDefinitions;
-    /**
-     * Creates an instance of the editor UI class.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * The main (outermost) DOM element of the editor UI.
-     *
-     * For example, in {@link module:editor-classic/classiceditor~ClassicEditor} it is a `<div>` which
-     * wraps the editable element and the toolbar. In {@link module:editor-inline/inlineeditor~InlineEditor}
-     * it is the editable element itself (as there is no other wrapper). However, in
-     * {@link module:editor-decoupled/decouplededitor~DecoupledEditor} it is set to `null` because this editor does not
-     * come with a single "main" HTML element (its editable element and toolbar are separate).
-     *
-     * This property can be understood as a shorthand for retrieving the element that a specific editor integration
-     * considers to be its main DOM element.
-     */
-    get element(): HTMLElement | null;
-    /**
-     * Fires the {@link module:ui/editorui/editorui~EditorUI#event:update `update`} event.
-     *
-     * This method should be called when the editor UI (e.g. positions of its balloons) needs to be updated due to
-     * some environmental change which CKEditor 5 is not aware of (e.g. resize of a container in which it is used).
-     */
-    update(): void;
-    /**
-     * Destroys the UI.
-     */
-    destroy(): void;
-    /**
-     * Stores the native DOM editable element used by the editor under a unique name.
-     *
-     * Also, registers the element in the editor to maintain the accessibility of the UI. When the user is editing text in a focusable
-     * editable area, they can use the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke to navigate over editor toolbars. See {@link #addToolbar}.
-     *
-     * @param rootName The unique name of the editable element.
-     * @param domElement The native DOM editable element.
-     */
-    setEditableElement(rootName: string, domElement: HTMLElement): void;
-    /**
-     * Removes the editable from the editor UI. Removes all handlers added by {@link #setEditableElement}.
-     *
-     * @param rootName The name of the editable element to remove.
-     */
-    removeEditableElement(rootName: string): void;
-    /**
-     * Returns the editable editor element with the given name or null if editable does not exist.
-     *
-     * @param rootName The editable name.
-     */
-    getEditableElement(rootName?: string): HTMLElement | undefined;
-    /**
-     * Returns array of names of all editor editable elements.
-     */
-    getEditableElementsNames(): IterableIterator<string>;
-    /**
-     * Adds a toolbar to the editor UI. Used primarily to maintain the accessibility of the UI.
-     *
-     * Focusable toolbars can be accessed (focused) by users by pressing the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke.
-     * Successive keystroke presses navigate over available toolbars.
-     *
-     * @param toolbarView A instance of the toolbar to be registered.
-     */
-    addToolbar(toolbarView: ToolbarView, options?: FocusableToolbarOptions): void;
-    /**
-     * Stores all editable elements used by the editor instance.
-     *
-     * @deprecated
-     */
-    protected get _editableElements(): unknown;
-    /**
-     * Returns viewport offsets object:
-     *
-     * ```js
-     * {
-     * 	top: Number,
-     * 	right: Number,
-     * 	bottom: Number,
-     * 	left: Number
-     * }
-     * ```
-     *
-     * Only top property is currently supported.
-     */
-    private _readViewportOffsetFromConfig;
-    /**
-     * Starts listening for <kbd>Alt</kbd> + <kbd>F10</kbd> and <kbd>Esc</kbd> keystrokes in the context of focusable
-     * {@link #setEditableElement editable elements} and {@link #addToolbar toolbars}
-     * to allow users navigate across the UI.
-     */
-    private _initFocusTracking;
-    /**
-     * Returns definitions of toolbars that could potentially be focused, sorted by their importance for the user.
-     *
-     * Focusable toolbars candidates are either:
-     * * already visible,
-     * * have `beforeFocus()` set in their {@link module:ui/editorui/editorui~FocusableToolbarDefinition definition} that suggests that
-     * they might show up when called. Keep in mind that determining whether a toolbar will show up (and become focusable) is impossible
-     * at this stage because it depends on its implementation, that in turn depends on the editing context (selection).
-     *
-     * **Note**: Contextual toolbars take precedence over regular toolbars.
-     */
-    private _getFocusableCandidateToolbarDefinitions;
-    /**
-     * Returns a definition of the toolbar that is currently visible and focused (one of its children has focus).
-     *
-     * `null` is returned when no toolbar is currently focused.
-     */
-    private _getCurrentFocusedToolbarDefinition;
-    /**
-     * Focuses a focusable toolbar candidate using its definition.
-     *
-     * @param candidateToolbarDefinition A definition of the toolbar to focus.
-     * @returns `true` when the toolbar candidate was focused. `false` otherwise.
-     */
-    private _focusFocusableCandidateToolbar;
-    /**
-     * Provides an integration between {@link #viewportOffset} and {@link module:utils/dom/scroll~scrollViewportToShowTarget}.
-     * It allows the UI-agnostic engine method to consider user-configured viewport offsets specific for the integration.
-     *
-     * @param evt The `scrollToTheSelection` event info.
-     * @param data The payload carried by the `scrollToTheSelection` event.
-     */
-    private _handleScrollToTheSelection;
-}
-/**
- * Fired when the editor UI is ready.
- *
- * Fired before {@link module:engine/controller/datacontroller~DataController#event:ready}.
- *
- * @eventName ~EditorUI#ready
- */
-export type EditorUIReadyEvent = {
-    name: 'ready';
-    args: [];
-};
-/**
- * Fired whenever the UI (all related components) should be refreshed.
- *
- * **Note:**: The event is fired after each {@link module:engine/view/document~Document#event:layoutChanged}.
- * It can also be fired manually via the {@link module:ui/editorui/editorui~EditorUI#update} method.
- *
- * @eventName ~EditorUI#update
- */
-export type EditorUIUpdateEvent = {
-    name: 'update';
-    args: [];
-};
-/**
- * A definition of a focusable toolbar. Used by {@link module:ui/editorui/editorui~EditorUI#addToolbar}.
- */
-export interface FocusableToolbarDefinition {
-    /**
-     * An instance of a focusable toolbar view.
-     */
-    toolbarView: ToolbarView;
-    /**
-     * Options of a focusable toolbar view:
-     *
-     * * `isContextual`: Marks the higher priority toolbar. For example when there are 2 visible toolbars,
-     * it allows to distinguish which toolbar should be focused first after the `alt+f10` keystroke
-     * * `beforeFocus`: A callback executed before the `ToolbarView` gains focus upon the `Alt+F10` keystroke.
-     * * `afterBlur`: A callback executed after `ToolbarView` loses focus upon `Esc` keystroke but before
-     * the focus goes back to the `origin`.
-     */
-    options: FocusableToolbarOptions;
-}
-export interface FocusableToolbarOptions {
-    /**
-     * Set `true` if the toolbar is attached to the content of the editor. Such toolbar takes
-     * a precedence over other toolbars when a user pressed <kbd>Alt</kbd> + <kbd>F10</kbd>.
-     */
-    isContextual?: boolean;
-    /**
-     * Specify a callback executed before the toolbar instance DOM element gains focus
-     * upon the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke.
-     */
-    beforeFocus?: () => void;
-    /**
-     * Specify a callback executed after the toolbar instance DOM element loses focus upon
-     * <kbd>Esc</kbd> keystroke but before the focus goes back to the {@link ~EditorUI#setEditableElement editable element}.
-     */
-    afterBlur?: () => void;
-}
-export {};
+/**
+ * @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 ui/editorui/editorui
+ */
+import ComponentFactory from '../componentfactory';
+import TooltipManager from '../tooltipmanager';
+import PoweredBy from './poweredby';
+import AriaLiveAnnouncer from '../arialiveannouncer';
+import type EditorUIView from './editoruiview';
+import type ToolbarView from '../toolbar/toolbarview';
+import { FocusTracker } from '@ckeditor/ckeditor5-utils';
+import type { Editor } from '@ckeditor/ckeditor5-core';
+declare const EditorUI_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Observable;
+    prototype: import("@ckeditor/ckeditor5-utils").Observable;
+};
+/**
+ * A class providing the minimal interface that is required to successfully bootstrap any editor UI.
+ */
+export default abstract class EditorUI extends EditorUI_base {
+    /**
+     * The editor that the UI belongs to.
+     */
+    readonly editor: Editor;
+    /**
+     * An instance of the {@link module:ui/componentfactory~ComponentFactory}, a registry used by plugins
+     * to register factories of specific UI components.
+     */
+    readonly componentFactory: ComponentFactory;
+    /**
+     * Stores the information about the editor UI focus and propagates it so various plugins and components
+     * are unified as a focus group.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * Manages the tooltips displayed on mouseover and focus across the UI.
+     */
+    readonly tooltipManager: TooltipManager;
+    /**
+     * A helper that enables the "powered by" feature in the editor and renders a link to the project's webpage.
+     */
+    readonly poweredBy: PoweredBy;
+    /**
+     * A helper that manages the content of an `aria-live` regions used by editor features to announce status changes
+     * to screen readers.
+     */
+    readonly ariaLiveAnnouncer: AriaLiveAnnouncer;
+    /**
+     * Indicates the UI is ready. Set `true` after {@link #event:ready} event is fired.
+     *
+     * @readonly
+     * @default false
+     */
+    isReady: boolean;
+    abstract get view(): EditorUIView;
+    /**
+     * Stores viewport offsets from every direction.
+     *
+     * Viewport offset can be used to constrain balloons or other UI elements into an element smaller than the viewport.
+     * This can be useful if there are any other absolutely positioned elements that may interfere with editor UI.
+     *
+     * Example `editor.ui.viewportOffset` returns:
+     *
+     * ```js
+     * {
+     * 	top: 50,
+     * 	right: 50,
+     * 	bottom: 50,
+     * 	left: 50
+     * }
+     * ```
+     *
+     * This property can be overriden after editor already being initialized:
+     *
+     * ```js
+     * editor.ui.viewportOffset = {
+     * 	top: 100,
+     * 	right: 0,
+     * 	bottom: 0,
+     * 	left: 0
+     * };
+     * ```
+     *
+     * @observable
+     */
+    viewportOffset: {
+        left?: number;
+        right?: number;
+        top?: number;
+        bottom?: number;
+    };
+    /**
+     * Stores all editable elements used by the editor instance.
+     */
+    private _editableElementsMap;
+    /**
+     * All available & focusable toolbars.
+     */
+    private _focusableToolbarDefinitions;
+    /**
+     * Creates an instance of the editor UI class.
+     *
+     * @param editor The editor instance.
+     */
+    constructor(editor: Editor);
+    /**
+     * The main (outermost) DOM element of the editor UI.
+     *
+     * For example, in {@link module:editor-classic/classiceditor~ClassicEditor} it is a `<div>` which
+     * wraps the editable element and the toolbar. In {@link module:editor-inline/inlineeditor~InlineEditor}
+     * it is the editable element itself (as there is no other wrapper). However, in
+     * {@link module:editor-decoupled/decouplededitor~DecoupledEditor} it is set to `null` because this editor does not
+     * come with a single "main" HTML element (its editable element and toolbar are separate).
+     *
+     * This property can be understood as a shorthand for retrieving the element that a specific editor integration
+     * considers to be its main DOM element.
+     */
+    get element(): HTMLElement | null;
+    /**
+     * Fires the {@link module:ui/editorui/editorui~EditorUI#event:update `update`} event.
+     *
+     * This method should be called when the editor UI (e.g. positions of its balloons) needs to be updated due to
+     * some environmental change which CKEditor 5 is not aware of (e.g. resize of a container in which it is used).
+     */
+    update(): void;
+    /**
+     * Destroys the UI.
+     */
+    destroy(): void;
+    /**
+     * Stores the native DOM editable element used by the editor under a unique name.
+     *
+     * Also, registers the element in the editor to maintain the accessibility of the UI. When the user is editing text in a focusable
+     * editable area, they can use the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke to navigate over editor toolbars. See {@link #addToolbar}.
+     *
+     * @param rootName The unique name of the editable element.
+     * @param domElement The native DOM editable element.
+     */
+    setEditableElement(rootName: string, domElement: HTMLElement): void;
+    /**
+     * Removes the editable from the editor UI. Removes all handlers added by {@link #setEditableElement}.
+     *
+     * @param rootName The name of the editable element to remove.
+     */
+    removeEditableElement(rootName: string): void;
+    /**
+     * Returns the editable editor element with the given name or null if editable does not exist.
+     *
+     * @param rootName The editable name.
+     */
+    getEditableElement(rootName?: string): HTMLElement | undefined;
+    /**
+     * Returns array of names of all editor editable elements.
+     */
+    getEditableElementsNames(): IterableIterator<string>;
+    /**
+     * Adds a toolbar to the editor UI. Used primarily to maintain the accessibility of the UI.
+     *
+     * Focusable toolbars can be accessed (focused) by users by pressing the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke.
+     * Successive keystroke presses navigate over available toolbars.
+     *
+     * @param toolbarView A instance of the toolbar to be registered.
+     */
+    addToolbar(toolbarView: ToolbarView, options?: FocusableToolbarOptions): void;
+    /**
+     * Stores all editable elements used by the editor instance.
+     *
+     * @deprecated
+     */
+    protected get _editableElements(): unknown;
+    /**
+     * Returns viewport offsets object:
+     *
+     * ```js
+     * {
+     * 	top: Number,
+     * 	right: Number,
+     * 	bottom: Number,
+     * 	left: Number
+     * }
+     * ```
+     *
+     * Only top property is currently supported.
+     */
+    private _readViewportOffsetFromConfig;
+    /**
+     * Starts listening for <kbd>Alt</kbd> + <kbd>F10</kbd> and <kbd>Esc</kbd> keystrokes in the context of focusable
+     * {@link #setEditableElement editable elements} and {@link #addToolbar toolbars}
+     * to allow users navigate across the UI.
+     */
+    private _initFocusTracking;
+    /**
+     * Returns definitions of toolbars that could potentially be focused, sorted by their importance for the user.
+     *
+     * Focusable toolbars candidates are either:
+     * * already visible,
+     * * have `beforeFocus()` set in their {@link module:ui/editorui/editorui~FocusableToolbarDefinition definition} that suggests that
+     * they might show up when called. Keep in mind that determining whether a toolbar will show up (and become focusable) is impossible
+     * at this stage because it depends on its implementation, that in turn depends on the editing context (selection).
+     *
+     * **Note**: Contextual toolbars take precedence over regular toolbars.
+     */
+    private _getFocusableCandidateToolbarDefinitions;
+    /**
+     * Returns a definition of the toolbar that is currently visible and focused (one of its children has focus).
+     *
+     * `null` is returned when no toolbar is currently focused.
+     */
+    private _getCurrentFocusedToolbarDefinition;
+    /**
+     * Focuses a focusable toolbar candidate using its definition.
+     *
+     * @param candidateToolbarDefinition A definition of the toolbar to focus.
+     * @returns `true` when the toolbar candidate was focused. `false` otherwise.
+     */
+    private _focusFocusableCandidateToolbar;
+    /**
+     * Provides an integration between {@link #viewportOffset} and {@link module:utils/dom/scroll~scrollViewportToShowTarget}.
+     * It allows the UI-agnostic engine method to consider user-configured viewport offsets specific for the integration.
+     *
+     * @param evt The `scrollToTheSelection` event info.
+     * @param data The payload carried by the `scrollToTheSelection` event.
+     */
+    private _handleScrollToTheSelection;
+}
+/**
+ * Fired when the editor UI is ready.
+ *
+ * Fired before {@link module:engine/controller/datacontroller~DataController#event:ready}.
+ *
+ * @eventName ~EditorUI#ready
+ */
+export type EditorUIReadyEvent = {
+    name: 'ready';
+    args: [];
+};
+/**
+ * Fired whenever the UI (all related components) should be refreshed.
+ *
+ * **Note:**: The event is fired after each {@link module:engine/view/document~Document#event:layoutChanged}.
+ * It can also be fired manually via the {@link module:ui/editorui/editorui~EditorUI#update} method.
+ *
+ * @eventName ~EditorUI#update
+ */
+export type EditorUIUpdateEvent = {
+    name: 'update';
+    args: [];
+};
+/**
+ * A definition of a focusable toolbar. Used by {@link module:ui/editorui/editorui~EditorUI#addToolbar}.
+ */
+export interface FocusableToolbarDefinition {
+    /**
+     * An instance of a focusable toolbar view.
+     */
+    toolbarView: ToolbarView;
+    /**
+     * Options of a focusable toolbar view:
+     *
+     * * `isContextual`: Marks the higher priority toolbar. For example when there are 2 visible toolbars,
+     * it allows to distinguish which toolbar should be focused first after the `alt+f10` keystroke
+     * * `beforeFocus`: A callback executed before the `ToolbarView` gains focus upon the `Alt+F10` keystroke.
+     * * `afterBlur`: A callback executed after `ToolbarView` loses focus upon `Esc` keystroke but before
+     * the focus goes back to the `origin`.
+     */
+    options: FocusableToolbarOptions;
+}
+export interface FocusableToolbarOptions {
+    /**
+     * Set `true` if the toolbar is attached to the content of the editor. Such toolbar takes
+     * a precedence over other toolbars when a user pressed <kbd>Alt</kbd> + <kbd>F10</kbd>.
+     */
+    isContextual?: boolean;
+    /**
+     * Specify a callback executed before the toolbar instance DOM element gains focus
+     * upon the <kbd>Alt</kbd> + <kbd>F10</kbd> keystroke.
+     */
+    beforeFocus?: () => void;
+    /**
+     * Specify a callback executed after the toolbar instance DOM element loses focus upon
+     * <kbd>Esc</kbd> keystroke but before the focus goes back to the {@link ~EditorUI#setEditableElement editable element}.
+     */
+    afterBlur?: () => void;
+}
+export {};