@ckeditor/ckeditor5-widget 40.0.0 → 40.1.0

package/src/widgettoolbarrepository.js

@@ -1,268 +1,268 @@
-/**
- * @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 widget/widgettoolbarrepository
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { BalloonPanelView, ContextualBalloon, ToolbarView } from '@ckeditor/ckeditor5-ui';
-import { CKEditorError, logWarning } from '@ckeditor/ckeditor5-utils';
-import { isWidget } from './utils';
-/**
- * Widget toolbar repository plugin. A central point for registering widget toolbars. This plugin handles the whole
- * toolbar rendering process and exposes a concise API.
- *
- * To add a toolbar for your widget use the {@link ~WidgetToolbarRepository#register `WidgetToolbarRepository#register()`} method.
- *
- * The following example comes from the {@link module:image/imagetoolbar~ImageToolbar} plugin:
- *
- * ```ts
- * class ImageToolbar extends Plugin {
- * 	static get requires() {
- * 		return [ WidgetToolbarRepository ];
- * 	}
- *
- * 	afterInit() {
- * 		const editor = this.editor;
- * 		const widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
- *
- * 		widgetToolbarRepository.register( 'image', {
- * 			items: editor.config.get( 'image.toolbar' ),
- * 			getRelatedElement: getClosestSelectedImageWidget
- * 		} );
- * 	}
- * }
- * ```
- */
-export default class WidgetToolbarRepository extends Plugin {
-    constructor() {
-        super(...arguments);
-        /**
-         * A map of toolbar definitions.
-         */
-        this._toolbarDefinitions = new Map();
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ContextualBalloon];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'WidgetToolbarRepository';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Disables the default balloon toolbar for all widgets.
-        if (editor.plugins.has('BalloonToolbar')) {
-            const balloonToolbar = editor.plugins.get('BalloonToolbar');
-            this.listenTo(balloonToolbar, 'show', evt => {
-                if (isWidgetSelected(editor.editing.view.document.selection)) {
-                    evt.stop();
-                }
-            }, { priority: 'high' });
-        }
-        this._balloon = this.editor.plugins.get('ContextualBalloon');
-        this.on('change:isEnabled', () => {
-            this._updateToolbarsVisibility();
-        });
-        this.listenTo(editor.ui, 'update', () => {
-            this._updateToolbarsVisibility();
-        });
-        // UI#update is not fired after focus is back in editor, we need to check if balloon panel should be visible.
-        this.listenTo(editor.ui.focusTracker, 'change:isFocused', () => {
-            this._updateToolbarsVisibility();
-        }, { priority: 'low' });
-    }
-    destroy() {
-        super.destroy();
-        for (const toolbarConfig of this._toolbarDefinitions.values()) {
-            toolbarConfig.view.destroy();
-        }
-    }
-    /**
-     * Registers toolbar in the WidgetToolbarRepository. It renders it in the `ContextualBalloon` based on the value of the invoked
-     * `getRelatedElement` function. Toolbar items are gathered from `items` array.
-     * The balloon's CSS class is by default `ck-toolbar-container` and may be override with the `balloonClassName` option.
-     *
-     * Note: This method should be called in the {@link module:core/plugin~PluginInterface#afterInit `Plugin#afterInit()`}
-     * callback (or later) to make sure that the given toolbar items were already registered by other plugins.
-     *
-     * @param toolbarId An id for the toolbar. Used to
-     * @param options.ariaLabel Label used by assistive technologies to describe this toolbar element.
-     * @param options.items Array of toolbar items.
-     * @param options.getRelatedElement Callback which returns an element the toolbar should be attached to.
-     * @param options.balloonClassName CSS class for the widget balloon.
-     */
-    register(toolbarId, { ariaLabel, items, getRelatedElement, balloonClassName = 'ck-toolbar-container' }) {
-        // Trying to register a toolbar without any item.
-        if (!items.length) {
-            /**
-             * When {@link module:widget/widgettoolbarrepository~WidgetToolbarRepository#register registering} a new widget toolbar, you
-             * need to provide a non-empty array with the items that will be inserted into the toolbar.
-             *
-             * If you see this error when integrating the editor, you likely forgot to configure one of the widget toolbars.
-             *
-             * See for instance:
-             *
-             * * {@link module:table/tableconfig~TableConfig#contentToolbar `config.table.contentToolbar`}
-             * * {@link module:image/imageconfig~ImageConfig#toolbar `config.image.toolbar`}
-             *
-             * @error widget-toolbar-no-items
-             * @param toolbarId The id of the toolbar that has not been configured correctly.
-             */
-            logWarning('widget-toolbar-no-items', { toolbarId });
-            return;
-        }
-        const editor = this.editor;
-        const t = editor.t;
-        const toolbarView = new ToolbarView(editor.locale);
-        toolbarView.ariaLabel = ariaLabel || t('Widget toolbar');
-        if (this._toolbarDefinitions.has(toolbarId)) {
-            /**
-             * Toolbar with the given id was already added.
-             *
-             * @error widget-toolbar-duplicated
-             * @param toolbarId Toolbar id.
-             */
-            throw new CKEditorError('widget-toolbar-duplicated', this, { toolbarId });
-        }
-        const toolbarDefinition = {
-            view: toolbarView,
-            getRelatedElement,
-            balloonClassName,
-            itemsConfig: items,
-            initialized: false
-        };
-        // Register the toolbar so it becomes available for Alt+F10 and Esc navigation.
-        editor.ui.addToolbar(toolbarView, {
-            isContextual: true,
-            beforeFocus: () => {
-                const relatedElement = getRelatedElement(editor.editing.view.document.selection);
-                if (relatedElement) {
-                    this._showToolbar(toolbarDefinition, relatedElement);
-                }
-            },
-            afterBlur: () => {
-                this._hideToolbar(toolbarDefinition);
-            }
-        });
-        this._toolbarDefinitions.set(toolbarId, toolbarDefinition);
-    }
-    /**
-     * Iterates over stored toolbars and makes them visible or hidden.
-     */
-    _updateToolbarsVisibility() {
-        let maxRelatedElementDepth = 0;
-        let deepestRelatedElement = null;
-        let deepestToolbarDefinition = null;
-        for (const definition of this._toolbarDefinitions.values()) {
-            const relatedElement = definition.getRelatedElement(this.editor.editing.view.document.selection);
-            if (!this.isEnabled || !relatedElement) {
-                if (this._isToolbarInBalloon(definition)) {
-                    this._hideToolbar(definition);
-                }
-            }
-            else if (!this.editor.ui.focusTracker.isFocused) {
-                if (this._isToolbarVisible(definition)) {
-                    this._hideToolbar(definition);
-                }
-            }
-            else {
-                const relatedElementDepth = relatedElement.getAncestors().length;
-                // Many toolbars can express willingness to be displayed but they do not know about
-                // each other. Figure out which toolbar is deepest in the view tree to decide which
-                // should be displayed. For instance, if a selected image is inside a table cell, display
-                // the ImageToolbar rather than the TableToolbar (#60).
-                if (relatedElementDepth > maxRelatedElementDepth) {
-                    maxRelatedElementDepth = relatedElementDepth;
-                    deepestRelatedElement = relatedElement;
-                    deepestToolbarDefinition = definition;
-                }
-            }
-        }
-        if (deepestToolbarDefinition) {
-            this._showToolbar(deepestToolbarDefinition, deepestRelatedElement);
-        }
-    }
-    /**
-     * Hides the given toolbar.
-     */
-    _hideToolbar(toolbarDefinition) {
-        this._balloon.remove(toolbarDefinition.view);
-        this.stopListening(this._balloon, 'change:visibleView');
-    }
-    /**
-     * Shows up the toolbar if the toolbar is not visible.
-     * Otherwise, repositions the toolbar's balloon when toolbar's view is the most top view in balloon stack.
-     *
-     * It might happen here that the toolbar's view is under another view. Then do nothing as the other toolbar view
-     * should be still visible after the {@link module:ui/editorui/editorui~EditorUI#event:update}.
-     */
-    _showToolbar(toolbarDefinition, relatedElement) {
-        if (this._isToolbarVisible(toolbarDefinition)) {
-            repositionContextualBalloon(this.editor, relatedElement);
-        }
-        else if (!this._isToolbarInBalloon(toolbarDefinition)) {
-            if (!toolbarDefinition.initialized) {
-                toolbarDefinition.initialized = true;
-                toolbarDefinition.view.fillFromConfig(toolbarDefinition.itemsConfig, this.editor.ui.componentFactory);
-            }
-            this._balloon.add({
-                view: toolbarDefinition.view,
-                position: getBalloonPositionData(this.editor, relatedElement),
-                balloonClassName: toolbarDefinition.balloonClassName
-            });
-            // Update toolbar position each time stack with toolbar view is switched to visible.
-            // This is in a case target element has changed when toolbar was in invisible stack
-            // e.g. target image was wrapped by a block quote.
-            // See https://github.com/ckeditor/ckeditor5-widget/issues/92.
-            this.listenTo(this._balloon, 'change:visibleView', () => {
-                for (const definition of this._toolbarDefinitions.values()) {
-                    if (this._isToolbarVisible(definition)) {
-                        const relatedElement = definition.getRelatedElement(this.editor.editing.view.document.selection);
-                        repositionContextualBalloon(this.editor, relatedElement);
-                    }
-                }
-            });
-        }
-    }
-    _isToolbarVisible(toolbar) {
-        return this._balloon.visibleView === toolbar.view;
-    }
-    _isToolbarInBalloon(toolbar) {
-        return this._balloon.hasView(toolbar.view);
-    }
-}
-function repositionContextualBalloon(editor, relatedElement) {
-    const balloon = editor.plugins.get('ContextualBalloon');
-    const position = getBalloonPositionData(editor, relatedElement);
-    balloon.updatePosition(position);
-}
-function getBalloonPositionData(editor, relatedElement) {
-    const editingView = editor.editing.view;
-    const defaultPositions = BalloonPanelView.defaultPositions;
-    return {
-        target: editingView.domConverter.mapViewToDom(relatedElement),
-        positions: [
-            defaultPositions.northArrowSouth,
-            defaultPositions.northArrowSouthWest,
-            defaultPositions.northArrowSouthEast,
-            defaultPositions.southArrowNorth,
-            defaultPositions.southArrowNorthWest,
-            defaultPositions.southArrowNorthEast,
-            defaultPositions.viewportStickyNorth
-        ]
-    };
-}
-function isWidgetSelected(selection) {
-    const viewElement = selection.getSelectedElement();
-    return !!(viewElement && isWidget(viewElement));
-}
+/**
+ * @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 widget/widgettoolbarrepository
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { BalloonPanelView, ContextualBalloon, ToolbarView } from '@ckeditor/ckeditor5-ui';
+import { CKEditorError, logWarning } from '@ckeditor/ckeditor5-utils';
+import { isWidget } from './utils';
+/**
+ * Widget toolbar repository plugin. A central point for registering widget toolbars. This plugin handles the whole
+ * toolbar rendering process and exposes a concise API.
+ *
+ * To add a toolbar for your widget use the {@link ~WidgetToolbarRepository#register `WidgetToolbarRepository#register()`} method.
+ *
+ * The following example comes from the {@link module:image/imagetoolbar~ImageToolbar} plugin:
+ *
+ * ```ts
+ * class ImageToolbar extends Plugin {
+ * 	static get requires() {
+ * 		return [ WidgetToolbarRepository ];
+ * 	}
+ *
+ * 	afterInit() {
+ * 		const editor = this.editor;
+ * 		const widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
+ *
+ * 		widgetToolbarRepository.register( 'image', {
+ * 			items: editor.config.get( 'image.toolbar' ),
+ * 			getRelatedElement: getClosestSelectedImageWidget
+ * 		} );
+ * 	}
+ * }
+ * ```
+ */
+export default class WidgetToolbarRepository extends Plugin {
+    constructor() {
+        super(...arguments);
+        /**
+         * A map of toolbar definitions.
+         */
+        this._toolbarDefinitions = new Map();
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ContextualBalloon];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'WidgetToolbarRepository';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Disables the default balloon toolbar for all widgets.
+        if (editor.plugins.has('BalloonToolbar')) {
+            const balloonToolbar = editor.plugins.get('BalloonToolbar');
+            this.listenTo(balloonToolbar, 'show', evt => {
+                if (isWidgetSelected(editor.editing.view.document.selection)) {
+                    evt.stop();
+                }
+            }, { priority: 'high' });
+        }
+        this._balloon = this.editor.plugins.get('ContextualBalloon');
+        this.on('change:isEnabled', () => {
+            this._updateToolbarsVisibility();
+        });
+        this.listenTo(editor.ui, 'update', () => {
+            this._updateToolbarsVisibility();
+        });
+        // UI#update is not fired after focus is back in editor, we need to check if balloon panel should be visible.
+        this.listenTo(editor.ui.focusTracker, 'change:isFocused', () => {
+            this._updateToolbarsVisibility();
+        }, { priority: 'low' });
+    }
+    destroy() {
+        super.destroy();
+        for (const toolbarConfig of this._toolbarDefinitions.values()) {
+            toolbarConfig.view.destroy();
+        }
+    }
+    /**
+     * Registers toolbar in the WidgetToolbarRepository. It renders it in the `ContextualBalloon` based on the value of the invoked
+     * `getRelatedElement` function. Toolbar items are gathered from `items` array.
+     * The balloon's CSS class is by default `ck-toolbar-container` and may be override with the `balloonClassName` option.
+     *
+     * Note: This method should be called in the {@link module:core/plugin~PluginInterface#afterInit `Plugin#afterInit()`}
+     * callback (or later) to make sure that the given toolbar items were already registered by other plugins.
+     *
+     * @param toolbarId An id for the toolbar. Used to
+     * @param options.ariaLabel Label used by assistive technologies to describe this toolbar element.
+     * @param options.items Array of toolbar items.
+     * @param options.getRelatedElement Callback which returns an element the toolbar should be attached to.
+     * @param options.balloonClassName CSS class for the widget balloon.
+     */
+    register(toolbarId, { ariaLabel, items, getRelatedElement, balloonClassName = 'ck-toolbar-container' }) {
+        // Trying to register a toolbar without any item.
+        if (!items.length) {
+            /**
+             * When {@link module:widget/widgettoolbarrepository~WidgetToolbarRepository#register registering} a new widget toolbar, you
+             * need to provide a non-empty array with the items that will be inserted into the toolbar.
+             *
+             * If you see this error when integrating the editor, you likely forgot to configure one of the widget toolbars.
+             *
+             * See for instance:
+             *
+             * * {@link module:table/tableconfig~TableConfig#contentToolbar `config.table.contentToolbar`}
+             * * {@link module:image/imageconfig~ImageConfig#toolbar `config.image.toolbar`}
+             *
+             * @error widget-toolbar-no-items
+             * @param toolbarId The id of the toolbar that has not been configured correctly.
+             */
+            logWarning('widget-toolbar-no-items', { toolbarId });
+            return;
+        }
+        const editor = this.editor;
+        const t = editor.t;
+        const toolbarView = new ToolbarView(editor.locale);
+        toolbarView.ariaLabel = ariaLabel || t('Widget toolbar');
+        if (this._toolbarDefinitions.has(toolbarId)) {
+            /**
+             * Toolbar with the given id was already added.
+             *
+             * @error widget-toolbar-duplicated
+             * @param toolbarId Toolbar id.
+             */
+            throw new CKEditorError('widget-toolbar-duplicated', this, { toolbarId });
+        }
+        const toolbarDefinition = {
+            view: toolbarView,
+            getRelatedElement,
+            balloonClassName,
+            itemsConfig: items,
+            initialized: false
+        };
+        // Register the toolbar so it becomes available for Alt+F10 and Esc navigation.
+        editor.ui.addToolbar(toolbarView, {
+            isContextual: true,
+            beforeFocus: () => {
+                const relatedElement = getRelatedElement(editor.editing.view.document.selection);
+                if (relatedElement) {
+                    this._showToolbar(toolbarDefinition, relatedElement);
+                }
+            },
+            afterBlur: () => {
+                this._hideToolbar(toolbarDefinition);
+            }
+        });
+        this._toolbarDefinitions.set(toolbarId, toolbarDefinition);
+    }
+    /**
+     * Iterates over stored toolbars and makes them visible or hidden.
+     */
+    _updateToolbarsVisibility() {
+        let maxRelatedElementDepth = 0;
+        let deepestRelatedElement = null;
+        let deepestToolbarDefinition = null;
+        for (const definition of this._toolbarDefinitions.values()) {
+            const relatedElement = definition.getRelatedElement(this.editor.editing.view.document.selection);
+            if (!this.isEnabled || !relatedElement) {
+                if (this._isToolbarInBalloon(definition)) {
+                    this._hideToolbar(definition);
+                }
+            }
+            else if (!this.editor.ui.focusTracker.isFocused) {
+                if (this._isToolbarVisible(definition)) {
+                    this._hideToolbar(definition);
+                }
+            }
+            else {
+                const relatedElementDepth = relatedElement.getAncestors().length;
+                // Many toolbars can express willingness to be displayed but they do not know about
+                // each other. Figure out which toolbar is deepest in the view tree to decide which
+                // should be displayed. For instance, if a selected image is inside a table cell, display
+                // the ImageToolbar rather than the TableToolbar (#60).
+                if (relatedElementDepth > maxRelatedElementDepth) {
+                    maxRelatedElementDepth = relatedElementDepth;
+                    deepestRelatedElement = relatedElement;
+                    deepestToolbarDefinition = definition;
+                }
+            }
+        }
+        if (deepestToolbarDefinition) {
+            this._showToolbar(deepestToolbarDefinition, deepestRelatedElement);
+        }
+    }
+    /**
+     * Hides the given toolbar.
+     */
+    _hideToolbar(toolbarDefinition) {
+        this._balloon.remove(toolbarDefinition.view);
+        this.stopListening(this._balloon, 'change:visibleView');
+    }
+    /**
+     * Shows up the toolbar if the toolbar is not visible.
+     * Otherwise, repositions the toolbar's balloon when toolbar's view is the most top view in balloon stack.
+     *
+     * It might happen here that the toolbar's view is under another view. Then do nothing as the other toolbar view
+     * should be still visible after the {@link module:ui/editorui/editorui~EditorUI#event:update}.
+     */
+    _showToolbar(toolbarDefinition, relatedElement) {
+        if (this._isToolbarVisible(toolbarDefinition)) {
+            repositionContextualBalloon(this.editor, relatedElement);
+        }
+        else if (!this._isToolbarInBalloon(toolbarDefinition)) {
+            if (!toolbarDefinition.initialized) {
+                toolbarDefinition.initialized = true;
+                toolbarDefinition.view.fillFromConfig(toolbarDefinition.itemsConfig, this.editor.ui.componentFactory);
+            }
+            this._balloon.add({
+                view: toolbarDefinition.view,
+                position: getBalloonPositionData(this.editor, relatedElement),
+                balloonClassName: toolbarDefinition.balloonClassName
+            });
+            // Update toolbar position each time stack with toolbar view is switched to visible.
+            // This is in a case target element has changed when toolbar was in invisible stack
+            // e.g. target image was wrapped by a block quote.
+            // See https://github.com/ckeditor/ckeditor5-widget/issues/92.
+            this.listenTo(this._balloon, 'change:visibleView', () => {
+                for (const definition of this._toolbarDefinitions.values()) {
+                    if (this._isToolbarVisible(definition)) {
+                        const relatedElement = definition.getRelatedElement(this.editor.editing.view.document.selection);
+                        repositionContextualBalloon(this.editor, relatedElement);
+                    }
+                }
+            });
+        }
+    }
+    _isToolbarVisible(toolbar) {
+        return this._balloon.visibleView === toolbar.view;
+    }
+    _isToolbarInBalloon(toolbar) {
+        return this._balloon.hasView(toolbar.view);
+    }
+}
+function repositionContextualBalloon(editor, relatedElement) {
+    const balloon = editor.plugins.get('ContextualBalloon');
+    const position = getBalloonPositionData(editor, relatedElement);
+    balloon.updatePosition(position);
+}
+function getBalloonPositionData(editor, relatedElement) {
+    const editingView = editor.editing.view;
+    const defaultPositions = BalloonPanelView.defaultPositions;
+    return {
+        target: editingView.domConverter.mapViewToDom(relatedElement),
+        positions: [
+            defaultPositions.northArrowSouth,
+            defaultPositions.northArrowSouthWest,
+            defaultPositions.northArrowSouthEast,
+            defaultPositions.southArrowNorth,
+            defaultPositions.southArrowNorthWest,
+            defaultPositions.southArrowNorthEast,
+            defaultPositions.viewportStickyNorth
+        ]
+    };
+}
+function isWidgetSelected(selection) {
+    const viewElement = selection.getSelectedElement();
+    return !!(viewElement && isWidget(viewElement));
+}

