@rapidmx/web-client 0.15.1 → 0.16.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 +373 -373
- package/apps/admin/branding/index.tsx +39 -39
- package/apps/admin/data-requests/index.tsx +482 -480
- package/apps/admin/domains/[uid].tsx +164 -164
- package/apps/admin/escrow-scopes/[uid].tsx +348 -348
- package/apps/admin/index.tsx +127 -124
- package/apps/admin/mailboxes/[uid].tsx +269 -224
- package/apps/admin/mailboxes/new/index.tsx +28 -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/escrow/audit-log/index.tsx +196 -196
- package/apps/escrow/matters/[uid].tsx +621 -621
- package/apps/shared/auth/adminAccess.ts +99 -99
- package/apps/shared/components/admin/layout/AdminShell.tsx +378 -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 +444 -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 +217 -216
- package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
- package/apps/shared/components/layout/AppShell.tsx +480 -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 +612 -491
- package/apps/shared/components/mail/MailSelectionBar.tsx +236 -227
- package/apps/shared/components/mail/MessageDetailPane.tsx +1559 -1559
- 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 +137 -113
- package/apps/shared/components/mail/layout/SidebarSection.tsx +66 -0
- package/apps/shared/components/mail/reading/PendingMessageCard.tsx +68 -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 +255 -254
- package/apps/shared/components/tasks/TasksSidebar.tsx +1 -1
- package/apps/shared/components/tasks/layout/TasksShell.tsx +218 -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/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/primaryMailbox.ts +71 -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/useMarkMessageRead.ts +47 -47
- package/apps/shared/mail/useNewMailNotifications.ts +178 -178
- package/apps/shared/navigation/AppRouter.tsx +300 -300
- package/apps/shared/navigation/routerContext.tsx +83 -83
- 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/calendar/index.tsx +578 -571
- package/apps/www/contacts/[uid].tsx +109 -109
- package/apps/www/contacts/index.tsx +6 -0
- package/apps/www/index.tsx +2847 -2479
- package/apps/www/messages/[uid].tsx +135 -135
- package/apps/www/settings/auto-reply/index.tsx +133 -133
- package/apps/www/settings/encryption/index.tsx +1287 -1287
- package/apps/www/settings/filters/[uid].tsx +176 -176
- package/apps/www/settings/filters/index.tsx +102 -102
- package/apps/www/settings/filters/new/index.tsx +140 -140
- package/apps/www/settings/labels/index.tsx +204 -204
- package/apps/www/settings/privacy/index.tsx +492 -492
- package/apps/www/settings/profile/index.tsx +248 -248
- package/apps/www/settings/read-receipts/index.tsx +147 -147
- package/apps/www/settings/sharing/index.tsx +256 -256
- package/apps/www/settings/signatures/[uid].tsx +172 -172
- package/apps/www/settings/signatures/index.tsx +88 -88
- package/apps/www/settings/signatures/new/index.tsx +135 -135
- package/apps/www/tasks/index.tsx +649 -649
- package/dist/apps/admin/data-requests/index.js +1 -1
- package/dist/apps/admin/index.js +2 -1
- package/dist/apps/admin/mailboxes/[uid].js +12 -2
- package/dist/apps/shared/components/admin/layout/AdminShell.js +2 -2
- 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/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 +3 -2
- 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 +4 -3
- 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/MailSelectionBar.d.ts +6 -1
- package/dist/apps/shared/components/mail/MailSelectionBar.js +3 -3
- 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 +5 -0
- package/dist/apps/shared/components/mail/layout/MailShell.js +64 -45
- 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/PendingMessageCard.d.ts +14 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.js +16 -0
- package/dist/apps/shared/components/settings/layout/SettingsShell.js +6 -5
- package/dist/apps/shared/components/tasks/TasksSidebar.js +1 -1
- package/dist/apps/shared/components/tasks/layout/TasksShell.js +4 -3
- package/dist/apps/shared/mail/folderCounts.d.ts +10 -0
- package/dist/apps/shared/mail/folderCounts.js +12 -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/primaryMailbox.d.ts +29 -0
- package/dist/apps/shared/mail/primaryMailbox.js +61 -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/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/calendar/index.js +3 -2
- package/dist/apps/www/contacts/index.js +3 -1
- package/dist/apps/www/index.js +426 -189
- package/package.json +2 -2
|
@@ -1,89 +1,89 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import type { ShortcutDef } from "./keymap.js";
|
|
6
|
-
import { parseSpec, resolveModifiers } from "./parse.js";
|
|
7
|
-
import type { KeyEnvironment } from "./platform.js";
|
|
8
|
-
|
|
9
|
-
const KEY_NAMES: Record<string, string> = {
|
|
10
|
-
escape: "Esc",
|
|
11
|
-
enter: "Enter",
|
|
12
|
-
tab: "Tab",
|
|
13
|
-
backspace: "Backspace",
|
|
14
|
-
delete: "Delete",
|
|
15
|
-
insert: "Insert",
|
|
16
|
-
home: "Home",
|
|
17
|
-
end: "End",
|
|
18
|
-
pageup: "Page Up",
|
|
19
|
-
pagedown: "Page Down",
|
|
20
|
-
arrowup: "↑",
|
|
21
|
-
arrowdown: "↓",
|
|
22
|
-
arrowleft: "←",
|
|
23
|
-
arrowright: "→",
|
|
24
|
-
" ": "Space",
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
const MAC_KEY_NAMES: Record<string, string> = { ...KEY_NAMES, enter: "↩", backspace: "⌫", delete: "⌦" };
|
|
28
|
-
|
|
29
|
-
/** The key as it is printed on a key cap: `R`, `F5`, `Enter`, an arrow. */
|
|
30
|
-
function keyLabel(key: string, mac: boolean): string {
|
|
31
|
-
return (mac ? MAC_KEY_NAMES : KEY_NAMES)[key] ?? key.toUpperCase();
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
/** A spec as a person reads it: `Ctrl+Shift+R`, or `⌃⇧R`-style glyphs on a Mac (`⌘` for Cmd, `⌥` for Option). */
|
|
35
|
-
export function formatSpec(spec: string, env: KeyEnvironment): string {
|
|
36
|
-
const parsed = parseSpec(spec);
|
|
37
|
-
const modifiers = resolveModifiers(parsed, env);
|
|
38
|
-
if (env.mac) {
|
|
39
|
-
return [modifiers.ctrl && "⌃", modifiers.alt && "⌥", modifiers.shift && "⇧", modifiers.meta && "⌘", keyLabel(parsed.key, true)]
|
|
40
|
-
.filter(Boolean)
|
|
41
|
-
.join("");
|
|
42
|
-
}
|
|
43
|
-
return [modifiers.ctrl && "Ctrl", modifiers.shift && "Shift", modifiers.alt && "Alt", modifiers.meta && "Meta", keyLabel(parsed.key, false)]
|
|
44
|
-
.filter(Boolean)
|
|
45
|
-
.join("+");
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
const ARIA_NAMED_KEYS: Record<string, string> = {
|
|
49
|
-
escape: "Escape",
|
|
50
|
-
enter: "Enter",
|
|
51
|
-
tab: "Tab",
|
|
52
|
-
backspace: "Backspace",
|
|
53
|
-
delete: "Delete",
|
|
54
|
-
insert: "Insert",
|
|
55
|
-
home: "Home",
|
|
56
|
-
end: "End",
|
|
57
|
-
pageup: "PageUp",
|
|
58
|
-
pagedown: "PageDown",
|
|
59
|
-
arrowup: "ArrowUp",
|
|
60
|
-
arrowdown: "ArrowDown",
|
|
61
|
-
arrowleft: "ArrowLeft",
|
|
62
|
-
arrowright: "ArrowRight",
|
|
63
|
-
" ": "Space",
|
|
64
|
-
};
|
|
65
|
-
|
|
66
|
-
/** A spec in `aria-keyshortcuts` syntax: `Control+Shift+R`, `Meta+R`. */
|
|
67
|
-
export function ariaSpec(spec: string, env: KeyEnvironment): string {
|
|
68
|
-
const parsed = parseSpec(spec);
|
|
69
|
-
const modifiers = resolveModifiers(parsed, env);
|
|
70
|
-
const key = ARIA_NAMED_KEYS[parsed.key] ?? parsed.key.toUpperCase();
|
|
71
|
-
return [modifiers.ctrl && "Control", modifiers.alt && "Alt", modifiers.shift && "Shift", modifiers.meta && "Meta", key].filter(Boolean).join("+");
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
/** Every spec that triggers a shortcut here: its keys, and in the desktop client also its desktop-only ones. */
|
|
75
|
-
export function specsFor(shortcut: ShortcutDef, env: KeyEnvironment): string[] {
|
|
76
|
-
return env.electron && shortcut.electronKeys ? [...shortcut.keys, ...shortcut.electronKeys] : [...shortcut.keys];
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
/** The `aria-keyshortcuts` value for a control that runs a shortcut: every alternative, space separated. */
|
|
80
|
-
export function ariaKeyShortcuts(shortcut: ShortcutDef, env: KeyEnvironment): string {
|
|
81
|
-
return specsFor(shortcut, env)
|
|
82
|
-
.map((spec) => ariaSpec(spec, env))
|
|
83
|
-
.join(" ");
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
/** A tooltip/name suffix such as `Reply (Ctrl+R)`: the label with the shortcut's first key. */
|
|
87
|
-
export function withHint(label: string, shortcut: ShortcutDef, env: KeyEnvironment): string {
|
|
88
|
-
return `${label} (${formatSpec(shortcut.keys[0], env)})`;
|
|
89
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import type { ShortcutDef } from "./keymap.js";
|
|
6
|
+
import { parseSpec, resolveModifiers } from "./parse.js";
|
|
7
|
+
import type { KeyEnvironment } from "./platform.js";
|
|
8
|
+
|
|
9
|
+
const KEY_NAMES: Record<string, string> = {
|
|
10
|
+
escape: "Esc",
|
|
11
|
+
enter: "Enter",
|
|
12
|
+
tab: "Tab",
|
|
13
|
+
backspace: "Backspace",
|
|
14
|
+
delete: "Delete",
|
|
15
|
+
insert: "Insert",
|
|
16
|
+
home: "Home",
|
|
17
|
+
end: "End",
|
|
18
|
+
pageup: "Page Up",
|
|
19
|
+
pagedown: "Page Down",
|
|
20
|
+
arrowup: "↑",
|
|
21
|
+
arrowdown: "↓",
|
|
22
|
+
arrowleft: "←",
|
|
23
|
+
arrowright: "→",
|
|
24
|
+
" ": "Space",
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
const MAC_KEY_NAMES: Record<string, string> = { ...KEY_NAMES, enter: "↩", backspace: "⌫", delete: "⌦" };
|
|
28
|
+
|
|
29
|
+
/** The key as it is printed on a key cap: `R`, `F5`, `Enter`, an arrow. */
|
|
30
|
+
function keyLabel(key: string, mac: boolean): string {
|
|
31
|
+
return (mac ? MAC_KEY_NAMES : KEY_NAMES)[key] ?? key.toUpperCase();
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** A spec as a person reads it: `Ctrl+Shift+R`, or `⌃⇧R`-style glyphs on a Mac (`⌘` for Cmd, `⌥` for Option). */
|
|
35
|
+
export function formatSpec(spec: string, env: KeyEnvironment): string {
|
|
36
|
+
const parsed = parseSpec(spec);
|
|
37
|
+
const modifiers = resolveModifiers(parsed, env);
|
|
38
|
+
if (env.mac) {
|
|
39
|
+
return [modifiers.ctrl && "⌃", modifiers.alt && "⌥", modifiers.shift && "⇧", modifiers.meta && "⌘", keyLabel(parsed.key, true)]
|
|
40
|
+
.filter(Boolean)
|
|
41
|
+
.join("");
|
|
42
|
+
}
|
|
43
|
+
return [modifiers.ctrl && "Ctrl", modifiers.shift && "Shift", modifiers.alt && "Alt", modifiers.meta && "Meta", keyLabel(parsed.key, false)]
|
|
44
|
+
.filter(Boolean)
|
|
45
|
+
.join("+");
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const ARIA_NAMED_KEYS: Record<string, string> = {
|
|
49
|
+
escape: "Escape",
|
|
50
|
+
enter: "Enter",
|
|
51
|
+
tab: "Tab",
|
|
52
|
+
backspace: "Backspace",
|
|
53
|
+
delete: "Delete",
|
|
54
|
+
insert: "Insert",
|
|
55
|
+
home: "Home",
|
|
56
|
+
end: "End",
|
|
57
|
+
pageup: "PageUp",
|
|
58
|
+
pagedown: "PageDown",
|
|
59
|
+
arrowup: "ArrowUp",
|
|
60
|
+
arrowdown: "ArrowDown",
|
|
61
|
+
arrowleft: "ArrowLeft",
|
|
62
|
+
arrowright: "ArrowRight",
|
|
63
|
+
" ": "Space",
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
/** A spec in `aria-keyshortcuts` syntax: `Control+Shift+R`, `Meta+R`. */
|
|
67
|
+
export function ariaSpec(spec: string, env: KeyEnvironment): string {
|
|
68
|
+
const parsed = parseSpec(spec);
|
|
69
|
+
const modifiers = resolveModifiers(parsed, env);
|
|
70
|
+
const key = ARIA_NAMED_KEYS[parsed.key] ?? parsed.key.toUpperCase();
|
|
71
|
+
return [modifiers.ctrl && "Control", modifiers.alt && "Alt", modifiers.shift && "Shift", modifiers.meta && "Meta", key].filter(Boolean).join("+");
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/** Every spec that triggers a shortcut here: its keys, and in the desktop client also its desktop-only ones. */
|
|
75
|
+
export function specsFor(shortcut: ShortcutDef, env: KeyEnvironment): string[] {
|
|
76
|
+
return env.electron && shortcut.electronKeys ? [...shortcut.keys, ...shortcut.electronKeys] : [...shortcut.keys];
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** The `aria-keyshortcuts` value for a control that runs a shortcut: every alternative, space separated. */
|
|
80
|
+
export function ariaKeyShortcuts(shortcut: ShortcutDef, env: KeyEnvironment): string {
|
|
81
|
+
return specsFor(shortcut, env)
|
|
82
|
+
.map((spec) => ariaSpec(spec, env))
|
|
83
|
+
.join(" ");
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** A tooltip/name suffix such as `Reply (Ctrl+R)`: the label with the shortcut's first key. */
|
|
87
|
+
export function withHint(label: string, shortcut: ShortcutDef, env: KeyEnvironment): string {
|
|
88
|
+
return `${label} (${formatSpec(shortcut.keys[0], env)})`;
|
|
89
|
+
}
|
|
@@ -1,114 +1,114 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Where a shortcut applies. `global` works in every view; a view scope (`mail`, `calendar`, `contacts`, `tasks`) exists only while that
|
|
8
|
-
* view is mounted; `compose` applies while focus is inside a compose window; `dialog` is for what a modal dialog binds itself - a
|
|
9
|
-
* dialog on screen silences every other scope.
|
|
10
|
-
*/
|
|
11
|
-
export type ShortcutScope = "global" | "mail" | "compose" | "calendar" | "contacts" | "tasks" | "dialog";
|
|
12
|
-
|
|
13
|
-
/** The scopes the help dialog lists, in the order it lists them. */
|
|
14
|
-
export const HELP_SCOPES: readonly ShortcutScope[] = ["global", "mail", "compose", "calendar", "contacts", "tasks"];
|
|
15
|
-
|
|
16
|
-
export const SCOPE_LABELS: Record<ShortcutScope, string> = {
|
|
17
|
-
global: "Global",
|
|
18
|
-
mail: "Mail",
|
|
19
|
-
compose: "Compose",
|
|
20
|
-
calendar: "Calendar",
|
|
21
|
-
contacts: "Contacts",
|
|
22
|
-
tasks: "Tasks",
|
|
23
|
-
dialog: "Dialog",
|
|
24
|
-
};
|
|
25
|
-
|
|
26
|
-
/** One action the keyboard can trigger, and the keys that trigger it. Views register handlers for these; nothing else defines a key. */
|
|
27
|
-
export interface ShortcutDef {
|
|
28
|
-
/** Stable name, unique across the map - what the help dialog de-duplicates on. */
|
|
29
|
-
id: string;
|
|
30
|
-
/** Specs (see `parseSpec()`) that trigger it, the first being the one shown first. `mod` is Ctrl, or Cmd on macOS. */
|
|
31
|
-
keys: readonly string[];
|
|
32
|
-
/** Extra specs that apply only in the desktop client, where the browser's own reserved keys (Ctrl+N, Ctrl+T) are the app's. */
|
|
33
|
-
electronKeys?: readonly string[];
|
|
34
|
-
/** What the help dialog and a button's tooltip call it. */
|
|
35
|
-
label: string;
|
|
36
|
-
scope: ShortcutScope;
|
|
37
|
-
/** Fires from a focused button or link too (Enter on a message row); by default Enter/Space are left to what has the focus. */
|
|
38
|
-
allowOnActivatable?: boolean;
|
|
39
|
-
/** Keeps firing while the key is held (arrows); by default a held key runs a one-shot action once. */
|
|
40
|
-
repeat?: boolean;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
function def<T extends ShortcutDef>(shortcut: T): T {
|
|
44
|
-
return shortcut;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* The whole key map, in the order the help dialog lists it. The navigation set is literally Ctrl+Shift+<letter> on every platform (Cmd+Shift
|
|
49
|
-
* on macOS collides with the browsers' own - Cmd+Shift+A/B/C/L/M/S are tab search, the bookmarks bar, Inspect, the sidebar, the profile
|
|
50
|
-
* switcher and Save As - so it is not offered); the mail actions use `mod`, so Reply is Ctrl+R on Windows and Linux and Cmd+R on a Mac.
|
|
51
|
-
* Ctrl+Q (mark read) stays Ctrl on a Mac because Cmd+Q is the system's Quit.
|
|
52
|
-
*/
|
|
53
|
-
export const SHORTCUTS = {
|
|
54
|
-
global: {
|
|
55
|
-
account: def({ id: "go.account", keys: ["ctrl+shift+a"], label: "Go to Account", scope: "global" }),
|
|
56
|
-
settings: def({ id: "go.settings", keys: ["ctrl+shift+s"], label: "Go to Settings", scope: "global" }),
|
|
57
|
-
contacts: def({ id: "go.contacts", keys: ["ctrl+shift+b"], label: "Go to Contacts", scope: "global" }),
|
|
58
|
-
mail: def({ id: "go.mail", keys: ["ctrl+shift+m"], label: "Go to Mail", scope: "global" }),
|
|
59
|
-
calendar: def({ id: "go.calendar", keys: ["ctrl+shift+c"], label: "Go to Calendar", scope: "global" }),
|
|
60
|
-
tasks: def({ id: "go.tasks", keys: ["ctrl+shift+l"], electronKeys: ["ctrl+shift+t"], label: "Go to Tasks", scope: "global" }),
|
|
61
|
-
help: def({ id: "help", keys: ["?", "ctrl+/"], label: "Keyboard shortcuts", scope: "global" }),
|
|
62
|
-
},
|
|
63
|
-
mail: {
|
|
64
|
-
create: def({ id: "mail.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "mail" }),
|
|
65
|
-
reply: def({ id: "mail.reply", keys: ["mod+r"], label: "Reply", scope: "mail" }),
|
|
66
|
-
replyAll: def({ id: "mail.replyAll", keys: ["mod+shift+r"], label: "Reply all", scope: "mail" }),
|
|
67
|
-
forward: def({ id: "mail.forward", keys: ["mod+shift+f"], label: "Forward", scope: "mail" }),
|
|
68
|
-
delete: def({ id: "mail.delete", keys: ["mod+d", "delete"], label: "Delete", scope: "mail" }),
|
|
69
|
-
archive: def({ id: "mail.archive", keys: ["e", "backspace"], label: "Archive", scope: "mail" }),
|
|
70
|
-
move: def({ id: "mail.move", keys: ["mod+shift+v"], label: "Move to folder", scope: "mail" }),
|
|
71
|
-
markRead: def({ id: "mail.markRead", keys: ["ctrl+q"], label: "Mark as read", scope: "mail" }),
|
|
72
|
-
markUnread: def({ id: "mail.markUnread", keys: ["mod+u"], label: "Mark as unread", scope: "mail" }),
|
|
73
|
-
flag: def({ id: "mail.flag", keys: ["insert"], label: "Flag or unflag", scope: "mail" }),
|
|
74
|
-
next: def({ id: "mail.next", keys: ["arrowdown", "j"], label: "Next message", scope: "mail", repeat: true }),
|
|
75
|
-
previous: def({ id: "mail.previous", keys: ["arrowup", "k"], label: "Previous message", scope: "mail", repeat: true }),
|
|
76
|
-
nextUnread: def({ id: "mail.nextUnread", keys: ["ctrl+."], label: "Next unread message", scope: "mail" }),
|
|
77
|
-
previousUnread: def({ id: "mail.previousUnread", keys: ["ctrl+,"], label: "Previous unread message", scope: "mail" }),
|
|
78
|
-
open: def({ id: "mail.open", keys: ["enter"], label: "Open the message on its own page", scope: "mail", allowOnActivatable: true }),
|
|
79
|
-
close: def({ id: "mail.close", keys: ["escape"], label: "Clear the selection", scope: "mail" }),
|
|
80
|
-
search: def({ id: "mail.search", keys: ["/", "mod+e"], label: "Search mail", scope: "mail" }),
|
|
81
|
-
},
|
|
82
|
-
compose: {
|
|
83
|
-
create: def({ id: "compose.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "compose" }),
|
|
84
|
-
send: def({ id: "compose.send", keys: ["mod+enter"], label: "Send", scope: "compose" }),
|
|
85
|
-
saveDraft: def({ id: "compose.saveDraft", keys: ["mod+s"], label: "Save draft", scope: "compose" }),
|
|
86
|
-
close: def({ id: "compose.close", keys: ["escape"], label: "Close (keeps the draft)", scope: "compose" }),
|
|
87
|
-
},
|
|
88
|
-
calendar: {
|
|
89
|
-
create: def({ id: "calendar.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New event", scope: "calendar" }),
|
|
90
|
-
today: def({ id: "calendar.today", keys: ["t"], label: "Go to today", scope: "calendar" }),
|
|
91
|
-
previous: def({ id: "calendar.previous", keys: ["arrowleft", "mod+arrowleft"], label: "Previous period", scope: "calendar", repeat: true }),
|
|
92
|
-
next: def({ id: "calendar.next", keys: ["arrowright", "mod+arrowright"], label: "Next period", scope: "calendar", repeat: true }),
|
|
93
|
-
day: def({ id: "calendar.day", keys: ["ctrl+alt+1"], label: "Day view", scope: "calendar" }),
|
|
94
|
-
workWeek: def({ id: "calendar.workWeek", keys: ["ctrl+alt+2"], label: "Work week view", scope: "calendar" }),
|
|
95
|
-
week: def({ id: "calendar.week", keys: ["ctrl+alt+3"], label: "Week view", scope: "calendar" }),
|
|
96
|
-
month: def({ id: "calendar.month", keys: ["ctrl+alt+4"], label: "Month view", scope: "calendar" }),
|
|
97
|
-
},
|
|
98
|
-
contacts: {
|
|
99
|
-
create: def({ id: "contacts.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New contact", scope: "contacts" }),
|
|
100
|
-
search: def({ id: "contacts.search", keys: ["/", "mod+e"], label: "Search contacts", scope: "contacts" }),
|
|
101
|
-
},
|
|
102
|
-
tasks: {
|
|
103
|
-
create: def({ id: "tasks.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New task", scope: "tasks" }),
|
|
104
|
-
},
|
|
105
|
-
} as const;
|
|
106
|
-
|
|
107
|
-
/** Every shortcut of the map flattened, in listing order. */
|
|
108
|
-
export const ALL_SHORTCUTS: readonly ShortcutDef[] = Object.values(SHORTCUTS).flatMap((group) => Object.values(group) as ShortcutDef[]);
|
|
109
|
-
|
|
110
|
-
/** Where a shortcut sits in the listing, for ordering registrations that arrive in whatever order components mount. */
|
|
111
|
-
export function shortcutRank(shortcut: ShortcutDef): number {
|
|
112
|
-
const index = ALL_SHORTCUTS.findIndex((candidate) => candidate.id === shortcut.id);
|
|
113
|
-
return index === -1 ? ALL_SHORTCUTS.length : index;
|
|
114
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Where a shortcut applies. `global` works in every view; a view scope (`mail`, `calendar`, `contacts`, `tasks`) exists only while that
|
|
8
|
+
* view is mounted; `compose` applies while focus is inside a compose window; `dialog` is for what a modal dialog binds itself - a
|
|
9
|
+
* dialog on screen silences every other scope.
|
|
10
|
+
*/
|
|
11
|
+
export type ShortcutScope = "global" | "mail" | "compose" | "calendar" | "contacts" | "tasks" | "dialog";
|
|
12
|
+
|
|
13
|
+
/** The scopes the help dialog lists, in the order it lists them. */
|
|
14
|
+
export const HELP_SCOPES: readonly ShortcutScope[] = ["global", "mail", "compose", "calendar", "contacts", "tasks"];
|
|
15
|
+
|
|
16
|
+
export const SCOPE_LABELS: Record<ShortcutScope, string> = {
|
|
17
|
+
global: "Global",
|
|
18
|
+
mail: "Mail",
|
|
19
|
+
compose: "Compose",
|
|
20
|
+
calendar: "Calendar",
|
|
21
|
+
contacts: "Contacts",
|
|
22
|
+
tasks: "Tasks",
|
|
23
|
+
dialog: "Dialog",
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
/** One action the keyboard can trigger, and the keys that trigger it. Views register handlers for these; nothing else defines a key. */
|
|
27
|
+
export interface ShortcutDef {
|
|
28
|
+
/** Stable name, unique across the map - what the help dialog de-duplicates on. */
|
|
29
|
+
id: string;
|
|
30
|
+
/** Specs (see `parseSpec()`) that trigger it, the first being the one shown first. `mod` is Ctrl, or Cmd on macOS. */
|
|
31
|
+
keys: readonly string[];
|
|
32
|
+
/** Extra specs that apply only in the desktop client, where the browser's own reserved keys (Ctrl+N, Ctrl+T) are the app's. */
|
|
33
|
+
electronKeys?: readonly string[];
|
|
34
|
+
/** What the help dialog and a button's tooltip call it. */
|
|
35
|
+
label: string;
|
|
36
|
+
scope: ShortcutScope;
|
|
37
|
+
/** Fires from a focused button or link too (Enter on a message row); by default Enter/Space are left to what has the focus. */
|
|
38
|
+
allowOnActivatable?: boolean;
|
|
39
|
+
/** Keeps firing while the key is held (arrows); by default a held key runs a one-shot action once. */
|
|
40
|
+
repeat?: boolean;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function def<T extends ShortcutDef>(shortcut: T): T {
|
|
44
|
+
return shortcut;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The whole key map, in the order the help dialog lists it. The navigation set is literally Ctrl+Shift+<letter> on every platform (Cmd+Shift
|
|
49
|
+
* on macOS collides with the browsers' own - Cmd+Shift+A/B/C/L/M/S are tab search, the bookmarks bar, Inspect, the sidebar, the profile
|
|
50
|
+
* switcher and Save As - so it is not offered); the mail actions use `mod`, so Reply is Ctrl+R on Windows and Linux and Cmd+R on a Mac.
|
|
51
|
+
* Ctrl+Q (mark read) stays Ctrl on a Mac because Cmd+Q is the system's Quit.
|
|
52
|
+
*/
|
|
53
|
+
export const SHORTCUTS = {
|
|
54
|
+
global: {
|
|
55
|
+
account: def({ id: "go.account", keys: ["ctrl+shift+a"], label: "Go to Account", scope: "global" }),
|
|
56
|
+
settings: def({ id: "go.settings", keys: ["ctrl+shift+s"], label: "Go to Settings", scope: "global" }),
|
|
57
|
+
contacts: def({ id: "go.contacts", keys: ["ctrl+shift+b"], label: "Go to Contacts", scope: "global" }),
|
|
58
|
+
mail: def({ id: "go.mail", keys: ["ctrl+shift+m"], label: "Go to Mail", scope: "global" }),
|
|
59
|
+
calendar: def({ id: "go.calendar", keys: ["ctrl+shift+c"], label: "Go to Calendar", scope: "global" }),
|
|
60
|
+
tasks: def({ id: "go.tasks", keys: ["ctrl+shift+l"], electronKeys: ["ctrl+shift+t"], label: "Go to Tasks", scope: "global" }),
|
|
61
|
+
help: def({ id: "help", keys: ["?", "ctrl+/"], label: "Keyboard shortcuts", scope: "global" }),
|
|
62
|
+
},
|
|
63
|
+
mail: {
|
|
64
|
+
create: def({ id: "mail.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "mail" }),
|
|
65
|
+
reply: def({ id: "mail.reply", keys: ["mod+r"], label: "Reply", scope: "mail" }),
|
|
66
|
+
replyAll: def({ id: "mail.replyAll", keys: ["mod+shift+r"], label: "Reply all", scope: "mail" }),
|
|
67
|
+
forward: def({ id: "mail.forward", keys: ["mod+shift+f"], label: "Forward", scope: "mail" }),
|
|
68
|
+
delete: def({ id: "mail.delete", keys: ["mod+d", "delete"], label: "Delete", scope: "mail" }),
|
|
69
|
+
archive: def({ id: "mail.archive", keys: ["e", "backspace"], label: "Archive", scope: "mail" }),
|
|
70
|
+
move: def({ id: "mail.move", keys: ["mod+shift+v"], label: "Move to folder", scope: "mail" }),
|
|
71
|
+
markRead: def({ id: "mail.markRead", keys: ["ctrl+q"], label: "Mark as read", scope: "mail" }),
|
|
72
|
+
markUnread: def({ id: "mail.markUnread", keys: ["mod+u"], label: "Mark as unread", scope: "mail" }),
|
|
73
|
+
flag: def({ id: "mail.flag", keys: ["insert"], label: "Flag or unflag", scope: "mail" }),
|
|
74
|
+
next: def({ id: "mail.next", keys: ["arrowdown", "j"], label: "Next message", scope: "mail", repeat: true }),
|
|
75
|
+
previous: def({ id: "mail.previous", keys: ["arrowup", "k"], label: "Previous message", scope: "mail", repeat: true }),
|
|
76
|
+
nextUnread: def({ id: "mail.nextUnread", keys: ["ctrl+."], label: "Next unread message", scope: "mail" }),
|
|
77
|
+
previousUnread: def({ id: "mail.previousUnread", keys: ["ctrl+,"], label: "Previous unread message", scope: "mail" }),
|
|
78
|
+
open: def({ id: "mail.open", keys: ["enter"], label: "Open the message on its own page", scope: "mail", allowOnActivatable: true }),
|
|
79
|
+
close: def({ id: "mail.close", keys: ["escape"], label: "Clear the selection", scope: "mail" }),
|
|
80
|
+
search: def({ id: "mail.search", keys: ["/", "mod+e"], label: "Search mail", scope: "mail" }),
|
|
81
|
+
},
|
|
82
|
+
compose: {
|
|
83
|
+
create: def({ id: "compose.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "compose" }),
|
|
84
|
+
send: def({ id: "compose.send", keys: ["mod+enter"], label: "Send", scope: "compose" }),
|
|
85
|
+
saveDraft: def({ id: "compose.saveDraft", keys: ["mod+s"], label: "Save draft", scope: "compose" }),
|
|
86
|
+
close: def({ id: "compose.close", keys: ["escape"], label: "Close (keeps the draft)", scope: "compose" }),
|
|
87
|
+
},
|
|
88
|
+
calendar: {
|
|
89
|
+
create: def({ id: "calendar.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New event", scope: "calendar" }),
|
|
90
|
+
today: def({ id: "calendar.today", keys: ["t"], label: "Go to today", scope: "calendar" }),
|
|
91
|
+
previous: def({ id: "calendar.previous", keys: ["arrowleft", "mod+arrowleft"], label: "Previous period", scope: "calendar", repeat: true }),
|
|
92
|
+
next: def({ id: "calendar.next", keys: ["arrowright", "mod+arrowright"], label: "Next period", scope: "calendar", repeat: true }),
|
|
93
|
+
day: def({ id: "calendar.day", keys: ["ctrl+alt+1"], label: "Day view", scope: "calendar" }),
|
|
94
|
+
workWeek: def({ id: "calendar.workWeek", keys: ["ctrl+alt+2"], label: "Work week view", scope: "calendar" }),
|
|
95
|
+
week: def({ id: "calendar.week", keys: ["ctrl+alt+3"], label: "Week view", scope: "calendar" }),
|
|
96
|
+
month: def({ id: "calendar.month", keys: ["ctrl+alt+4"], label: "Month view", scope: "calendar" }),
|
|
97
|
+
},
|
|
98
|
+
contacts: {
|
|
99
|
+
create: def({ id: "contacts.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New contact", scope: "contacts" }),
|
|
100
|
+
search: def({ id: "contacts.search", keys: ["/", "mod+e"], label: "Search contacts", scope: "contacts" }),
|
|
101
|
+
},
|
|
102
|
+
tasks: {
|
|
103
|
+
create: def({ id: "tasks.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New task", scope: "tasks" }),
|
|
104
|
+
},
|
|
105
|
+
} as const;
|
|
106
|
+
|
|
107
|
+
/** Every shortcut of the map flattened, in listing order. */
|
|
108
|
+
export const ALL_SHORTCUTS: readonly ShortcutDef[] = Object.values(SHORTCUTS).flatMap((group) => Object.values(group) as ShortcutDef[]);
|
|
109
|
+
|
|
110
|
+
/** Where a shortcut sits in the listing, for ordering registrations that arrive in whatever order components mount. */
|
|
111
|
+
export function shortcutRank(shortcut: ShortcutDef): number {
|
|
112
|
+
const index = ALL_SHORTCUTS.findIndex((candidate) => candidate.id === shortcut.id);
|
|
113
|
+
return index === -1 ? ALL_SHORTCUTS.length : index;
|
|
114
|
+
}
|
|
@@ -1,65 +1,65 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
import type { RefObject } from "react";
|
|
6
|
-
import type { ShortcutDef, ShortcutScope } from "./keymap.js";
|
|
7
|
-
import { ParsedSpec } from "./parse.js";
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* What a handler does with its key. Returning `false` says it did not handle it (nothing selected, a button that is disabled right now)
|
|
11
|
-
* - the key is then left alone, and a handler of a lower scope may take it. Anything else means it did, and the key is consumed.
|
|
12
|
-
*/
|
|
13
|
-
export type ShortcutHandler = (event: KeyboardEvent) => boolean | void;
|
|
14
|
-
|
|
15
|
-
/** One mounted view's claim on a shortcut. */
|
|
16
|
-
export interface Registration {
|
|
17
|
-
/** Unique per registration. */
|
|
18
|
-
id: number;
|
|
19
|
-
shortcut: ShortcutDef;
|
|
20
|
-
scope: ShortcutScope;
|
|
21
|
-
/** Called at event time; reads whatever the component holds now. */
|
|
22
|
-
run: ShortcutHandler;
|
|
23
|
-
/** Applies only to events whose target is inside this element (a compose window). */
|
|
24
|
-
container?: RefObject<Element | null>;
|
|
25
|
-
keys: ParsedSpec[];
|
|
26
|
-
electronKeys: ParsedSpec[];
|
|
27
|
-
/** Later registrations win over earlier ones in the same scope. */
|
|
28
|
-
order: number;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* The shortcuts that are mounted right now. Components add and remove their claims as they mount and unmount, so a page switch changes
|
|
33
|
-
* what a key does with nothing to re-wire; the dispatcher (`dispatchKeyEvent()`) looks handlers up here at the time of the key press,
|
|
34
|
-
* and the help dialog lists what is here.
|
|
35
|
-
*/
|
|
36
|
-
export class ShortcutRegistry {
|
|
37
|
-
private registrations: readonly Registration[] = [];
|
|
38
|
-
private counter = 0;
|
|
39
|
-
private listeners = new Set<() => void>();
|
|
40
|
-
|
|
41
|
-
/** Adds a claim; returns what removes it. */
|
|
42
|
-
add(claim: Omit<Registration, "id" | "order">): () => void {
|
|
43
|
-
const registration: Registration = { ...claim, id: ++this.counter, order: this.counter };
|
|
44
|
-
this.registrations = [...this.registrations, registration];
|
|
45
|
-
this.publish();
|
|
46
|
-
return () => {
|
|
47
|
-
this.registrations = this.registrations.filter((existing) => existing.id !== registration.id);
|
|
48
|
-
this.publish();
|
|
49
|
-
};
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
/** The current claims, oldest first. A new array whenever they change (so it can be a `useSyncExternalStore()` snapshot). */
|
|
53
|
-
getSnapshot = (): readonly Registration[] => this.registrations;
|
|
54
|
-
|
|
55
|
-
subscribe = (listener: () => void): (() => void) => {
|
|
56
|
-
this.listeners.add(listener);
|
|
57
|
-
return () => {
|
|
58
|
-
this.listeners.delete(listener);
|
|
59
|
-
};
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
private publish(): void {
|
|
63
|
-
this.listeners.forEach((listener) => listener());
|
|
64
|
-
}
|
|
65
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
import type { RefObject } from "react";
|
|
6
|
+
import type { ShortcutDef, ShortcutScope } from "./keymap.js";
|
|
7
|
+
import { ParsedSpec } from "./parse.js";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* What a handler does with its key. Returning `false` says it did not handle it (nothing selected, a button that is disabled right now)
|
|
11
|
+
* - the key is then left alone, and a handler of a lower scope may take it. Anything else means it did, and the key is consumed.
|
|
12
|
+
*/
|
|
13
|
+
export type ShortcutHandler = (event: KeyboardEvent) => boolean | void;
|
|
14
|
+
|
|
15
|
+
/** One mounted view's claim on a shortcut. */
|
|
16
|
+
export interface Registration {
|
|
17
|
+
/** Unique per registration. */
|
|
18
|
+
id: number;
|
|
19
|
+
shortcut: ShortcutDef;
|
|
20
|
+
scope: ShortcutScope;
|
|
21
|
+
/** Called at event time; reads whatever the component holds now. */
|
|
22
|
+
run: ShortcutHandler;
|
|
23
|
+
/** Applies only to events whose target is inside this element (a compose window). */
|
|
24
|
+
container?: RefObject<Element | null>;
|
|
25
|
+
keys: ParsedSpec[];
|
|
26
|
+
electronKeys: ParsedSpec[];
|
|
27
|
+
/** Later registrations win over earlier ones in the same scope. */
|
|
28
|
+
order: number;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* The shortcuts that are mounted right now. Components add and remove their claims as they mount and unmount, so a page switch changes
|
|
33
|
+
* what a key does with nothing to re-wire; the dispatcher (`dispatchKeyEvent()`) looks handlers up here at the time of the key press,
|
|
34
|
+
* and the help dialog lists what is here.
|
|
35
|
+
*/
|
|
36
|
+
export class ShortcutRegistry {
|
|
37
|
+
private registrations: readonly Registration[] = [];
|
|
38
|
+
private counter = 0;
|
|
39
|
+
private listeners = new Set<() => void>();
|
|
40
|
+
|
|
41
|
+
/** Adds a claim; returns what removes it. */
|
|
42
|
+
add(claim: Omit<Registration, "id" | "order">): () => void {
|
|
43
|
+
const registration: Registration = { ...claim, id: ++this.counter, order: this.counter };
|
|
44
|
+
this.registrations = [...this.registrations, registration];
|
|
45
|
+
this.publish();
|
|
46
|
+
return () => {
|
|
47
|
+
this.registrations = this.registrations.filter((existing) => existing.id !== registration.id);
|
|
48
|
+
this.publish();
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** The current claims, oldest first. A new array whenever they change (so it can be a `useSyncExternalStore()` snapshot). */
|
|
53
|
+
getSnapshot = (): readonly Registration[] => this.registrations;
|
|
54
|
+
|
|
55
|
+
subscribe = (listener: () => void): (() => void) => {
|
|
56
|
+
this.listeners.add(listener);
|
|
57
|
+
return () => {
|
|
58
|
+
this.listeners.delete(listener);
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
private publish(): void {
|
|
63
|
+
this.listeners.forEach((listener) => listener());
|
|
64
|
+
}
|
|
65
|
+
}
|