-
Notifications
You must be signed in to change notification settings - Fork 457
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #460 from subin-chella/keyboard-shortcut-with-library
Keyboard shortcut on renderer process
- Loading branch information
Showing
6 changed files
with
197 additions
and
20 deletions.
There are no files selected for viewing
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| export interface Shortcut { | ||
| key: string | ||
| action: string | ||
| description: string | ||
| displayValue: { | ||
| mac: string | ||
| other: string | ||
| } | ||
| } | ||
|
|
||
| export const shortcuts: Shortcut[] = [ | ||
| { | ||
| key: 'mod+O', | ||
| action: 'open-files', | ||
| description: 'Open Files', | ||
| displayValue: { mac: 'Cmd+O', other: 'Ctrl+O' }, | ||
| }, | ||
| { | ||
| key: 'mod+N', | ||
| action: 'open-new-note', | ||
| description: 'New Note', | ||
| displayValue: { mac: 'Cmd+N', other: 'Ctrl+N' }, | ||
| }, | ||
| { | ||
| key: 'mod+P', | ||
| action: 'open-search', | ||
| description: 'Semantic Search', | ||
| displayValue: { mac: 'Cmd+P', other: 'Ctrl+P' }, | ||
| }, | ||
| { | ||
| key: 'mod+T', | ||
| action: 'open-chat-bot', | ||
| description: 'Open Chatbot', | ||
| displayValue: { mac: 'Cmd+T', other: 'Ctrl+T' }, | ||
| }, | ||
| { | ||
| key: 'mod+D', | ||
| action: 'open-new-directory-modal', | ||
| description: 'New Directory', | ||
| displayValue: { mac: 'Cmd+D', other: 'Ctrl+D' }, | ||
| }, | ||
| { | ||
| key: 'mod+L', | ||
| action: 'open-flashcard-quiz-modal', | ||
| description: 'Flashcard quiz', | ||
| displayValue: { mac: 'Cmd+L', other: 'Ctrl+L' }, | ||
| }, | ||
| { | ||
| key: 'mod+,', | ||
| action: 'open-settings-modal', | ||
| description: 'Settings', | ||
| displayValue: { mac: 'Cmd+,', other: 'Ctrl+,' }, | ||
| }, | ||
| ] |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import { useCallback, useEffect, useRef } from 'react' | ||
| import { useDebouncedCallback } from 'use-debounce' | ||
| import { useModalOpeners } from '../../contexts/ModalContext' | ||
| import { useChatContext } from '../../contexts/ChatContext' | ||
| import { useContentContext } from '@/contexts/ContentContext' | ||
| import { shortcuts } from './shortcutDefinitions' | ||
|
|
||
| function useAppShortcuts() { | ||
| const { setIsFlashcardModeOpen, setIsSettingsModalOpen } = useModalOpeners() | ||
| const { setSidebarShowing, openNewChat } = useChatContext() | ||
| const { createUntitledNote } = useContentContext() | ||
|
|
||
| const handleShortcut = useCallback( | ||
| (action: string) => { | ||
| switch (action) { | ||
| case 'open-new-note': | ||
| createUntitledNote() | ||
| break | ||
| case 'open-new-directory-modal': | ||
| window.dispatchEvent(new CustomEvent('open-new-directory-modal')) | ||
| break | ||
| case 'open-search': | ||
| setSidebarShowing('search') | ||
| break | ||
| case 'open-files': | ||
| setSidebarShowing('files') | ||
| break | ||
| case 'open-chat-bot': | ||
| openNewChat() | ||
| break | ||
| case 'open-flashcard-quiz-modal': | ||
| setIsFlashcardModeOpen(true) | ||
| break | ||
| case 'open-settings-modal': | ||
| setIsSettingsModalOpen(true) | ||
| break | ||
| default: | ||
| // No other cases | ||
| break | ||
| } | ||
| }, | ||
| [createUntitledNote, setSidebarShowing, setIsFlashcardModeOpen, setIsSettingsModalOpen, openNewChat], | ||
| ) | ||
|
|
||
| const handleShortcutRef = useRef(handleShortcut) | ||
| handleShortcutRef.current = handleShortcut | ||
|
|
||
| const debouncedHandleKeyDown = useDebouncedCallback((event: KeyboardEvent) => { | ||
| const modifierPressed = event.ctrlKey || event.metaKey | ||
| const keyPressed = event.key.toLowerCase() | ||
|
|
||
| const triggeredShortcut = shortcuts.find((s) => { | ||
| const [mod, key] = s.key.toLowerCase().split('+') | ||
| return mod === 'mod' && modifierPressed && key === keyPressed | ||
| }) | ||
|
|
||
| if (triggeredShortcut) { | ||
| event.preventDefault() | ||
| handleShortcutRef.current(triggeredShortcut.action) | ||
| } | ||
| }, 100) | ||
|
|
||
| useEffect(() => { | ||
| window.addEventListener('keydown', debouncedHandleKeyDown) | ||
| return () => { | ||
| window.removeEventListener('keydown', debouncedHandleKeyDown) | ||
| debouncedHandleKeyDown.cancel() | ||
| } | ||
| }, [debouncedHandleKeyDown]) | ||
|
|
||
| const getShortcutDescription = useCallback((action: string) => { | ||
| const shortcut = shortcuts.find((s) => s.action === action) | ||
| if (!shortcut) return '' | ||
| const platform = navigator.platform.toLowerCase().includes('mac') ? 'mac' : 'other' | ||
| return `${shortcut.description} (${shortcut.displayValue[platform]})` | ||
| }, []) | ||
|
|
||
| return { getShortcutDescription } | ||
| } | ||
|
|
||
| export default useAppShortcuts |