ckeditor5-elements-menu 0.0.0-stage → 49.0.0

package/dist/breadcrumbs/elementBreadcrumbs.js

@@ -0,0 +1,225 @@
+import { Plugin } from 'ckeditor5';
+import { isInDocument } from 'ckeditor5-elements-core';
+import ElementMenu, {} from '../elementMenu.js';
+import {} from './breadcrumbItemView.js';
+import BreadcrumbsView, {} from './breadcrumbsView.js';
+/**
+ * Converting the data view of a large document takes a while. When the last conversion took longer than this (in
+ * milliseconds), the next one waits for {@link THROTTLE_TIME}, so editing elements quickly does not convert every time.
+ */
+const SLOW_CONVERSION_TIME = 10;
+const THROTTLE_TIME = 250;
+/**
+ * Shows the data view structure at the current selection (the elements of the editor data, as in `getData()`), e.g.
+ * `aside.note › p`, `ul › li` or `figure.table › table › tbody › tr › td`.
+ *
+ * Inline elements are items, as any element. CKEditor's text attributes, marks on the text such as its `<strong>`, are
+ * skipped. The selected element, e.g. an image, is the innermost item.
+ *
+ * Place them in a toolbar as the `breadcrumbs` component, or anywhere else using a view from {@link createView}.
+ *
+ * Clicking is configured only by the `elementBreadcrumbs.menu` editor config option (see {@link ElementBreadcrumbsConfig}): with it,
+ * the items are buttons that open the menu of their element, with `ElementMenu`, as the context menu does; without it,
+ * they are labels.
+ *
+ * The data view is converted again only when elements change, not when typing or moving the cursor. For a large
+ * document, that happens at most every 250 ms.
+ */
+export default class ElementBreadcrumbs extends Plugin {
+    _dataView = null;
+    _isDataViewOutdated = true;
+    _isConversionSlow = false;
+    _conversionTimeout = null;
+    static get pluginName() {
+        return 'ElementBreadcrumbs';
+    }
+    static get requires() {
+        return [ElementMenu];
+    }
+    constructor(editor) {
+        super(editor);
+        this.set('items', []);
+    }
+    init() {
+        const editor = this.editor;
+        editor.ui.componentFactory.add('breadcrumbs', locale => this.createView(locale));
+        this.listenTo(editor.ui, 'ready', () => {
+            this.refresh();
+        });
+        // Both selection and data changes.
+        this.listenTo(editor.model.document, 'change', () => {
+            if (hasElementChanges(editor.model.document.differ.getChanges())) {
+                this._isDataViewOutdated = true;
+            }
+            this._update();
+        });
+    }
+    /**
+     * Creates a breadcrumbs view that follows {@link items}.
+     */
+    createView(locale = this.editor.locale) {
+        const isClickable = typeof this.editor.config.get('elementBreadcrumbs')?.menu === 'function';
+        const view = new BreadcrumbsView(locale, { isClickable });
+        view.setItems(this.items);
+        view.listenTo(this, 'change:items', () => {
+            view.setItems(this.items);
+        });
+        view.on('execute', (evt, item) => {
+            this._openMenu(item);
+        });
+        return view;
+    }
+    /**
+     * Updates {@link items} from the current selection, converting the data view first when elements changed.
+     */
+    refresh() {
+        const root = this.editor.model.document.selection.getFirstPosition()?.root;
+        if (root?.is('rootElement') && (this._isDataViewOutdated || root !== this._dataView?.root)) {
+            this._convert(root);
+        }
+        const items = this._getItems();
+        if (!areEqual(items, this.items)) {
+            this.items = items;
+        }
+    }
+    destroy() {
+        this._cancelConversion();
+        super.destroy();
+    }
+    /**
+     * Refreshes the items after a change. When converting is slow, the data view is converted later, and the items
+     * follow the outdated data view until then.
+     */
+    _update() {
+        const root = this.editor.model.document.selection.getFirstPosition()?.root;
+        if (this._isDataViewOutdated && this._isConversionSlow && root === this._dataView?.root) {
+            this._conversionTimeout ??= setTimeout(() => {
+                this._conversionTimeout = null;
+                this.refresh();
+            }, THROTTLE_TIME);
+        }
+        if (this._conversionTimeout) {
+            const items = this._getItems();
+            if (!areEqual(items, this.items)) {
+                this.items = items;
+            }
+        }
+        else {
+            this.refresh();
+        }
+    }
+    /**
+     * Converts the root to the data view, and maps its model elements to their view elements.
+     */
+    _convert(root) {
+        const data = this.editor.data;
+        const start = performance.now();
+        const viewElements = new WeakMap();
+        const modelElements = new WeakMap();
+        // The mapper of the data pipeline is cleared by the next conversion (e.g. `getData()`), so keep the mapping.
+        data.toView(root);
+        for (const { item } of this.editor.model.createRangeIn(root)) {
+            const viewElement = item.is('element') ? data.mapper.toViewElement(item) : undefined;
+            if (item.is('element') && viewElement) {
+                viewElements.set(item, viewElement);
+                modelElements.set(viewElement, item);
+            }
+        }
+        this._dataView = { root, viewElements, modelElements };
+        this._isDataViewOutdated = false;
+        this._isConversionSlow = performance.now() - start > SLOW_CONVERSION_TIME;
+        this._cancelConversion();
+    }
+    _cancelConversion() {
+        if (this._conversionTimeout) {
+            clearTimeout(this._conversionTimeout);
+            this._conversionTimeout = null;
+        }
+    }
+    /**
+     * Returns the data view elements at the selection: the view element of the selected element, or of the innermost
+     * element with the selection, and its ancestors.
+     */
+    _getItems() {
+        const dataView = this._dataView;
+        const selection = this.editor.model.document.selection;
+        const position = selection.getFirstPosition();
+        if (!dataView || position?.root !== dataView.root) {
+            return [];
+        }
+        // Elements created since the last conversion are not mapped yet; their closest mapped ancestor is used meanwhile.
+        let viewElement;
+        for (let element = selection.getSelectedElement() ?? position.parent; element?.is('element') && !element.is('rootElement') && !viewElement; element = element.parent) {
+            viewElement = dataView.viewElements.get(element);
+        }
+        return viewElement ? getPath(viewElement).map(node => createItem(node, dataView)) : [];
+    }
+    _openMenu(item) {
+        const menuItems = this.editor.config.get('elementBreadcrumbs')?.menu;
+        const element = item.modelElement;
+        if (!menuItems || !item.element || !element || !isInDocument(element)) {
+            return;
+        }
+        item.isExpanded = this.editor.plugins.get(ElementMenu).open(element, item.element, menuItems, {
+            // The breadcrumbs may have been replaced while the menu was open.
+            returnFocusTo: {
+                focus: () => {
+                    if (item.element?.isConnected) {
+                        item.focus();
+                    }
+                    else {
+                        this.editor.editing.view.focus();
+                    }
+                }
+            },
+            onHide: () => {
+                item.isExpanded = false;
+            }
+        });
+    }
+}
+/**
+ * Whether the changes add, remove or change elements. Typing (text changes) does not change the data view structure.
+ */
+function hasElementChanges(changes) {
+    return changes.some(change => change.type === 'attribute'
+        ? Array.from(change.range.getItems({ shallow: true })).some(item => item.is('element'))
+        : change.name !== '$text');
+}
+/**
+ * Returns the view element and its ancestors, outermost first, without:
+ *
+ * * text attributes (attribute elements without a block inside, such as `<strong>` or `<a>`); list items (`<ul>`,
+ *   `<li>`) are attribute elements too, but wrap blocks,
+ * * elements that are not rendered in the data, such as the paragraph in a list item or a table cell that has only
+ *   one paragraph.
+ */
+function getPath(viewElement) {
+    const path = [];
+    let hasBlock = false;
+    for (let node = viewElement; node?.is('element'); node = node.parent) {
+        const isTextAttribute = node.is('attributeElement') && !hasBlock;
+        if (!isTextAttribute && !node.getCustomProperty('dataPipeline:transparentRendering')) {
+            path.unshift(node);
+        }
+        hasBlock ||= node.is('containerElement');
+    }
+    return path;
+}
+/**
+ * Creates the item of a view element. Its model element is the mapped one, or the closest mapped ancestor of a part of
+ * a structure (e.g. a `tbody` is a part of a table). List items have none: they come from the attributes of the blocks
+ * in them, not from an element.
+ */
+function createItem(viewElement, dataView) {
+    let modelElement = null;
+    for (let node = viewElement; node?.is('element') && !modelElement && !node.is('attributeElement'); node = node.parent) {
+        modelElement = dataView.modelElements.get(node) ?? null;
+    }
+    return { label: [viewElement.name, ...viewElement.getClassNames()].join('.'), viewElement, modelElement };
+}
+function areEqual(a, b) {
+    return (a.length === b.length &&
+        a.every((item, index) => item.label === b[index]?.label && item.modelElement === b[index].modelElement));
+}
+//# sourceMappingURL=elementBreadcrumbs.js.map

