Class: FMenu

This is the builder for adding a menu to Univer. You shall never construct this class by yourself. Instead, call createMenu of FUniver to create a instance.

Please notice that until the appendTo method is called, the menu item is not added to the UI.

Please note that this menu cannot have submenus. If you want to have submenus, please use FSubmenu.

Extends

FMenuBase

Properties

Property	Modifier	Type
`MenuManagerPosition`	`static`	`any`
`RibbonPosition`	`static`	`any`
`RibbonStartGroup`	`static`	`any`

Methods

appendTo()


appendTo(path): void

Append the menu to any menu position on Univer UI.

Parameters

Parameter	Type	Description
`path`	`string` \| …[]	Some predefined path to append the menu. The paths can be an array, or an array joined by `

Returns

void

Example


// This menu item will appear on every `contextMenu.others` section.
univerAPI.createMenu({
  id: 'custom-menu-id-1',
  title: 'Custom Menu 1',
  action: () => {},
}).appendTo('contextMenu.others');
 
// This menu item will only appear on the `contextMenu.others` section on the main area.
univerAPI.createMenu({
  id: 'custom-menu-id-2',
  title: 'Custom Menu 2',
  action: () => { console.log(123); },
}).appendTo(['contextMenu.mainArea', 'contextMenu.others']);

Inherited from


FMenuBase.appendTo