@ckeditor/ckeditor5-ui 48.8.1-alpha.3 → 49.0.0-alpha.0

package/dist/editableui/editableuiview.d.ts

@@ -1,72 +1,83 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ui/editableui/editableuiview
- */
-import { View } from '../view.js';
-import type { EditingView } from '@ckeditor/ckeditor5-engine';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module ui/editableui/editableuiview
+*/
+import { View } from "../view.js";
+import type { EditingView } from "@ckeditor/ckeditor5-engine";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import type { ViewRootElementDefinition } from "@ckeditor/ckeditor5-core";
 /**
- * The editable UI view class.
- */
+* The editable UI view class.
+*/
 export declare class EditableUIView extends View {
-    /**
-     * The name of the editable UI view.
-     */
-    name: string | null;
-    /**
-     * Controls whether the editable is focused, i.e. the user is typing in it.
-     *
-     * @observable
-     */
-    isFocused: boolean;
-    /**
-     * The editing view instance the editable is related to. Editable uses the editing
-     * view to dynamically modify its certain DOM attributes after {@link #render rendering}.
-     *
-     * **Note**: The DOM attributes are performed by the editing view and not UI
-     * {@link module:ui/view~View#bindTemplate template bindings} because once rendered,
-     * the editable DOM element must remain under the full control of the engine to work properly.
-     */
-    protected _editingView: EditingView;
-    /**
-     * The element which is the main editable element (usually the one with `contentEditable="true"`).
-     */
-    protected _editableElement: HTMLElement | null | undefined;
-    /**
-     * Whether an external {@link #_editableElement} was passed into the constructor, which also means
-     * the view will not render its {@link #template}.
-     */
-    private _hasExternalElement;
-    /**
-     * Creates an instance of EditableUIView class.
-     *
-     * @param locale The locale instance.
-     * @param editingView The editing view instance the editable is related to.
-     * @param editableElement The editable element. If not specified, this view
-     * should create it. Otherwise, the existing element should be used.
-     */
-    constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement);
-    /**
-     * Renders the view by either applying the {@link #template} to the existing
-     * {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement} or assigning {@link #element}
-     * as {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement}.
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Whether an external {@link #_editableElement} was passed into the constructor, which also means
-     * the view will not render its {@link #template}.
-     */
-    get hasExternalElement(): boolean;
-    /**
-     * Updates the `ck-focused` and `ck-blurred` CSS classes on the {@link #element} according to
-     * the {@link #isFocused} property value using the {@link #_editingView editing view} API.
-     */
-    private _updateIsFocusedClasses;
+	/**
+	* The name of the editable UI view.
+	*/
+	name: string | null;
+	/**
+	* Controls whether the editable is focused, i.e. the user is typing in it.
+	*
+	* @observable
+	*/
+	isFocused: boolean;
+	/**
+	* Whether this editable is bound to an inline root (a root that only holds inline content, with no block children).
+	* Set by the editor's UI initialization, after plugin schema registrations have settled. When `true`, a
+	* `ck-editor__editable_inline-root` CSS class is added to the element so themes can distinguish inline roots from
+	* block ones; the placeholder helper also reads it to decide where to host the placeholder.
+	*
+	* @observable
+	*/
+	isInlineRoot: boolean;
+	/**
+	* The editing view instance the editable is related to. Editable uses the editing
+	* view to dynamically modify its certain DOM attributes after {@link #render rendering}.
+	*
+	* **Note**: The DOM attributes are performed by the editing view and not UI
+	* {@link module:ui/view~View#bindTemplate template bindings} because once rendered,
+	* the editable DOM element must remain under the full control of the engine to work properly.
+	*/
+	protected _editingView: EditingView;
+	/**
+	* The element which is the main editable element (usually the one with `contentEditable="true"`).
+	*/
+	protected _editableElement: HTMLElement | null | undefined;
+	/**
+	* Whether an external {@link #_editableElement} was passed into the constructor, which also means
+	* the view will not render its {@link #template}.
+	*/
+	private _hasExternalElement;
+	/**
+	* Creates an instance of EditableUIView class.
+	*
+	* @param locale The locale instance.
+	* @param editingView The editing view instance the editable is related to.
+	* @param editableElement The editable element. If an existing `HTMLElement` is passed, the view applies its
+	* template to it; otherwise the view creates a fresh element (a `<div>` by default, or one matching the given
+	* {@link module:core/editor/editorconfig~ViewRootElementDefinition}).
+	*/
+	constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition);
+	/**
+	* Renders the view by either applying the {@link #template} to the existing
+	* {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement} or assigning {@link #element}
+	* as {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement}.
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Whether an external {@link #_editableElement} was passed into the constructor, which also means
+	* the view will not render its {@link #template}.
+	*/
+	get hasExternalElement(): boolean;
+	/**
+	* Updates the `ck-focused` and `ck-blurred` CSS classes on the {@link #element} according to
+	* the {@link #isFocused} property value using the {@link #_editingView editing view} API.
+	*/
+	private _updateIsFocusedClasses;
 }

