Created
June 22, 2022 17:14
-
-
Save johnbwoodruff/725227db5ae734f73de6efd3af2a7960 to your computer and use it in GitHub Desktop.
Electron Fiddle Gist - Application Menu Accelerator Bug
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html> | |
<html> | |
<head> | |
<meta charset="UTF-8"> | |
<!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP --> | |
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'"> | |
<link href="./styles.css" rel="stylesheet"> | |
<title>Hello World!</title> | |
</head> | |
<body> | |
<h1>Hello World!</h1> | |
We are using Node.js <span id="node-version"></span>, | |
Chromium <span id="chrome-version"></span>, | |
and Electron <span id="electron-version"></span>. | |
<p>Note in the below JSON that all of the predefined roles have <code>null</code> instead of the actual accelerator.</p> | |
<pre> | |
<code id="menu"></code> | |
</pre> | |
<!-- You can also require other files to run in this process --> | |
<script src="./renderer.js"></script> | |
</body> | |
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Modules to control application life and create native browser window | |
const {app, BrowserWindow, Menu, ipcMain} = require('electron') | |
const path = require('path') | |
/** | |
* This is the example menu from the docs at https://www.electronjs.org/docs/latest/api/menu | |
*/ | |
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) | |
function createWindow () { | |
// Create the browser window. | |
const mainWindow = new BrowserWindow({ | |
width: 800, | |
height: 600, | |
webPreferences: { | |
preload: path.join(__dirname, 'preload.js'), | |
contextIsolation: true | |
} | |
}) | |
// and load the index.html of the app. | |
mainWindow.loadFile('index.html') | |
// Open the DevTools. | |
// mainWindow.webContents.openDevTools() | |
} | |
// This method will be called when Electron has finished | |
// initialization and is ready to create browser windows. | |
// Some APIs can only be used after this event occurs. | |
app.whenReady().then(() => { | |
createWindow() | |
app.on('activate', function () { | |
// On macOS it's common to re-create a window in the app when the | |
// dock icon is clicked and there are no other windows open. | |
if (BrowserWindow.getAllWindows().length === 0) createWindow() | |
}) | |
}) | |
// Quit when all windows are closed, except on macOS. There, it's common | |
// for applications and their menu bar to stay active until the user quits | |
// explicitly with Cmd + Q. | |
app.on('window-all-closed', function () { | |
if (process.platform !== 'darwin') app.quit() | |
}) | |
// In this file you can include the rest of your app's specific main process | |
// code. You can also put them in separate files and require them here. | |
/** | |
* A minimal function to recursively convert the menu into something that can be serialized | |
* and sent to the renderer process. | |
*/ | |
function convertMenu(item) { | |
return { | |
commandId: item.commandId, | |
accelerator: item.accelerator, | |
label: item.label, | |
type: item.type, | |
submenu: | |
item.type === 'submenu' | |
? item.submenu.items.filter(i => i.visible).map(i => convertMenu(i)) | |
: null | |
}; | |
} | |
ipcMain.handle('app/menu', () => { | |
const menu = Menu.getApplicationMenu(); | |
return menu.items.map(item => convertMenu(item)); | |
}); | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"name": "aware-method-appreciate-ydf2b", | |
"productName": "aware-method-appreciate-ydf2b", | |
"description": "My Electron application description", | |
"keywords": [], | |
"main": "./main.js", | |
"version": "1.0.0", | |
"author": "johnwoodruff", | |
"scripts": { | |
"start": "electron ." | |
}, | |
"dependencies": {}, | |
"devDependencies": { | |
"electron": "19.0.4" | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
const { contextBridge, ipcRenderer } = require('electron'); | |
// All of the Node.js APIs are available in the preload process. | |
// It has the same sandbox as a Chrome extension. | |
window.addEventListener('DOMContentLoaded', () => { | |
const replaceText = (selector, text) => { | |
const element = document.getElementById(selector) | |
if (element) element.innerText = text | |
} | |
for (const type of ['chrome', 'node', 'electron']) { | |
replaceText(`${type}-version`, process.versions[type]) | |
} | |
}) | |
/** | |
* Enable renderer to get the application menu via contextBridge | |
*/ | |
contextBridge.exposeInMainWorld('electronAPI', { | |
getMenu: () => ipcRenderer.invoke('app/menu') | |
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// This file is required by the index.html file and will | |
// be executed in the renderer process for that window. | |
// No Node.js APIs are available in this process because | |
// `nodeIntegration` is turned off. Use `preload.js` to | |
// selectively enable features needed in the rendering | |
// process. | |
/** | |
* Get menu, prettify it, and render to the codeblock | |
*/ | |
window.electronAPI.getMenu().then((menu) => { | |
console.log(menu); | |
const el = document.querySelector('#menu'); | |
if(el) el.innerText = JSON.stringify(menu, null, 4); | |
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/* styles.css */ | |
/* Add styles here to customize the appearance of your app */ | |
pre, code { | |
background-color: #eee; | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment