Skip to content

ckeditor5-elements / ElementMenuShowOptions

Interface: ElementMenuShowOptions ​

The options of ElementMenu#open and ElementMenu#show.

Properties ​

isObsolete? ​

ts
isObsolete?: () => boolean;

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.

Returns ​

boolean


label? ​

ts
label?: string;

The accessible name of the menu of an element (see ElementMenu#open). Defaults to "Element menu".


onHide? ​

ts
onHide?: () => void;

Called when the menu closes, for any reason: Esc, a click outside, an executed item, or another menu replacing it.

Returns ​

void


returnFocusTo? ​

ts
returnFocusTo?: object;

What gets the focus when the menu is closed with Esc, e.g. the button that opened the menu. Defaults to the editor.

focus() ​

ts
focus(): void;
Returns ​

void