From d86a13cc8920260e50c9a4c0ae7512f541cf5fa7 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com> Date: Wed, 1 Oct 2025 20:22:04 +0100 Subject: [PATCH] shortcuts and config menu (#4530) # Description of Changes --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details. --------- Co-authored-by: Claude --- .../public/locales/en-GB/translation.json | 16 ++ frontend/src/App.tsx | 17 +- .../src/components/hotkeys/HotkeyDisplay.tsx | 58 +++++ .../src/components/shared/AppConfigModal.css | 130 ++++++++++ .../src/components/shared/AppConfigModal.tsx | 245 ++++++++++-------- .../src/components/shared/QuickAccessBar.tsx | 9 +- .../shared/config/configNavSections.tsx | 57 ++++ .../config/configSections/HotkeysSection.tsx | 171 ++++++++++++ .../shared/config/configSections/Overview.tsx | 102 ++++++++ .../src/components/shared/config/types.ts | 19 ++ .../tools/toolPicker/ToolButton.tsx | 18 +- frontend/src/contexts/HotkeyContext.tsx | 211 +++++++++++++++ frontend/src/contexts/ToolWorkflowContext.tsx | 4 +- frontend/src/pages/HomePage.tsx | 14 + frontend/src/styles/theme.css | 18 ++ frontend/src/utils/hotkeys.ts | 191 ++++++++++++++ 16 files changed, 1152 insertions(+), 128 deletions(-) create mode 100644 frontend/src/components/hotkeys/HotkeyDisplay.tsx create mode 100644 frontend/src/components/shared/AppConfigModal.css create mode 100644 frontend/src/components/shared/config/configNavSections.tsx create mode 100644 frontend/src/components/shared/config/configSections/HotkeysSection.tsx create mode 100644 frontend/src/components/shared/config/configSections/Overview.tsx create mode 100644 frontend/src/components/shared/config/types.ts create mode 100644 frontend/src/contexts/HotkeyContext.tsx create mode 100644 frontend/src/utils/hotkeys.ts diff --git a/frontend/public/locales/en-GB/translation.json b/frontend/public/locales/en-GB/translation.json index dd9ff0400..c6e7a95a6 100644 --- a/frontend/public/locales/en-GB/translation.json +++ b/frontend/public/locales/en-GB/translation.json @@ -255,6 +255,22 @@ "cacheInputs": { "name": "Save form inputs", "help": "Enable to store previously used inputs for future runs" + }, + "hotkeys": { + "title": "Keyboard Shortcuts", + "description": "Hover a tool to see its shortcut or customise it below. Click \"Change shortcut\" and press a new key combination. Press Esc to cancel.", + "errorModifier": { + "mac": "Include ⌘ (Command), ⌥ (Option), or another modifier in your shortcut.", + "windows": "Include Ctrl, Alt, or another modifier in your shortcut." + }, + "errorConflict": "Shortcut already used by {{tool}}.", + "none": "Not assigned", + "customBadge": "Custom", + "defaultLabel": "Default: {{shortcut}}", + "capturing": "Press keys… (Esc to cancel)", + "change": "Change shortcut", + "reset": "Reset", + "shortcut": "Shortcut" } }, "changeCreds": { diff --git a/frontend/src/App.tsx b/frontend/src/App.tsx index 529da2643..d926b9f0d 100644 --- a/frontend/src/App.tsx +++ b/frontend/src/App.tsx @@ -4,6 +4,7 @@ import { FileContextProvider } from "./contexts/FileContext"; import { NavigationProvider } from "./contexts/NavigationContext"; import { FilesModalProvider } from "./contexts/FilesModalContext"; import { ToolWorkflowProvider } from "./contexts/ToolWorkflowContext"; +import { HotkeyProvider } from "./contexts/HotkeyContext"; import { SidebarProvider } from "./contexts/SidebarContext"; import ErrorBoundary from "./components/shared/ErrorBoundary"; import HomePage from "./pages/HomePage"; @@ -44,15 +45,17 @@ export default function App() { - - - - + + + + + - - - + + + + diff --git a/frontend/src/components/hotkeys/HotkeyDisplay.tsx b/frontend/src/components/hotkeys/HotkeyDisplay.tsx new file mode 100644 index 000000000..e240f987e --- /dev/null +++ b/frontend/src/components/hotkeys/HotkeyDisplay.tsx @@ -0,0 +1,58 @@ +import React from 'react'; +import { HotkeyBinding } from '../../utils/hotkeys'; +import { useHotkeys } from '../../contexts/HotkeyContext'; + +interface HotkeyDisplayProps { + binding: HotkeyBinding | null | undefined; + size?: 'sm' | 'md'; + muted?: boolean; +} + +const baseKeyStyle: React.CSSProperties = { + display: 'inline-flex', + alignItems: 'center', + justifyContent: 'center', + borderRadius: '0.375rem', + background: 'var(--mantine-color-gray-1)', + border: '1px solid var(--mantine-color-gray-3)', + padding: '0.125rem 0.35rem', + fontSize: '0.75rem', + lineHeight: 1, + fontFamily: 'var(--mantine-font-family-monospace, monospace)', + minWidth: '1.35rem', + color: 'var(--mantine-color-text)', +}; + +export const HotkeyDisplay: React.FC = ({ binding, size = 'sm', muted = false }) => { + const { getDisplayParts } = useHotkeys(); + const parts = getDisplayParts(binding); + + if (!binding || parts.length === 0) { + return null; + } + + const keyStyle = size === 'md' + ? { ...baseKeyStyle, fontSize: '0.85rem', padding: '0.2rem 0.5rem' } + : baseKeyStyle; + + return ( + + {parts.map((part, index) => ( + + {part} + {index < parts.length - 1 && +} + + ))} + + ); +}; + +export default HotkeyDisplay; \ No newline at end of file diff --git a/frontend/src/components/shared/AppConfigModal.css b/frontend/src/components/shared/AppConfigModal.css new file mode 100644 index 000000000..2ada07184 --- /dev/null +++ b/frontend/src/components/shared/AppConfigModal.css @@ -0,0 +1,130 @@ +/* AppConfigModal styles */ +.modal-container { + display: flex; + gap: 0; + height: 37.5rem; /* 600px */ +} + +.modal-nav { + width: 15rem; /* 240px */ + height: 37.5rem; /* 600px */ + border-top-left-radius: 0.75rem; /* 12px */ + border-bottom-left-radius: 0.75rem; /* 12px */ + overflow: hidden; + display: flex; + flex-direction: column; +} + +/* Mobile: compact icon-only navigation */ +@media (max-width: 1024px) { + .modal-container { + height: 100vh !important; + max-height: none !important; + } + + .modal-nav { + width: 5rem; /* 80px - wider for larger icons */ + height: 100vh !important; + max-height: none !important; + border-top-left-radius: 0; + border-bottom-left-radius: 0; + } + + .modal-nav-scroll { + padding: 1rem 0.5rem; + } + + .modal-nav-section { + margin-bottom: 1.5rem; + } + + .modal-nav-item.mobile { + padding: 1rem; + justify-content: center; + border-radius: 0.75rem; + margin-bottom: 0.75rem; + } + + .modal-content { + height: 100vh !important; + max-height: none !important; + border-radius: 0; + } +} + +.modal-nav-scroll { + flex: 1; + overflow-y: auto; + padding: 1rem; + padding-bottom: 2rem; + scrollbar-width: none; + -ms-overflow-style: none; +} + +.modal-nav-scroll::-webkit-scrollbar { + display: none; +} + +.modal-nav-section { + margin-bottom: 1rem; +} + +.modal-nav-section-items { + margin-top: 0.5rem; +} + +.modal-nav-item { + cursor: pointer; + padding: 0.5rem 0.625rem; /* 8px 10px */ + border-radius: 0.5rem; /* 8px */ + display: flex; + align-items: center; + gap: 0.5rem; + margin-bottom: 0.25rem; /* 4px */ +} + +.modal-content { + flex: 1; + height: 37.5rem; /* 600px */ + display: flex; + flex-direction: column; + overflow: hidden; +} + +.modal-content-scroll { + flex: 1; + overflow-y: auto; + scrollbar-width: none; + -ms-overflow-style: none; +} + +.modal-content-scroll::-webkit-scrollbar { + display: none; +} + +.modal-header { + position: sticky; + top: 0; + z-index: 5; + display: flex; + justify-content: space-between; + align-items: center; + padding: 1rem; +} + +.modal-body { + padding: 2rem; + padding-top: 1rem; +} + +.confirm-modal-content { + display: flex; + flex-direction: column; + gap: 1rem; +} + +.confirm-modal-buttons { + display: flex; + justify-content: flex-end; + gap: 0.5rem; +} \ No newline at end of file diff --git a/frontend/src/components/shared/AppConfigModal.tsx b/frontend/src/components/shared/AppConfigModal.tsx index a73e3ff73..2ed7f71b7 100644 --- a/frontend/src/components/shared/AppConfigModal.tsx +++ b/frontend/src/components/shared/AppConfigModal.tsx @@ -1,6 +1,11 @@ -import React from 'react'; -import { Modal, Button, Stack, Text, Code, ScrollArea, Group, Badge, Alert, Loader } from '@mantine/core'; -import { useAppConfig } from '../../hooks/useAppConfig'; +import React, { useMemo, useState, useEffect } from 'react'; +import { Modal, Text, ActionIcon } from '@mantine/core'; +import { useMediaQuery } from '@mantine/hooks'; +import LocalIcon from './LocalIcon'; +import Overview from './config/configSections/Overview'; +import { createConfigNavSections } from './config/configNavSections'; +import { NavKey } from './config/types'; +import './AppConfigModal.css'; interface AppConfigModalProps { opened: boolean; @@ -8,131 +13,143 @@ interface AppConfigModalProps { } const AppConfigModal: React.FC = ({ opened, onClose }) => { - const { config, loading, error, refetch } = useAppConfig(); + const [active, setActive] = useState('overview'); + const isMobile = useMediaQuery("(max-width: 1024px)"); - const renderConfigSection = (title: string, data: any) => { - if (!data || typeof data !== 'object') return null; + useEffect(() => { + const handler = (ev: Event) => { + const detail = (ev as CustomEvent).detail as { key?: NavKey } | undefined; + if (detail?.key) { + setActive(detail.key); + } + }; + window.addEventListener('appConfig:navigate', handler as EventListener); + return () => window.removeEventListener('appConfig:navigate', handler as EventListener); + }, []); - return ( - - {title} - - {Object.entries(data).map(([key, value]) => ( - - - {key}: - - {typeof value === 'boolean' ? ( - - {value ? 'true' : 'false'} - - ) : typeof value === 'object' ? ( - {JSON.stringify(value, null, 2)} - ) : ( - String(value) || 'null' - )} - - ))} - - - ); + const colors = useMemo(() => ({ + navBg: 'var(--modal-nav-bg)', + sectionTitle: 'var(--modal-nav-section-title)', + navItem: 'var(--modal-nav-item)', + navItemActive: 'var(--modal-nav-item-active)', + navItemActiveBg: 'var(--modal-nav-item-active-bg)', + contentBg: 'var(--modal-content-bg)', + headerBorder: 'var(--modal-header-border)', + }), []); + + // Placeholder logout handler (not needed in open-source but keeps SaaS compatibility) + const handleLogout = () => { + // In SaaS this would sign out, in open-source it does nothing + console.log('Logout placeholder for SaaS compatibility'); }; - const basicConfig = config ? { - appName: config.appName, - appNameNavbar: config.appNameNavbar, - baseUrl: config.baseUrl, - contextPath: config.contextPath, - serverPort: config.serverPort, - } : null; + // Left navigation structure and icons + const configNavSections = useMemo(() => + createConfigNavSections( + Overview, + handleLogout + ), + [] + ); - const securityConfig = config ? { - enableLogin: config.enableLogin, - } : null; + const activeLabel = useMemo(() => { + for (const section of configNavSections) { + const found = section.items.find(i => i.key === active); + if (found) return found.label; + } + return ''; + }, [configNavSections, active]); - const systemConfig = config ? { - enableAlphaFunctionality: config.enableAlphaFunctionality, - enableAnalytics: config.enableAnalytics, - } : null; - - const premiumConfig = config ? { - premiumEnabled: config.premiumEnabled, - premiumKey: config.premiumKey ? '***hidden***' : null, - runningProOrHigher: config.runningProOrHigher, - runningEE: config.runningEE, - license: config.license, - } : null; - - const integrationConfig = config ? { - GoogleDriveEnabled: config.GoogleDriveEnabled, - SSOAutoLogin: config.SSOAutoLogin, - } : null; - - const legalConfig = config ? { - termsAndConditions: config.termsAndConditions, - privacyPolicy: config.privacyPolicy, - cookiePolicy: config.cookiePolicy, - impressum: config.impressum, - accessibilityStatement: config.accessibilityStatement, - } : null; + const activeComponent = useMemo(() => { + for (const section of configNavSections) { + const found = section.items.find(i => i.key === active); + if (found) return found.component; + } + return null; + }, [configNavSections, active]); return ( - - - - This modal shows the current application configuration for testing purposes only. - - - +
+ {/* Left navigation */} +
+
+ {configNavSections.map(section => ( +
+ {!isMobile && ( + + {section.title} + + )} +
+ {section.items.map(item => { + const isActive = active === item.key; + const color = isActive ? colors.navItemActive : colors.navItem; + const iconSize = isMobile ? 28 : 18; + return ( +
setActive(item.key)} + className={`modal-nav-item ${isMobile ? 'mobile' : ''}`} + style={{ + background: isActive ? colors.navItemActiveBg : 'transparent', + }} + > + + {!isMobile && ( + + {item.label} + + )} +
+ ); + })} +
+
+ ))} +
+
- {loading && ( - - - Loading configuration... - - )} - - {error && ( - - {error} - - )} - - {config && ( - - - {renderConfigSection('Basic Configuration', basicConfig)} - {renderConfigSection('Security Configuration', securityConfig)} - {renderConfigSection('System Configuration', systemConfig)} - {renderConfigSection('Premium/Enterprise Configuration', premiumConfig)} - {renderConfigSection('Integration Configuration', integrationConfig)} - {renderConfigSection('Legal Configuration', legalConfig)} - - {config.error && ( - - {config.error} - - )} - - - Raw Configuration - - {JSON.stringify(config, null, 2)} - - - - - )} - + {/* Right content */} +
+
+ {/* Sticky header with section title and small close button */} +
+ {activeLabel} + + + +
+
+ {activeComponent} +
+
+
+
); }; diff --git a/frontend/src/components/shared/QuickAccessBar.tsx b/frontend/src/components/shared/QuickAccessBar.tsx index 8bc536bdb..b7206fa93 100644 --- a/frontend/src/components/shared/QuickAccessBar.tsx +++ b/frontend/src/components/shared/QuickAccessBar.tsx @@ -12,6 +12,7 @@ import { ButtonConfig } from '../../types/sidebar'; import './quickAccessBar/QuickAccessBar.css'; import AllToolsNavButton from './AllToolsNavButton'; import ActiveToolButton from "./quickAccessBar/ActiveToolButton"; +import AppConfigModal from './AppConfigModal'; import { isNavButtonActive, getNavButtonStyle, @@ -217,7 +218,7 @@ const QuickAccessBar = forwardRef((_, ref) => {
{/* Config button at the bottom */} - {/* {buttonConfigs + {buttonConfigs .filter(config => config.id === 'config') .map(config => (
@@ -237,14 +238,14 @@ const QuickAccessBar = forwardRef((_, ref) => { {config.name}
- ))} */} + ))}
- {/* setConfigModalOpen(false)} - /> */} + /> ); }); diff --git a/frontend/src/components/shared/config/configNavSections.tsx b/frontend/src/components/shared/config/configNavSections.tsx new file mode 100644 index 000000000..912ad8647 --- /dev/null +++ b/frontend/src/components/shared/config/configNavSections.tsx @@ -0,0 +1,57 @@ +import React from 'react'; +import { NavKey } from './types'; +import HotkeysSection from './configSections/HotkeysSection'; + +export interface ConfigNavItem { + key: NavKey; + label: string; + icon: string; + component: React.ReactNode; +} + +export interface ConfigNavSection { + title: string; + items: ConfigNavItem[]; +} + +export interface ConfigColors { + navBg: string; + sectionTitle: string; + navItem: string; + navItemActive: string; + navItemActiveBg: string; + contentBg: string; + headerBorder: string; +} + +export const createConfigNavSections = ( + Overview: React.ComponentType<{ onLogoutClick: () => void }>, + onLogoutClick: () => void +): ConfigNavSection[] => { + const sections: ConfigNavSection[] = [ + { + title: 'Account', + items: [ + { + key: 'overview', + label: 'Overview', + icon: 'person-rounded', + component: + }, + ], + }, + { + title: 'Preferences', + items: [ + { + key: 'hotkeys', + label: 'Keyboard Shortcuts', + icon: 'keyboard-rounded', + component: + }, + ], + }, + ]; + + return sections; +}; \ No newline at end of file diff --git a/frontend/src/components/shared/config/configSections/HotkeysSection.tsx b/frontend/src/components/shared/config/configSections/HotkeysSection.tsx new file mode 100644 index 000000000..e0240f55a --- /dev/null +++ b/frontend/src/components/shared/config/configSections/HotkeysSection.tsx @@ -0,0 +1,171 @@ +import React, { useEffect, useMemo, useState } from 'react'; +import { Alert, Badge, Box, Button, Divider, Group, Paper, Stack, Text } from '@mantine/core'; +import { useTranslation } from 'react-i18next'; +import { useToolWorkflow } from '../../../../contexts/ToolWorkflowContext'; +import { useHotkeys } from '../../../../contexts/HotkeyContext'; +import HotkeyDisplay from '../../../hotkeys/HotkeyDisplay'; +import { bindingEquals, eventToBinding } from '../../../../utils/hotkeys'; + +const rowStyle: React.CSSProperties = { + display: 'flex', + flexDirection: 'column', + gap: '0.5rem', +}; + +const rowHeaderStyle: React.CSSProperties = { + display: 'flex', + flexWrap: 'wrap', + alignItems: 'center', + justifyContent: 'space-between', + gap: '0.5rem', +}; + +const HotkeysSection: React.FC = () => { + const { t } = useTranslation(); + const { toolRegistry } = useToolWorkflow(); + const { hotkeys, defaults, updateHotkey, resetHotkey, pauseHotkeys, resumeHotkeys, getDisplayParts, isMac } = useHotkeys(); + const [editingTool, setEditingTool] = useState(null); + const [error, setError] = useState(null); + + const tools = useMemo(() => Object.entries(toolRegistry), [toolRegistry]); + + useEffect(() => { + if (!editingTool) { + return; + } + pauseHotkeys(); + return () => { + resumeHotkeys(); + }; + }, [editingTool, pauseHotkeys, resumeHotkeys]); + + useEffect(() => { + if (!editingTool) { + return; + } + + const handleKeyDown = (event: KeyboardEvent) => { + event.preventDefault(); + event.stopPropagation(); + + if (event.key === 'Escape') { + setEditingTool(null); + setError(null); + return; + } + + const binding = eventToBinding(event as KeyboardEvent); + if (!binding) { + const osKey = isMac ? 'mac' : 'windows'; + const fallbackText = isMac + ? 'Include ⌘ (Command), ⌥ (Option), or another modifier in your shortcut.' + : 'Include Ctrl, Alt, or another modifier in your shortcut.'; + setError(t(`settings.hotkeys.errorModifier.${osKey}`, fallbackText)); + return; + } + + const conflictEntry = Object.entries(hotkeys).find(([toolId, existing]) => ( + toolId !== editingTool && bindingEquals(existing, binding) + )); + + if (conflictEntry) { + const conflictTool = toolRegistry[conflictEntry[0]]?.name ?? conflictEntry[0]; + setError(t('settings.hotkeys.errorConflict', 'Shortcut already used by {{tool}}.', { tool: conflictTool })); + return; + } + + updateHotkey(editingTool, binding); + setEditingTool(null); + setError(null); + }; + + window.addEventListener('keydown', handleKeyDown, true); + return () => { + window.removeEventListener('keydown', handleKeyDown, true); + }; + }, [editingTool, hotkeys, toolRegistry, updateHotkey, t]); + + const handleStartCapture = (toolId: string) => { + setEditingTool(toolId); + setError(null); + }; + + return ( + +
+ Keyboard Shortcuts + + Customize keyboard shortcuts for quick tool access. Click "Change shortcut" and press a new key combination. Press Esc to cancel. + +
+ + + + {tools.map(([toolId, tool], index) => { + const currentBinding = hotkeys[toolId]; + const defaultBinding = defaults[toolId]; + const isEditing = editingTool === toolId; + const defaultParts = getDisplayParts(defaultBinding); + const defaultLabel = defaultParts.length > 0 + ? defaultParts.join(' + ') + : t('settings.hotkeys.none', 'Not assigned'); + + return ( + + +
+
+ {tool.name} + + + {!bindingEquals(currentBinding, defaultBinding) && ( + + {t('settings.hotkeys.customBadge', 'Custom')} + + )} + + {t('settings.hotkeys.defaultLabel', 'Default: {{shortcut}}', { shortcut: defaultLabel })} + + +
+ + + + + +
+ + {isEditing && error && ( + + {error} + + )} + + + {index < tools.length - 1 && } + + ); + })} + + + + ); +}; + +export default HotkeysSection; \ No newline at end of file diff --git a/frontend/src/components/shared/config/configSections/Overview.tsx b/frontend/src/components/shared/config/configSections/Overview.tsx new file mode 100644 index 000000000..e591655e0 --- /dev/null +++ b/frontend/src/components/shared/config/configSections/Overview.tsx @@ -0,0 +1,102 @@ +import React from 'react'; +import { Stack, Text, Code, Group, Badge, Alert, Loader } from '@mantine/core'; +import { useAppConfig } from '../../../../hooks/useAppConfig'; + +const Overview: React.FC = () => { + const { config, loading, error } = useAppConfig(); + + const renderConfigSection = (title: string, data: any) => { + if (!data || typeof data !== 'object') return null; + + return ( + + {title} + + {Object.entries(data).map(([key, value]) => ( + + + {key}: + + {typeof value === 'boolean' ? ( + + {value ? 'true' : 'false'} + + ) : typeof value === 'object' ? ( + {JSON.stringify(value, null, 2)} + ) : ( + String(value) || 'null' + )} + + ))} + + + ); + }; + + const basicConfig = config ? { + appName: config.appName, + appNameNavbar: config.appNameNavbar, + baseUrl: config.baseUrl, + contextPath: config.contextPath, + serverPort: config.serverPort, + } : null; + + const securityConfig = config ? { + enableLogin: config.enableLogin, + } : null; + + const systemConfig = config ? { + enableAlphaFunctionality: config.enableAlphaFunctionality, + enableAnalytics: config.enableAnalytics, + } : null; + + const integrationConfig = config ? { + GoogleDriveEnabled: config.GoogleDriveEnabled, + SSOAutoLogin: config.SSOAutoLogin, + } : null; + + if (loading) { + return ( + + + Loading configuration... + + ); + } + + if (error) { + return ( + + {error} + + ); + } + + return ( + +
+ Application Configuration + + Current application settings and configuration details. + +
+ + {config && ( + <> + {renderConfigSection('Basic Configuration', basicConfig)} + {renderConfigSection('Security Configuration', securityConfig)} + {renderConfigSection('System Configuration', systemConfig)} + {renderConfigSection('Integration Configuration', integrationConfig)} + + {config.error && ( + + {config.error} + + )} + + )} + + ); +}; + +export default Overview; \ No newline at end of file diff --git a/frontend/src/components/shared/config/types.ts b/frontend/src/components/shared/config/types.ts new file mode 100644 index 000000000..2ef734422 --- /dev/null +++ b/frontend/src/components/shared/config/types.ts @@ -0,0 +1,19 @@ +export type NavKey = + | 'overview' + | 'preferences' + | 'notifications' + | 'connections' + | 'general' + | 'people' + | 'teams' + | 'security' + | 'identity' + | 'plan' + | 'payments' + | 'requests' + | 'developer' + | 'api-keys' + | 'hotkeys'; + + + // some of these are not used yet, but appear in figma designs \ No newline at end of file diff --git a/frontend/src/components/tools/toolPicker/ToolButton.tsx b/frontend/src/components/tools/toolPicker/ToolButton.tsx index 236cbb49f..40cee33a7 100644 --- a/frontend/src/components/tools/toolPicker/ToolButton.tsx +++ b/frontend/src/components/tools/toolPicker/ToolButton.tsx @@ -1,10 +1,13 @@ import React from "react"; import { Button } from "@mantine/core"; +import { useTranslation } from "react-i18next"; import { Tooltip } from "../../shared/Tooltip"; import { ToolRegistryEntry } from "../../../data/toolsTaxonomy"; import { useToolNavigation } from "../../../hooks/useToolNavigation"; import { handleUnlessSpecialClick } from "../../../utils/clickHandlers"; import FitText from "../../shared/FitText"; +import { useHotkeys } from "../../../contexts/HotkeyContext"; +import HotkeyDisplay from "../../hotkeys/HotkeyDisplay"; interface ToolButtonProps { id: string; @@ -17,8 +20,11 @@ interface ToolButtonProps { } const ToolButton: React.FC = ({ id, tool, isSelected, onSelect, disableNavigation = false, matchedSynonym }) => { + const { t } = useTranslation(); // Special case: read and multiTool are navigational tools that are always available const isUnavailable = !tool.component && !tool.link && id !== 'read' && id !== 'multiTool'; + const { hotkeys } = useHotkeys(); + const binding = hotkeys[id]; const { getToolNavigation } = useToolNavigation(); const handleClick = (id: string) => { @@ -37,7 +43,17 @@ const ToolButton: React.FC = ({ id, tool, isSelected, onSelect, const tooltipContent = isUnavailable ? (Coming soon: {tool.description}) - : tool.description; + : ( +
+ {tool.description} + {binding && ( +
+ {t('settings.hotkeys.shortcut', 'Shortcut')} + +
+ )} +
+ ); const buttonContent = ( <> diff --git a/frontend/src/contexts/HotkeyContext.tsx b/frontend/src/contexts/HotkeyContext.tsx new file mode 100644 index 000000000..fe9cbb600 --- /dev/null +++ b/frontend/src/contexts/HotkeyContext.tsx @@ -0,0 +1,211 @@ +import React, { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react'; +import { HotkeyBinding, bindingEquals, bindingMatchesEvent, deserializeBindings, getDisplayParts, isMacLike, normalizeBinding, serializeBindings } from '../utils/hotkeys'; +import { useToolWorkflow } from './ToolWorkflowContext'; +import { ToolId } from '../types/toolId'; + +interface HotkeyContextValue { + hotkeys: Record; + defaults: Record; + isMac: boolean; + updateHotkey: (toolId: string, binding: HotkeyBinding) => void; + resetHotkey: (toolId: string) => void; + isBindingAvailable: (binding: HotkeyBinding, excludeToolId?: string) => boolean; + pauseHotkeys: () => void; + resumeHotkeys: () => void; + areHotkeysPaused: boolean; + getDisplayParts: (binding: HotkeyBinding | null | undefined) => string[]; +} + +const HotkeyContext = createContext(undefined); + +const STORAGE_KEY = 'stirlingpdf.hotkeys'; + +const KEY_ORDER: string[] = [ + 'Digit1', 'Digit2', 'Digit3', 'Digit4', 'Digit5', 'Digit6', 'Digit7', 'Digit8', 'Digit9', 'Digit0', + 'KeyQ', 'KeyW', 'KeyE', 'KeyR', 'KeyT', 'KeyY', 'KeyU', 'KeyI', 'KeyO', 'KeyP', + 'KeyA', 'KeyS', 'KeyD', 'KeyF', 'KeyG', 'KeyH', 'KeyJ', 'KeyK', 'KeyL', + 'KeyZ', 'KeyX', 'KeyC', 'KeyV', 'KeyB', 'KeyN', 'KeyM', + 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12', +]; + +const generateDefaultHotkeys = (toolIds: string[], macLike: boolean): Record => { + const defaults: Record = {}; + let index = 0; + let useShift = false; + + const nextBinding = (): HotkeyBinding => { + if (index >= KEY_ORDER.length) { + index = 0; + if (!useShift) { + useShift = true; + } else { + // If we somehow run out of combinations, wrap back around (unlikely given tool count) + useShift = false; + } + } + + const code = KEY_ORDER[index]; + index += 1; + + return { + code, + alt: true, + shift: useShift, + meta: macLike, + ctrl: !macLike, + }; + }; + + toolIds.forEach(toolId => { + defaults[toolId] = nextBinding(); + }); + + return defaults; +}; + +const shouldIgnoreTarget = (target: EventTarget | null): boolean => { + if (!target || !(target instanceof HTMLElement)) { + return false; + } + const editable = target.closest('input, textarea, [contenteditable="true"], [role="textbox"]'); + return Boolean(editable); +}; + +export const HotkeyProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => { + const { toolRegistry, handleToolSelect } = useToolWorkflow(); + const isMac = useMemo(() => isMacLike(), []); + const [customBindings, setCustomBindings] = useState>(() => { + if (typeof window === 'undefined') { + return {}; + } + return deserializeBindings(window.localStorage?.getItem(STORAGE_KEY)); + }); + const [areHotkeysPaused, setHotkeysPaused] = useState(false); + + const toolIds = useMemo(() => Object.keys(toolRegistry), [toolRegistry]); + + const defaults = useMemo(() => generateDefaultHotkeys(toolIds, isMac), [toolIds, isMac]); + + // Remove bindings for tools that are no longer present + useEffect(() => { + setCustomBindings(prev => { + const next: Record = {}; + let changed = false; + Object.entries(prev).forEach(([toolId, binding]) => { + if (toolRegistry[toolId]) { + next[toolId] = binding; + } else { + changed = true; + } + }); + return changed ? next : prev; + }); + }, [toolRegistry]); + + const resolved = useMemo(() => { + const merged: Record = {}; + toolIds.forEach(toolId => { + const custom = customBindings[toolId]; + merged[toolId] = custom ? normalizeBinding(custom) : defaults[toolId]; + }); + return merged; + }, [customBindings, defaults, toolIds]); + + useEffect(() => { + if (typeof window === 'undefined') { + return; + } + window.localStorage.setItem(STORAGE_KEY, serializeBindings(customBindings)); + }, [customBindings]); + + const isBindingAvailable = useCallback((binding: HotkeyBinding, excludeToolId?: string) => { + const normalized = normalizeBinding(binding); + return Object.entries(resolved).every(([toolId, existing]) => { + if (toolId === excludeToolId) { + return true; + } + return !bindingEquals(existing, normalized); + }); + }, [resolved]); + + const updateHotkey = useCallback((toolId: string, binding: HotkeyBinding) => { + setCustomBindings(prev => { + const normalized = normalizeBinding(binding); + const defaultsForTool = defaults[toolId]; + const next = { ...prev }; + if (defaultsForTool && bindingEquals(defaultsForTool, normalized)) { + delete next[toolId]; + } else { + next[toolId] = normalized; + } + return next; + }); + }, [defaults]); + + const resetHotkey = useCallback((toolId: string) => { + setCustomBindings(prev => { + if (!(toolId in prev)) { + return prev; + } + const next = { ...prev }; + delete next[toolId]; + return next; + }); + }, []); + + const pauseHotkeys = useCallback(() => setHotkeysPaused(true), []); + const resumeHotkeys = useCallback(() => setHotkeysPaused(false), []); + + useEffect(() => { + if (areHotkeysPaused) { + return; + } + + const handler = (event: KeyboardEvent) => { + if (event.repeat) return; + if (shouldIgnoreTarget(event.target)) return; + + const entries = Object.entries(resolved) as Array<[string, HotkeyBinding]>; + for (const [toolId, binding] of entries) { + if (bindingMatchesEvent(binding, event)) { + event.preventDefault(); + event.stopPropagation(); + handleToolSelect(toolId as ToolId); + break; + } + } + }; + + window.addEventListener('keydown', handler, true); + return () => { + window.removeEventListener('keydown', handler, true); + }; + }, [resolved, areHotkeysPaused, handleToolSelect]); + + const contextValue = useMemo(() => ({ + hotkeys: resolved, + defaults, + isMac, + updateHotkey, + resetHotkey, + isBindingAvailable, + pauseHotkeys, + resumeHotkeys, + areHotkeysPaused, + getDisplayParts: (binding) => getDisplayParts(binding ?? null, isMac), + }), [resolved, defaults, isMac, updateHotkey, resetHotkey, isBindingAvailable, pauseHotkeys, resumeHotkeys, areHotkeysPaused]); + + return ( + + {children} + + ); +}; + +export const useHotkeys = (): HotkeyContextValue => { + const context = useContext(HotkeyContext); + if (!context) { + throw new Error('useHotkeys must be used within a HotkeyProvider'); + } + return context; +}; \ No newline at end of file diff --git a/frontend/src/contexts/ToolWorkflowContext.tsx b/frontend/src/contexts/ToolWorkflowContext.tsx index e38375daa..98a0fd37d 100644 --- a/frontend/src/contexts/ToolWorkflowContext.tsx +++ b/frontend/src/contexts/ToolWorkflowContext.tsx @@ -75,7 +75,7 @@ interface ToolWorkflowContextValue extends ToolWorkflowState { // Tool management (from hook) selectedToolKey: string | null; selectedTool: ToolRegistryEntry | null; - toolRegistry: any; // From useToolManagement + toolRegistry: Record; getSelectedTool: (toolId: string | null) => ToolRegistryEntry | null; // UI Actions @@ -231,7 +231,7 @@ export function ToolWorkflowProvider({ children }: ToolWorkflowProviderProps) { // Filter tools based on search query with fuzzy matching (name, description, id, synonyms) const filteredTools = useMemo(() => { if (!toolRegistry) return []; - return filterToolRegistryByQuery(toolRegistry as Record, state.searchQuery); + return filterToolRegistryByQuery(toolRegistry as ToolRegistry, state.searchQuery); }, [toolRegistry, state.searchQuery]); const isPanelVisible = useMemo(() => diff --git a/frontend/src/pages/HomePage.tsx b/frontend/src/pages/HomePage.tsx index f283a1caa..4b9514a3c 100644 --- a/frontend/src/pages/HomePage.tsx +++ b/frontend/src/pages/HomePage.tsx @@ -15,6 +15,7 @@ import RightRail from "../components/shared/RightRail"; import FileManager from "../components/FileManager"; import LocalIcon from "../components/shared/LocalIcon"; import { useFilesModalContext } from "../contexts/FilesModalContext"; +import AppConfigModal from "../components/shared/AppConfigModal"; import "./HomePage.css"; @@ -37,6 +38,7 @@ export default function HomePage() { const sliderRef = useRef(null); const [activeMobileView, setActiveMobileView] = useState("tools"); const isProgrammaticScroll = useRef(false); + const [configModalOpen, setConfigModalOpen] = useState(false); const brandAltText = t("home.mobile.brandAlt", "Stirling PDF logo"); const brandIconSrc = `${BASE_PATH}/branding/StirlingPDFLogoNoText${ @@ -207,8 +209,20 @@ export default function HomePage() { {t('quickAccess.files', 'Files')} + + setConfigModalOpen(false)} + /> ) : ( = { + Minus: '-', + Equal: '=', + Backquote: '`', + BracketLeft: '[', + BracketRight: ']', + Backslash: '\\', + IntlBackslash: '\\', + Semicolon: ';', + Quote: '\'', + Comma: ',', + Period: '.', + Slash: '/', + Space: 'Space', + Tab: 'Tab', + Escape: 'Esc', + Enter: 'Enter', + NumpadEnter: 'Num Enter', + NumpadAdd: 'Num +', + NumpadSubtract: 'Num -', + NumpadMultiply: 'Num *', + NumpadDivide: 'Num /', + NumpadDecimal: 'Num .', + NumpadComma: 'Num ,', + NumpadEqual: 'Num =', +}; + +export const isMacLike = (): boolean => { + if (typeof navigator === 'undefined') { + return false; + } + const platform = navigator.platform?.toLowerCase() ?? ''; + const userAgent = navigator.userAgent?.toLowerCase() ?? ''; + return /mac|iphone|ipad|ipod/.test(platform) || /mac|iphone|ipad|ipod/.test(userAgent); +}; + +export const isModifierCode = (code: string): boolean => MODIFIER_CODES.has(code); + +const isFunctionKey = (code: string): boolean => /^F\d{1,2}$/.test(code); + +export const bindingEquals = (a?: HotkeyBinding | null, b?: HotkeyBinding | null): boolean => { + if (!a && !b) return true; + if (!a || !b) return false; + return ( + a.code === b.code && + Boolean(a.alt) === Boolean(b.alt) && + Boolean(a.ctrl) === Boolean(b.ctrl) && + Boolean(a.meta) === Boolean(b.meta) && + Boolean(a.shift) === Boolean(b.shift) + ); +}; + +export const bindingMatchesEvent = (binding: HotkeyBinding, event: KeyboardEvent): boolean => { + return ( + event.code === binding.code && + event.altKey === Boolean(binding.alt) && + event.ctrlKey === Boolean(binding.ctrl) && + event.metaKey === Boolean(binding.meta) && + event.shiftKey === Boolean(binding.shift) + ); +}; + +export const eventToBinding = (event: KeyboardEvent | ReactKeyboardEvent): HotkeyBinding | null => { + const code = event.code; + if (!code || isModifierCode(code)) { + return null; + } + + const binding: HotkeyBinding = { + code, + alt: event.altKey, + ctrl: event.ctrlKey, + meta: event.metaKey, + shift: event.shiftKey, + }; + + // Require at least one modifier to avoid clashing with text input + if (!binding.alt && !binding.ctrl && !binding.meta) { + return null; + } + + return binding; +}; + +const getKeyLabel = (code: string): string => { + if (CODE_LABEL_MAP[code]) { + return CODE_LABEL_MAP[code]; + } + + if (code.startsWith('Key')) { + return code.slice(3); + } + + if (code.startsWith('Digit')) { + return code.slice(5); + } + + if (code.startsWith('Numpad')) { + const remainder = code.slice(6); + if (/^[0-9]$/.test(remainder)) { + return `Num ${remainder}`; + } + return `Num ${remainder}`; + } + + // Match function keys (F1-F12) + if (isFunctionKey(code)) { + return code; + } + + switch (code) { + case 'ArrowUp': + return '↑'; + case 'ArrowDown': + return '↓'; + case 'ArrowLeft': + return '←'; + case 'ArrowRight': + return '→'; + default: + return code; + } +}; + +export const getDisplayParts = (binding: HotkeyBinding | null | undefined, macLike: boolean): string[] => { + if (!binding) return []; + const parts: string[] = []; + if (binding.meta) { + parts.push(macLike ? '⌘' : 'Win'); + } + if (binding.ctrl) { + parts.push(macLike ? '⌃' : 'Ctrl'); + } + if (binding.alt) { + parts.push(macLike ? '⌥' : 'Alt'); + } + if (binding.shift) { + parts.push(macLike ? '⇧' : 'Shift'); + } + parts.push(getKeyLabel(binding.code)); + return parts; +}; + +export const serializeBindings = (bindings: Record): string => { + return JSON.stringify(bindings); +}; + +export const deserializeBindings = (value: string | null | undefined): Record => { + if (!value) { + return {}; + } + try { + const parsed = JSON.parse(value) as Record; + if (typeof parsed !== 'object' || parsed === null) { + return {}; + } + return parsed; + } catch (error) { + console.warn('Failed to parse stored hotkey bindings', error); + return {}; + } +}; + +export const normalizeBinding = (binding: HotkeyBinding): HotkeyBinding => ({ + code: binding.code, + alt: Boolean(binding.alt), + ctrl: Boolean(binding.ctrl), + meta: Boolean(binding.meta), + shift: Boolean(binding.shift), +}); \ No newline at end of file