package/dist/editableui/inline/inlineeditableuiview.d.ts

@@ -1,43 +1,45 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ui/editableui/inline/inlineeditableuiview
- */
-import { EditableUIView } from '../editableuiview.js';
-import type { EditingView } from '@ckeditor/ckeditor5-engine';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module ui/editableui/inline/inlineeditableuiview
+*/
+import { EditableUIView } from "../editableuiview.js";
+import type { EditingView } from "@ckeditor/ckeditor5-engine";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import type { ViewRootElementDefinition } from "@ckeditor/ckeditor5-core";
 /**
- * The inline editable UI class implementing an inline {@link module:ui/editableui/editableuiview~EditableUIView}.
- */
+* The inline editable UI class implementing an inline {@link module:ui/editableui/editableuiview~EditableUIView}.
+*/
 export declare class InlineEditableUIView extends EditableUIView {
-    /**
-     * The cached options object passed to the constructor.
-     */
-    private readonly _options;
-    /**
-     * Creates an instance of the InlineEditableUIView class.
-     *
-     * @param locale The locale instance.
-     * @param editingView The editing view instance the editable is related to.
-     * @param editableElement The editable element. If not specified, the
-     * {@link module:ui/editableui/editableuiview~EditableUIView}
-     * will create it. Otherwise, the existing element will be used.
-     * @param options Additional configuration of the view.
-     * @param options.label The label of the editable for assistive technologies. If not provided, a default label is used or,
-     * the existing `aria-label` attribute value from the specified `editableElement` is preserved.
-     */
-    constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement, options?: InlineEditableUIViewOptions);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Returns a normalized label for the editable view based on the environment.
-     */
-    getEditableAriaLabel(): string;
+	/**
+	* The cached options object passed to the constructor.
+	*/
+	private readonly _options;
+	/**
+	* Creates an instance of the InlineEditableUIView class.
+	*
+	* @param locale The locale instance.
+	* @param editingView The editing view instance the editable is related to.
+	* @param editableElement The editable element. May be an existing `HTMLElement`, a
+	* {@link module:core/editor/editorconfig~ViewRootElementDefinition} describing the element to create,
+	* or `undefined` to create a default `<div>` element. See
+	* {@link module:ui/editableui/editableuiview~EditableUIView}.
+	* @param options Additional configuration of the view.
+	* @param options.label The label of the editable for assistive technologies. If not provided, a default label is used or,
+	* the existing `aria-label` attribute value from the specified `editableElement` is preserved.
+	*/
+	constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition, options?: InlineEditableUIViewOptions);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Returns a normalized label for the editable view based on the environment.
+	*/
+	getEditableAriaLabel(): string;
 }
 export type InlineEditableUIViewOptions = {
-    label?: ((view: InlineEditableUIView) => string) | string | Record<string, string>;
+	label?: ((view: InlineEditableUIView) => string) | string | Record<string, string>;
 };

package/dist/editorui/accessibilityhelp/accessibilityhelp.d.ts

