allow hiding context menu items

This commit is contained in:
Kendall Garner 2024-08-26 21:35:12 -07:00
parent f746114041
commit 004c9a8d06
No known key found for this signature in database
GPG key ID: 18D2767419676C87
6 changed files with 100 additions and 1 deletions

View file

@ -461,6 +461,8 @@
"clearQueryCache": "clear feishin cache", "clearQueryCache": "clear feishin cache",
"clearQueryCache_description": "a 'soft clear' of feishin. this will refresh playlists, track metadata, and reset saved lyrics. settings, server credentials and cached images are preserved", "clearQueryCache_description": "a 'soft clear' of feishin. this will refresh playlists, track metadata, and reset saved lyrics. settings, server credentials and cached images are preserved",
"clearCacheSuccess": "cache cleared successfully", "clearCacheSuccess": "cache cleared successfully",
"contextMenu": "context menu (right click) configuration",
"contextMenu_description": "allows you to hide items that are shown in the menu when you right click on an item. items that are unchecked will be hidden",
"crossfadeDuration": "crossfade duration", "crossfadeDuration": "crossfade duration",
"crossfadeDuration_description": "sets the duration of the crossfade effect", "crossfadeDuration_description": "sets the duration of the crossfade effect",
"crossfadeStyle": "crossfade style", "crossfadeStyle": "crossfade style",

View file