package/src/widgettypearound/utils.d.ts

@@ -1,38 +1,38 @@
-/**
- * @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
- */
-import type { DocumentSelection, DomConverter, Element, Schema, Selection, ViewElement } from '@ckeditor/ckeditor5-engine';
-/**
- * The name of the type around model selection attribute responsible for
- * displaying a fake caret next to a selected widget.
- */
-export declare const TYPE_AROUND_SELECTION_ATTRIBUTE = "widget-type-around";
-/**
- * Checks if an element is a widget that qualifies to get the widget type around UI.
- */
-export declare function isTypeAroundWidget(viewElement: ViewElement | undefined, modelElement: Element, schema: Schema): boolean;
-/**
- * For the passed HTML element, this helper finds the closest widget type around button ancestor.
- */
-export declare function getClosestTypeAroundDomButton(domElement: HTMLElement): HTMLElement | null;
-/**
- * For the passed widget type around button element, this helper determines at which position
- * the paragraph would be inserted into the content if, for instance, the button was
- * clicked by the user.
- *
- * @returns The position of the button.
- */
-export declare function getTypeAroundButtonPosition(domElement: HTMLElement): 'before' | 'after';
-/**
- * For the passed HTML element, this helper returns the closest view widget ancestor.
- */
-export declare function getClosestWidgetViewElement(domElement: HTMLElement, domConverter: DomConverter): ViewElement;
-/**
- * For the passed selection instance, it returns the position of the fake caret displayed next to a widget.
- *
- * **Note**: If the fake caret is not currently displayed, `null` is returned.
- *
- * @returns The position of the fake caret or `null` when none is present.
- */
-export declare function getTypeAroundFakeCaretPosition(selection: Selection | DocumentSelection): 'before' | 'after' | null;
+/**
+ * @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
+ */
+import type { DocumentSelection, DomConverter, Element, Schema, Selection, ViewElement } from '@ckeditor/ckeditor5-engine';
+/**
+ * The name of the type around model selection attribute responsible for
+ * displaying a fake caret next to a selected widget.
+ */
+export declare const TYPE_AROUND_SELECTION_ATTRIBUTE = "widget-type-around";
+/**
+ * Checks if an element is a widget that qualifies to get the widget type around UI.
+ */
+export declare function isTypeAroundWidget(viewElement: ViewElement | undefined, modelElement: Element, schema: Schema): boolean;
+/**
+ * For the passed HTML element, this helper finds the closest widget type around button ancestor.
+ */
+export declare function getClosestTypeAroundDomButton(domElement: HTMLElement): HTMLElement | null;
+/**
+ * For the passed widget type around button element, this helper determines at which position
+ * the paragraph would be inserted into the content if, for instance, the button was
+ * clicked by the user.
+ *
+ * @returns The position of the button.
+ */
+export declare function getTypeAroundButtonPosition(domElement: HTMLElement): 'before' | 'after';
+/**
+ * For the passed HTML element, this helper returns the closest view widget ancestor.
+ */
+export declare function getClosestWidgetViewElement(domElement: HTMLElement, domConverter: DomConverter): ViewElement;
+/**
+ * For the passed selection instance, it returns the position of the fake caret displayed next to a widget.
+ *
+ * **Note**: If the fake caret is not currently displayed, `null` is returned.
+ *
+ * @returns The position of the fake caret or `null` when none is present.
+ */
+export declare function getTypeAroundFakeCaretPosition(selection: Selection | DocumentSelection): 'before' | 'after' | null;