@ckeditor/ckeditor5-editor-inline 41.3.0-alpha.3 → 41.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-editor-inline",
-  "version": "41.3.0-alpha.3",
+  "version": "41.3.0",
   "description": "Inline editor implementation for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.3.0-alpha.3",
+    "ckeditor5": "41.3.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",
@@ -25,7 +25,6 @@
     "directory": "packages/ckeditor5-editor-inline"
   },
   "files": [
-    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/dist/content-index.css

@@ -1,4 +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
- */

package/dist/editor-index.css

@@ -1,4 +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
- */

package/dist/index.css

@@ -1,4 +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
- */

package/dist/types/index.d.ts

@@ -1,12 +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-oss-license
- */
-/**
- * @module editor-inline
- */
-export { default as InlineEditor } from './inlineeditor.js';

package/dist/types/inlineeditor.d.ts

@@ -1,180 +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-oss-license
- */
-/**
- * @module editor-inline/inlineeditor
- */
-import { Editor, Context, type EditorConfig } from 'ckeditor5/src/core.js';
-import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
-import InlineEditorUI from './inlineeditorui.js';
-declare const InlineEditor_base: import("ckeditor5/src/utils.js").Mixed<typeof Editor, import("ckeditor5/src/core.js").ElementApi>;
-/**
- * The {@glink installation/getting-started/predefined-builds#inline-editor 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.
- *
- * # Inline editor and inline build
- *
- * The inline editor can be used directly from source (if you installed the
- * [`@ckeditor/ckeditor5-editor-inline`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline) package)
- * but it is also available in the {@glink installation/getting-started/predefined-builds#inline-editor inline build}.
- *
- * {@glink installation/getting-started/predefined-builds Builds}
- * are ready-to-use editors with plugins bundled in. When using the editor from
- * source you need to take care of loading all plugins by yourself
- * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
- * Using the editor from source gives much better flexibility and allows easier customization.
- *
- * Read more about initializing the editor from source or as a build in
- * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
- */
-export default class InlineEditor extends InlineEditor_base {
-    /**
-     * @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 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( 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.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' ), {
-     * 		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.
-     *
-     * # Using the editor from source
-     *
-     * The code samples listed in the previous sections of this documentation assume that you are using an
-     * {@glink installation/getting-started/predefined-builds editor build} (for example – `@ckeditor/ckeditor5-build-inline`).
-     *
-     * If you want to use the inline editor from source (`@ckeditor/ckeditor5-editor-inline/src/inlineeditor`),
-     * you need to define the list of
-     * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
-     * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
-     * source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
-     *
-     * @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 {@link module:core/context~Context} class.
-     *
-     * Exposed as static editor field for easier access in editor builds.
-     */
-    static Context: typeof Context;
-    /**
-     * The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
-     *
-     * Exposed as static editor field for easier access in editor builds.
-     */
-    static EditorWatchdog: typeof EditorWatchdog;
-    /**
-     * The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
-     *
-     * Exposed as static editor field for easier access in editor builds.
-     */
-    static ContextWatchdog: typeof ContextWatchdog;
-}
-export {};

package/dist/types/inlineeditorui.d.ts

@@ -1,56 +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-oss-license
- */
-/**
- * @module editor-inline/inlineeditorui
- */
-import { type Editor } from 'ckeditor5/src/core.js';
-import { EditorUI } from 'ckeditor5/src/ui.js';
-import type InlineEditorUIView from './inlineeditoruiview.js';
-/**
- * The inline editor UI class.
- *
- * @extends module:ui/editorui/editorui~EditorUI
- */
-export default 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;
-}

package/dist/types/inlineeditoruiview.d.ts

