Type Editor

---

Type Editor / @type-editor/menu / types/MenuElement / MenuElement

Interface: MenuElement

Defined in: packages/menu/src/types/MenuElement.ts:10

The types defined in this module aren't the only thing you can display in your menu. Anything that conforms to this interface can be put into a menu structure.

Methods

render()

render(
   view,
   showLabel?,
   isLegacy?,
   parentMenuElement?): {
  dom: HTMLElement;
  update: (state) => boolean;
};

Defined in: packages/menu/src/types/MenuElement.ts:24

Render the element for display in the menu. Must return a DOM element and a function that can be used to update the element to a new state. The update function must return false if the update hid the entire element.

Parameters

Parameter	Type	Description
view	PmEditorView	The editor view instance
showLabel?	boolean	Whether to show the label (if applicable, e.g. in DropdownMenu)
isLegacy?	boolean	Backward compatibility mode
parentMenuElement?	ParentMenuElement	The parent menu element to notify of updates of child elements (especially in dropdown menus)

Returns

{
  dom: HTMLElement;
  update: (state) => boolean;
}

An object containing the DOM element and an update function

Name	Type	Defined in
dom	HTMLElement	packages/menu/src/types/MenuElement.ts:24
update()	(state) => boolean	packages/menu/src/types/MenuElement.ts:24