api.menu

MenuApi

Items in the editor's menu bar. A path whose last segment names no submenu makes one.

Members

Types

Declarations only this group names.

TopMenutype

type TopMenu = "File" | "Edit" | "View" | "Layer" | "Scenario" | "Triggers" | "Tools" | "Plugins" | "Help";

MenuPathtype

type MenuPath = TopMenu | `${TopMenu}/${string}` | (string & {});

A top-level menu, or a submenu by label: "File/Import". A last segment that names no submenu gets one of the plugin's own, at the end of the menu ("Tools/AI"), and a first segment that names no top-level menu gets one made for the plugin, placed before Help ("Account").

MenuItemSpecinterface

interface MenuItemSpec

`label: string`	In English, like the path's segments: it is the item's identity (another plugin's `after` names it), and the menu shows it translated through the catalogues the plugin registered with `i18n.register`, so it follows a language change.
`shortcut?: string`	Display only — bind the key with `hotkeys.add`.
`icon?: "plugin" \| PluginIcon`	A mark in front of the label: `"plugin"` for the plugin's own icon (the manifest's), or any `PluginIcon`. Use it when the item does something a built-in never would — reach a network, say — so the user can tell at a glance.
`after?: string`	Where in the menu: the English label of the built-in item or submenu to sit directly under (`"Open Recent"`) — labels are identities, and the same whatever language the menu is showing. Without it, or when nothing has that label, the item goes to the end of the menu after a separator.
`separator?: boolean`	A separator line above this item — for grouping the items of a submenu of your own.
`enabled?: () => boolean`
`run?: () => void`	What the item does. Give this or `command`.
`command?: string`	A registered command's id, instead of a `run` of its own.