package/dist/breadcrumbs/elementBreadcrumbs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementBreadcrumbs.js","sourceRoot":"","sources":["../../src/breadcrumbs/elementBreadcrumbs.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,MAAM,EAWN,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,WAAW,EAAE,EAA0B,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAA2D,MAAM,yBAAyB,CAAC;AAClG,OAAO,eAAe,EAAE,EAAoC,MAAM,sBAAsB,CAAC;AAEzF;;;GAGG;AACH,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,aAAa,GAAG,GAAG,CAAC;AAuB1B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,MAAM;IAQ7C,SAAS,GAAoB,IAAI,CAAC;IAClC,mBAAmB,GAAG,IAAI,CAAC;IAC3B,iBAAiB,GAAG,KAAK,CAAC;IAC1B,kBAAkB,GAAyC,IAAI,CAAC;IAEjE,MAAM,KAAK,UAAU;QAC3B,OAAO,oBAA6B,CAAC;IACtC,CAAC;IAEM,MAAM,KAAK,QAAQ;QACzB,OAAO,CAAC,WAAW,CAAU,CAAC;IAC/B,CAAC;IAED,YAAY,MAAc;QACzB,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACvB,CAAC;IAEM,IAAI;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAEjF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;YACtC,IAAI,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,mCAAmC;QACnC,IAAI,CAAC,QAAQ,CAA2B,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE;YAC7E,IAAI,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;gBAClE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;YACjC,CAAC;YAED,IAAI,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,SAAiB,IAAI,CAAC,MAAM,CAAC,MAAM;QACpD,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,IAAI,KAAK,UAAU,CAAC;QAC7F,MAAM,IAAI,GAAG,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAE1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE;YACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAA8B,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC7D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,OAAO;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC;QAE3E,IAAI,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,IAAI,KAAK,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;YAC5F,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAE/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACpB,CAAC;IACF,CAAC;IAEe,OAAO;QACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,KAAK,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;;OAGG;IACK,OAAO;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC;QAE3E,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,KAAK,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC;YACzF,IAAI,CAAC,kBAAkB,KAAK,UAAU,CAAC,GAAG,EAAE;gBAC3C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;gBAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,CAAC,EAAE,aAAa,CAAC,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAE/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,CAAC;QACF,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC;IACF,CAAC;IAED;;OAEG;IACK,QAAQ,CAAC,IAAsB;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,YAAY,GAAG,IAAI,OAAO,EAA6B,CAAC;QAC9D,MAAM,aAAa,GAAG,IAAI,OAAO,EAA6B,CAAC;QAE/D,6GAA6G;QAC7G,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAElB,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAErF,IAAI,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,WAAW,EAAE,CAAC;gBACvC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBACpC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACtC,CAAC;QACF,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;QACvD,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;QACjC,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,oBAAoB,CAAC;QAC1E,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC1B,CAAC;IAEO,iBAAiB;QACxB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACtC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,SAAS;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAE9C,IAAI,CAAC,QAAQ,IAAI,QAAQ,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,kHAAkH;QAClH,IAAI,WAAoC,CAAC;QAEzC,KACC,IAAI,OAAO,GACV,SAAS,CAAC,kBAAkB,EAAE,IAAI,QAAQ,CAAC,MAAM,EAClD,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EACpE,OAAO,GAAG,OAAO,CAAC,MAAM,EACvB,CAAC;YACF,WAAW,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxF,CAAC;IAEO,SAAS,CAAC,IAAwB;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;QACrE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC;QAElC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YACvE,OAAO;QACR,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE;YAC7F,kEAAkE;YAClE,aAAa,EAAE;gBACd,KAAK,EAAE,GAAG,EAAE;oBACX,IAAI,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;wBAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;oBACd,CAAC;yBAAM,CAAC;wBACP,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;oBAClC,CAAC;gBACF,CAAC;aACD;YACD,MAAM,EAAE,GAAG,EAAE;gBACZ,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACzB,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;CACD;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,OAA8B;IACxD,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAC5B,MAAM,CAAC,IAAI,KAAK,WAAW;QAC1B,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QACvF,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAC1B,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,OAAO,CAAC,WAAwB;IACxC,MAAM,IAAI,GAAkB,EAAE,CAAC;IAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,KAAK,IAAI,IAAI,GAA2C,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC9G,MAAM,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC;QAEjE,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,mCAAmC,CAAC,EAAE,CAAC;YACtF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;QAED,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,WAAwB,EAAE,QAAkB;IAC/D,IAAI,YAAY,GAAwB,IAAI,CAAC;IAE7C,KACC,IAAI,IAAI,GAA2C,WAAW,EAC9D,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,EACpE,IAAI,GAAG,IAAI,CAAC,MAAM,EACjB,CAAC;QACF,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IACzD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;AAC3G,CAAC;AAED,SAAS,QAAQ,CAAC,CAA4B,EAAE,CAA4B;IAC3E,OAAO,CACN,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CACvG,CAAC;AACH,CAAC"}

