Menu
Класс: Menu
Со здайте меню приложения и контекстное меню.
Процесс: Главный
new Menu()
Создает новое меню.
Статические методы
Класс Menu
имеет следующие статические методы:
Menu.setApplicationMenu(menu)
menu
Menu | null
Устанавливает меню
в качестве меню приложения на macOS. On Windows and Linux, the menu
will be set as each window's top menu.
Также на Windows и Linux, Вы можете использовать &
в названии подменю верхнего списка, чтобы указать, какая буква должна получить сгенерированный акселератор( Accelerator ). Для примера, использование &File
для меню файла в результате сгенерирует акс елератор( Accelerator ) Alt-F
, который открывает соответствующее меню. The indicated character in the button label then gets an underline, and the &
character is not displayed on the button label.
In order to escape the &
character in an item name, add a proceeding &
. For example, &&File
would result in &File
displayed on the button label.
Passing null
will suppress the default menu. On Windows and Linux, this has the additional effect of removing the menu bar from the window.
Примечание: Меню по умолчанию будет создано автоматически, если приложение не установит его. Он содержит стандартные элементы, такие как Файл
, Редактировать
, Вид
, Окно
и Помощь
.
Menu.getApplicationMenu()
Возвращает Menu | null
- меню приложения, если значение задано, в противном случае null
.
Примечание: Возвращенный экземпляр Menu
не поддерживает динамическое добавление или удаление пунктов меню. Параметры экземпляра все ещё могут быть динамически изменены.
Menu.sendActionToFirstResponder(action)
macOS
action
string
Посылает action
первому ответчику приложения. Это используется для эмуляции поведения меню macOS. Чаще всего вы будет использовать свойство role
экземпляра MenuItem
.
Для дополнительной информации по нативным действиям в macOS смотрите macOS Cocoa Event Handling Guide.
Menu.buildFromTemplate(template)
template
(MenuItemConstructorOptions | MenuItem)[]
Возвращает Menu
Generally, the template
is an array of options
for constructing a MenuItem. The usage can be referenced above.
Вы также можете прикрепить другие поля к элементу template
и они станут свойствами элементов созданного меню.
Методы экземпляра
Объект меню
имеет следующие методы экземпляра:
menu.popup([options])
Переключает это меню в контекстное меню в BrowserWindow
.
menu.closePopup([browserWindow])
browserWindow
BrowserWindow (опционально) - по умолчанию это сфокусированное окно.
Закрывает контекстное меню в browserWindow
.
menu.append(menuItem)
menuItem
MenuItem
Добавляет menuItem
в меню.
menu.getMenuItemById(id)
id
string
Возвращает элемент MenuItem
с указанным id
menu.insert(pos, menuItem)
port
IntegermenuItem
MenuItem
Вставляет menuItem
в меню на позицию pos
.
События экземпляра
Объекты созданные с помощью new Menu
или возвращенные из Menu.buildFromTemplate
вызывают следующие события:
Примечание: Некоторые методы доступны только в определенных операционных системах и помечены как таковые.
Событие: 'menu-will-show'
Возвращает:
- Событие типа
event
Вызывается при вызове menu.popup()
.
Событие: 'menu-will-close'
Возвращает:
- Событие типа
event
Вызывается, когда всплывающее окно закрывается вручную или с помощью menu.closePopup()
.
Свойства экземпляра
Объекты menu
также имеют следующие свойства:
menu.items
Массив MenuItem[]
содержит элементы меню.
Каждое Menu
состоит из нескольких MenuItem
и каждое MenuItem
может иметь подменю.
Примеры
An example of creating the application menu with the simple template API:
const { app, Menu } = require('electron')
const isMac = process.platform === 'darwin'
const template = [
// { role: 'appMenu' }
...(isMac
? [{
label: app.name,
submenu: [
{ role: 'about' },
{ type: 'separator' },
{ role: 'services' },
{ type: 'separator' },
{ role: 'hide' },
{ role: 'hideOthers' },
{ role: 'unhide' },
{ type: 'separator' },
{ role: 'quit' }
]
}]
: []),
// { role: 'fileMenu' }
{
label: 'File',
submenu: [
isMac ? { role: 'close' } : { role: 'quit' }
]
},
// { role: 'editMenu' }
{
label: 'Edit',
submenu: [
{ role: 'undo' },
{ role: 'redo' },
{ type: 'separator' },
{ role: 'cut' },
{ role: 'copy' },
{ role: 'paste' },
...(isMac
? [
{ role: 'pasteAndMatchStyle' },
{ role: 'delete' },
{ role: 'selectAll' },
{ type: 'separator' },
{
label: 'Speech',
submenu: [
{ role: 'startSpeaking' },
{ role: 'stopSpeaking' }
]
}
]
: [
{ role: 'delete' },
{ type: 'separator' },
{ role: 'selectAll' }
])
]
},
// { role: 'viewMenu' }
{
label: 'View',
submenu: [
{ role: 'reload' },
{ role: 'forceReload' },
{ role: 'toggleDevTools' },
{ type: 'separator' },
{ role: 'resetZoom' },
{ role: 'zoomIn' },
{ role: 'zoomOut' },
{ type: 'separator' },
{ role: 'togglefullscreen' }
]
},
// { role: 'windowMenu' }
{
label: 'Window',
submenu: [
{ role: 'minimize' },
{ role: 'zoom' },
...(isMac
? [
{ type: 'separator' },
{ role: 'front' },
{ type: 'separator' },
{ role: 'window' }
]
: [
{ role: 'close' }
])
]
},
{
role: 'help',
submenu: [
{
label: 'Learn More',
click: async () => {
const { shell } = require('electron')
await shell.openExternal('https://electronjs.org')
}
}
]
}
]
const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)