@@ -1,141 +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-oss-license
- */
-/**
- * @module editor-inline/inlineeditoruiview
- */
-import { BalloonPanelView, EditorUIView, InlineEditableUIView, ToolbarView } from 'ckeditor5/src/ui.js';
-import { type PositioningFunction, type Locale } from 'ckeditor5/src/utils.js';
-import type { EditingView } from 'ckeditor5/src/engine.js';
-/**
- * Inline editor UI view. Uses an nline editable and a floating toolbar.
- */
-export default class InlineEditorUIView extends EditorUIView {
-    /**
-     * A floating toolbar view instance.
-     */
-    readonly toolbar: ToolbarView;
-    /**
-     * The offset from the top edge of the web browser's viewport which makes the
-     * UI become sticky. The default value is `0`, which means that the UI becomes
-     * sticky when its upper edge touches the top of the page viewport.
-     *
-     * This attribute is useful when the web page has UI elements positioned to the top
-     * either using `position: fixed` or `position: sticky`, which would cover the
-     * UI or vice–versa (depending on the `z-index` hierarchy).
-     *
-     * Bound to {@link module:ui/editorui/editorui~EditorUI#viewportOffset `EditorUI#viewportOffset`}.
-     *
-     * If {@link module:core/editor/editorconfig~EditorConfig#ui `EditorConfig#ui.viewportOffset.top`} is defined, then
-     * it will override the default value.
-     *
-     * @observable
-     * @default 0
-     */
-    viewportTopOffset: number;
-    /**
-     * A balloon panel view instance.
-     */
-    readonly panel: BalloonPanelView;
-    /**
-     * A set of positioning functions used by the {@link #panel} to float around
-     * {@link #element editableElement}.
-     *
-     * The positioning functions are as follows:
-     *
-     * * West:
-     *
-     * ```
-     * [ Panel ]
-     * +------------------+
-     * | #editableElement |
-     * +------------------+
-     *
-     * +------------------+
-     * | #editableElement |
-     * |[ Panel ]         |
-     * |                  |
-     * +------------------+
-     *
-     * +------------------+
-     * | #editableElement |
-     * +------------------+
-     * [ Panel ]
-     * ```
-     *
-     * * East:
-     *
-     * ```
-     *            [ Panel ]
-     * +------------------+
-     * | #editableElement |
-     * +------------------+
-     *
-     * +------------------+
-     * | #editableElement |
-     * |         [ Panel ]|
-     * |                  |
-     * +------------------+
-     *
-     * +------------------+
-     * | #editableElement |
-     * +------------------+
-     *            [ Panel ]
-     * ```
-     *
-     * See: {@link module:utils/dom/position~Options#positions}.
-     */
-    readonly panelPositions: Array<PositioningFunction>;
-    /**
-     * Editable UI view.
-     */
-    readonly editable: InlineEditableUIView;
-    /**
-     * An instance of the resize observer that helps dynamically determine the geometry of the toolbar
-     * and manage items that do not fit into a single row.
-     *
-     * **Note:** Created in {@link #render}.
-     */
-    private _resizeObserver;
-    /**
-     * Creates an instance of the inline editor UI view.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param editingView The editing view instance this view is related to.
-     * @param editableElement The editable element. If not specified, it will be automatically created by
-     * {@link module:ui/editableui/editableuiview~EditableUIView}. Otherwise, the given element will be used.
-     * @param options Configuration options for the view instance.
-     * @param options.shouldToolbarGroupWhenFull When set `true` enables automatic items grouping
-     * in the main {@link module:editor-inline/inlineeditoruiview~InlineEditorUIView#toolbar toolbar}.
-     * See {@link module:ui/toolbar/toolbarview~ToolbarOptions#shouldGroupWhenFull} to learn more.
-     */
-    constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement, options?: {
-        shouldToolbarGroupWhenFull?: boolean;
-    });
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Determines the panel top position of the {@link #panel} in {@link #panelPositions}.
-     *
-     * @param editableRect Rect of the {@link #element}.
-     * @param panelRect Rect of the {@link #panel}.
-     */
-    private _getPanelPositionTop;
-    /**
-     * Returns the positions for {@link #panelPositions}.
-     *
-     * See: {@link module:utils/dom/position~Options#positions}.
-     */
-    private _getPanelPositions;
-}