package/dist/contextMenu/contextMenuObserver.d.ts

@@ -0,0 +1,19 @@
+import { DomEventObserver, type ViewDocumentDomEventData } from 'ckeditor5';
+/**
+ * Fires the `contextmenu` event on the view document when the user opens the native context menu in an editable.
+ */
+export default class ContextMenuObserver extends DomEventObserver<'contextmenu'> {
+    get domEventType(): 'contextmenu';
+    /**
+     * Fires `contextmenu` on the view document for the DOM event.
+     */
+    onDomEvent(domEvent: MouseEvent): void;
+}
+/**
+ * Fired on the view document by the {@link ContextMenuObserver}.
+ */
+export interface ViewDocumentContextMenuEvent {
+    name: 'contextmenu';
+    args: [data: ViewDocumentDomEventData<MouseEvent>];
+}
+//# sourceMappingURL=contextMenuObserver.d.ts.map

package/dist/contextMenu/contextMenuObserver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextMenuObserver.d.ts","sourceRoot":"","sources":["../../src/contextMenu/contextMenuObserver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAE5E;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,gBAAgB,CAAC,aAAa,CAAC;IAG/E,IAAW,YAAY,IAAI,aAAa,CAEvC;IAED;;OAEG;IACI,UAAU,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI;CAG7C;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,CAAC,IAAI,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;CACnD"}

