@rapidmx/web-client 0.15.1 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +381 -373
- package/apps/admin/branding/index.tsx +39 -39
- package/apps/admin/data-requests/index.tsx +482 -480
- package/apps/admin/distribution-lists/new/index.tsx +3 -1
- package/apps/admin/domains/[uid].tsx +166 -164
- package/apps/admin/domains/new/index.tsx +3 -1
- package/apps/admin/escrow-scopes/[uid].tsx +350 -348
- package/apps/admin/escrow-scopes/new/index.tsx +3 -1
- package/apps/admin/index.tsx +129 -124
- package/apps/admin/mailboxes/[uid].tsx +271 -224
- package/apps/admin/mailboxes/new/index.tsx +30 -28
- package/apps/admin/plugins/index.tsx +15 -15
- package/apps/admin/retention-policy/index.tsx +39 -39
- package/apps/admin/signing-certificates/index.tsx +343 -343
- package/apps/admin/transport-rules/new/index.tsx +3 -1
- package/apps/escrow/audit-log/index.tsx +196 -196
- package/apps/escrow/matters/[uid].tsx +621 -621
- package/apps/escrow/matters/new/index.tsx +3 -1
- package/apps/shared/auth/adminAccess.ts +99 -99
- package/apps/shared/components/admin/layout/AdminShell.tsx +381 -378
- package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -0
- package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
- package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -0
- package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
- package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
- package/apps/shared/components/admin/settings/MailboxCreateForm.tsx +50 -3
- package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
- package/apps/shared/components/admin/settings/PluginsManager.tsx +1545 -1545
- package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
- package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
- package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -444
- package/apps/shared/components/admin/usePagedList.tsx +129 -129
- package/apps/shared/components/calendar/EventEditor.tsx +5 -10
- package/apps/shared/components/calendar/EventFormParts.tsx +16 -47
- package/apps/shared/components/calendar/EventModal.tsx +206 -206
- package/apps/shared/components/calendar/GuestInput.tsx +100 -0
- package/apps/shared/components/calendar/MonthView.tsx +185 -185
- package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
- package/apps/shared/components/calendar/RequestChangeForm.tsx +23 -54
- package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
- package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
- package/apps/shared/components/calendar/allDay.ts +124 -124
- package/apps/shared/components/calendar/eventForm.ts +2 -2
- package/apps/shared/components/calendar/eventFormat.ts +49 -22
- package/apps/shared/components/calendar/layout/CalendarShell.tsx +201 -200
- package/apps/shared/components/contacts/ContactForm.tsx +383 -383
- package/apps/shared/components/contacts/ContactsSidebar.tsx +1 -1
- package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -98
- package/apps/shared/components/contacts/layout/ContactsShell.tsx +218 -216
- package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
- package/apps/shared/components/layout/AppShell.tsx +461 -480
- package/apps/shared/components/layout/FloatingActionButton.tsx +31 -0
- package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
- package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
- package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
- package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
- package/apps/shared/components/layout/UserMenu.tsx +439 -424
- package/apps/shared/components/mail/ConversationList.tsx +323 -323
- package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -491
- package/apps/shared/components/mail/EmptyFolderBar.tsx +41 -0
- package/apps/shared/components/mail/MailSelectionBar.tsx +240 -227
- package/apps/shared/components/mail/MenuButton.tsx +31 -11
- package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1559
- package/apps/shared/components/mail/PermanentDeleteDialog.tsx +47 -0
- package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
- package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
- package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1677
- package/apps/shared/components/mail/compose/RecipientInput.tsx +54 -11
- package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
- package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
- package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
- package/apps/shared/components/mail/layout/FolderBadgeChip.tsx +21 -0
- package/apps/shared/components/mail/layout/MailShell.tsx +161 -134
- package/apps/shared/components/mail/layout/SidebarSection.tsx +66 -0
- package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -0
- package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -0
- package/apps/shared/components/mail/reading/PendingMessageCard.tsx +68 -0
- package/apps/shared/components/mail/reading/messageExport.ts +59 -0
- package/apps/shared/components/mail/reading/printMessage.ts +99 -0
- package/apps/shared/components/mail/reading/useMessageActions.ts +443 -0
- package/apps/shared/components/mail/verificationSeals.ts +125 -125
- package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
- package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
- package/apps/shared/components/settings/layout/SettingsShell.tsx +257 -254
- package/apps/shared/components/tasks/TasksSidebar.tsx +1 -1
- package/apps/shared/components/tasks/layout/TasksShell.tsx +219 -217
- package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
- package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
- package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
- package/apps/shared/keyboard/dispatch.ts +124 -124
- package/apps/shared/keyboard/format.ts +89 -89
- package/apps/shared/keyboard/keymap.ts +114 -114
- package/apps/shared/keyboard/registry.ts +65 -65
- package/apps/shared/keyboard/targets.ts +79 -79
- package/apps/shared/mail/folderCounts.ts +17 -0
- package/apps/shared/mail/folderOfType.ts +49 -0
- package/apps/shared/mail/folderTree.ts +143 -143
- package/apps/shared/mail/listAllPages.ts +39 -39
- package/apps/shared/mail/newMailNotifications.ts +171 -171
- package/apps/shared/mail/outbox/outgoingReplies.ts +192 -0
- package/apps/shared/mail/outbox/sendJob.ts +19 -1
- package/apps/shared/mail/outbox/sendOutcomes.ts +13 -4
- package/apps/shared/mail/permanentDelete.ts +160 -0
- package/apps/shared/mail/primaryMailbox.ts +71 -0
- package/apps/shared/mail/reportNotices.ts +66 -0
- package/apps/shared/mail/senderBlocking.ts +141 -0
- package/apps/shared/mail/useCollapsedSections.ts +146 -0
- package/apps/shared/mail/useMailConnection.ts +205 -203
- package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
- package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -0
- package/apps/shared/mail/useMarkMessageRead.ts +47 -47
- package/apps/shared/mail/useNewMailNotifications.ts +178 -178
- package/apps/shared/mail/usePermanentDelete.tsx +160 -0
- package/apps/shared/navigation/frameContext.tsx +1 -1
- package/apps/shared/navigation/index.ts +43 -0
- package/apps/shared/navigation/pageTitle.ts +19 -0
- package/apps/shared/notifications/store.ts +560 -560
- package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
- package/apps/shared/search/crossMailboxSearch.ts +169 -0
- package/apps/shared/search/localIndexBuilder.ts +481 -481
- package/apps/shared/signing/enrollmentStorage.ts +33 -33
- package/apps/shared/signing/enrollmentTracker.ts +385 -385
- package/apps/shared/signing/enrollmentView.ts +251 -251
- package/apps/shared/signing/useNow.ts +19 -19
- package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
- package/apps/shared/styles/app.css +396 -386
- package/apps/www/_shell.tsx +82 -0
- package/apps/www/calendar/index.tsx +581 -571
- package/apps/www/contacts/[uid].tsx +112 -109
- package/apps/www/contacts/index.tsx +14 -3
- package/apps/www/index.tsx +2962 -2479
- package/apps/www/messages/[uid].tsx +139 -135
- package/apps/www/settings/appearance/index.tsx +5 -2
- package/apps/www/settings/auto-reply/index.tsx +136 -133
- package/apps/www/settings/blocked-senders/index.tsx +303 -0
- package/apps/www/settings/encryption/index.tsx +1290 -1287
- package/apps/www/settings/filters/[uid].tsx +179 -176
- package/apps/www/settings/filters/index.tsx +105 -102
- package/apps/www/settings/filters/new/index.tsx +165 -140
- package/apps/www/settings/labels/index.tsx +207 -204
- package/apps/www/settings/privacy/index.tsx +495 -492
- package/apps/www/settings/profile/index.tsx +251 -248
- package/apps/www/settings/read-receipts/index.tsx +150 -147
- package/apps/www/settings/sharing/index.tsx +259 -256
- package/apps/www/settings/signatures/[uid].tsx +175 -172
- package/apps/www/settings/signatures/index.tsx +91 -88
- package/apps/www/settings/signatures/new/index.tsx +138 -135
- package/apps/www/tasks/index.tsx +654 -649
- package/dist/apps/admin/data-requests/index.js +1 -1
- package/dist/apps/admin/distribution-lists/new/index.js +3 -1
- package/dist/apps/admin/domains/[uid].js +3 -1
- package/dist/apps/admin/domains/new/index.js +3 -1
- package/dist/apps/admin/escrow-scopes/[uid].js +3 -1
- package/dist/apps/admin/escrow-scopes/new/index.js +3 -1
- package/dist/apps/admin/index.js +5 -2
- package/dist/apps/admin/mailboxes/[uid].js +15 -3
- package/dist/apps/admin/mailboxes/new/index.js +3 -1
- package/dist/apps/admin/transport-rules/new/index.js +3 -1
- package/dist/apps/escrow/matters/new/index.js +3 -1
- package/dist/apps/shared/components/admin/layout/AdminShell.js +6 -3
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.d.ts +35 -0
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.js +115 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.d.ts +16 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.js +92 -0
- package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
- package/dist/apps/shared/components/admin/settings/MailboxCreateForm.js +25 -3
- package/dist/apps/shared/components/admin/setup/SetupWizard.js +3 -1
- package/dist/apps/shared/components/calendar/EventEditor.js +5 -10
- package/dist/apps/shared/components/calendar/EventFormParts.d.ts +3 -2
- package/dist/apps/shared/components/calendar/EventFormParts.js +5 -16
- package/dist/apps/shared/components/calendar/GuestInput.d.ts +45 -0
- package/dist/apps/shared/components/calendar/GuestInput.js +30 -0
- package/dist/apps/shared/components/calendar/RequestChangeForm.js +11 -22
- package/dist/apps/shared/components/calendar/eventForm.d.ts +2 -2
- package/dist/apps/shared/components/calendar/eventFormat.d.ts +21 -8
- package/dist/apps/shared/components/calendar/eventFormat.js +50 -23
- package/dist/apps/shared/components/calendar/layout/CalendarShell.js +5 -4
- package/dist/apps/shared/components/contacts/ContactsSidebar.js +1 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.d.ts +3 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.js +4 -2
- package/dist/apps/shared/components/contacts/layout/ContactsShell.js +7 -5
- package/dist/apps/shared/components/layout/AppShell.d.ts +8 -11
- package/dist/apps/shared/components/layout/AppShell.js +24 -33
- package/dist/apps/shared/components/layout/FloatingActionButton.d.ts +13 -0
- package/dist/apps/shared/components/layout/FloatingActionButton.js +9 -0
- package/dist/apps/shared/components/layout/UserMenu.d.ts +4 -1
- package/dist/apps/shared/components/layout/UserMenu.js +6 -5
- package/dist/apps/shared/components/mail/ConversationThreadPane.js +127 -22
- package/dist/apps/shared/components/mail/EmptyFolderBar.d.ts +18 -0
- package/dist/apps/shared/components/mail/EmptyFolderBar.js +10 -0
- package/dist/apps/shared/components/mail/MailSelectionBar.d.ts +14 -4
- package/dist/apps/shared/components/mail/MailSelectionBar.js +11 -13
- package/dist/apps/shared/components/mail/MenuButton.d.ts +9 -2
- package/dist/apps/shared/components/mail/MenuButton.js +15 -11
- package/dist/apps/shared/components/mail/MessageDetailPane.d.ts +5 -0
- package/dist/apps/shared/components/mail/MessageDetailPane.js +147 -7
- package/dist/apps/shared/components/mail/PermanentDeleteDialog.d.ts +19 -0
- package/dist/apps/shared/components/mail/PermanentDeleteDialog.js +11 -0
- package/dist/apps/shared/components/mail/compose/ComposeWindow.js +8 -4
- package/dist/apps/shared/components/mail/compose/RecipientInput.d.ts +21 -1
- package/dist/apps/shared/components/mail/compose/RecipientInput.js +18 -10
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.d.ts +6 -0
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.js +9 -0
- package/dist/apps/shared/components/mail/layout/MailShell.d.ts +16 -7
- package/dist/apps/shared/components/mail/layout/MailShell.js +78 -65
- package/dist/apps/shared/components/mail/layout/SidebarSection.d.ts +23 -0
- package/dist/apps/shared/components/mail/layout/SidebarSection.js +16 -0
- package/dist/apps/shared/components/mail/reading/MessageMoreMenu.d.ts +56 -0
- package/dist/apps/shared/components/mail/reading/MessageMoreMenu.js +153 -0
- package/dist/apps/shared/components/mail/reading/MessageSourceDialog.d.ts +27 -0
- package/dist/apps/shared/components/mail/reading/MessageSourceDialog.js +27 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.d.ts +14 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.js +16 -0
- package/dist/apps/shared/components/mail/reading/messageExport.d.ts +19 -0
- package/dist/apps/shared/components/mail/reading/messageExport.js +51 -0
- package/dist/apps/shared/components/mail/reading/printMessage.d.ts +30 -0
- package/dist/apps/shared/components/mail/reading/printMessage.js +70 -0
- package/dist/apps/shared/components/mail/reading/useMessageActions.d.ts +57 -0
- package/dist/apps/shared/components/mail/reading/useMessageActions.js +366 -0
- package/dist/apps/shared/components/settings/layout/SettingsShell.js +10 -7
- package/dist/apps/shared/components/tasks/TasksSidebar.js +1 -1
- package/dist/apps/shared/components/tasks/layout/TasksShell.js +7 -5
- package/dist/apps/shared/keyboard/GlobalShortcuts.js +1 -1
- package/dist/apps/shared/mail/folderCounts.d.ts +10 -0
- package/dist/apps/shared/mail/folderCounts.js +12 -0
- package/dist/apps/shared/mail/folderOfType.d.ts +13 -0
- package/dist/apps/shared/mail/folderOfType.js +40 -0
- package/dist/apps/shared/mail/outbox/outgoingReplies.d.ts +80 -0
- package/dist/apps/shared/mail/outbox/outgoingReplies.js +131 -0
- package/dist/apps/shared/mail/outbox/sendJob.d.ts +5 -1
- package/dist/apps/shared/mail/outbox/sendJob.js +14 -1
- package/dist/apps/shared/mail/outbox/sendOutcomes.js +13 -4
- package/dist/apps/shared/mail/permanentDelete.d.ts +62 -0
- package/dist/apps/shared/mail/permanentDelete.js +127 -0
- package/dist/apps/shared/mail/primaryMailbox.d.ts +29 -0
- package/dist/apps/shared/mail/primaryMailbox.js +61 -0
- package/dist/apps/shared/mail/reportNotices.d.ts +21 -0
- package/dist/apps/shared/mail/reportNotices.js +47 -0
- package/dist/apps/shared/mail/senderBlocking.d.ts +26 -0
- package/dist/apps/shared/mail/senderBlocking.js +92 -0
- package/dist/apps/shared/mail/useCollapsedSections.d.ts +32 -0
- package/dist/apps/shared/mail/useCollapsedSections.js +110 -0
- package/dist/apps/shared/mail/useMailConnection.js +3 -1
- package/dist/apps/shared/mail/useMailboxUpdateAccess.d.ts +11 -0
- package/dist/apps/shared/mail/useMailboxUpdateAccess.js +52 -0
- package/dist/apps/shared/mail/usePermanentDelete.d.ts +35 -0
- package/dist/apps/shared/mail/usePermanentDelete.js +96 -0
- package/dist/apps/shared/navigation/frameContext.d.ts +1 -1
- package/dist/apps/shared/navigation/index.d.ts +16 -0
- package/dist/apps/shared/navigation/index.js +34 -0
- package/dist/apps/shared/navigation/pageTitle.d.ts +11 -0
- package/dist/apps/shared/navigation/pageTitle.js +12 -0
- package/dist/apps/shared/search/crossMailboxSearch.d.ts +72 -0
- package/dist/apps/shared/search/crossMailboxSearch.js +136 -0
- package/dist/apps/shared/styles/app.css +396 -386
- package/dist/apps/www/_shell.d.ts +26 -0
- package/dist/apps/www/_shell.js +31 -0
- package/dist/apps/www/calendar/index.d.ts +7 -2
- package/dist/apps/www/calendar/index.js +7 -4
- package/dist/apps/www/contacts/[uid].d.ts +14 -3
- package/dist/apps/www/contacts/[uid].js +5 -3
- package/dist/apps/www/contacts/index.d.ts +7 -2
- package/dist/apps/www/contacts/index.js +8 -4
- package/dist/apps/www/index.d.ts +7 -2
- package/dist/apps/www/index.js +542 -207
- package/dist/apps/www/messages/[uid].d.ts +14 -3
- package/dist/apps/www/messages/[uid].js +7 -5
- package/dist/apps/www/settings/appearance/index.d.ts +8 -2
- package/dist/apps/www/settings/appearance/index.js +4 -2
- package/dist/apps/www/settings/auto-reply/index.d.ts +7 -2
- package/dist/apps/www/settings/auto-reply/index.js +4 -2
- package/dist/apps/www/settings/blocked-senders/index.d.ts +9 -0
- package/dist/apps/www/settings/blocked-senders/index.js +134 -0
- package/dist/apps/www/settings/encryption/index.d.ts +7 -2
- package/dist/apps/www/settings/encryption/index.js +4 -2
- package/dist/apps/www/settings/filters/[uid].d.ts +7 -2
- package/dist/apps/www/settings/filters/[uid].js +4 -2
- package/dist/apps/www/settings/filters/index.d.ts +7 -2
- package/dist/apps/www/settings/filters/index.js +4 -2
- package/dist/apps/www/settings/filters/new/index.d.ts +7 -2
- package/dist/apps/www/settings/filters/new/index.js +28 -5
- package/dist/apps/www/settings/labels/index.d.ts +7 -2
- package/dist/apps/www/settings/labels/index.js +4 -2
- package/dist/apps/www/settings/privacy/index.d.ts +7 -2
- package/dist/apps/www/settings/privacy/index.js +4 -2
- package/dist/apps/www/settings/profile/index.d.ts +7 -2
- package/dist/apps/www/settings/profile/index.js +4 -2
- package/dist/apps/www/settings/read-receipts/index.d.ts +7 -2
- package/dist/apps/www/settings/read-receipts/index.js +4 -2
- package/dist/apps/www/settings/sharing/index.d.ts +7 -2
- package/dist/apps/www/settings/sharing/index.js +4 -2
- package/dist/apps/www/settings/signatures/[uid].d.ts +7 -2
- package/dist/apps/www/settings/signatures/[uid].js +4 -2
- package/dist/apps/www/settings/signatures/index.d.ts +7 -2
- package/dist/apps/www/settings/signatures/index.js +4 -2
- package/dist/apps/www/settings/signatures/new/index.d.ts +7 -2
- package/dist/apps/www/settings/signatures/new/index.js +5 -3
- package/dist/apps/www/tasks/index.d.ts +7 -2
- package/dist/apps/www/tasks/index.js +5 -3
- package/package.json +4 -2
- package/apps/shared/navigation/AppRouter.tsx +0 -300
- package/apps/shared/navigation/idle.ts +0 -45
- package/apps/shared/navigation/routerContext.tsx +0 -83
- package/apps/shared/navigation/routes.ts +0 -72
- package/apps/www/_routedPage.tsx +0 -24
- package/apps/www/_routes.ts +0 -37
- package/dist/apps/shared/navigation/AppRouter.d.ts +0 -52
- package/dist/apps/shared/navigation/AppRouter.js +0 -242
- package/dist/apps/shared/navigation/idle.d.ts +0 -14
- package/dist/apps/shared/navigation/idle.js +0 -43
- package/dist/apps/shared/navigation/routerContext.d.ts +0 -37
- package/dist/apps/shared/navigation/routerContext.js +0 -56
- package/dist/apps/shared/navigation/routes.d.ts +0 -32
- package/dist/apps/shared/navigation/routes.js +0 -37
- package/dist/apps/www/_routedPage.d.ts +0 -12
- package/dist/apps/www/_routedPage.js +0 -19
- package/dist/apps/www/_routes.d.ts +0 -11
- package/dist/apps/www/_routes.js +0 -31
|
@@ -1,62 +1,62 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import React, { PropsWithChildren, createContext, useContext, useEffect, useMemo, useState, useSyncExternalStore } from "react";
|
|
6
|
-
import { dispatchKeyEvent } from "./dispatch.js";
|
|
7
|
-
import { KeyEnvironment, SERVER_ENVIRONMENT, currentEnvironment } from "./platform.js";
|
|
8
|
-
import { Registration, ShortcutRegistry } from "./registry.js";
|
|
9
|
-
|
|
10
|
-
interface ShortcutContextValue {
|
|
11
|
-
registry: ShortcutRegistry;
|
|
12
|
-
env: KeyEnvironment;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
const ShortcutContext = createContext<ShortcutContextValue | null>(null);
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* The web client's one keyboard layer. Mounted once, by `AppChrome` (the frame that stays mounted as the router swaps pages), so shortcuts
|
|
19
|
-
* work in every view - mail, calendar, contacts, tasks, settings - and a page change only changes which handlers are registered.
|
|
20
|
-
*
|
|
21
|
-
* One `keydown` listener on `document` (bubbling, so what a widget handles itself and `preventDefault()`s is left alone) hands each key to
|
|
22
|
-
* `dispatchKeyEvent()`. Views claim keys with `useShortcut()`. Outside a provider - an admin page, a component rendered on its own - that
|
|
23
|
-
* hook does nothing.
|
|
24
|
-
*
|
|
25
|
-
* The platform (macOS, the desktop client) is read after mount, never during render, so the server render and hydration agree.
|
|
26
|
-
*/
|
|
27
|
-
export function ShortcutProvider({ children }: PropsWithChildren) {
|
|
28
|
-
const registry = useMemo(() => new ShortcutRegistry(), []);
|
|
29
|
-
const [env, setEnv] = useState<KeyEnvironment>(SERVER_ENVIRONMENT);
|
|
30
|
-
useEffect(() => {
|
|
31
|
-
setEnv(currentEnvironment());
|
|
32
|
-
}, []);
|
|
33
|
-
useEffect(() => {
|
|
34
|
-
function handleKeyDown(event: KeyboardEvent) {
|
|
35
|
-
dispatchKeyEvent(registry, event, currentEnvironment(), document);
|
|
36
|
-
}
|
|
37
|
-
document.addEventListener("keydown", handleKeyDown);
|
|
38
|
-
return () => document.removeEventListener("keydown", handleKeyDown);
|
|
39
|
-
}, [registry]);
|
|
40
|
-
const value = useMemo(() => ({ registry, env }), [registry, env]);
|
|
41
|
-
return <ShortcutContext.Provider value={value}>{children}</ShortcutContext.Provider>;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/** The registry, or `null` outside a `ShortcutProvider`. */
|
|
45
|
-
export function useShortcutRegistry(): ShortcutRegistry | null {
|
|
46
|
-
return useContext(ShortcutContext)?.registry ?? null;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
/** The platform as the keyboard layer sees it - `SERVER_ENVIRONMENT` until the client has mounted, and outside a provider. */
|
|
50
|
-
export function useKeyEnvironment(): KeyEnvironment {
|
|
51
|
-
return useContext(ShortcutContext)?.env ?? SERVER_ENVIRONMENT;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
const NO_REGISTRATIONS: readonly Registration[] = [];
|
|
55
|
-
const getNoRegistrations = () => NO_REGISTRATIONS;
|
|
56
|
-
const NEVER = () => () => undefined;
|
|
57
|
-
|
|
58
|
-
/** Everything registered right now, updating as views mount and unmount - what the help dialog lists. Empty outside a provider. */
|
|
59
|
-
export function useRegisteredShortcuts(): readonly Registration[] {
|
|
60
|
-
const registry = useShortcutRegistry();
|
|
61
|
-
return useSyncExternalStore(registry?.subscribe ?? NEVER, registry?.getSnapshot ?? getNoRegistrations, getNoRegistrations);
|
|
62
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import React, { PropsWithChildren, createContext, useContext, useEffect, useMemo, useState, useSyncExternalStore } from "react";
|
|
6
|
+
import { dispatchKeyEvent } from "./dispatch.js";
|
|
7
|
+
import { KeyEnvironment, SERVER_ENVIRONMENT, currentEnvironment } from "./platform.js";
|
|
8
|
+
import { Registration, ShortcutRegistry } from "./registry.js";
|
|
9
|
+
|
|
10
|
+
interface ShortcutContextValue {
|
|
11
|
+
registry: ShortcutRegistry;
|
|
12
|
+
env: KeyEnvironment;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
const ShortcutContext = createContext<ShortcutContextValue | null>(null);
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The web client's one keyboard layer. Mounted once, by `AppChrome` (the frame that stays mounted as the router swaps pages), so shortcuts
|
|
19
|
+
* work in every view - mail, calendar, contacts, tasks, settings - and a page change only changes which handlers are registered.
|
|
20
|
+
*
|
|
21
|
+
* One `keydown` listener on `document` (bubbling, so what a widget handles itself and `preventDefault()`s is left alone) hands each key to
|
|
22
|
+
* `dispatchKeyEvent()`. Views claim keys with `useShortcut()`. Outside a provider - an admin page, a component rendered on its own - that
|
|
23
|
+
* hook does nothing.
|
|
24
|
+
*
|
|
25
|
+
* The platform (macOS, the desktop client) is read after mount, never during render, so the server render and hydration agree.
|
|
26
|
+
*/
|
|
27
|
+
export function ShortcutProvider({ children }: PropsWithChildren) {
|
|
28
|
+
const registry = useMemo(() => new ShortcutRegistry(), []);
|
|
29
|
+
const [env, setEnv] = useState<KeyEnvironment>(SERVER_ENVIRONMENT);
|
|
30
|
+
useEffect(() => {
|
|
31
|
+
setEnv(currentEnvironment());
|
|
32
|
+
}, []);
|
|
33
|
+
useEffect(() => {
|
|
34
|
+
function handleKeyDown(event: KeyboardEvent) {
|
|
35
|
+
dispatchKeyEvent(registry, event, currentEnvironment(), document);
|
|
36
|
+
}
|
|
37
|
+
document.addEventListener("keydown", handleKeyDown);
|
|
38
|
+
return () => document.removeEventListener("keydown", handleKeyDown);
|
|
39
|
+
}, [registry]);
|
|
40
|
+
const value = useMemo(() => ({ registry, env }), [registry, env]);
|
|
41
|
+
return <ShortcutContext.Provider value={value}>{children}</ShortcutContext.Provider>;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** The registry, or `null` outside a `ShortcutProvider`. */
|
|
45
|
+
export function useShortcutRegistry(): ShortcutRegistry | null {
|
|
46
|
+
return useContext(ShortcutContext)?.registry ?? null;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/** The platform as the keyboard layer sees it - `SERVER_ENVIRONMENT` until the client has mounted, and outside a provider. */
|
|
50
|
+
export function useKeyEnvironment(): KeyEnvironment {
|
|
51
|
+
return useContext(ShortcutContext)?.env ?? SERVER_ENVIRONMENT;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const NO_REGISTRATIONS: readonly Registration[] = [];
|
|
55
|
+
const getNoRegistrations = () => NO_REGISTRATIONS;
|
|
56
|
+
const NEVER = () => () => undefined;
|
|
57
|
+
|
|
58
|
+
/** Everything registered right now, updating as views mount and unmount - what the help dialog lists. Empty outside a provider. */
|
|
59
|
+
export function useRegisteredShortcuts(): readonly Registration[] {
|
|
60
|
+
const registry = useShortcutRegistry();
|
|
61
|
+
return useSyncExternalStore(registry?.subscribe ?? NEVER, registry?.getSnapshot ?? getNoRegistrations, getNoRegistrations);
|
|
62
|
+
}
|
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import React from "react";
|
|
6
|
-
import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
|
|
7
|
-
import { formatSpec, specsFor } from "./format.js";
|
|
8
|
-
import { HELP_SCOPES, SCOPE_LABELS, SHORTCUTS, ShortcutDef, shortcutRank } from "./keymap.js";
|
|
9
|
-
import { useKeyEnvironment, useRegisteredShortcuts } from "./ShortcutProvider.js";
|
|
10
|
-
import { useShortcut } from "./useShortcut.js";
|
|
11
|
-
|
|
12
|
-
export interface ShortcutsDialogProps {
|
|
13
|
-
open: boolean;
|
|
14
|
-
onClose: () => void;
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
function Keys({ shortcut }: { shortcut: ShortcutDef }) {
|
|
18
|
-
const env = useKeyEnvironment();
|
|
19
|
-
return (
|
|
20
|
-
<span className="flex flex-wrap justify-end gap-x-1.5 gap-y-1 shrink-0">
|
|
21
|
-
{specsFor(shortcut, env).map((spec, index) => (
|
|
22
|
-
<React.Fragment key={spec}>
|
|
23
|
-
{index > 0 && <span className="text-xs text-text-muted self-center">or</span>}
|
|
24
|
-
<kbd className="px-1.5 py-0.5 rounded-sm border border-border bg-surface-alt text-xs font-sans font-semibold whitespace-nowrap">
|
|
25
|
-
{formatSpec(spec, env)}
|
|
26
|
-
</kbd>
|
|
27
|
-
</React.Fragment>
|
|
28
|
-
))}
|
|
29
|
-
</span>
|
|
30
|
-
);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* The keyboard shortcuts help dialog: what can be done from the keyboard *here*. It lists what is registered right now (see
|
|
35
|
-
* `useRegisteredShortcuts()`), so it shows the global shortcuts and those of the view that is on screen - and the compose window's while one
|
|
36
|
-
* is open - in groups, with the platform's own key names (Ctrl or Cmd, Alt or Option), and in the desktop client also the keys only it has.
|
|
37
|
-
* A shortcut a view cannot do at the moment (no message selected) is not registered, and so not listed.
|
|
38
|
-
*
|
|
39
|
-
* Built on `Modal`: focus moves into the dialog and stays there, Escape closes it, and it has an accessible name. `?` and Ctrl+/ close it too.
|
|
40
|
-
*/
|
|
41
|
-
export default function ShortcutsDialog({ open, onClose }: ShortcutsDialogProps) {
|
|
42
|
-
// Mounted only while open: the body subscribes to the registry, which every view's shortcuts change as it mounts - not something the
|
|
43
|
-
// whole app should re-render for while the dialog is closed.
|
|
44
|
-
return open ? <ShortcutsDialogBody onClose={onClose} /> : null;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
function ShortcutsDialogBody({ onClose }: { onClose: () => void }) {
|
|
48
|
-
const registrations = useRegisteredShortcuts();
|
|
49
|
-
useShortcut(SHORTCUTS.global.help, onClose, { scope: "dialog" });
|
|
50
|
-
const groups = HELP_SCOPES.map((scope) => {
|
|
51
|
-
const listed = new Map<string, ShortcutDef>();
|
|
52
|
-
for (const registration of registrations) {
|
|
53
|
-
if (registration.scope === scope) {
|
|
54
|
-
listed.set(registration.shortcut.id, registration.shortcut);
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
return { scope, shortcuts: [...listed.values()].sort((a, b) => shortcutRank(a) - shortcutRank(b)) };
|
|
58
|
-
}).filter((group) => group.shortcuts.length > 0);
|
|
59
|
-
|
|
60
|
-
return (
|
|
61
|
-
<Modal open onClose={onClose} title="Keyboard shortcuts">
|
|
62
|
-
<div className="flex flex-col gap-5">
|
|
63
|
-
{groups.map(({ scope, shortcuts }) => (
|
|
64
|
-
<section key={scope} aria-labelledby={`shortcuts-${scope}`}>
|
|
65
|
-
<h3 id={`shortcuts-${scope}`} className="text-xs font-bold uppercase tracking-wide text-text-muted mb-2">
|
|
66
|
-
{SCOPE_LABELS[scope]}
|
|
67
|
-
</h3>
|
|
68
|
-
<ul className="flex flex-col gap-1.5">
|
|
69
|
-
{shortcuts.map((shortcut) => (
|
|
70
|
-
<li key={shortcut.id} className="flex items-start justify-between gap-4 text-sm">
|
|
71
|
-
<span>{shortcut.label}</span>
|
|
72
|
-
<Keys shortcut={shortcut} />
|
|
73
|
-
</li>
|
|
74
|
-
))}
|
|
75
|
-
</ul>
|
|
76
|
-
</section>
|
|
77
|
-
))}
|
|
78
|
-
<p className="text-xs text-text-muted border-t border-border pt-3">
|
|
79
|
-
Some browsers keep a few keys for themselves, so a shortcut may not work everywhere.
|
|
80
|
-
</p>
|
|
81
|
-
</div>
|
|
82
|
-
</Modal>
|
|
83
|
-
);
|
|
84
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import React from "react";
|
|
6
|
+
import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
|
|
7
|
+
import { formatSpec, specsFor } from "./format.js";
|
|
8
|
+
import { HELP_SCOPES, SCOPE_LABELS, SHORTCUTS, ShortcutDef, shortcutRank } from "./keymap.js";
|
|
9
|
+
import { useKeyEnvironment, useRegisteredShortcuts } from "./ShortcutProvider.js";
|
|
10
|
+
import { useShortcut } from "./useShortcut.js";
|
|
11
|
+
|
|
12
|
+
export interface ShortcutsDialogProps {
|
|
13
|
+
open: boolean;
|
|
14
|
+
onClose: () => void;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function Keys({ shortcut }: { shortcut: ShortcutDef }) {
|
|
18
|
+
const env = useKeyEnvironment();
|
|
19
|
+
return (
|
|
20
|
+
<span className="flex flex-wrap justify-end gap-x-1.5 gap-y-1 shrink-0">
|
|
21
|
+
{specsFor(shortcut, env).map((spec, index) => (
|
|
22
|
+
<React.Fragment key={spec}>
|
|
23
|
+
{index > 0 && <span className="text-xs text-text-muted self-center">or</span>}
|
|
24
|
+
<kbd className="px-1.5 py-0.5 rounded-sm border border-border bg-surface-alt text-xs font-sans font-semibold whitespace-nowrap">
|
|
25
|
+
{formatSpec(spec, env)}
|
|
26
|
+
</kbd>
|
|
27
|
+
</React.Fragment>
|
|
28
|
+
))}
|
|
29
|
+
</span>
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* The keyboard shortcuts help dialog: what can be done from the keyboard *here*. It lists what is registered right now (see
|
|
35
|
+
* `useRegisteredShortcuts()`), so it shows the global shortcuts and those of the view that is on screen - and the compose window's while one
|
|
36
|
+
* is open - in groups, with the platform's own key names (Ctrl or Cmd, Alt or Option), and in the desktop client also the keys only it has.
|
|
37
|
+
* A shortcut a view cannot do at the moment (no message selected) is not registered, and so not listed.
|
|
38
|
+
*
|
|
39
|
+
* Built on `Modal`: focus moves into the dialog and stays there, Escape closes it, and it has an accessible name. `?` and Ctrl+/ close it too.
|
|
40
|
+
*/
|
|
41
|
+
export default function ShortcutsDialog({ open, onClose }: ShortcutsDialogProps) {
|
|
42
|
+
// Mounted only while open: the body subscribes to the registry, which every view's shortcuts change as it mounts - not something the
|
|
43
|
+
// whole app should re-render for while the dialog is closed.
|
|
44
|
+
return open ? <ShortcutsDialogBody onClose={onClose} /> : null;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
function ShortcutsDialogBody({ onClose }: { onClose: () => void }) {
|
|
48
|
+
const registrations = useRegisteredShortcuts();
|
|
49
|
+
useShortcut(SHORTCUTS.global.help, onClose, { scope: "dialog" });
|
|
50
|
+
const groups = HELP_SCOPES.map((scope) => {
|
|
51
|
+
const listed = new Map<string, ShortcutDef>();
|
|
52
|
+
for (const registration of registrations) {
|
|
53
|
+
if (registration.scope === scope) {
|
|
54
|
+
listed.set(registration.shortcut.id, registration.shortcut);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
return { scope, shortcuts: [...listed.values()].sort((a, b) => shortcutRank(a) - shortcutRank(b)) };
|
|
58
|
+
}).filter((group) => group.shortcuts.length > 0);
|
|
59
|
+
|
|
60
|
+
return (
|
|
61
|
+
<Modal open onClose={onClose} title="Keyboard shortcuts">
|
|
62
|
+
<div className="flex flex-col gap-5">
|
|
63
|
+
{groups.map(({ scope, shortcuts }) => (
|
|
64
|
+
<section key={scope} aria-labelledby={`shortcuts-${scope}`}>
|
|
65
|
+
<h3 id={`shortcuts-${scope}`} className="text-xs font-bold uppercase tracking-wide text-text-muted mb-2">
|
|
66
|
+
{SCOPE_LABELS[scope]}
|
|
67
|
+
</h3>
|
|
68
|
+
<ul className="flex flex-col gap-1.5">
|
|
69
|
+
{shortcuts.map((shortcut) => (
|
|
70
|
+
<li key={shortcut.id} className="flex items-start justify-between gap-4 text-sm">
|
|
71
|
+
<span>{shortcut.label}</span>
|
|
72
|
+
<Keys shortcut={shortcut} />
|
|
73
|
+
</li>
|
|
74
|
+
))}
|
|
75
|
+
</ul>
|
|
76
|
+
</section>
|
|
77
|
+
))}
|
|
78
|
+
<p className="text-xs text-text-muted border-t border-border pt-3">
|
|
79
|
+
Some browsers keep a few keys for themselves, so a shortcut may not work everywhere.
|
|
80
|
+
</p>
|
|
81
|
+
</div>
|
|
82
|
+
</Modal>
|
|
83
|
+
);
|
|
84
|
+
}
|
|
@@ -1,124 +1,124 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import type { ShortcutScope } from "./keymap.js";
|
|
6
|
-
import { matchesEvent } from "./match.js";
|
|
7
|
-
import { ParsedSpec, resolveModifiers } from "./parse.js";
|
|
8
|
-
import type { KeyEnvironment } from "./platform.js";
|
|
9
|
-
import type { Registration, ShortcutRegistry } from "./registry.js";
|
|
10
|
-
import { isActivatable, isInPopoverDialog, isInWidget, isModalOpen, isPopupOpenAt, isTextEntry, regionScopeOf } from "./targets.js";
|
|
11
|
-
|
|
12
|
-
/** The keys of the four view scopes: only the mounted view has registrations, so precedence among them is moot. */
|
|
13
|
-
const VIEW_SCOPES: readonly ShortcutScope[] = ["mail", "calendar", "contacts", "tasks"];
|
|
14
|
-
|
|
15
|
-
/** Keys that move the caret or delete text, which a text field owns even with Ctrl or Alt held (word jumps, delete-word). */
|
|
16
|
-
const EDITING_KEYS = new Set(["arrowup", "arrowdown", "arrowleft", "arrowright", "home", "end", "pageup", "pagedown", "backspace", "delete"]);
|
|
17
|
-
|
|
18
|
-
/** The Copy / Cut / Paste / Select all / Undo / Redo / Find chords: never a shortcut, anywhere - they act on the page's selection, not on a view. */
|
|
19
|
-
function isReservedChord(parsed: ParsedSpec, env: KeyEnvironment): boolean {
|
|
20
|
-
const modifiers = resolveModifiers(parsed, env);
|
|
21
|
-
return (modifiers.ctrl || modifiers.meta) && !modifiers.alt && !modifiers.shift && ["a", "c", "v", "x", "z", "y", "f"].includes(parsed.key);
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
/** Paste as plain text (Ctrl+Shift+V) and Redo (Ctrl+Shift+Z): text-editing chords in a field, free everywhere else (Ctrl+Shift+V is Move to). */
|
|
25
|
-
function isShiftedEditingChord(parsed: ParsedSpec, env: KeyEnvironment): boolean {
|
|
26
|
-
const modifiers = resolveModifiers(parsed, env);
|
|
27
|
-
return (modifiers.ctrl || modifiers.meta) && !modifiers.alt && modifiers.shift && ["z", "v"].includes(parsed.key);
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* Whether `parsed` may fire with the event on this target.
|
|
32
|
-
*
|
|
33
|
-
* A text field (input, textarea, select, contenteditable - the rich-text editor) keeps everything that types or edits: bare keys
|
|
34
|
-
* (`j`, `?`, Delete), the caret keys with any modifier, and paste-as-plain-text and redo. A chord with Ctrl/Cmd/Alt works from one (that is how Ctrl+Enter sends from
|
|
35
|
-
* the body), except that Option on a Mac and Ctrl+Alt (AltGr) elsewhere type characters, so those don't. Escape works from a field unless a
|
|
36
|
-
* popup it owns is open (or it is in a popover dialog of its own). Outside a field, a bare key still isn't taken from a widget that reads keys itself (an open menu, a list box), and
|
|
37
|
-
* Enter/Space are left to the button or link that has the focus - unless the shortcut asked for them.
|
|
38
|
-
*/
|
|
39
|
-
function allowedOnTarget(registration: Registration, parsed: ParsedSpec, target: EventTarget | null, env: KeyEnvironment): boolean {
|
|
40
|
-
const modifiers = resolveModifiers(parsed, env);
|
|
41
|
-
const command = modifiers.ctrl || modifiers.meta || modifiers.alt;
|
|
42
|
-
if (parsed.key === "escape" && (isPopupOpenAt(target) || isInPopoverDialog(target))) {
|
|
43
|
-
return false;
|
|
44
|
-
}
|
|
45
|
-
if (isTextEntry(target)) {
|
|
46
|
-
if (parsed.key === "escape") {
|
|
47
|
-
return true;
|
|
48
|
-
}
|
|
49
|
-
if (!command || EDITING_KEYS.has(parsed.key) || isShiftedEditingChord(parsed, env)) {
|
|
50
|
-
return false;
|
|
51
|
-
}
|
|
52
|
-
return !(modifiers.alt && !modifiers.meta && (env.mac || modifiers.ctrl));
|
|
53
|
-
}
|
|
54
|
-
if (!command) {
|
|
55
|
-
if (isInWidget(target)) {
|
|
56
|
-
return false;
|
|
57
|
-
}
|
|
58
|
-
if ((parsed.key === "enter" || parsed.key === " ") && !registration.shortcut.allowOnActivatable && isActivatable(target)) {
|
|
59
|
-
return false;
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
return true;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
/** The scopes that may act on this event, highest precedence first. */
|
|
66
|
-
function activeScopes(event: KeyboardEvent, doc: Document): readonly ShortcutScope[] {
|
|
67
|
-
if (isModalOpen(doc)) {
|
|
68
|
-
return ["dialog"];
|
|
69
|
-
}
|
|
70
|
-
if (regionScopeOf(event.target) === "compose") {
|
|
71
|
-
return ["compose", "global"];
|
|
72
|
-
}
|
|
73
|
-
return [...VIEW_SCOPES, "global"];
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
/** Whether the registration applies to where the event happened (a compose window's shortcuts only inside it). */
|
|
77
|
-
function inContainer(registration: Registration, event: KeyboardEvent): boolean {
|
|
78
|
-
if (!registration.container) {
|
|
79
|
-
return true;
|
|
80
|
-
}
|
|
81
|
-
return !!registration.container.current?.contains(event.target as Node | null);
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Handles one `keydown`: finds the registered shortcut it is, and runs its handler. Returns whether a handler ran - and only then is the
|
|
86
|
-
* event's default prevented and its propagation stopped, so a key nobody claims (or a handler that declines) behaves exactly as if this layer
|
|
87
|
-
* did not exist.
|
|
88
|
-
*
|
|
89
|
-
* Skipped outright: an event some other handler already `defaultPrevented` (a menu, the rich-text editor's own bindings), one from an IME
|
|
90
|
-
* composition, a bare modifier key, and the Copy/Cut/Paste/Select all/Undo/Redo/Find chords. A held key repeats: an action that is not
|
|
91
|
-
* marked `repeat` runs on the first press only, and the repeats are swallowed (so a browser doesn't reload on a held Ctrl+R) without running it.
|
|
92
|
-
*
|
|
93
|
-
* Which registration wins: the dialog scope alone while a modal is open; else, inside a compose window, `compose` then `global`; else
|
|
94
|
-
* whichever view is mounted, then `global`. Within a scope the most recently mounted registration goes first, and one that returns
|
|
95
|
-
* `false` passes the key on to the next.
|
|
96
|
-
*/
|
|
97
|
-
export function dispatchKeyEvent(registry: ShortcutRegistry, event: KeyboardEvent, env: KeyEnvironment, doc: Document): boolean {
|
|
98
|
-
if (event.defaultPrevented || event.isComposing || event.key === "Process" || ["Control", "Shift", "Alt", "Meta"].includes(event.key)) {
|
|
99
|
-
return false;
|
|
100
|
-
}
|
|
101
|
-
const scopes = activeScopes(event, doc);
|
|
102
|
-
const candidates = registry
|
|
103
|
-
.getSnapshot()
|
|
104
|
-
.filter((registration) => scopes.includes(registration.scope) && inContainer(registration, event))
|
|
105
|
-
.sort((a, b) => scopes.indexOf(a.scope) - scopes.indexOf(b.scope) || b.order - a.order);
|
|
106
|
-
for (const registration of candidates) {
|
|
107
|
-
const specs = env.electron ? [...registration.keys, ...registration.electronKeys] : registration.keys;
|
|
108
|
-
const parsed = specs.find((spec) => matchesEvent(spec, event, env));
|
|
109
|
-
if (!parsed || isReservedChord(parsed, env) || !allowedOnTarget(registration, parsed, event.target, env)) {
|
|
110
|
-
continue;
|
|
111
|
-
}
|
|
112
|
-
if (event.repeat && !registration.shortcut.repeat) {
|
|
113
|
-
event.preventDefault();
|
|
114
|
-
event.stopPropagation();
|
|
115
|
-
return true;
|
|
116
|
-
}
|
|
117
|
-
if (registration.run(event) !== false) {
|
|
118
|
-
event.preventDefault();
|
|
119
|
-
event.stopPropagation();
|
|
120
|
-
return true;
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
return false;
|
|
124
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import type { ShortcutScope } from "./keymap.js";
|
|
6
|
+
import { matchesEvent } from "./match.js";
|
|
7
|
+
import { ParsedSpec, resolveModifiers } from "./parse.js";
|
|
8
|
+
import type { KeyEnvironment } from "./platform.js";
|
|
9
|
+
import type { Registration, ShortcutRegistry } from "./registry.js";
|
|
10
|
+
import { isActivatable, isInPopoverDialog, isInWidget, isModalOpen, isPopupOpenAt, isTextEntry, regionScopeOf } from "./targets.js";
|
|
11
|
+
|
|
12
|
+
/** The keys of the four view scopes: only the mounted view has registrations, so precedence among them is moot. */
|
|
13
|
+
const VIEW_SCOPES: readonly ShortcutScope[] = ["mail", "calendar", "contacts", "tasks"];
|
|
14
|
+
|
|
15
|
+
/** Keys that move the caret or delete text, which a text field owns even with Ctrl or Alt held (word jumps, delete-word). */
|
|
16
|
+
const EDITING_KEYS = new Set(["arrowup", "arrowdown", "arrowleft", "arrowright", "home", "end", "pageup", "pagedown", "backspace", "delete"]);
|
|
17
|
+
|
|
18
|
+
/** The Copy / Cut / Paste / Select all / Undo / Redo / Find chords: never a shortcut, anywhere - they act on the page's selection, not on a view. */
|
|
19
|
+
function isReservedChord(parsed: ParsedSpec, env: KeyEnvironment): boolean {
|
|
20
|
+
const modifiers = resolveModifiers(parsed, env);
|
|
21
|
+
return (modifiers.ctrl || modifiers.meta) && !modifiers.alt && !modifiers.shift && ["a", "c", "v", "x", "z", "y", "f"].includes(parsed.key);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** Paste as plain text (Ctrl+Shift+V) and Redo (Ctrl+Shift+Z): text-editing chords in a field, free everywhere else (Ctrl+Shift+V is Move to). */
|
|
25
|
+
function isShiftedEditingChord(parsed: ParsedSpec, env: KeyEnvironment): boolean {
|
|
26
|
+
const modifiers = resolveModifiers(parsed, env);
|
|
27
|
+
return (modifiers.ctrl || modifiers.meta) && !modifiers.alt && modifiers.shift && ["z", "v"].includes(parsed.key);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Whether `parsed` may fire with the event on this target.
|
|
32
|
+
*
|
|
33
|
+
* A text field (input, textarea, select, contenteditable - the rich-text editor) keeps everything that types or edits: bare keys
|
|
34
|
+
* (`j`, `?`, Delete), the caret keys with any modifier, and paste-as-plain-text and redo. A chord with Ctrl/Cmd/Alt works from one (that is how Ctrl+Enter sends from
|
|
35
|
+
* the body), except that Option on a Mac and Ctrl+Alt (AltGr) elsewhere type characters, so those don't. Escape works from a field unless a
|
|
36
|
+
* popup it owns is open (or it is in a popover dialog of its own). Outside a field, a bare key still isn't taken from a widget that reads keys itself (an open menu, a list box), and
|
|
37
|
+
* Enter/Space are left to the button or link that has the focus - unless the shortcut asked for them.
|
|
38
|
+
*/
|
|
39
|
+
function allowedOnTarget(registration: Registration, parsed: ParsedSpec, target: EventTarget | null, env: KeyEnvironment): boolean {
|
|
40
|
+
const modifiers = resolveModifiers(parsed, env);
|
|
41
|
+
const command = modifiers.ctrl || modifiers.meta || modifiers.alt;
|
|
42
|
+
if (parsed.key === "escape" && (isPopupOpenAt(target) || isInPopoverDialog(target))) {
|
|
43
|
+
return false;
|
|
44
|
+
}
|
|
45
|
+
if (isTextEntry(target)) {
|
|
46
|
+
if (parsed.key === "escape") {
|
|
47
|
+
return true;
|
|
48
|
+
}
|
|
49
|
+
if (!command || EDITING_KEYS.has(parsed.key) || isShiftedEditingChord(parsed, env)) {
|
|
50
|
+
return false;
|
|
51
|
+
}
|
|
52
|
+
return !(modifiers.alt && !modifiers.meta && (env.mac || modifiers.ctrl));
|
|
53
|
+
}
|
|
54
|
+
if (!command) {
|
|
55
|
+
if (isInWidget(target)) {
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
if ((parsed.key === "enter" || parsed.key === " ") && !registration.shortcut.allowOnActivatable && isActivatable(target)) {
|
|
59
|
+
return false;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
return true;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/** The scopes that may act on this event, highest precedence first. */
|
|
66
|
+
function activeScopes(event: KeyboardEvent, doc: Document): readonly ShortcutScope[] {
|
|
67
|
+
if (isModalOpen(doc)) {
|
|
68
|
+
return ["dialog"];
|
|
69
|
+
}
|
|
70
|
+
if (regionScopeOf(event.target) === "compose") {
|
|
71
|
+
return ["compose", "global"];
|
|
72
|
+
}
|
|
73
|
+
return [...VIEW_SCOPES, "global"];
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/** Whether the registration applies to where the event happened (a compose window's shortcuts only inside it). */
|
|
77
|
+
function inContainer(registration: Registration, event: KeyboardEvent): boolean {
|
|
78
|
+
if (!registration.container) {
|
|
79
|
+
return true;
|
|
80
|
+
}
|
|
81
|
+
return !!registration.container.current?.contains(event.target as Node | null);
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Handles one `keydown`: finds the registered shortcut it is, and runs its handler. Returns whether a handler ran - and only then is the
|
|
86
|
+
* event's default prevented and its propagation stopped, so a key nobody claims (or a handler that declines) behaves exactly as if this layer
|
|
87
|
+
* did not exist.
|
|
88
|
+
*
|
|
89
|
+
* Skipped outright: an event some other handler already `defaultPrevented` (a menu, the rich-text editor's own bindings), one from an IME
|
|
90
|
+
* composition, a bare modifier key, and the Copy/Cut/Paste/Select all/Undo/Redo/Find chords. A held key repeats: an action that is not
|
|
91
|
+
* marked `repeat` runs on the first press only, and the repeats are swallowed (so a browser doesn't reload on a held Ctrl+R) without running it.
|
|
92
|
+
*
|
|
93
|
+
* Which registration wins: the dialog scope alone while a modal is open; else, inside a compose window, `compose` then `global`; else
|
|
94
|
+
* whichever view is mounted, then `global`. Within a scope the most recently mounted registration goes first, and one that returns
|
|
95
|
+
* `false` passes the key on to the next.
|
|
96
|
+
*/
|
|
97
|
+
export function dispatchKeyEvent(registry: ShortcutRegistry, event: KeyboardEvent, env: KeyEnvironment, doc: Document): boolean {
|
|
98
|
+
if (event.defaultPrevented || event.isComposing || event.key === "Process" || ["Control", "Shift", "Alt", "Meta"].includes(event.key)) {
|
|
99
|
+
return false;
|
|
100
|
+
}
|
|
101
|
+
const scopes = activeScopes(event, doc);
|
|
102
|
+
const candidates = registry
|
|
103
|
+
.getSnapshot()
|
|
104
|
+
.filter((registration) => scopes.includes(registration.scope) && inContainer(registration, event))
|
|
105
|
+
.sort((a, b) => scopes.indexOf(a.scope) - scopes.indexOf(b.scope) || b.order - a.order);
|
|
106
|
+
for (const registration of candidates) {
|
|
107
|
+
const specs = env.electron ? [...registration.keys, ...registration.electronKeys] : registration.keys;
|
|
108
|
+
const parsed = specs.find((spec) => matchesEvent(spec, event, env));
|
|
109
|
+
if (!parsed || isReservedChord(parsed, env) || !allowedOnTarget(registration, parsed, event.target, env)) {
|
|
110
|
+
continue;
|
|
111
|
+
}
|
|
112
|
+
if (event.repeat && !registration.shortcut.repeat) {
|
|
113
|
+
event.preventDefault();
|
|
114
|
+
event.stopPropagation();
|
|
115
|
+
return true;
|
|
116
|
+
}
|
|
117
|
+
if (registration.run(event) !== false) {
|
|
118
|
+
event.preventDefault();
|
|
119
|
+
event.stopPropagation();
|
|
120
|
+
return true;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
return false;
|
|
124
|
+
}
|