@ckeditor/ckeditor5-editor-inline 48.2.0 → 48.3.0-alpha.1

package/dist/inlineeditor.d.ts

@@ -1,235 +1,235 @@
 /**
- * @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 editor-inline/inlineeditor
- */
-import { Editor, type EditorConfig } from '@ckeditor/ckeditor5-core';
-import { InlineEditorUI } from './inlineeditorui.js';
-declare const InlineEditor_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Editor, import("@ckeditor/ckeditor5-core").ElementApi>;
+* @module editor-inline/inlineeditor
+*/
+import { Editor, type EditorConfig, type ElementApiMixinConstructor } from "@ckeditor/ckeditor5-core";
+import { InlineEditorUI } from "./inlineeditorui.js";
+declare const InlineEditorBase: ElementApiMixinConstructor<typeof Editor>;
 /**
- * The inline editor implementation. It uses an inline editable and a floating toolbar.
- * See the {@glink examples/builds/inline-editor demo}.
- *
- * In order to create a inline editor instance, use the static
- * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method.
- */
-export declare class InlineEditor extends /* #__PURE__ */ InlineEditor_base {
-    /**
-     * @inheritDoc
-     */
-    static get editorName(): 'InlineEditor';
-    /**
-     * @inheritDoc
-     */
-    readonly ui: InlineEditorUI;
-    /**
-     * Creates an instance of the inline editor.
-     *
-     * **Note:** Do not use the constructor to create editor instances. Use the static
-     * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method instead.
-     *
-     * @param config The editor configuration.
-     */
-    protected constructor(config: EditorConfig);
-    /**
-     * Creates an instance of the inline editor.
-     *
-     * **Note:** Do not use the constructor to create editor instances. Use the static
-     * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method instead.
-     *
-     * **Note**: This constructor signature is deprecated and will be removed in the future release.
-     *
-     * @deprecated
-     * @param sourceElementOrData The DOM element that will be the source for the created editor
-     * (on which the editor will be initialized) or initial data for the editor. For more information see
-     * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
-     * @param config The editor configuration.
-     */
-    protected constructor(sourceElementOrData: HTMLElement | string, config: EditorConfig);
-    /**
-     * Destroys the editor instance, releasing all resources used by it.
-     *
-     * Updates the original editor element with the data if the
-     * {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}
-     * configuration option is set to `true`.
-     */
-    destroy(): Promise<unknown>;
-    /**
-     * Creates a new inline editor instance.
-     *
-     * There are three general ways how the editor can be initialized.
-     *
-     * # Using an existing DOM element (and loading data from it)
-     *
-     * You can initialize the editor using an existing DOM element:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( {
-     * 		root: {
-     * 			element: document.querySelector( '#editor' )
-     * 		}
-     * 	} )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * The element's content will be used as the editor data and the element will become the editable element.
-     *
-     * # Creating a detached editor
-     *
-     * Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
-     * In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( {
-     * 		root: {
-     * 			initialData: '<p>Hello world!</p>'
-     * 		}
-     * 	} )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     *
-     * 		// Initial data was provided so the editor UI element needs to be added manually to the DOM.
-     * 		document.body.appendChild( editor.ui.element );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
-     * web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
-     *
-     * # Using an existing DOM element (and data provided in `config.root.initialData`)
-     *
-     * You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( {
-     * 		root: {
-     * 			element: document.querySelector( '#editor' ),
-     * 			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
-     * 		}
-     * 	} )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * This method can be used to initialize the editor on an existing element with the specified content in case if your integration
-     * makes it difficult to set the content of the source element.
-     *
-     * # Configuring the editor
-     *
-     * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
-     * customizing plugins, toolbar and more.
-     *
-     * @param config The editor configuration.
-     * @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
-     */
-    static create(config: EditorConfig): Promise<InlineEditor>;
-    /**
-     * Creates a new inline editor instance.
-     *
-     * **Note**: This method signature is deprecated and will be removed in the future release.
-     *
-     * There are three general ways how the editor can be initialized.
-     *
-     * # Using an existing DOM element (and loading data from it)
-     *
-     * You can initialize the editor using an existing DOM element:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( document.querySelector( '#editor' ) )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * The element's content will be used as the editor data and the element will become the editable element.
-     *
-     * # Creating a detached editor
-     *
-     * Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
-     * In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( '<p>Hello world!</p>' )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     *
-     * 		// Initial data was provided so the editor UI element needs to be added manually to the DOM.
-     * 		document.body.appendChild( editor.ui.element );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
-     * web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
-     *
-     * # Using an existing DOM element (and data provided in `config.root.initialData`)
-     *
-     * You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
-     *
-     * ```ts
-     * InlineEditor
-     * 	.create( document.querySelector( '#editor' ), {
-     * 		root: {
-     * 			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
-     * 		}
-     * 	} )
-     * 	.then( editor => {
-     * 		console.log( 'Editor was initialized', editor );
-     * 	} )
-     * 	.catch( err => {
-     * 		console.error( err.stack );
-     * 	} );
-     * ```
-     *
-     * This method can be used to initialize the editor on an existing element with the specified content in case if your integration
-     * makes it difficult to set the content of the source element.
-     *
-     * Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
-     *
-     * # Configuring the editor
-     *
-     * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
-     * customizing plugins, toolbar and more.
-     *
-     * @deprecated
-     * @param sourceElementOrData The DOM element that will be the source for the created editor
-     * or the editor's initial data.
-     *
-     * If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
-     * The editor data will be set back to the original element once the editor is destroyed only if the
-     * {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy}
-     * option is set to `true`.
-     *
-     * If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
-     * It is available under the {@link module:editor-inline/inlineeditorui~InlineEditorUI#element `editor.ui.element`} property.
-     *
-     * @param config The editor configuration.
-     * @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
-     */
-    static create(sourceElementOrData: HTMLElement | string, config: EditorConfig): Promise<InlineEditor>;
+* The inline editor implementation. It uses an inline editable and a floating toolbar.
+* See the {@glink examples/builds/inline-editor demo}.
+*
+* In order to create a inline editor instance, use the static
+* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method.
+*/
+export declare class InlineEditor extends InlineEditorBase {
+	/**
+	* @inheritDoc
+	*/
+	static override get editorName(): "InlineEditor";
+	/**
+	* @inheritDoc
+	*/
+	readonly ui: InlineEditorUI;
+	/**
+	* Creates an instance of the inline editor.
+	*
+	* **Note:** Do not use the constructor to create editor instances. Use the static
+	* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method instead.
+	*
+	* @param config The editor configuration.
+	*/
+	protected constructor(config: EditorConfig);
+	/**
+	* Creates an instance of the inline editor.
+	*
+	* **Note:** Do not use the constructor to create editor instances. Use the static
+	* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method instead.
+	*
+	* **Note**: This constructor signature is deprecated and will be removed in the future release.
+	*
+	* @deprecated
+	* @param sourceElementOrData The DOM element that will be the source for the created editor
+	* (on which the editor will be initialized) or initial data for the editor. For more information see
+	* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
+	* @param config The editor configuration.
+	*/
+	protected constructor(sourceElementOrData: HTMLElement | string, config: EditorConfig);
+	/**
+	* Destroys the editor instance, releasing all resources used by it.
+	*
+	* Updates the original editor element with the data if the
+	* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy `updateSourceElementOnDestroy`}
+	* configuration option is set to `true`.
+	*/
+	override destroy(): Promise<unknown>;
+	/**
+	* Creates a new inline editor instance.
+	*
+	* There are three general ways how the editor can be initialized.
+	*
+	* # Using an existing DOM element (and loading data from it)
+	*
+	* You can initialize the editor using an existing DOM element:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( {
+	* 		root: {
+	* 			element: document.querySelector( '#editor' )
+	* 		}
+	* 	} )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* The element's content will be used as the editor data and the element will become the editable element.
+	*
+	* # Creating a detached editor
+	*
+	* Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
+	* In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( {
+	* 		root: {
+	* 			initialData: '<p>Hello world!</p>'
+	* 		}
+	* 	} )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	*
+	* 		// Initial data was provided so the editor UI element needs to be added manually to the DOM.
+	* 		document.body.appendChild( editor.ui.element );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
+	* web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
+	*
+	* # Using an existing DOM element (and data provided in `config.root.initialData`)
+	*
+	* You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( {
+	* 		root: {
+	* 			element: document.querySelector( '#editor' ),
+	* 			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
+	* 		}
+	* 	} )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* This method can be used to initialize the editor on an existing element with the specified content in case if your integration
+	* makes it difficult to set the content of the source element.
+	*
+	* # Configuring the editor
+	*
+	* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
+	* customizing plugins, toolbar and more.
+	*
+	* @param config The editor configuration.
+	* @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
+	*/
+	static override create(config: EditorConfig): Promise<InlineEditor>;
+	/**
+	* Creates a new inline editor instance.
+	*
+	* **Note**: This method signature is deprecated and will be removed in the future release.
+	*
+	* There are three general ways how the editor can be initialized.
+	*
+	* # Using an existing DOM element (and loading data from it)
+	*
+	* You can initialize the editor using an existing DOM element:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( document.querySelector( '#editor' ) )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* The element's content will be used as the editor data and the element will become the editable element.
+	*
+	* # Creating a detached editor
+	*
+	* Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
+	* In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( '<p>Hello world!</p>' )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	*
+	* 		// Initial data was provided so the editor UI element needs to be added manually to the DOM.
+	* 		document.body.appendChild( editor.ui.element );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
+	* web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
+	*
+	* # Using an existing DOM element (and data provided in `config.root.initialData`)
+	*
+	* You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
+	*
+	* ```ts
+	* InlineEditor
+	* 	.create( document.querySelector( '#editor' ), {
+	* 		root: {
+	* 			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
+	* 		}
+	* 	} )
+	* 	.then( editor => {
+	* 		console.log( 'Editor was initialized', editor );
+	* 	} )
+	* 	.catch( err => {
+	* 		console.error( err.stack );
+	* 	} );
+	* ```
+	*
+	* This method can be used to initialize the editor on an existing element with the specified content in case if your integration
+	* makes it difficult to set the content of the source element.
+	*
+	* Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
+	*
+	* # Configuring the editor
+	*
+	* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
+	* customizing plugins, toolbar and more.
+	*
+	* @deprecated
+	* @param sourceElementOrData The DOM element that will be the source for the created editor
+	* or the editor's initial data.
+	*
+	* If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
+	* The editor data will be set back to the original element once the editor is destroyed only if the
+	* {@link module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy}
+	* option is set to `true`.
+	*
+	* If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
+	* It is available under the {@link module:editor-inline/inlineeditorui~InlineEditorUI#element `editor.ui.element`} property.
+	*
+	* @param config The editor configuration.
+	* @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
+	*/
+	static override create(sourceElementOrData: HTMLElement | string, config: EditorConfig): Promise<InlineEditor>;
 }
 export {};

package/dist/inlineeditorui.d.ts

@@ -1,52 +1,52 @@
 /**
- * @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 editor-inline/inlineeditorui
- */
-import { type Editor } from '@ckeditor/ckeditor5-core';
-import { EditorUI } from '@ckeditor/ckeditor5-ui';
-import { type InlineEditorUIView } from './inlineeditoruiview.js';
+* @module editor-inline/inlineeditorui
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { EditorUI } from "@ckeditor/ckeditor5-ui";
+import { type InlineEditorUIView } from "./inlineeditoruiview.js";
 /**
- * The inline editor UI class.
- *
- * @extends module:ui/editorui/editorui~EditorUI
- */
+* The inline editor UI class.
+*
+* @extends module:ui/editorui/editorui~EditorUI
+*/
 export declare class InlineEditorUI extends EditorUI {
-    /**
-     * The main (top–most) view of the editor UI.
-     */
-    readonly view: InlineEditorUIView;
-    /**
-     * A normalized `config.toolbar` object.
-     */
-    private readonly _toolbarConfig;
-    /**
-     * Creates an instance of the inline editor UI class.
-     *
-     * @param editor The editor instance.
-     * @param view The view of the UI.
-     */
-    constructor(editor: Editor, view: InlineEditorUIView);
-    /**
-     * @inheritDoc
-     */
-    get element(): HTMLElement | null;
-    /**
-     * Initializes the UI.
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Initializes the inline editor toolbar and its panel.
-     */
-    private _initToolbar;
-    /**
-     * Enable the placeholder text on the editing root.
-     */
-    private _initPlaceholder;
+	/**
+	* The main (top–most) view of the editor UI.
+	*/
+	readonly view: InlineEditorUIView;
+	/**
+	* A normalized `config.toolbar` object.
+	*/
+	private readonly _toolbarConfig;
+	/**
+	* Creates an instance of the inline editor UI class.
+	*
+	* @param editor The editor instance.
+	* @param view The view of the UI.
+	*/
+	constructor(editor: Editor, view: InlineEditorUIView);
+	/**
+	* @inheritDoc
+	*/
+	override get element(): HTMLElement | null;
+	/**
+	* Initializes the UI.
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Initializes the inline editor toolbar and its panel.
+	*/
+	private _initToolbar;
+	/**
+	* Enable the placeholder text on the editing root.
+	*/
+	private _initPlaceholder;
 }