package/dist/contextMenu/contextMenuObserver.js

@@ -0,0 +1,18 @@
+import { DomEventObserver } from 'ckeditor5';
+/**
+ * Fires the `contextmenu` event on the view document when the user opens the native context menu in an editable.
+ */
+export default class ContextMenuObserver extends DomEventObserver {
+    // The base class declares it as an accessor, so it cannot be a field here.
+    // eslint-disable-next-line @typescript-eslint/class-literal-property-style
+    get domEventType() {
+        return 'contextmenu';
+    }
+    /**
+     * Fires `contextmenu` on the view document for the DOM event.
+     */
+    onDomEvent(domEvent) {
+        this.fire(domEvent.type, domEvent);
+    }
+}
+//# sourceMappingURL=contextMenuObserver.js.map

package/dist/contextMenu/contextMenuObserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextMenuObserver.js","sourceRoot":"","sources":["../../src/contextMenu/contextMenuObserver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAiC,MAAM,WAAW,CAAC;AAE5E;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,gBAA+B;IAC/E,2EAA2E;IAC3E,2EAA2E;IAC3E,IAAW,YAAY;QACtB,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,QAAoB;QACrC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;CACD"}

package/dist/contextMenu/elementContextMenu.d.ts

@@ -0,0 +1,34 @@
+import { Plugin, type ModelElement, type RectSource, type ViewElement } from 'ckeditor5';
+import ElementMenu from '../elementMenu.js';
+/**
+ * Shows the menu of an element when the user right-clicks it, or opens the context menu with the keyboard (the menu
+ * key, or Shift+F10) while the cursor is in it.
+ *
+ * The items come from the `elementContextMenu` editor config option only (see `ElementMenuConfig`): commands, submenus
+ * and `'|'` separators. Without it, or when it returns no items for an
+ * element, the native context menu shows. The menu itself is shown by the `ElementMenu` plugin.
+ */
+export default class ElementContextMenu extends Plugin {
+    static get requires(): readonly [typeof ElementMenu];
+    static get pluginName(): 'ElementContextMenu';
+    init(): void;
+    /**
+     * Opens the menu of the element next to the target (e.g. a button, or a `DOMRect` in viewport coordinates), with
+     * the items from the `elementContextMenu` config option.
+     *
+     * Returns `false` when there are no items, so the caller can let the native context menu show instead.
+     */
+    open(element: ModelElement, target: RectSource): boolean;
+    /**
+     * Opens the menu of the element at the selection (the selected element, or the element with the cursor), next to
+     * the selection.
+     *
+     * Returns `false` when there is no such element or no items.
+     */
+    openAtSelection(): boolean;
+    /**
+     * Returns the closest model element mapped to the given view element or its ancestors, skipping the root.
+     */
+    getModelElement(viewElement: ViewElement): ModelElement | null;
+}
+//# sourceMappingURL=elementContextMenu.d.ts.map

