Software-Mac/spacedrive
Software-Mac/spacedrive
1
0
Fork 0
mirror of https://github.com/spacedriveapp/spacedrive synced 2024-07-04 13:23:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ENG-1604] Change key matcher to use real OS (#2087)

Browse source 
useOperatingSystem(true)
This commit is contained in:
nikec 2024-02-13 13:44:33 +01:00 committed by GitHub
parent 55b21d7295
commit 63a60f363e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 28 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
interface/hooks/useKeyMatcher.ts
View file

@ -1,17 +1,19 @@
import { EditingKeys, ModifierKeys, modifierSymbols, UIKeys, NavigationKeys } from '@sd/ui';
import { useOperatingSystem } from './useOperatingSystem';
import { OperatingSystem } from '..';
import { EditingKeys, ModifierKeys, modifierSymbols, NavigationKeys, UIKeys } from '@sd/ui';
import { OperatingSystem } from '..';
import { useOperatingSystem } from './useOperatingSystem';
type keyTypes =
keyof typeof ModifierKeys | keyof typeof EditingKeys | keyof typeof UIKeys | keyof typeof NavigationKeys;
| keyof typeof ModifierKeys
| keyof typeof EditingKeys
| keyof typeof UIKeys
| keyof typeof NavigationKeys;
//This is a helper function to handle the possibility of a modifier key being undefined due to OS initial check
const modifierKey = (key: keyTypes, os: 'Windows' | 'macOS' | 'Other') => {
return modifierSymbols[key][os] ?? modifierSymbols[key]['Other'];
};
//Match macOS keys to Windows keys and others
const keysOsMap: {
[T in keyTypes]?: {
@ -20,48 +22,48 @@ const keysOsMap: {
} = {
Meta: {
macOS: { key: 'Meta', icon: modifierKey(ModifierKeys.Meta, 'macOS') },
all: { key: 'Control', icon: modifierKey(ModifierKeys.Control, 'Windows') }, },
all: { key: 'Control', icon: modifierKey(ModifierKeys.Control, 'Windows') }
},
Shift: {
macOS: { key: 'Shift', icon: modifierKey(ModifierKeys.Shift, 'macOS') },
all: { key: 'Shift', icon: modifierKey(ModifierKeys.Shift, 'Other') },
all: { key: 'Shift', icon: modifierKey(ModifierKeys.Shift, 'Other') }
},
Alt: {
macOS: { key: 'Alt', icon: modifierKey(ModifierKeys.Alt, 'macOS') },
all: { key: 'Alt', icon: modifierKey(ModifierKeys.Alt, 'Other') },
all: { key: 'Alt', icon: modifierKey(ModifierKeys.Alt, 'Other') }
},
Escape: {
macOS: { key: 'Escape', icon: modifierKey(UIKeys.Escape, 'macOS') },
all: { key: 'Escape', icon: modifierKey(UIKeys.Escape, 'Other') },
all: { key: 'Escape', icon: modifierKey(UIKeys.Escape, 'Other') }
},
Delete: {
macOS: { key: 'Delete', icon: modifierKey(EditingKeys.Delete, 'macOS') },
all: { key: 'Delete', icon: modifierKey(EditingKeys.Delete, 'Other') },
all: { key: 'Delete', icon: modifierKey(EditingKeys.Delete, 'Other') }
},
Backspace: {
macOS: { key: 'Backspace', icon: modifierKey(EditingKeys.Backspace, 'macOS') },
all: { key: 'Backspace', icon: modifierKey(EditingKeys.Backspace, 'Other') },
all: { key: 'Backspace', icon: modifierKey(EditingKeys.Backspace, 'Other') }
},
ArrowUp: {
all: { key: 'ArrowUp', icon: modifierKey(NavigationKeys.ArrowUp, 'Other') },
all: { key: 'ArrowUp', icon: modifierKey(NavigationKeys.ArrowUp, 'Other') }
},
ArrowDown: {
all: { key: 'ArrowDown', icon: modifierKey(NavigationKeys.ArrowDown, 'Other') },
all: { key: 'ArrowDown', icon: modifierKey(NavigationKeys.ArrowDown, 'Other') }
},
ArrowLeft: {
all: { key: 'ArrowLeft', icon: modifierKey(NavigationKeys.ArrowLeft, 'Other') },
all: { key: 'ArrowLeft', icon: modifierKey(NavigationKeys.ArrowLeft, 'Other') }
},
ArrowRight: {
all: { key: 'ArrowRight', icon: modifierKey(NavigationKeys.ArrowRight, 'Other') },
all: { key: 'ArrowRight', icon: modifierKey(NavigationKeys.ArrowRight, 'Other') }
}
}
};
type keysOfOsMap = keyof typeof keysOsMap;
type os = Exclude<OperatingSystem, "linux" | "browser" | "unknown"> | "all"
type os = Exclude<OperatingSystem, 'linux' | 'browser' | 'unknown'> | 'all';
export function useKeyMatcher<T extends keysOfOsMap>(arg: T):
{ key: string; icon: string } {
const os = useOperatingSystem() as os;
const key = keysOsMap[arg]?.[os] ?? keysOsMap[arg]?.['all']
export function useKeyMatcher<T extends keysOfOsMap>(arg: T): { key: string; icon: string } {
const os = useOperatingSystem(true) as os;
const key = keysOsMap[arg]?.[os] ?? keysOsMap[arg]?.['all'];
if (!key) {
throw new Error(`No key found for ${arg} on ${os}`);
}
@ -72,13 +74,13 @@ export function useKeyMatcher<T extends keysOfOsMap>(arg: T):
export function useKeysMatcher<T extends keysOfOsMap>(
arg: T[]
): Record<T, { key: string; icon: string }> {
const os = useOperatingSystem() as os;
const os = useOperatingSystem(true) as os;
const object = {} as Record<T, { key: string; icon: string }>;
for (const key of arg) {
object[key] = {
key: keysOsMap[key]?.[os]?.key as string ?? keysOsMap[key]?.['all']?.key,
icon: keysOsMap[key]?.[os]?.icon as string ?? keysOsMap[key]?.['all']?.icon,
};
object[key] = {
key: (keysOsMap[key]?.[os]?.key as string) ?? keysOsMap[key]?.['all']?.key,
icon: (keysOsMap[key]?.[os]?.icon as string) ?? keysOsMap[key]?.['all']?.icon
};
}
return object;
}