@@ -1,55 +1,54 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ui/editorui/accessibilityhelp/accessibilityhelp
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { Dialog } from '../../dialog/dialog.js';
-import { AccessibilityHelpContentView } from './accessibilityhelpcontentview.js';
-import '../../../theme/components/editorui/accessibilityhelp.css';
+* @module ui/editorui/accessibilityhelp/accessibilityhelp
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Dialog } from "../../dialog/dialog.js";
+import { AccessibilityHelpContentView } from "./accessibilityhelpcontentview.js";
 /**
- * A plugin that brings the accessibility help dialog to the editor available under the <kbd>Alt</kbd>+<kbd>0</kbd>
- * keystroke and via the "Accessibility help" toolbar button. The dialog displays a list of keystrokes that can be used
- * by the user to perform various actions in the editor.
- *
- * Keystroke information is loaded from {@link module:core/accessibility~Accessibility#keystrokeInfos}. New entries can be
- * added using the API provided by the {@link module:core/accessibility~Accessibility} class.
- */
+* A plugin that brings the accessibility help dialog to the editor available under the <kbd>Alt</kbd>+<kbd>0</kbd>
+* keystroke and via the "Accessibility help" toolbar button. The dialog displays a list of keystrokes that can be used
+* by the user to perform various actions in the editor.
+*
+* Keystroke information is loaded from {@link module:core/accessibility~Accessibility#keystrokeInfos}. New entries can be
+* added using the API provided by the {@link module:core/accessibility~Accessibility} class.
+*/
 export declare class AccessibilityHelp extends Plugin {
-    /**
-     * The view that displays the dialog content (list of keystrokes).
-     * Created when the dialog is opened for the first time.
-     */
-    contentView: AccessibilityHelpContentView | null;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Dialog];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AccessibilityHelp";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a button to show accessibility help dialog, for use either in toolbar or in menu bar.
-     */
-    private _createButton;
-    /**
-     * Injects a help text into each editing root's `aria-label` attribute allowing assistive technology users
-     * to discover the availability of the Accessibility help dialog.
-     */
-    private _setupRootLabels;
-    /**
-     * Shows the accessibility help dialog. Also, creates {@link #contentView} on demand.
-     */
-    private _toggleDialog;
+	/**
+	* The view that displays the dialog content (list of keystrokes).
+	* Created when the dialog is opened for the first time.
+	*/
+	contentView: AccessibilityHelpContentView | null;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Dialog]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AccessibilityHelp";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Creates a button to show accessibility help dialog, for use either in toolbar or in menu bar.
+	*/
+	private _createButton;
+	/**
+	* Injects a help text into each editing root's `aria-label` attribute allowing assistive technology users
+	* to discover the availability of the Accessibility help dialog.
+	*/
+	private _setupRootLabels;
+	/**
+	* Shows the accessibility help dialog. Also, creates {@link #contentView} on demand.
+	*/
+	private _toggleDialog;
 }

package/dist/editorui/accessibilityhelp/accessibilityhelpcontentview.d.ts

@@ -1,35 +1,35 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ui/editorui/accessibilityhelp/accessibilityhelpcontentview
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { View } from '../../view.js';
-import type { KeystrokeInfoDefinitions } from '@ckeditor/ckeditor5-core';
+* @module ui/editorui/accessibilityhelp/accessibilityhelpcontentview
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { View } from "../../view.js";
+import type { KeystrokeInfoDefinitions } from "@ckeditor/ckeditor5-core";
 /**
- * The view displaying keystrokes in the Accessibility help dialog.
- */
+* The view displaying keystrokes in the Accessibility help dialog.
+*/
 export declare class AccessibilityHelpContentView extends View<HTMLDivElement> {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, keystrokes: KeystrokeInfoDefinitions);
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * Creates `<section><h3>Category label</h3>...</section>` elements for each category of keystrokes.
-     */
-    private _createCategories;
-    /**
-     * Creates `[<h4>Optional label</h4>]<dl>...</dl>` elements for each group of keystrokes in a category.
-     */
-    private _createGroup;
-    /**
-     * Creates `<dt>Keystroke label</dt><dd>Keystroke definition</dd>` elements for each keystroke in a group.
-     */
-    private _createGroupRow;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale, keystrokes: KeystrokeInfoDefinitions);
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
+	/**
+	* Creates `<section><h3>Category label</h3>...</section>` elements for each category of keystrokes.
+	*/
+	private _createCategories;
+	/**
+	* Creates `[<h4>Optional label</h4>]<dl>...</dl>` elements for each group of keystrokes in a category.
+	*/
+	private _createGroup;
+	/**
+	* Creates `<dt>Keystroke label</dt><dd>Keystroke definition</dd>` elements for each keystroke in a group.
+	*/
+	private _createGroupRow;
 }