package/dist/contextMenu/elementContextMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementContextMenu.d.ts","sourceRoot":"","sources":["../../src/contextMenu/elementContextMenu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAGzF,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAG5C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,MAAM;IACrD,WAAkB,QAAQ,IAAI,SAAS,CAAC,OAAO,WAAW,CAAC,CAE1D;IAED,WAAkB,UAAU,IAAI,oBAAoB,CAEnD;IAEM,IAAI,IAAI,IAAI;IAmCnB;;;;;OAKG;IACI,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO;IAY/D;;;;;OAKG;IACI,eAAe,IAAI,OAAO;IAWjC;;OAEG;IACI,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,GAAG,IAAI;CAOrE"}

package/dist/contextMenu/elementContextMenu.js

@@ -0,0 +1,88 @@
+import { Plugin } from 'ckeditor5';
+import { getElementAtSelection, getElementsAround, isInDocument } from 'ckeditor5-elements-core';
+import { getDomTarget } from '../domTarget.js';
+import ElementMenu from '../elementMenu.js';
+import ContextMenuObserver, {} from './contextMenuObserver.js';
+/**
+ * Shows the menu of an element when the user right-clicks it, or opens the context menu with the keyboard (the menu
+ * key, or Shift+F10) while the cursor is in it.
+ *
+ * The items come from the `elementContextMenu` editor config option only (see `ElementMenuConfig`): commands, submenus
+ * and `'|'` separators. Without it, or when it returns no items for an
+ * element, the native context menu shows. The menu itself is shown by the `ElementMenu` plugin.
+ */
+export default class ElementContextMenu extends Plugin {
+    static get requires() {
+        return [ElementMenu];
+    }
+    static get pluginName() {
+        return 'ElementContextMenu';
+    }
+    init() {
+        const editor = this.editor;
+        const editingView = editor.editing.view;
+        editingView.addObserver(ContextMenuObserver);
+        this.listenTo(editingView.document, 'contextmenu', (evt, data) => {
+            const { domEvent } = data;
+            const element = this.getModelElement(data.target);
+            // A context menu opened with the keyboard (the menu key, or Shift+F10 in some browsers) targets the editable
+            // itself, not the element at the cursor. A right-click outside any element keeps the native menu.
+            const isOpen = element
+                ? this.open(element, new DOMRect(domEvent.clientX, domEvent.clientY, 0, 0))
+                : domEvent.button !== 2 && this.openAtSelection();
+            if (isOpen) {
+                data.preventDefault();
+            }
+        });
+        // Not every browser opens the context menu on Shift+F10 (e.g. on macOS), so handle it in all of them.
+        editor.keystrokes.set('Shift+F10', (data, cancel) => {
+            if (this.openAtSelection()) {
+                cancel();
+            }
+        });
+        if (typeof editor.config.get('elementContextMenu') === 'function') {
+            editor.accessibility.addKeystrokeInfos({
+                keystrokes: [{ label: editor.t('Open the menu of the element at the cursor'), keystroke: 'Shift+F10' }]
+            });
+        }
+    }
+    /**
+     * Opens the menu of the element next to the target (e.g. a button, or a `DOMRect` in viewport coordinates), with
+     * the items from the `elementContextMenu` config option.
+     *
+     * Returns `false` when there are no items, so the caller can let the native context menu show instead.
+     */
+    open(element, target) {
+        const config = this.editor.config.get('elementContextMenu');
+        if (typeof config !== 'function') {
+            return false;
+        }
+        return this.editor.plugins
+            .get(ElementMenu)
+            .open(element, target, config, { label: this.editor.t('Element menu') });
+    }
+    /**
+     * Opens the menu of the element at the selection (the selected element, or the element with the cursor), next to
+     * the selection.
+     *
+     * Returns `false` when there is no such element or no items.
+     */
+    openAtSelection() {
+        const element = getElementAtSelection(this.editor.model.document.selection);
+        const target = getDomTarget(this.editor);
+        if (!element || !isInDocument(element) || !target) {
+            return false;
+        }
+        return this.open(element, target);
+    }
+    /**
+     * Returns the closest model element mapped to the given view element or its ancestors, skipping the root.
+     */
+    getModelElement(viewElement) {
+        for (const { element } of getElementsAround(this.editor.editing.mapper, viewElement)) {
+            return element;
+        }
+        return null;
+    }
+}
+//# sourceMappingURL=elementContextMenu.js.map

