Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(menu): add more detail in Menu #1570

Merged
merged 1 commit into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@
"node-html-parser": "6.1.12",
"node-id3": "0.2.6",
"peerjs": "1.5.2",
"semver": "7.5.4",
"serve": "14.2.1",
"simple-youtube-age-restriction-bypass": "github:organization/Simple-YouTube-Age-Restriction-Bypass#v2.5.9",
"ts-morph": "21.0.1",
Expand All @@ -181,6 +182,7 @@
"@types/electron-localshortcut": "3.1.3",
"@types/howler": "2.2.11",
"@types/html-to-text": "9.0.4",
"@types/semver": "7.5.6",
"@typescript-eslint/eslint-plugin": "6.16.0",
"bufferutil": "4.0.8",
"builtin-modules": "3.3.0",
Expand Down
8 changes: 7 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion src/i18n/resources/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@
},
"plugins": {
"enabled": "Enabled",
"label": "Plugins"
"label": "Plugins",
"new": "NEW"
},
"view": {
"label": "View",
Expand Down
3 changes: 2 additions & 1 deletion src/i18n/resources/ko.json
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@
},
"plugins": {
"enabled": "활성화",
"label": "확장"
"label": "확장",
"new": "NEW"
},
"view": {
"label": "보기",
Expand Down
25 changes: 21 additions & 4 deletions src/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
shell,
} from 'electron';
import prompt from 'custom-electron-prompt';
import { satisfies } from 'semver';

import { allPlugins } from 'virtual:plugins';

Expand All @@ -23,6 +24,8 @@ import promptOptions from './providers/prompt-options';
import { getAllMenuTemplate, loadAllMenuPlugins } from './loader/menu';
import { setLanguage, t } from '@/i18n';

import packageJson from '../package.json';

export type MenuTemplate = Electron.MenuItemConstructorOptions[];

// True only if in-app-menu was loaded on launch
Expand All @@ -31,10 +34,14 @@ const inAppMenuActive = config.plugins.isEnabled('in-app-menu');
const pluginEnabledMenu = (
plugin: string,
label = '',
description: string | undefined = undefined,
isNew = false,
hasSubmenu = false,
refreshMenu: (() => void) | undefined = undefined,
): Electron.MenuItemConstructorOptions => ({
label: label || plugin,
sublabel: isNew ? t('main.menu.plugins.new') : undefined,
toolTip: description,
type: 'checkbox',
checked: config.plugins.isEnabled(plugin),
click(item: Electron.MenuItem) {
Expand Down Expand Up @@ -66,23 +73,30 @@ export const mainMenuTemplate = async (

const menuResult = Object.entries(getAllMenuTemplate()).map(
([id, template]) => {
const pluginLabel = allPlugins[id]?.name?.() ?? id;
const plugin = allPlugins[id];
const pluginLabel = plugin?.name?.() ?? id;
const pluginDescription = plugin?.description?.() ?? undefined;
const isNew = plugin?.addedVersion ? satisfies(packageJson.version, plugin.addedVersion) : false;

if (!config.plugins.isEnabled(id)) {
return [
id,
pluginEnabledMenu(id, pluginLabel, true, innerRefreshMenu),
pluginEnabledMenu(id, pluginLabel, pluginDescription, isNew, true, innerRefreshMenu),
] as const;
}

return [
id,
{
label: pluginLabel,
sublabel: isNew ? t('main.menu.plugins.new') : undefined,
toolTip: pluginDescription,
submenu: [
pluginEnabledMenu(
id,
t('main.menu.plugins.enabled'),
undefined,
false,
true,
innerRefreshMenu,
),
Expand All @@ -106,9 +120,12 @@ export const mainMenuTemplate = async (
const predefinedTemplate = menuResult.find((it) => it[0] === id);
if (predefinedTemplate) return predefinedTemplate[1];

const pluginLabel = allPlugins[id]?.name?.() ?? id;
const plugin = allPlugins[id];
const pluginLabel = plugin?.name?.() ?? id;
const pluginDescription = plugin?.description?.() ?? undefined;
const isNew = plugin?.addedVersion ? satisfies(packageJson.version, plugin.addedVersion) : false;

return pluginEnabledMenu(id, pluginLabel, true, innerRefreshMenu);
return pluginEnabledMenu(id, pluginLabel, pluginDescription, isNew, true, innerRefreshMenu);
});

const availableLanguages = Object.keys(languageResources);
Expand Down
1 change: 1 addition & 0 deletions src/plugins/album-actions/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export default createPlugin({
name: () => t('plugins.album-actions.name'),
description: () => t('plugins.album-actions.description'),
restartNeeded: false,
addedVersion: '3.2.0',
config: {
enabled: false,
},
Expand Down
12 changes: 12 additions & 0 deletions src/plugins/in-app-menu/menu/panel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ export const createPanel = (
menu.appendChild(iconWrapper);
menu.append(item.label);

if (item.sublabel) {
menu.classList.add('badge');
const menuBadge = document.createElement('menu-item-badge');
menuBadge.append(item.sublabel);
menu.append(menuBadge);
}
if (item.toolTip) {
const menuTooltip = document.createElement('menu-item-tooltip');
menuTooltip.append(item.toolTip);
menu.append(menuTooltip);
}

menu.addEventListener('click', async () => {
await window.ipcRenderer.invoke('menu-event', item.commandId);
const menuItem = (await window.ipcRenderer.invoke(
Expand Down
55 changes: 55 additions & 0 deletions src/plugins/in-app-menu/titlebar.css
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ menu-panel.position-by-bottom {
}

menu-item {
position: relative;

-webkit-app-region: none;
min-height: 32px;
height: 32px;
Expand All @@ -109,6 +111,9 @@ menu-item {
border-radius: 4px;
cursor: pointer;
}
menu-item.badge {
grid-template-columns: 32px 1fr auto minmax(32px, auto);
}
menu-item:hover {
background-color: rgba(255, 255, 255, 0.1);
}
Expand All @@ -128,6 +133,56 @@ menu-separator {
background-color: rgba(255, 255, 255, 0.2);
}

menu-item-badge {
display: flex;
justify-content: center;
align-items: center;

min-width: 16px;
height: 16px;
padding: 0 4px;
margin-left: 8px;

border-radius: 4px;
background-color: rgba(255, 255, 255, 0.2);
color: #f1f1f1;
font-size: 10px;
font-weight: 500;
line-height: 1;
}

menu-item-tooltip {
position: absolute;

left: 0;
top: calc(100% + 4px);

display: flex;
justify-content: center;
align-items: center;

min-width: 32px;
padding: 4px;

border-radius: 4px;
background-color: rgba(25, 25, 25, 0.8);
color: #f1f1f1;
font-size: 10px;

pointer-events: none;
z-index: 1000;

opacity: 0;
scale: 0.9;

transform-origin: 50% 0;
transition: all 0.225s ease-out;
}
menu-item:hover > menu-item-tooltip {
opacity: 1;
scale: 1.0;
}

/* classes */

.title-bar-icon {
Expand Down
1 change: 1 addition & 0 deletions src/plugins/music-together/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export default createPlugin({
name: () => t('plugins.music-together.name'),
description: () => t('plugins.music-together.description'),
restartNeeded: false,
addedVersion: '3.2.0',
config: {
enabled: false
},
Expand Down
1 change: 1 addition & 0 deletions src/types/plugins.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export interface PluginDef<
name: () => string;
authors?: Author[];
description?: () => string;
addedVersion?: string;
config?: Config;

menu?: (
Expand Down
Loading