@ -57,6 +57,7 @@ import {
useCurrentServer, useCurrentServer,
usePlayerStore, usePlayerStore,
useQueueControls, useQueueControls,
useSettingsStore,
} from '/@/renderer/store'; } from '/@/renderer/store';
import { usePlaybackType } from '/@/renderer/store/settings.store'; import { usePlaybackType } from '/@/renderer/store/settings.store';
import { Play, PlaybackType } from '/@/renderer/types'; import { Play, PlaybackType } from '/@/renderer/types';
@ -99,6 +100,7 @@ export interface ContextMenuProviderProps {
} }
export const ContextMenuProvider = ({ children }: ContextMenuProviderProps) => { export const ContextMenuProvider = ({ children }: ContextMenuProviderProps) => {
const disabledItems = useSettingsStore((state) => state.general.disabledContextMenu);
const { t } = useTranslation(); const { t } = useTranslation();
const [opened, setOpened] = useState(false); const [opened, setOpened] = useState(false);
const clickOutsideRef = useClickOutside(() => setOpened(false)); const clickOutsideRef = useClickOutside(() => setOpened(false));
@ -927,7 +929,8 @@ export const ContextMenuProvider = ({ children }: ContextMenuProviderProps) => {
> >
{ctx.menuItems?.map((item) => { {ctx.menuItems?.map((item) => {
return ( return (
!contextMenuItems[item.id].disabled && ( !contextMenuItems[item.id].disabled &&
!disabledItems[item.id] && (
<Fragment key={`context-menu-${item.id}`}> <Fragment key={`context-menu-${item.id}`}>
{item.children ? ( {item.children ? (
<HoverCard <HoverCard

View file

@ -39,6 +39,30 @@ export type ContextMenuItemType =
| 'playSimilarSongs' | 'playSimilarSongs'
| 'download'; | 'download';
export const CONFIGURABLE_CONTEXT_MENU_ITEMS: ContextMenuItemType[] = [
'moveToBottomOfQueue',
'moveToTopOfQueue',
'play',
'playLast',
'playNext',
'playSimilarSongs',
'addToPlaylist',
'removeFromPlaylist',
'addToFavorites',
'removeFromFavorites',
'setRating',
'download',
'shareItem',
'showDetails',
];
export const CONTEXT_MENU_ITEM_MAPPING: { [k in ContextMenuItemType]?: string } = {
moveToBottomOfQueue: 'moveToBottom',
moveToTopOfQueue: 'moveToTop',
playLast: 'addLast',
playNext: 'addNext',
};
export type SetContextMenuItems = { export type SetContextMenuItems = {
children?: boolean; children?: boolean;
disabled?: boolean; disabled?: boolean;

View file

@ -0,0 +1,58 @@
import { useTranslation } from 'react-i18next';
import { SettingsOptions } from '/@/renderer/features/settings/components/settings-option';
import { useState } from 'react';
import { Button, Checkbox } from '/@/renderer/components';
import { Divider, Stack } from '@mantine/core';
import {
CONFIGURABLE_CONTEXT_MENU_ITEMS,
CONTEXT_MENU_ITEM_MAPPING,
} from '/@/renderer/features/context-menu';
import { useSettingsStore, useSettingsStoreActions } from '/@/renderer/store';
export const ContextMenuSettings = () => {
const disabledItems = useSettingsStore((state) => state.general.disabledContextMenu);
const { toggleContextMenuItem } = useSettingsStoreActions();
const [open, setOpen] = useState(false);
const { t } = useTranslation();
return (
<>
<SettingsOptions
control={
<Button
compact
variant="filled"
onClick={() => setOpen(!open)}
>
{t(open ? 'common.close' : 'common.edit', { postProcess: 'titleCase' })}
</Button>
}
description={t('setting.contextMenu', {
context: 'description',
postProcess: 'sentenceCase',
})}
title={t('setting.contextMenu', {
postProcess: 'sentenceCase',
})}
/>
{open && (
<Stack>
{CONFIGURABLE_CONTEXT_MENU_ITEMS.map((item) => (
<Checkbox
key={item}
checked={!disabledItems[item]}
label={t(
`page.contextMenu.${CONTEXT_MENU_ITEM_MAPPING[item] || item}`,
{
postProcess: 'sentenceCase',
},
)}
onChange={() => toggleContextMenuItem(item)}
/>
))}
</Stack>
)}
<Divider />
</>
);
};

View file

@ -8,6 +8,7 @@ import { CacheSettings } from '/@/renderer/features/settings/components/window/c
import isElectron from 'is-electron'; import isElectron from 'is-electron';
import { HomeSettings } from '/@/renderer/features/settings/components/general/home-settings'; import { HomeSettings } from '/@/renderer/features/settings/components/general/home-settings';
import { SidebarReorder } from '/@/renderer/features/settings/components/general/sidebar-reorder'; import { SidebarReorder } from '/@/renderer/features/settings/components/general/sidebar-reorder';
import { ContextMenuSettings } from '/@/renderer/features/settings/components/general/context-menu-settings';
export const GeneralTab = () => { export const GeneralTab = () => {
return ( return (
@ -18,6 +19,7 @@ export const GeneralTab = () => {
<HomeSettings /> <HomeSettings />
<SidebarReorder /> <SidebarReorder />
<SidebarSettings /> <SidebarSettings />
<ContextMenuSettings />
{isElectron() && <RemoteSettings />} {isElectron() && <RemoteSettings />}
<CacheSettings /> <CacheSettings />
</Stack> </Stack>

View file

@ -24,6 +24,7 @@ import { randomString } from '/@/renderer/utils';
import i18n from '/@/i18n/i18n'; import i18n from '/@/i18n/i18n';
import { usePlayerStore } from '/@/renderer/store/player.store'; import { usePlayerStore } from '/@/renderer/store/player.store';
import { mergeOverridingColumns } from '/@/renderer/store/utils'; import { mergeOverridingColumns } from '/@/renderer/store/utils';
import type { ContextMenuItemType } from '/@/renderer/features/context-menu';
const utils = isElectron() ? window.electron.utils : null; const utils = isElectron() ? window.electron.utils : null;
@ -196,6 +197,7 @@ export interface SettingsState {
albumArtRes?: number | null; albumArtRes?: number | null;
buttonSize: number; buttonSize: number;
defaultFullPlaylist: boolean; defaultFullPlaylist: boolean;
disabledContextMenu: { [k in ContextMenuItemType]?: boolean };
doubleClickQueueAll: boolean; doubleClickQueueAll: boolean;
externalLinks: boolean; externalLinks: boolean;
followSystemTheme: boolean; followSystemTheme: boolean;
@ -293,6 +295,7 @@ export interface SettingsSlice extends SettingsState {
setSettings: (data: Partial<SettingsState>) => void; setSettings: (data: Partial<SettingsState>) => void;
setSidebarItems: (items: SidebarItemType[]) => void; setSidebarItems: (items: SidebarItemType[]) => void;
setTable: (type: TableType, data: DataTableProps) => void; setTable: (type: TableType, data: DataTableProps) => void;
toggleContextMenuItem: (item: ContextMenuItemType) => void;
toggleSidebarCollapseShare: () => void; toggleSidebarCollapseShare: () => void;
}; };
} }
@ -324,6 +327,7 @@ const initialState: SettingsState = {
albumArtRes: undefined, albumArtRes: undefined,
buttonSize: 20, buttonSize: 20,
defaultFullPlaylist: true, defaultFullPlaylist: true,
disabledContextMenu: {},
doubleClickQueueAll: true, doubleClickQueueAll: true,
externalLinks: true, externalLinks: true,
followSystemTheme: false, followSystemTheme: false,
@ -648,6 +652,12 @@ export const useSettingsStore = create<SettingsSlice>()(
state.tables[type] = data; state.tables[type] = data;
}); });
}, },
toggleContextMenuItem: (item: ContextMenuItemType) => {
set((state) => {
state.general.disabledContextMenu[item] =
!state.general.disabledContextMenu[item];
});
},
toggleSidebarCollapseShare: () => { toggleSidebarCollapseShare: () => {
set((state) => { set((state) => {
state.general.sidebarCollapseShared = state.general.sidebarCollapseShared =