package/dist/contextMenu/elementContextMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementContextMenu.js","sourceRoot":"","sources":["../../src/contextMenu/elementContextMenu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwD,MAAM,WAAW,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,mBAAmB,EAAE,EAAqC,MAAM,0BAA0B,CAAC;AAElG;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,MAAM;IAC9C,MAAM,KAAK,QAAQ;QACzB,OAAO,CAAC,WAAW,CAAU,CAAC;IAC/B,CAAC;IAEM,MAAM,KAAK,UAAU;QAC3B,OAAO,oBAA6B,CAAC;IACtC,CAAC;IAEM,IAAI;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAExC,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;QAE7C,IAAI,CAAC,QAAQ,CAA+B,WAAW,CAAC,QAAQ,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC9F,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;YAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAElD,6GAA6G;YAC7G,kGAAkG;YAClG,MAAM,MAAM,GAAG,OAAO;gBACrB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC3E,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAEnD,IAAI,MAAM,EAAE,CAAC;gBACZ,IAAI,CAAC,cAAc,EAAE,CAAC;YACvB,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,sGAAsG;QACtG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACnD,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;gBAC5B,MAAM,EAAE,CAAC;YACV,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,UAAU,EAAE,CAAC;YACnE,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC;gBACtC,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,4CAA4C,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;aACvG,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,OAAqB,EAAE,MAAkB;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAE5D,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;aACxB,GAAG,CAAC,WAAW,CAAC;aAChB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACI,eAAe;QACrB,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,WAAwB;QAC9C,KAAK,MAAM,EAAE,OAAO,EAAE,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC;YACtF,OAAO,OAAO,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/dist/domTarget.d.ts

