@rapidmx/web-client 0.19.0 → 0.20.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.
Files changed (131) hide show
  1. package/README.md +381 -381
  2. package/apps/admin/branding/index.tsx +39 -39
  3. package/apps/admin/data-requests/index.tsx +482 -482
  4. package/apps/admin/domains/[uid].tsx +166 -166
  5. package/apps/admin/escrow-scopes/[uid].tsx +350 -350
  6. package/apps/admin/index.tsx +129 -129
  7. package/apps/admin/mailboxes/[uid].tsx +271 -271
  8. package/apps/admin/mailboxes/new/index.tsx +30 -30
  9. package/apps/admin/plugins/index.tsx +15 -15
  10. package/apps/admin/retention-policy/index.tsx +39 -39
  11. package/apps/admin/signing-certificates/index.tsx +343 -343
  12. package/apps/escrow/audit-log/index.tsx +196 -196
  13. package/apps/escrow/matters/[uid].tsx +621 -621
  14. package/apps/shared/auth/adminAccess.ts +99 -99
  15. package/apps/shared/components/admin/diagnostics/HostCard.tsx +2 -0
  16. package/apps/shared/components/admin/diagnostics/PressureTiles.tsx +108 -0
  17. package/apps/shared/components/admin/diagnostics/PvcTable.tsx +20 -6
  18. package/apps/shared/components/admin/diagnostics/diagnosticsApi.ts +21 -2
  19. package/apps/shared/components/admin/layout/AdminShell.tsx +384 -384
  20. package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -238
  21. package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
  22. package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -194
  23. package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
  24. package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
  25. package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
  26. package/apps/shared/components/admin/settings/PluginsManager.tsx +2093 -1620
  27. package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
  28. package/apps/shared/components/admin/settings/pluginPreferences.ts +34 -0
  29. package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
  30. package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -446
  31. package/apps/shared/components/admin/usePagedList.tsx +129 -129
  32. package/apps/shared/components/calendar/EventModal.tsx +206 -206
  33. package/apps/shared/components/calendar/MonthView.tsx +185 -185
  34. package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
  35. package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
  36. package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
  37. package/apps/shared/components/calendar/allDay.ts +124 -124
  38. package/apps/shared/components/contacts/ContactForm.tsx +383 -383
  39. package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -103
  40. package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
  41. package/apps/shared/components/layout/AppShell.tsx +461 -461
  42. package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
  43. package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
  44. package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
  45. package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
  46. package/apps/shared/components/layout/UserMenu.tsx +439 -439
  47. package/apps/shared/components/mail/ConversationList.tsx +332 -323
  48. package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -613
  49. package/apps/shared/components/mail/MailSelectionBar.tsx +240 -240
  50. package/apps/shared/components/mail/MenuButton.tsx +404 -404
  51. package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1757
  52. package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
  53. package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
  54. package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1681
  55. package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
  56. package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
  57. package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
  58. package/apps/shared/components/mail/listPreferences.ts +3 -3
  59. package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -258
  60. package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -79
  61. package/apps/shared/components/mail/reading/messageExport.ts +59 -59
  62. package/apps/shared/components/mail/reading/printMessage.ts +99 -99
  63. package/apps/shared/components/mail/reading/useMessageActions.ts +443 -443
  64. package/apps/shared/components/mail/verificationSeals.ts +125 -125
  65. package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
  66. package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
  67. package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
  68. package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
  69. package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
  70. package/apps/shared/keyboard/dispatch.ts +124 -124
  71. package/apps/shared/keyboard/format.ts +89 -89
  72. package/apps/shared/keyboard/keymap.ts +114 -114
  73. package/apps/shared/keyboard/registry.ts +65 -65
  74. package/apps/shared/keyboard/targets.ts +79 -79
  75. package/apps/shared/mail/folderOfType.ts +49 -49
  76. package/apps/shared/mail/folderTree.ts +143 -143
  77. package/apps/shared/mail/listAllPages.ts +39 -39
  78. package/apps/shared/mail/newMailNotifications.ts +171 -171
  79. package/apps/shared/mail/outbox/sendJob.ts +445 -445
  80. package/apps/shared/mail/outbox/sendOutcomes.ts +155 -155
  81. package/apps/shared/mail/reportNotices.ts +66 -66
  82. package/apps/shared/mail/senderBlocking.ts +141 -141
  83. package/apps/shared/mail/useMailConnection.ts +205 -205
  84. package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
  85. package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -60
  86. package/apps/shared/mail/useMarkMessageRead.ts +47 -47
  87. package/apps/shared/mail/useNewMailNotifications.ts +178 -178
  88. package/apps/shared/notifications/store.ts +560 -560
  89. package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
  90. package/apps/shared/search/localIndexBuilder.ts +481 -481
  91. package/apps/shared/signing/enrollmentStorage.ts +33 -33
  92. package/apps/shared/signing/enrollmentTracker.ts +385 -385
  93. package/apps/shared/signing/enrollmentView.ts +251 -251
  94. package/apps/shared/signing/useNow.ts +19 -19
  95. package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
  96. package/apps/shared/styles/app.css +396 -396
  97. package/apps/www/calendar/index.tsx +581 -581
  98. package/apps/www/contacts/[uid].tsx +112 -112
  99. package/apps/www/index.tsx +3012 -2962
  100. package/apps/www/messages/[uid].tsx +139 -139
  101. package/apps/www/settings/auto-reply/index.tsx +136 -136
  102. package/apps/www/settings/blocked-senders/index.tsx +303 -303
  103. package/apps/www/settings/encryption/index.tsx +1290 -1290
  104. package/apps/www/settings/filters/[uid].tsx +179 -179
  105. package/apps/www/settings/filters/index.tsx +105 -105
  106. package/apps/www/settings/filters/new/index.tsx +165 -165
  107. package/apps/www/settings/labels/index.tsx +207 -207
  108. package/apps/www/settings/privacy/index.tsx +495 -495
  109. package/apps/www/settings/profile/index.tsx +251 -251
  110. package/apps/www/settings/read-receipts/index.tsx +150 -150
  111. package/apps/www/settings/sharing/index.tsx +259 -259
  112. package/apps/www/settings/signatures/[uid].tsx +175 -175
  113. package/apps/www/settings/signatures/index.tsx +91 -91
  114. package/apps/www/settings/signatures/new/index.tsx +138 -138
  115. package/apps/www/tasks/index.tsx +654 -654
  116. package/dist/apps/shared/components/admin/diagnostics/HostCard.js +2 -1
  117. package/dist/apps/shared/components/admin/diagnostics/PressureTiles.d.ts +22 -0
  118. package/dist/apps/shared/components/admin/diagnostics/PressureTiles.js +52 -0
  119. package/dist/apps/shared/components/admin/diagnostics/PvcTable.js +9 -4
  120. package/dist/apps/shared/components/admin/diagnostics/diagnosticsApi.d.ts +35 -2
  121. package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
  122. package/dist/apps/shared/components/admin/settings/PluginsManager.js +267 -35
  123. package/dist/apps/shared/components/admin/settings/pluginPreferences.d.ts +2 -0
  124. package/dist/apps/shared/components/admin/settings/pluginPreferences.js +35 -0
  125. package/dist/apps/shared/components/mail/ConversationList.d.ts +10 -3
  126. package/dist/apps/shared/components/mail/ConversationList.js +9 -5
  127. package/dist/apps/shared/components/mail/listPreferences.d.ts +1 -1
  128. package/dist/apps/shared/components/mail/reading/printMessage.js +11 -11
  129. package/dist/apps/shared/styles/app.css +396 -396
  130. package/dist/apps/www/index.js +51 -10
  131. package/package.json +2 -2