@@ -0,0 +1,8 @@
+import { type Editor } from 'ckeditor5';
+import type { ElementOrPosition } from 'ckeditor5-elements-core';
+/**
+ * Returns what a menu for the target is shown next to: the DOM element of an element, or the DOM range of a position.
+ * Without a target, the ones of the selection: its selected element, or its range. `null` when it is not rendered.
+ */
+export declare function getDomTarget(editor: Editor, target?: ElementOrPosition): HTMLElement | Range | null;
+//# sourceMappingURL=domTarget.d.ts.map

package/dist/domTarget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domTarget.d.ts","sourceRoot":"","sources":["../src/domTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,iBAAiB,GAAG,WAAW,GAAG,KAAK,GAAG,IAAI,CAmBnG"}

package/dist/domTarget.js

@@ -0,0 +1,20 @@
+import { ModelPosition } from 'ckeditor5';
+/**
+ * Returns what a menu for the target is shown next to: the DOM element of an element, or the DOM range of a position.
+ * Without a target, the ones of the selection: its selected element, or its range. `null` when it is not rendered.
+ */
+export function getDomTarget(editor, target) {
+    const { mapper, view } = editor.editing;
+    if (target instanceof ModelPosition) {
+        return view.domConverter.viewRangeToDom(view.createRange(mapper.toViewPosition(target)));
+    }
+    const element = target ?? editor.model.document.selection.getSelectedElement();
+    if (element) {
+        const viewElement = mapper.toViewElement(element);
+        const domElement = viewElement && view.domConverter.mapViewToDom(viewElement);
+        return domElement instanceof HTMLElement ? domElement : null;
+    }
+    const viewRange = view.document.selection.getFirstRange();
+    return viewRange ? view.domConverter.viewRangeToDom(viewRange) : null;
+}
+//# sourceMappingURL=domTarget.js.map

package/dist/domTarget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domTarget.js","sourceRoot":"","sources":["../src/domTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAe,MAAM,WAAW,CAAC;AAGvD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,MAA0B;IACtE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAExC,IAAI,MAAM,YAAY,aAAa,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;IAE/E,IAAI,OAAO,EAAE,CAAC;QACb,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,UAAU,GAAG,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE9E,OAAO,UAAU,YAAY,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;IAE1D,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvE,CAAC"}

package/dist/elementMenu.d.ts

@@ -0,0 +1,93 @@
+import { ContextualBalloon, Notification, Plugin, type Editor, type FocusableView, type ModelElement, type RectSource } from 'ckeditor5';
+import { type ElementOrPositionCommand } from 'ckeditor5-elements-core';
+/**
+ * A submenu of an element menu. Missing items are skipped, as in the menu.
+ */
+export interface ElementSubmenu {
+    title: string;
+    /**
+     * The icon (SVG string) shown next to the title.
+     */
+    icon?: string;
+    items: (ElementMenuItem | null | undefined)[];
+}
+/**
+ * An item of an element menu:
+ *
+ * * a command, shown as a button with its `title` and `icon`, enabled and "on" according to its
+ *   {@link ElementOrPositionCommand#getState state} for the element,
+ * * a submenu,
+ * * `'|'`, a separator. Separators at the start or the end of a menu, and repeated ones, are not shown, so a group of
+ *   items can start with one.
+ */
+export type ElementMenuItem = ElementOrPositionCommand | ElementSubmenu | '|';
+/**
+ * Returns the items of the menu of the given element, e.g. as the `elementContextMenu` or `elementBreadcrumbs.menu` editor
+ * config option. Missing items (e.g. commands that are not registered) are skipped. No items means no menu.
+ */
+export type ElementMenuConfig = (element: ModelElement, editor: Editor) => (ElementMenuItem | null | undefined)[];
+/**
+ * The options of {@link ElementMenu#open} and {@link ElementMenu#show}.
+ */
+export interface ElementMenuShowOptions {
+    /**
+     * The accessible name of the menu of an element (see {@link ElementMenu#open}). Defaults to "Element menu".
+     */
+    label?: string;
+    /**
+     * Called when the document data changes while the menu is open. When it returns `true`, the menu closes, e.g.
+     * because the element it is for was removed.
+     */
+    isObsolete?: () => boolean;
+    /**
+     * What gets the focus when the menu is closed with Esc, e.g. the button that opened the menu. Defaults to the editor.
+     */
+    returnFocusTo?: {
+        focus(): void;
+    };
+    /**
+     * Called when the menu closes, for any reason: Esc, a click outside, an executed item, or another menu replacing it.
+     */
+    onHide?: () => void;
+}
+/**
+ * Shows menus in a balloon: the menu of an element, built from commands, submenus and separators (see {@link open}),
+ * or any view, e.g. the quick insert search (see {@link show}).
+ *
+ * The element context menu, the breadcrumbs and quick insert show their menus with it. The menu of an element is
+ * CKEditor's dropdown menu (see {@link ElementMenuView}).
+ *
+ * Executing an item closes the menu. Esc and clicking outside close it too; Esc returns the focus to the editor, or to
+ * {@link ElementMenuShowOptions.returnFocusTo}.
+ */
+export default class ElementMenu extends Plugin {
+    /**
+     * The view in the open menu, if any.
+     */
+    view: FocusableView | null;
+    private _keystrokes;
+    private _isObsolete;
+    private _onHide;
+    static get requires(): readonly [typeof ContextualBalloon, typeof Notification];
+    static get pluginName(): 'ElementMenu';
+    init(): void;
+    /**
+     * Opens the menu of the element next to the target (e.g. a button, or a `DOMRect` in viewport coordinates), with
+     * the items from the config callback. The menu closes when the element is removed.
+     *
+     * Returns `false` when there are no items.
+     */
+    open(element: ModelElement, target: RectSource, config: ElementMenuConfig, { label, isObsolete, ...options }?: ElementMenuShowOptions): boolean;
+    /**
+     * Shows the view (e.g. a menu) next to the target (e.g. a button, or a `DOMRect` in viewport coordinates), and
+     * focuses it. The menu closes when the view, or an item of CKEditor's dropdown menu in it, fires `execute`.
+     */
+    show(view: FocusableView, target: RectSource, { isObsolete, returnFocusTo, onHide }?: ElementMenuShowOptions): void;
+    /**
+     * Hides the open menu, if any.
+     */
+    hide(): void;
+    destroy(): void;
+    private get _balloon();
+}
+//# sourceMappingURL=elementMenu.d.ts.map

package/dist/elementMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementMenu.d.ts","sourceRoot":"","sources":["../src/elementMenu.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EAGjB,YAAY,EACZ,MAAM,EAEN,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAgB,KAAK,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAGtF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,EAAE,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,wBAAwB,GAAG,cAAc,GAAG,GAAG,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC;AAElH;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,MAAM;IAC9C;;OAEG;IACI,IAAI,EAAE,aAAa,GAAG,IAAI,CAAQ;IAEzC,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAAgC;IACnD,OAAO,CAAC,OAAO,CAA6B;IAE5C,WAAkB,QAAQ,IAAI,SAAS,CAAC,OAAO,iBAAiB,EAAE,OAAO,YAAY,CAAC,CAGrF;IAED,WAAkB,UAAU,IAAI,aAAa,CAE5C;IAEM,IAAI,IAAI,IAAI;IAQnB;;;;;OAKG;IACI,IAAI,CACV,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,iBAAiB,EACzB,EAAE,KAAqC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAE,sBAA2B,GAC5F,OAAO;IAwBV;;;OAGG;IACI,IAAI,CACV,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,UAAU,EAClB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,GAAE,sBAA2B,GAChE,IAAI;IAqDP;;OAEG;IACI,IAAI,IAAI,IAAI;IAuBH,OAAO,IAAI,IAAI;IAK/B,OAAO,KAAK,QAAQ,GAEnB;CACD"}