@@ -1,404 +1,404 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import React, { ReactNode, useEffect, useRef, useState } from "react";
6
- import { HiCheck, HiChevronDown, HiChevronLeft, HiChevronRight, HiMinus } from "react-icons/hi2";
7
- import PopoverPortal from "@rapidmx/react-shared/components/overlays/PopoverPortal.js";
8
-
9
- /** What every row has. `checked` turns it into a radio/checkbox item (the caller says which via `role`) and
10
- * draws the checkmark column; without it the row is a plain command. */
11
- interface MenuItemBase {
12
- key: string;
13
- label: string;
14
- /** A one-line explanation under the label, for an item whose effect isn't obvious from its name. */
15
- description?: string;
16
- role?: "menuitem" | "menuitemradio" | "menuitemcheckbox";
17
- /** `"mixed"` is ARIA's third checkbox state - some of the things this row acts on have it and some
18
- * don't, which is what a label applied to only part of a multi-message selection looks like. */
19
- checked?: boolean | "mixed";
20
- /** A colour swatch before the label - a label's own colour. */
21
- swatchColor?: string;
22
- /** An icon before the label, for a menu whose rows are commands (the reading pane's "More actions"). */
23
- icon?: ReactNode;
24
- /** A tooltip for the row - the full text of a label the row truncates. */
25
- title?: string;
26
- disabled?: boolean;
27
- /** Leaves the menu open after choosing this row, for a multi-select list where several rows are ticked
28
- * before one command commits them all. */
29
- keepOpen?: boolean;
30
- }
31
-
32
- /** A row that does something when chosen. */
33
- export interface MenuCommandSpec extends MenuItemBase {
34
- onSelect: () => void;
35
- submenu?: never;
36
- }
37
-
38
- /** A row that opens a submenu instead: choosing it replaces the menu's contents with these sections, under
39
- * a Back row. One level deep, which is all any menu here needs - so it has nothing of its own to do. */
40
- export interface MenuSubmenuSpec extends MenuItemBase {
41
- submenu: MenuSectionSpec[];
42
- onSelect?: never;
43
- }
44
-
45
- export type MenuItemSpec = MenuCommandSpec | MenuSubmenuSpec;
46
-
47
- /** A labelled group of items. Groups after the first are drawn with a separator above them. */
48
- export interface MenuSectionSpec {
49
- key: string;
50
- label?: string;
51
- /** A short note under the group's items - e.g. why some of them are unavailable right now. */
52
- note?: string;
53
- items: MenuItemSpec[];
54
- }
55
-
56
- // `PopoverPortal` positions a fixed-size box (it has no auto-height mode), so the menu's height is
57
- // computed from its own contents rather than measured - from whichever level is *shown*, so a submenu
58
- // isn't left standing in the parent menu's taller box. These are the exact heights the classes below
59
- // render at, so the box is never short enough to clip its last row: an item is `h-9`, a group label
60
- // `h-6`, a note as many `leading-4` lines as it wraps to, a separator a 1px rule inside `my-1`, and the
61
- // list itself `py-1`.
62
- const ITEM_HEIGHT = 36;
63
- const ITEM_DESCRIPTION_HEIGHT = 16;
64
- const GROUP_LABEL_HEIGHT = 24;
65
- const NOTE_LINE_HEIGHT = 16;
66
- const NOTE_PADDING = 4;
67
- /** A note wraps, so its height depends on how much of it fits a line: `text-xs` averages a little over 6px
68
- * a character, and the note sits inside the list's `px-3`. Rounded so the estimate is never *under* the
69
- * lines the browser actually draws - a box a few pixels too tall shows blank space, one too short clips. */
70
- const NOTE_CHAR_WIDTH = 6.4;
71
- const NOTE_PADDING_X = 24;
72
- const SEPARATOR_HEIGHT = 9;
73
- const LIST_PADDING = 8;
74
- const MENU_MAX_HEIGHT = 460;
75
- const DEFAULT_MENU_WIDTH = 248;
76
-
77
- /** How tall `note` renders at `width`, wrapped. */
78
- function noteHeight(note: string, width: number): number {
79
- const charsPerLine = Math.max(1, Math.floor((width - NOTE_PADDING_X) / NOTE_CHAR_WIDTH));
80
- return Math.ceil(note.length / charsPerLine) * NOTE_LINE_HEIGHT + NOTE_PADDING;
81
- }
82
-
83
- /** The height `PopoverPortal` is asked for - exact for a short menu, capped (the list scrolls) for a long one. */
84
- export function menuHeight(sections: MenuSectionSpec[], width: number = DEFAULT_MENU_WIDTH): number {
85
- let height = LIST_PADDING;
86
- sections.forEach((section, index) => {
87
- if (index > 0) {
88
- height += SEPARATOR_HEIGHT;
89
- }
90
- if (section.label) {
91
- height += GROUP_LABEL_HEIGHT;
92
- }
93
- for (const item of section.items) {
94
- height += ITEM_HEIGHT + (item.description ? ITEM_DESCRIPTION_HEIGHT : 0);
95
- }
96
- if (section.note) {
97
- height += noteHeight(section.note, width);
98
- }
99
- });
100
- return Math.min(height, MENU_MAX_HEIGHT);
101
- }
102
-
103
- export interface MenuButtonProps {
104
- /** The trigger's visible label. Not drawn (nor is the chevron) with `iconOnly`, where `aria-label` is all the trigger says. */
105
- label: ReactNode;
106
- /** The trigger is just its `icon` - a round icon button like the reading pane's own command row, whose `className` it takes over
107
- * completely. `aria-label` (and `title`) name it. */
108
- iconOnly?: boolean;
109
- /** The trigger's accessible name, which also names the menu itself - includes the current selection
110
- * where there is one ("Filter: Unread"), so the button says what it's set to, not just what it does. */
111
- "aria-label": string;
112
- icon?: ReactNode;
113
- disabled?: boolean;
114
- title?: string;
115
- sections: MenuSectionSpec[];
116
- width?: number;
117
- /** Extra classes for the trigger, on top of the shared toolbar-button styling. */
118
- className?: string;
119
- /** Told whenever the menu opens or closes - how a caller resets a draft it keeps for the menu's own
120
- * multi-select rows (see `useLabelDraft()`). */
121
- onOpenChange?: (open: boolean) => void;
122
- }
123
-
124
- /**
125
- * A toolbar button that opens an ARIA menu: `role="menu"` rows with checkmarks for the current choice,
126
- * full keyboard support (Enter/Space or Arrow Down to open, arrows/Home/End to move with wrap, Enter/Space
127
- * to choose, Escape or Tab to close with focus returning to the trigger) and a click outside to dismiss.
128
- *
129
- * Rendered through `PopoverPortal` rather than as an absolutely-positioned child: the mail list toolbar
130
- * lives inside the list's own `overflow-y-auto` scroll container, which clips an absolute popup however
131
- * high its `z-index` - the same reason Compose's own pickers portal out (see `PopoverPortal`'s own doc
132
- * comment). The portal supplies the positioning, the outside-click dismissal and the box; the menu
133
- * semantics, roving focus and keyboard handling are this component's own.
134
- */
135
- export default function MenuButton({
136
- label,
137
- iconOnly = false,
138
- icon,
139
- disabled,
140
- title,
141
- sections,
142
- width = DEFAULT_MENU_WIDTH,
143
- className = "",
144
- "aria-label": ariaLabel,
145
- onOpenChange,
146
- }: MenuButtonProps) {
147
- const [open, setOpen] = useState(false);
148
- const [activeIndex, setActiveIndex] = useState(0);
149
- // The key of the item whose submenu is showing, or `null` at the top level. Held as a key, not as the
150
- // item itself, because `sections` is rebuilt on every render.
151
- const [submenuKey, setSubmenuKey] = useState<string | null>(null);
152
- const triggerRef = useRef<HTMLButtonElement>(null);
153
- const itemRefs = useRef<(HTMLButtonElement | null)[]>([]);
154
- // State, not a ref: `PopoverPortal` renders nothing at all until its own positioning effect has run, so
155
- // the rows don't exist yet when this component's effects first fire. Keying the focus effect on the
156
- // menu node itself makes it run again once they do.
157
- const [menuNode, setMenuNode] = useState<HTMLDivElement | null>(null);
158
-
159
- const openSubmenu = sections
160
- .flatMap((section) => section.items)
161
- .find((item): item is MenuSubmenuSpec => item.key === submenuKey && !!item.submenu);
162
- /** The row that leaves a submenu again - synthesized rather than asked of the caller, so every submenu
163
- * has the same way back however it was built. */
164
- const backItem: MenuCommandSpec = {
165
- key: "__back",
166
- label: `Back to ${ariaLabel}`,
167
- keepOpen: true,
168
- onSelect: () => leaveSubmenu(),
169
- };
170
- const shownSections: MenuSectionSpec[] = openSubmenu
171
- ? [{ key: "__back", items: [backItem] }, ...openSubmenu.submenu]
172
- : sections;
173
- const items = shownSections.flatMap((section) => section.items);
174
- const enabledIndexes = items.map((item, index) => (item.disabled ? -1 : index)).filter((index) => index !== -1);
175
-
176
- /** The row focus starts on: the current choice where there is one, else the first row that can take focus. */
177
- function initialActiveIndex(within: MenuItemSpec[]): number {
178
- const checked = within.findIndex((item) => item.checked === true && !item.disabled);
179
- const enabled = within.map((item, index) => (item.disabled ? -1 : index)).filter((index) => index !== -1);
180
- return checked === -1 ? (enabled[0] ?? 0) : checked;
181
- }
182
-
183
- function openMenu() {
184
- setSubmenuKey(null);
185
- setActiveIndex(initialActiveIndex(sections.flatMap((section) => section.items)));
186
- setOpen(true);
187
- onOpenChange?.(true);
188
- }
189
-
190
- function closeMenu(returnFocus: boolean) {
191
- setOpen(false);
192
- setSubmenuKey(null);
193
- onOpenChange?.(false);
194
- if (returnFocus) {
195
- triggerRef.current?.focus();
196
- }
197
- }
198
-
199
- function enterSubmenu(item: MenuSubmenuSpec) {
200
- setSubmenuKey(item.key);
201
- const rows = item.submenu.flatMap((section) => section.items);
202
- // Past the Back row, onto the first row of the submenu itself - or, when none of them can take focus (every row is unavailable right now), onto
203
- // the Back row, so the keyboard still has a place to be.
204
- setActiveIndex(rows.some((row) => !row.disabled) ? 1 + initialActiveIndex(rows) : 0);
205
- }
206
-
207
- function leaveSubmenu() {
208
- // Back on the row the submenu was opened from.
209
- const parentIndex = sections.flatMap((section) => section.items).findIndex((item) => item.key === submenuKey);
210
- setSubmenuKey(null);
211
- setActiveIndex(parentIndex);
212
- }
213
-
214
- /** What a row does when it is chosen: open its submenu, or run it and close unless it asked to stay. */
215
- function selectItem(item: MenuItemSpec) {
216
- if (item.submenu) {
217
- enterSubmenu(item);
218
- return;
219
- }
220
- item.onSelect();
221
- if (!item.keepOpen) {
222
- closeMenu(true);
223
- }
224
- }
225
-
226
- // Roving focus: only the active row is tabbable, and it takes DOM focus whenever it changes, so the
227
- // arrow keys move the screen reader's cursor too rather than only a visual highlight.
228
- useEffect(() => {
229
- if (open && menuNode) {
230
- // A disabled row can't take focus, so a menu with nothing enabled focuses its own container -
231
- // otherwise the keys it handles would go to whatever had focus before it opened.
232
- if (enabledIndexes.length === 0) {
233
- menuNode.focus();
234
- } else {
235
- itemRefs.current[activeIndex]?.focus();
236
- }
237
- }
238
- // `submenuKey` too: drilling in or out can land on the same index in the other level's list, and
239
- // the row that index *means* is a different button, which the effect must move focus to.
240
- }, [open, activeIndex, submenuKey, menuNode]);
241
-
242
- function moveActive(delta: number) {
243
- if (enabledIndexes.length === 0) {
244
- return;
245
- }
246
- const position = enabledIndexes.indexOf(activeIndex);
247
- setActiveIndex(enabledIndexes[(position + delta + enabledIndexes.length) % enabledIndexes.length]);
248
- }
249
-
250
- function handleMenuKeyDown(e: React.KeyboardEvent) {
251
- if (e.key === "ArrowDown") {
252
- e.preventDefault();
253
- moveActive(1);
254
- } else if (e.key === "ArrowUp") {
255
- e.preventDefault();
256
- moveActive(-1);
257
- } else if (e.key === "Home") {
258
- e.preventDefault();
259
- setActiveIndex(enabledIndexes[0] ?? 0);
260
- } else if (e.key === "End") {
261
- e.preventDefault();
262
- setActiveIndex(enabledIndexes[enabledIndexes.length - 1] ?? 0);
263
- } else if (e.key === "ArrowRight" && items[activeIndex]?.submenu) {
264
- e.preventDefault();
265
- enterSubmenu(items[activeIndex]);
266
- } else if ((e.key === "ArrowLeft" || e.key === "Escape") && openSubmenu) {
267
- // ARIA's own submenu behaviour: Escape leaves the submenu for its parent menu rather than
268
- // dismissing the whole thing.
269
- e.preventDefault();
270
- leaveSubmenu();
271
- } else if (e.key === "Escape" || e.key === "Tab") {
272
- e.preventDefault();
273
- closeMenu(true);
274
- }
275
- }
276
-
277
- function handleTriggerKeyDown(e: React.KeyboardEvent) {
278
- if (!open && (e.key === "ArrowDown" || e.key === "ArrowUp")) {
279
- e.preventDefault();
280
- openMenu();
281
- }
282
- }
283
-
284
- let itemIndex = -1;
285
-
286
- return (
287
- <>
288
- <button
289
- ref={triggerRef}
290
- type="button"
291
- aria-haspopup="menu"
292
- aria-expanded={open}
293
- aria-label={ariaLabel}
294
- title={title}
295
- disabled={disabled}
296
- onClick={() => (open ? closeMenu(false) : openMenu())}
297
- onKeyDown={handleTriggerKeyDown}
298
- className={
299
- iconOnly
300
- ? className
301
- : [
302
- // `min-w-0` so a long label ("Filter: Has attachments") truncates instead of pushing
303
- // whatever sits beside it in the toolbar off the edge of a 384px list column.
304
- "inline-flex min-w-0 items-center gap-1 px-2 py-1 rounded-md text-sm text-text hover:bg-surface-alt disabled:opacity-50 disabled:hover:bg-transparent",
305
- className,
306
- ].join(" ")
307
- }
308
- >
309
- {icon}
310
- {!iconOnly && <span className="truncate">{label}</span>}
311
- {!iconOnly && <HiChevronDown size={14} aria-hidden="true" className="shrink-0 text-text-muted" />}
312
- </button>
313
- {open && (
314
- <PopoverPortal
315
- anchorRef={triggerRef}
316
- onClose={() => closeMenu(false)}
317
- width={width}
318
- height={menuHeight(shownSections, width)}
319
- aria-label={ariaLabel}
320
- >
321
- <div
322
- ref={setMenuNode}
323
- role="menu"
324
- tabIndex={-1}
325
- aria-label={ariaLabel}
326
- onKeyDown={handleMenuKeyDown}
327
- className="flex-1 overflow-y-auto py-1"
328
- >
329
- {shownSections.map((section, sectionIndex) => (
330
- <div key={section.key} role="group" aria-label={section.label} className={sectionIndex > 0 ? "border-t border-border mt-1 pt-1" : ""}>
331
- {section.label && (
332
- <div aria-hidden="true" className="h-6 flex items-center px-3 text-xs font-semibold uppercase tracking-wide text-text-muted">
333
- {section.label}
334
- </div>
335
- )}
336
- {section.items.map((item) => {
337
- itemIndex += 1;
338
- const index = itemIndex;
339
- const role = item.role ?? "menuitem";
340
- return (
341
- <button
342
- key={item.key}
343
- ref={(node) => {
344
- itemRefs.current[index] = node;
345
- }}
346
- type="button"
347
- role={role}
348
- disabled={item.disabled}
349
- title={item.title}
350
- tabIndex={index === activeIndex ? 0 : -1}
351
- {...(role === "menuitem"
352
- ? {}
353
- : { "aria-checked": item.checked === "mixed" ? ("mixed" as const) : !!item.checked })}
354
- {...(item.submenu ? { "aria-haspopup": "menu" as const, "aria-expanded": false } : {})}
355
- onClick={() => selectItem(item)}
356
- className="w-full flex items-start gap-2 px-3 py-2 text-left text-sm text-text hover:bg-surface-alt disabled:opacity-50 disabled:hover:bg-transparent"
357
- >
358
- <span className="w-4 shrink-0 flex justify-center pt-0.5">
359
- {item.key === "__back" && (
360
- <HiChevronLeft size={14} aria-hidden="true" className="text-text-muted" />
361
- )}
362
- {item.checked === "mixed" ? (
363
- <HiMinus size={14} aria-hidden="true" className="text-primary-dark" />
364
- ) : (
365
- item.checked && <HiCheck size={14} aria-hidden="true" className="text-primary-dark" />
366
- )}
367
- </span>
368
- <span className="min-w-0 flex-1">
369
- <span className="flex h-5 items-center gap-1.5">
370
- {item.icon && (
371
- <span aria-hidden="true" className="shrink-0 text-text-muted">
372
- {item.icon}
373
- </span>
374
- )}
375
- {item.swatchColor && (
376
- <span
377
- aria-hidden="true"
378
- className="w-2.5 h-2.5 rounded-full shrink-0"
379
- style={{ backgroundColor: item.swatchColor }}
380
- />
381
- )}
382
- <span className="truncate">{item.label}</span>
383
- </span>
384
- {item.description && (
385
- <span className="block h-4 text-xs leading-4 text-text-muted truncate font-normal">
386
- {item.description}
387
- </span>
388
- )}
389
- </span>
390
- {item.submenu && (
391
- <HiChevronRight size={14} aria-hidden="true" className="shrink-0 mt-0.5 text-text-muted" />
392
- )}
393
- </button>
394
- );
395
- })}
396
- {section.note && <p className="px-3 py-1 text-xs leading-4 text-text-muted">{section.note}</p>}
397
- </div>
398
- ))}
399
- </div>
400
- </PopoverPortal>
401
- )}
402
- </>
403
- );
404
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import React, { ReactNode, useEffect, useRef, useState } from "react";
6
+ import { HiCheck, HiChevronDown, HiChevronLeft, HiChevronRight, HiMinus } from "react-icons/hi2";
7
+ import PopoverPortal from "@rapidmx/react-shared/components/overlays/PopoverPortal.js";
8
+
9
+ /** What every row has. `checked` turns it into a radio/checkbox item (the caller says which via `role`) and
10
+ * draws the checkmark column; without it the row is a plain command. */
11
+ interface MenuItemBase {
12
+ key: string;
13
+ label: string;
14
+ /** A one-line explanation under the label, for an item whose effect isn't obvious from its name. */
15
+ description?: string;
16
+ role?: "menuitem" | "menuitemradio" | "menuitemcheckbox";
17
+ /** `"mixed"` is ARIA's third checkbox state - some of the things this row acts on have it and some
18
+ * don't, which is what a label applied to only part of a multi-message selection looks like. */
19
+ checked?: boolean | "mixed";
20
+ /** A colour swatch before the label - a label's own colour. */
21
+ swatchColor?: string;
22
+ /** An icon before the label, for a menu whose rows are commands (the reading pane's "More actions"). */
23
+ icon?: ReactNode;
24
+ /** A tooltip for the row - the full text of a label the row truncates. */
25
+ title?: string;
26
+ disabled?: boolean;
27
+ /** Leaves the menu open after choosing this row, for a multi-select list where several rows are ticked
28
+ * before one command commits them all. */
29
+ keepOpen?: boolean;
30
+ }
31
+
32
+ /** A row that does something when chosen. */
33
+ export interface MenuCommandSpec extends MenuItemBase {
34
+ onSelect: () => void;
35
+ submenu?: never;
36
+ }
37
+
38
+ /** A row that opens a submenu instead: choosing it replaces the menu's contents with these sections, under
39
+ * a Back row. One level deep, which is all any menu here needs - so it has nothing of its own to do. */
40
+ export interface MenuSubmenuSpec extends MenuItemBase {
41
+ submenu: MenuSectionSpec[];
42
+ onSelect?: never;
43
+ }
44
+
45
+ export type MenuItemSpec = MenuCommandSpec | MenuSubmenuSpec;
46
+
47
+ /** A labelled group of items. Groups after the first are drawn with a separator above them. */
48
+ export interface MenuSectionSpec {
49
+ key: string;
50
+ label?: string;
51
+ /** A short note under the group's items - e.g. why some of them are unavailable right now. */
52
+ note?: string;
53
+ items: MenuItemSpec[];
54
+ }
55
+
56
+ // `PopoverPortal` positions a fixed-size box (it has no auto-height mode), so the menu's height is
57
+ // computed from its own contents rather than measured - from whichever level is *shown*, so a submenu
58
+ // isn't left standing in the parent menu's taller box. These are the exact heights the classes below
59
+ // render at, so the box is never short enough to clip its last row: an item is `h-9`, a group label
60
+ // `h-6`, a note as many `leading-4` lines as it wraps to, a separator a 1px rule inside `my-1`, and the
61
+ // list itself `py-1`.
62
+ const ITEM_HEIGHT = 36;
63
+ const ITEM_DESCRIPTION_HEIGHT = 16;
64
+ const GROUP_LABEL_HEIGHT = 24;
65
+ const NOTE_LINE_HEIGHT = 16;
66
+ const NOTE_PADDING = 4;
67
+ /** A note wraps, so its height depends on how much of it fits a line: `text-xs` averages a little over 6px
68
+ * a character, and the note sits inside the list's `px-3`. Rounded so the estimate is never *under* the
69
+ * lines the browser actually draws - a box a few pixels too tall shows blank space, one too short clips. */
70
+ const NOTE_CHAR_WIDTH = 6.4;
71
+ const NOTE_PADDING_X = 24;
72
+ const SEPARATOR_HEIGHT = 9;
73
+ const LIST_PADDING = 8;
74
+ const MENU_MAX_HEIGHT = 460;
75
+ const DEFAULT_MENU_WIDTH = 248;
76
+
77
+ /** How tall `note` renders at `width`, wrapped. */
78
+ function noteHeight(note: string, width: number): number {
79
+ const charsPerLine = Math.max(1, Math.floor((width - NOTE_PADDING_X) / NOTE_CHAR_WIDTH));
80
+ return Math.ceil(note.length / charsPerLine) * NOTE_LINE_HEIGHT + NOTE_PADDING;
81
+ }
82
+
83
+ /** The height `PopoverPortal` is asked for - exact for a short menu, capped (the list scrolls) for a long one. */
84
+ export function menuHeight(sections: MenuSectionSpec[], width: number = DEFAULT_MENU_WIDTH): number {
85
+ let height = LIST_PADDING;
86
+ sections.forEach((section, index) => {
87
+ if (index > 0) {
88
+ height += SEPARATOR_HEIGHT;
89
+ }
90
+ if (section.label) {
91
+ height += GROUP_LABEL_HEIGHT;
92
+ }
93
+ for (const item of section.items) {
94
+ height += ITEM_HEIGHT + (item.description ? ITEM_DESCRIPTION_HEIGHT : 0);
95
+ }
96
+ if (section.note) {
97
+ height += noteHeight(section.note, width);
98
+ }
99
+ });
100
+ return Math.min(height, MENU_MAX_HEIGHT);
101
+ }
102
+
103
+ export interface MenuButtonProps {
104
+ /** The trigger's visible label. Not drawn (nor is the chevron) with `iconOnly`, where `aria-label` is all the trigger says. */
105
+ label: ReactNode;
106
+ /** The trigger is just its `icon` - a round icon button like the reading pane's own command row, whose `className` it takes over
107
+ * completely. `aria-label` (and `title`) name it. */
108
+ iconOnly?: boolean;
109
+ /** The trigger's accessible name, which also names the menu itself - includes the current selection
110
+ * where there is one ("Filter: Unread"), so the button says what it's set to, not just what it does. */
111
+ "aria-label": string;
112
+ icon?: ReactNode;
113
+ disabled?: boolean;
114
+ title?: string;
115
+ sections: MenuSectionSpec[];
116
+ width?: number;
117
+ /** Extra classes for the trigger, on top of the shared toolbar-button styling. */
118
+ className?: string;
119
+ /** Told whenever the menu opens or closes - how a caller resets a draft it keeps for the menu's own
120
+ * multi-select rows (see `useLabelDraft()`). */
121
+ onOpenChange?: (open: boolean) => void;
122
+ }
123
+
124
+ /**
125
+ * A toolbar button that opens an ARIA menu: `role="menu"` rows with checkmarks for the current choice,
126
+ * full keyboard support (Enter/Space or Arrow Down to open, arrows/Home/End to move with wrap, Enter/Space
127
+ * to choose, Escape or Tab to close with focus returning to the trigger) and a click outside to dismiss.
128
+ *
129
+ * Rendered through `PopoverPortal` rather than as an absolutely-positioned child: the mail list toolbar
130
+ * lives inside the list's own `overflow-y-auto` scroll container, which clips an absolute popup however
131
+ * high its `z-index` - the same reason Compose's own pickers portal out (see `PopoverPortal`'s own doc
132
+ * comment). The portal supplies the positioning, the outside-click dismissal and the box; the menu
133
+ * semantics, roving focus and keyboard handling are this component's own.
134
+ */
135
+ export default function MenuButton({
136
+ label,
137
+ iconOnly = false,
138
+ icon,
139
+ disabled,
140
+ title,
141
+ sections,
142
+ width = DEFAULT_MENU_WIDTH,
143
+ className = "",
144
+ "aria-label": ariaLabel,
145
+ onOpenChange,
146
+ }: MenuButtonProps) {
147
+ const [open, setOpen] = useState(false);
148
+ const [activeIndex, setActiveIndex] = useState(0);
149
+ // The key of the item whose submenu is showing, or `null` at the top level. Held as a key, not as the
150
+ // item itself, because `sections` is rebuilt on every render.
151
+ const [submenuKey, setSubmenuKey] = useState<string | null>(null);
152
+ const triggerRef = useRef<HTMLButtonElement>(null);
153
+ const itemRefs = useRef<(HTMLButtonElement | null)[]>([]);
154
+ // State, not a ref: `PopoverPortal` renders nothing at all until its own positioning effect has run, so
155
+ // the rows don't exist yet when this component's effects first fire. Keying the focus effect on the
156
+ // menu node itself makes it run again once they do.
157
+ const [menuNode, setMenuNode] = useState<HTMLDivElement | null>(null);
158
+
159
+ const openSubmenu = sections
160
+ .flatMap((section) => section.items)
161
+ .find((item): item is MenuSubmenuSpec => item.key === submenuKey && !!item.submenu);
162
+ /** The row that leaves a submenu again - synthesized rather than asked of the caller, so every submenu
163
+ * has the same way back however it was built. */
164
+ const backItem: MenuCommandSpec = {
165
+ key: "__back",
166
+ label: `Back to ${ariaLabel}`,
167
+ keepOpen: true,
168
+ onSelect: () => leaveSubmenu(),
169
+ };
170
+ const shownSections: MenuSectionSpec[] = openSubmenu
171
+ ? [{ key: "__back", items: [backItem] }, ...openSubmenu.submenu]
172
+ : sections;
173
+ const items = shownSections.flatMap((section) => section.items);
174
+ const enabledIndexes = items.map((item, index) => (item.disabled ? -1 : index)).filter((index) => index !== -1);
175
+
176
+ /** The row focus starts on: the current choice where there is one, else the first row that can take focus. */
177
+ function initialActiveIndex(within: MenuItemSpec[]): number {
178
+ const checked = within.findIndex((item) => item.checked === true && !item.disabled);
179
+ const enabled = within.map((item, index) => (item.disabled ? -1 : index)).filter((index) => index !== -1);
180
+ return checked === -1 ? (enabled[0] ?? 0) : checked;
181
+ }
182
+
183
+ function openMenu() {
184
+ setSubmenuKey(null);
185
+ setActiveIndex(initialActiveIndex(sections.flatMap((section) => section.items)));
186
+ setOpen(true);
187
+ onOpenChange?.(true);
188
+ }
189
+
190
+ function closeMenu(returnFocus: boolean) {
191
+ setOpen(false);
192
+ setSubmenuKey(null);
193
+ onOpenChange?.(false);
194
+ if (returnFocus) {
195
+ triggerRef.current?.focus();
196
+ }
197
+ }
198
+
199
+ function enterSubmenu(item: MenuSubmenuSpec) {
200
+ setSubmenuKey(item.key);
201
+ const rows = item.submenu.flatMap((section) => section.items);
202
+ // Past the Back row, onto the first row of the submenu itself - or, when none of them can take focus (every row is unavailable right now), onto
203
+ // the Back row, so the keyboard still has a place to be.
204
+ setActiveIndex(rows.some((row) => !row.disabled) ? 1 + initialActiveIndex(rows) : 0);
205
+ }
206
+
207
+ function leaveSubmenu() {
208
+ // Back on the row the submenu was opened from.
209
+ const parentIndex = sections.flatMap((section) => section.items).findIndex((item) => item.key === submenuKey);
210
+ setSubmenuKey(null);
211
+ setActiveIndex(parentIndex);
212
+ }
213
+
214
+ /** What a row does when it is chosen: open its submenu, or run it and close unless it asked to stay. */
215
+ function selectItem(item: MenuItemSpec) {
216
+ if (item.submenu) {
217
+ enterSubmenu(item);
218
+ return;
219
+ }
220
+ item.onSelect();
221
+ if (!item.keepOpen) {
222
+ closeMenu(true);
223
+ }
224
+ }
225
+
226
+ // Roving focus: only the active row is tabbable, and it takes DOM focus whenever it changes, so the
227
+ // arrow keys move the screen reader's cursor too rather than only a visual highlight.
228
+ useEffect(() => {
229
+ if (open && menuNode) {
230
+ // A disabled row can't take focus, so a menu with nothing enabled focuses its own container -
231
+ // otherwise the keys it handles would go to whatever had focus before it opened.
232
+ if (enabledIndexes.length === 0) {
233
+ menuNode.focus();
234
+ } else {
235
+ itemRefs.current[activeIndex]?.focus();
236
+ }
237
+ }
238
+ // `submenuKey` too: drilling in or out can land on the same index in the other level's list, and
239
+ // the row that index *means* is a different button, which the effect must move focus to.
240
+ }, [open, activeIndex, submenuKey, menuNode]);
241
+
242
+ function moveActive(delta: number) {
243
+ if (enabledIndexes.length === 0) {
244
+ return;
245
+ }
246
+ const position = enabledIndexes.indexOf(activeIndex);
247
+ setActiveIndex(enabledIndexes[(position + delta + enabledIndexes.length) % enabledIndexes.length]);
248
+ }
249
+
250
+ function handleMenuKeyDown(e: React.KeyboardEvent) {
251
+ if (e.key === "ArrowDown") {
252
+ e.preventDefault();
253
+ moveActive(1);
254
+ } else if (e.key === "ArrowUp") {
255
+ e.preventDefault();
256
+ moveActive(-1);
257
+ } else if (e.key === "Home") {
258
+ e.preventDefault();
259
+ setActiveIndex(enabledIndexes[0] ?? 0);
260
+ } else if (e.key === "End") {
261
+ e.preventDefault();
262
+ setActiveIndex(enabledIndexes[enabledIndexes.length - 1] ?? 0);
263
+ } else if (e.key === "ArrowRight" && items[activeIndex]?.submenu) {
264
+ e.preventDefault();
265
+ enterSubmenu(items[activeIndex]);
266
+ } else if ((e.key === "ArrowLeft" || e.key === "Escape") && openSubmenu) {
267
+ // ARIA's own submenu behaviour: Escape leaves the submenu for its parent menu rather than
268
+ // dismissing the whole thing.
269
+ e.preventDefault();
270
+ leaveSubmenu();
271
+ } else if (e.key === "Escape" || e.key === "Tab") {
272
+ e.preventDefault();
273
+ closeMenu(true);
274
+ }
275
+ }
276
+
277
+ function handleTriggerKeyDown(e: React.KeyboardEvent) {
278
+ if (!open && (e.key === "ArrowDown" || e.key === "ArrowUp")) {
279
+ e.preventDefault();
280
+ openMenu();
281
+ }
282
+ }
283
+
284
+ let itemIndex = -1;
285
+
286
+ return (
287
+ <>
288
+ <button
289
+ ref={triggerRef}
290
+ type="button"
291
+ aria-haspopup="menu"
292
+ aria-expanded={open}
293
+ aria-label={ariaLabel}
294
+ title={title}
295
+ disabled={disabled}
296
+ onClick={() => (open ? closeMenu(false) : openMenu())}
297
+ onKeyDown={handleTriggerKeyDown}
298
+ className={
299
+ iconOnly
300
+ ? className
301
+ : [
302
+ // `min-w-0` so a long label ("Filter: Has attachments") truncates instead of pushing
303
+ // whatever sits beside it in the toolbar off the edge of a 384px list column.
304
+ "inline-flex min-w-0 items-center gap-1 px-2 py-1 rounded-md text-sm text-text hover:bg-surface-alt disabled:opacity-50 disabled:hover:bg-transparent",
305
+ className,
306
+ ].join(" ")
307
+ }
308
+ >
309
+ {icon}
310
+ {!iconOnly && <span className="truncate">{label}</span>}
311
+ {!iconOnly && <HiChevronDown size={14} aria-hidden="true" className="shrink-0 text-text-muted" />}
312
+ </button>
313
+ {open && (
314
+ <PopoverPortal
315
+ anchorRef={triggerRef}
316
+ onClose={() => closeMenu(false)}
317
+ width={width}
318
+ height={menuHeight(shownSections, width)}
319
+ aria-label={ariaLabel}
320
+ >
321
+ <div
322
+ ref={setMenuNode}
323
+ role="menu"
324
+ tabIndex={-1}
325
+ aria-label={ariaLabel}
326
+ onKeyDown={handleMenuKeyDown}
327
+ className="flex-1 overflow-y-auto py-1"
328
+ >
329
+ {shownSections.map((section, sectionIndex) => (
330
+ <div key={section.key} role="group" aria-label={section.label} className={sectionIndex > 0 ? "border-t border-border mt-1 pt-1" : ""}>
331
+ {section.label && (
332
+ <div aria-hidden="true" className="h-6 flex items-center px-3 text-xs font-semibold uppercase tracking-wide text-text-muted">
333
+ {section.label}
334
+ </div>
335
+ )}
336
+ {section.items.map((item) => {
337
+ itemIndex += 1;
338
+ const index = itemIndex;
339
+ const role = item.role ?? "menuitem";
340
+ return (
341
+ <button
342
+ key={item.key}
343
+ ref={(node) => {
344
+ itemRefs.current[index] = node;
345
+ }}
346
+ type="button"
347
+ role={role}
348
+ disabled={item.disabled}
349
+ title={item.title}
350
+ tabIndex={index === activeIndex ? 0 : -1}
351
+ {...(role === "menuitem"
352
+ ? {}
353
+ : { "aria-checked": item.checked === "mixed" ? ("mixed" as const) : !!item.checked })}
354
+ {...(item.submenu ? { "aria-haspopup": "menu" as const, "aria-expanded": false } : {})}
355
+ onClick={() => selectItem(item)}
356
+ className="w-full flex items-start gap-2 px-3 py-2 text-left text-sm text-text hover:bg-surface-alt disabled:opacity-50 disabled:hover:bg-transparent"
357
+ >
358
+ <span className="w-4 shrink-0 flex justify-center pt-0.5">
359
+ {item.key === "__back" && (
360
+ <HiChevronLeft size={14} aria-hidden="true" className="text-text-muted" />
361
+ )}
362
+ {item.checked === "mixed" ? (
363
+ <HiMinus size={14} aria-hidden="true" className="text-primary-dark" />
364
+ ) : (
365
+ item.checked && <HiCheck size={14} aria-hidden="true" className="text-primary-dark" />
366
+ )}
367
+ </span>
368
+ <span className="min-w-0 flex-1">
369
+ <span className="flex h-5 items-center gap-1.5">
370
+ {item.icon && (
371
+ <span aria-hidden="true" className="shrink-0 text-text-muted">
372
+ {item.icon}
373
+ </span>
374
+ )}
375
+ {item.swatchColor && (
376
+ <span
377
+ aria-hidden="true"
378
+ className="w-2.5 h-2.5 rounded-full shrink-0"
379
+ style={{ backgroundColor: item.swatchColor }}
380
+ />
381
+ )}
382
+ <span className="truncate">{item.label}</span>
383
+ </span>
384
+ {item.description && (
385
+ <span className="block h-4 text-xs leading-4 text-text-muted truncate font-normal">
386
+ {item.description}
387
+ </span>
388
+ )}
389
+ </span>
390
+ {item.submenu && (
391
+ <HiChevronRight size={14} aria-hidden="true" className="shrink-0 mt-0.5 text-text-muted" />
392
+ )}
393
+ </button>
394
+ );
395
+ })}
396
+ {section.note && <p className="px-3 py-1 text-xs leading-4 text-text-muted">{section.note}</p>}
397
+ </div>
398
+ ))}
399
+ </div>
400
+ </PopoverPortal>
401
+ )}
402
+ </>
403
+ );
404
+ }