@rapidmx/web-client 0.18.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 -1545
  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 +328 -48
  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,315 +1,315 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import React, { KeyboardEvent, ReactNode, useEffect, useLayoutEffect, useRef, useState } from "react";
6
- import { createPortal } from "react-dom";
7
- import type { IconType } from "react-icons";
8
- import { HiOutlineEllipsisHorizontal } from "react-icons/hi2";
9
-
10
- /** One button of a `ResponsiveToolbar`. */
11
- export interface ToolbarAction {
12
- id: string;
13
- /** The visible caption while there is room, else the tooltip and the accessible name. */
14
- label: string;
15
- icon: IconType;
16
- onClick: () => void;
17
- disabled?: boolean;
18
- /** A toggle: the button's pressed state. */
19
- pressed?: boolean;
20
- /** `title` and `aria-keyshortcuts` for a button with a shortcut - kept as given, whatever the layout. */
21
- hint?: { title: string; "aria-keyshortcuts"?: string };
22
- /** Actions with the same `group` sit together; a divider goes between groups. */
23
- group: number;
24
- /** Which goes into the "More" menu first when there is not room: the lowest number first. Never used for `essential`. */
25
- rank: number;
26
- /** Never moves into the "More" menu (the primary action). */
27
- essential?: boolean;
28
- }
29
-
30
- /** Room (px) each kind of button takes, and what the bar spends on its padding, a divider and the "More" button - the layout is computed from them
31
- * rather than measured, so the first paint on the client is already right and nothing jumps. */
32
- export const LABELLED_BUTTON_WIDTH = 64;
33
- export const ICON_BUTTON_WIDTH = 36;
34
- const BAR_PADDING = 16;
35
- const DIVIDER_WIDTH = 9;
36
-
37
- export interface ToolbarLayout {
38
- /** Captions under the icons. */
39
- labels: boolean;
40
- /** The ids of the actions shown as buttons, in order. The rest are in the "More" menu. */
41
- visible: string[];
42
- }
43
-
44
- function widthOf(actions: ToolbarAction[], perButton: number, more: boolean): number {
45
- const groups = new Set(actions.map((action) => action.group)).size;
46
- return BAR_PADDING + actions.length * perButton + Math.max(0, groups - 1) * DIVIDER_WIDTH + (more ? perButton : 0);
47
- }
48
-
49
- /**
50
- * Which buttons a bar of `width` px shows, and how: every one with its caption when that fits; else every one as an icon (the captions go first);
51
- * else as many icons as fit, the least important (`rank`) going into a "More" menu one at a time - the essential ones stay whatever the width.
52
- * Pure, so it is the same on the server and the client for a given width; `width === undefined` (not measured yet, no ResizeObserver) shows
53
- * everything.
54
- */
55
- export function layoutToolbar(actions: ToolbarAction[], width: number | undefined): ToolbarLayout {
56
- const ordered = [...actions].sort((a, b) => a.group - b.group);
57
- const all = ordered.map((action) => action.id);
58
- if (width === undefined) {
59
- return { labels: true, visible: all };
60
- }
61
- if (widthOf(ordered, LABELLED_BUTTON_WIDTH, false) <= width) {
62
- return { labels: true, visible: all };
63
- }
64
- if (widthOf(ordered, ICON_BUTTON_WIDTH, false) <= width) {
65
- return { labels: false, visible: all };
66
- }
67
- // Not everything fits: the least important actions go into "More" one at a time, until what is left and the "More" button do.
68
- let shown = ordered;
69
- for (const dropped of ordered.filter((action) => !action.essential).sort((x, y) => x.rank - y.rank)) {
70
- if (widthOf(shown, ICON_BUTTON_WIDTH, true) <= width) {
71
- break;
72
- }
73
- shown = shown.filter((action) => action !== dropped);
74
- }
75
- return { labels: false, visible: shown.map((action) => action.id) };
76
- }
77
-
78
- /** The width of `ref`'s element, kept current with a ResizeObserver; `undefined` until measured (and where there is no ResizeObserver). */
79
- export function useElementWidth(ref: React.RefObject<HTMLElement | null>): number | undefined {
80
- const [width, setWidth] = useState<number | undefined>(undefined);
81
- useLayoutEffect(() => {
82
- const element = ref.current;
83
- if (!element || typeof ResizeObserver === "undefined") {
84
- return;
85
- }
86
- setWidth(element.getBoundingClientRect().width);
87
- const observer = new ResizeObserver((entries) => {
88
- const box = entries[0]?.contentRect.width;
89
- if (box !== undefined) {
90
- setWidth(Math.round(box));
91
- }
92
- });
93
- observer.observe(element);
94
- return () => observer.disconnect();
95
- }, [ref]);
96
- return width;
97
- }
98
-
99
- function ToolbarButton({ action, labels }: { action: ToolbarAction; labels: boolean }) {
100
- const Icon = action.icon;
101
- return (
102
- <button
103
- type="button"
104
- onClick={action.onClick}
105
- disabled={action.disabled}
106
- aria-pressed={action.pressed}
107
- // A tooltip when the caption is not on show (the shortcut's own title, when it has one, wins).
108
- title={action.hint?.title ?? (labels ? undefined : action.label)}
109
- aria-keyshortcuts={action.hint?.["aria-keyshortcuts"]}
110
- data-toolbar-item=""
111
- className={[
112
- "flex shrink-0 flex-col items-center justify-center gap-1 rounded-sm text-xs disabled:opacity-40 disabled:cursor-not-allowed",
113
- labels ? "w-16 py-1.5" : "h-9 w-9",
114
- action.pressed ? "bg-primary/10 text-primary-dark" : "text-text-muted hover:not-disabled:bg-surface-alt hover:not-disabled:text-text",
115
- ].join(" ")}
116
- >
117
- <Icon size={18} aria-hidden="true" />
118
- <span className={labels ? "leading-tight text-center" : "sr-only"}>{action.label}</span>
119
- </button>
120
- );
121
- }
122
-
123
- /** The menu that holds what does not fit: a button, and a portalled `role="menu"` so nothing clips it. Arrow keys, Home, End and Escape; focus returns to the button. */
124
- function MoreMenu({ actions }: { actions: ToolbarAction[] }) {
125
- const [open, setOpen] = useState(false);
126
- const [anchor, setAnchor] = useState<{ right: number; top: number } | null>(null);
127
- const buttonRef = useRef<HTMLButtonElement>(null);
128
- const menuRef = useRef<HTMLDivElement>(null);
129
-
130
- useLayoutEffect(() => {
131
- if (!open) {
132
- setAnchor(null);
133
- return;
134
- }
135
- function place() {
136
- const rect = buttonRef.current!.getBoundingClientRect();
137
- setAnchor({ right: Math.max(8, window.innerWidth - rect.right), top: rect.bottom + 4 });
138
- }
139
- place();
140
- window.addEventListener("resize", place);
141
- window.addEventListener("scroll", place, true);
142
- return () => {
143
- window.removeEventListener("resize", place);
144
- window.removeEventListener("scroll", place, true);
145
- };
146
- }, [open]);
147
-
148
- // On open, the first item that can be used gets the focus.
149
- useEffect(() => {
150
- if (open && anchor) {
151
- menuRef.current?.querySelector<HTMLElement>('[role="menuitem"]:not(:disabled)')?.focus();
152
- }
153
- }, [open, anchor !== null]);
154
-
155
- useEffect(() => {
156
- if (!open) {
157
- return;
158
- }
159
- function handlePointerDown(event: MouseEvent) {
160
- if (event.target instanceof Node && !buttonRef.current?.contains(event.target) && !menuRef.current?.contains(event.target)) {
161
- setOpen(false);
162
- }
163
- }
164
- document.addEventListener("mousedown", handlePointerDown);
165
- return () => document.removeEventListener("mousedown", handlePointerDown);
166
- }, [open]);
167
-
168
- function close(refocus: boolean) {
169
- setOpen(false);
170
- if (refocus) {
171
- buttonRef.current?.focus();
172
- }
173
- }
174
-
175
- function handleMenuKeyDown(event: KeyboardEvent<HTMLDivElement>) {
176
- const items = Array.from(menuRef.current!.querySelectorAll<HTMLElement>('[role="menuitem"]:not(:disabled)'));
177
- const index = items.indexOf(document.activeElement as HTMLElement);
178
- const focusAt = (next: number) => {
179
- event.preventDefault();
180
- items[(next + items.length) % items.length]?.focus();
181
- };
182
- if (event.key === "Escape") {
183
- event.preventDefault();
184
- event.stopPropagation();
185
- close(true);
186
- } else if (event.key === "ArrowDown") {
187
- focusAt(index + 1);
188
- } else if (event.key === "ArrowUp") {
189
- focusAt(index - 1);
190
- } else if (event.key === "Home") {
191
- focusAt(0);
192
- } else if (event.key === "End") {
193
- focusAt(items.length - 1);
194
- } else if (event.key === "Tab") {
195
- close(false);
196
- }
197
- }
198
-
199
- return (
200
- <>
201
- <button
202
- ref={buttonRef}
203
- type="button"
204
- aria-haspopup="menu"
205
- aria-expanded={open}
206
- aria-label="More actions"
207
- title="More actions"
208
- data-toolbar-item=""
209
- onClick={() => setOpen((current) => !current)}
210
- onKeyDown={(event) => {
211
- if (event.key === "ArrowDown" && !open) {
212
- event.preventDefault();
213
- setOpen(true);
214
- }
215
- }}
216
- className={[
217
- "flex h-9 w-9 shrink-0 items-center justify-center rounded-sm text-text-muted hover:bg-surface-alt hover:text-text",
218
- open ? "bg-surface-alt text-text" : "",
219
- ].join(" ")}
220
- >
221
- <HiOutlineEllipsisHorizontal size={18} aria-hidden="true" />
222
- </button>
223
- {open &&
224
- anchor &&
225
- createPortal(
226
- <div
227
- ref={menuRef}
228
- role="menu"
229
- aria-label="More actions"
230
- onKeyDown={handleMenuKeyDown}
231
- style={{ position: "fixed", right: anchor.right, top: anchor.top }}
232
- className="z-[70] w-52 max-w-[calc(100vw-1rem)] rounded-md border border-border bg-surface py-1.5 shadow-modal"
233
- >
234
- {actions.map((action) => {
235
- const Icon = action.icon;
236
- return (
237
- <button
238
- key={action.id}
239
- type="button"
240
- role="menuitem"
241
- disabled={action.disabled}
242
- title={action.hint?.title}
243
- aria-keyshortcuts={action.hint?.["aria-keyshortcuts"]}
244
- onClick={() => {
245
- close(true);
246
- action.onClick();
247
- }}
248
- className="flex w-full items-center gap-3 px-3.5 py-2 text-left text-sm text-text hover:not-disabled:bg-surface-alt focus-visible:bg-surface-alt disabled:cursor-not-allowed disabled:opacity-40"
249
- >
250
- <Icon size={18} aria-hidden="true" className="shrink-0 text-text-muted" />
251
- {action.label}
252
- </button>
253
- );
254
- })}
255
- </div>,
256
- document.body,
257
- )}
258
- </>
259
- );
260
- }
261
-
262
- /**
263
- * A toolbar that fits the column it is in - never wider, never over another pane. It measures its own width (`ResizeObserver`) and shows every
264
- * action with a caption when there is room; when there is not, the captions go first (each button keeps its tooltip and accessible name), then the
265
- * least important actions move into a "More" menu (`layoutToolbar()`). Arrow keys, Home and End move between the buttons; the menu is a real
266
- * `role="menu"`. `children` (a hidden file input, say) are rendered inside the toolbar's element but take no room.
267
- */
268
- export default function ResponsiveToolbar({ label, actions, leading, children }: { label: string; actions: ToolbarAction[]; leading?: ReactNode; children?: ReactNode }) {
269
- const ref = useRef<HTMLDivElement>(null);
270
- const width = useElementWidth(ref);
271
- const layout = layoutToolbar(actions, width);
272
- const ordered = [...actions].sort((a, b) => a.group - b.group);
273
- const shown = ordered.filter((action) => layout.visible.includes(action.id));
274
- const hidden = ordered.filter((action) => !layout.visible.includes(action.id));
275
-
276
- function handleKeyDown(event: KeyboardEvent<HTMLDivElement>) {
277
- if (!["ArrowLeft", "ArrowRight", "Home", "End"].includes(event.key) || (event.target as HTMLElement).closest('[role="menu"]')) {
278
- return;
279
- }
280
- const items = Array.from(ref.current!.querySelectorAll<HTMLElement>("[data-toolbar-item]:not(:disabled)"));
281
- const index = items.indexOf(event.target as HTMLElement);
282
- if (index === -1) {
283
- return;
284
- }
285
- event.preventDefault();
286
- const next = event.key === "Home" ? 0 : event.key === "End" ? items.length - 1 : index + (event.key === "ArrowRight" ? 1 : -1);
287
- items[(next + items.length) % items.length].focus();
288
- }
289
-
290
- return (
291
- <div
292
- ref={ref}
293
- role="toolbar"
294
- aria-label={label}
295
- onKeyDown={handleKeyDown}
296
- // `overflow-x-clip` is the guarantee: whatever the layout says, the bar can never paint outside its own column.
297
- className="flex min-w-0 items-stretch gap-0.5 overflow-x-clip border-b border-border bg-surface-alt px-2 py-1"
298
- >
299
- {leading}
300
- {shown.map((action, index) => (
301
- <React.Fragment key={action.id}>
302
- {index > 0 && shown[index - 1].group !== action.group && <div className="my-1 w-px shrink-0 self-stretch bg-border" aria-hidden="true" />}
303
- <ToolbarButton action={action} labels={layout.labels} />
304
- </React.Fragment>
305
- ))}
306
- {hidden.length > 0 && (
307
- <>
308
- <div className="my-1 w-px shrink-0 self-stretch bg-border" aria-hidden="true" />
309
- <MoreMenu actions={hidden} />
310
- </>
311
- )}
312
- {children}
313
- </div>
314
- );
315
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import React, { KeyboardEvent, ReactNode, useEffect, useLayoutEffect, useRef, useState } from "react";
6
+ import { createPortal } from "react-dom";
7
+ import type { IconType } from "react-icons";
8
+ import { HiOutlineEllipsisHorizontal } from "react-icons/hi2";
9
+
10
+ /** One button of a `ResponsiveToolbar`. */
11
+ export interface ToolbarAction {
12
+ id: string;
13
+ /** The visible caption while there is room, else the tooltip and the accessible name. */
14
+ label: string;
15
+ icon: IconType;
16
+ onClick: () => void;
17
+ disabled?: boolean;
18
+ /** A toggle: the button's pressed state. */
19
+ pressed?: boolean;
20
+ /** `title` and `aria-keyshortcuts` for a button with a shortcut - kept as given, whatever the layout. */
21
+ hint?: { title: string; "aria-keyshortcuts"?: string };
22
+ /** Actions with the same `group` sit together; a divider goes between groups. */
23
+ group: number;
24
+ /** Which goes into the "More" menu first when there is not room: the lowest number first. Never used for `essential`. */
25
+ rank: number;
26
+ /** Never moves into the "More" menu (the primary action). */
27
+ essential?: boolean;
28
+ }
29
+
30
+ /** Room (px) each kind of button takes, and what the bar spends on its padding, a divider and the "More" button - the layout is computed from them
31
+ * rather than measured, so the first paint on the client is already right and nothing jumps. */
32
+ export const LABELLED_BUTTON_WIDTH = 64;
33
+ export const ICON_BUTTON_WIDTH = 36;
34
+ const BAR_PADDING = 16;
35
+ const DIVIDER_WIDTH = 9;
36
+
37
+ export interface ToolbarLayout {
38
+ /** Captions under the icons. */
39
+ labels: boolean;
40
+ /** The ids of the actions shown as buttons, in order. The rest are in the "More" menu. */
41
+ visible: string[];
42
+ }
43
+
44
+ function widthOf(actions: ToolbarAction[], perButton: number, more: boolean): number {
45
+ const groups = new Set(actions.map((action) => action.group)).size;
46
+ return BAR_PADDING + actions.length * perButton + Math.max(0, groups - 1) * DIVIDER_WIDTH + (more ? perButton : 0);
47
+ }
48
+
49
+ /**
50
+ * Which buttons a bar of `width` px shows, and how: every one with its caption when that fits; else every one as an icon (the captions go first);
51
+ * else as many icons as fit, the least important (`rank`) going into a "More" menu one at a time - the essential ones stay whatever the width.
52
+ * Pure, so it is the same on the server and the client for a given width; `width === undefined` (not measured yet, no ResizeObserver) shows
53
+ * everything.
54
+ */
55
+ export function layoutToolbar(actions: ToolbarAction[], width: number | undefined): ToolbarLayout {
56
+ const ordered = [...actions].sort((a, b) => a.group - b.group);
57
+ const all = ordered.map((action) => action.id);
58
+ if (width === undefined) {
59
+ return { labels: true, visible: all };
60
+ }
61
+ if (widthOf(ordered, LABELLED_BUTTON_WIDTH, false) <= width) {
62
+ return { labels: true, visible: all };
63
+ }
64
+ if (widthOf(ordered, ICON_BUTTON_WIDTH, false) <= width) {
65
+ return { labels: false, visible: all };
66
+ }
67
+ // Not everything fits: the least important actions go into "More" one at a time, until what is left and the "More" button do.
68
+ let shown = ordered;
69
+ for (const dropped of ordered.filter((action) => !action.essential).sort((x, y) => x.rank - y.rank)) {
70
+ if (widthOf(shown, ICON_BUTTON_WIDTH, true) <= width) {
71
+ break;
72
+ }
73
+ shown = shown.filter((action) => action !== dropped);
74
+ }
75
+ return { labels: false, visible: shown.map((action) => action.id) };
76
+ }
77
+
78
+ /** The width of `ref`'s element, kept current with a ResizeObserver; `undefined` until measured (and where there is no ResizeObserver). */
79
+ export function useElementWidth(ref: React.RefObject<HTMLElement | null>): number | undefined {
80
+ const [width, setWidth] = useState<number | undefined>(undefined);
81
+ useLayoutEffect(() => {
82
+ const element = ref.current;
83
+ if (!element || typeof ResizeObserver === "undefined") {
84
+ return;
85
+ }
86
+ setWidth(element.getBoundingClientRect().width);
87
+ const observer = new ResizeObserver((entries) => {
88
+ const box = entries[0]?.contentRect.width;
89
+ if (box !== undefined) {
90
+ setWidth(Math.round(box));
91
+ }
92
+ });
93
+ observer.observe(element);
94
+ return () => observer.disconnect();
95
+ }, [ref]);
96
+ return width;
97
+ }
98
+
99
+ function ToolbarButton({ action, labels }: { action: ToolbarAction; labels: boolean }) {
100
+ const Icon = action.icon;
101
+ return (
102
+ <button
103
+ type="button"
104
+ onClick={action.onClick}
105
+ disabled={action.disabled}
106
+ aria-pressed={action.pressed}
107
+ // A tooltip when the caption is not on show (the shortcut's own title, when it has one, wins).
108
+ title={action.hint?.title ?? (labels ? undefined : action.label)}
109
+ aria-keyshortcuts={action.hint?.["aria-keyshortcuts"]}
110
+ data-toolbar-item=""
111
+ className={[
112
+ "flex shrink-0 flex-col items-center justify-center gap-1 rounded-sm text-xs disabled:opacity-40 disabled:cursor-not-allowed",
113
+ labels ? "w-16 py-1.5" : "h-9 w-9",
114
+ action.pressed ? "bg-primary/10 text-primary-dark" : "text-text-muted hover:not-disabled:bg-surface-alt hover:not-disabled:text-text",
115
+ ].join(" ")}
116
+ >
117
+ <Icon size={18} aria-hidden="true" />
118
+ <span className={labels ? "leading-tight text-center" : "sr-only"}>{action.label}</span>
119
+ </button>
120
+ );
121
+ }
122
+
123
+ /** The menu that holds what does not fit: a button, and a portalled `role="menu"` so nothing clips it. Arrow keys, Home, End and Escape; focus returns to the button. */
124
+ function MoreMenu({ actions }: { actions: ToolbarAction[] }) {
125
+ const [open, setOpen] = useState(false);
126
+ const [anchor, setAnchor] = useState<{ right: number; top: number } | null>(null);
127
+ const buttonRef = useRef<HTMLButtonElement>(null);
128
+ const menuRef = useRef<HTMLDivElement>(null);
129
+
130
+ useLayoutEffect(() => {
131
+ if (!open) {
132
+ setAnchor(null);
133
+ return;
134
+ }
135
+ function place() {
136
+ const rect = buttonRef.current!.getBoundingClientRect();
137
+ setAnchor({ right: Math.max(8, window.innerWidth - rect.right), top: rect.bottom + 4 });
138
+ }
139
+ place();
140
+ window.addEventListener("resize", place);
141
+ window.addEventListener("scroll", place, true);
142
+ return () => {
143
+ window.removeEventListener("resize", place);
144
+ window.removeEventListener("scroll", place, true);
145
+ };
146
+ }, [open]);
147
+
148
+ // On open, the first item that can be used gets the focus.
149
+ useEffect(() => {
150
+ if (open && anchor) {
151
+ menuRef.current?.querySelector<HTMLElement>('[role="menuitem"]:not(:disabled)')?.focus();
152
+ }
153
+ }, [open, anchor !== null]);
154
+
155
+ useEffect(() => {
156
+ if (!open) {
157
+ return;
158
+ }
159
+ function handlePointerDown(event: MouseEvent) {
160
+ if (event.target instanceof Node && !buttonRef.current?.contains(event.target) && !menuRef.current?.contains(event.target)) {
161
+ setOpen(false);
162
+ }
163
+ }
164
+ document.addEventListener("mousedown", handlePointerDown);
165
+ return () => document.removeEventListener("mousedown", handlePointerDown);
166
+ }, [open]);
167
+
168
+ function close(refocus: boolean) {
169
+ setOpen(false);
170
+ if (refocus) {
171
+ buttonRef.current?.focus();
172
+ }
173
+ }
174
+
175
+ function handleMenuKeyDown(event: KeyboardEvent<HTMLDivElement>) {
176
+ const items = Array.from(menuRef.current!.querySelectorAll<HTMLElement>('[role="menuitem"]:not(:disabled)'));
177
+ const index = items.indexOf(document.activeElement as HTMLElement);
178
+ const focusAt = (next: number) => {
179
+ event.preventDefault();
180
+ items[(next + items.length) % items.length]?.focus();
181
+ };
182
+ if (event.key === "Escape") {
183
+ event.preventDefault();
184
+ event.stopPropagation();
185
+ close(true);
186
+ } else if (event.key === "ArrowDown") {
187
+ focusAt(index + 1);
188
+ } else if (event.key === "ArrowUp") {
189
+ focusAt(index - 1);
190
+ } else if (event.key === "Home") {
191
+ focusAt(0);
192
+ } else if (event.key === "End") {
193
+ focusAt(items.length - 1);
194
+ } else if (event.key === "Tab") {
195
+ close(false);
196
+ }
197
+ }
198
+
199
+ return (
200
+ <>
201
+ <button
202
+ ref={buttonRef}
203
+ type="button"
204
+ aria-haspopup="menu"
205
+ aria-expanded={open}
206
+ aria-label="More actions"
207
+ title="More actions"
208
+ data-toolbar-item=""
209
+ onClick={() => setOpen((current) => !current)}
210
+ onKeyDown={(event) => {
211
+ if (event.key === "ArrowDown" && !open) {
212
+ event.preventDefault();
213
+ setOpen(true);
214
+ }
215
+ }}
216
+ className={[
217
+ "flex h-9 w-9 shrink-0 items-center justify-center rounded-sm text-text-muted hover:bg-surface-alt hover:text-text",
218
+ open ? "bg-surface-alt text-text" : "",
219
+ ].join(" ")}
220
+ >
221
+ <HiOutlineEllipsisHorizontal size={18} aria-hidden="true" />
222
+ </button>
223
+ {open &&
224
+ anchor &&
225
+ createPortal(
226
+ <div
227
+ ref={menuRef}
228
+ role="menu"
229
+ aria-label="More actions"
230
+ onKeyDown={handleMenuKeyDown}
231
+ style={{ position: "fixed", right: anchor.right, top: anchor.top }}
232
+ className="z-[70] w-52 max-w-[calc(100vw-1rem)] rounded-md border border-border bg-surface py-1.5 shadow-modal"
233
+ >
234
+ {actions.map((action) => {
235
+ const Icon = action.icon;
236
+ return (
237
+ <button
238
+ key={action.id}
239
+ type="button"
240
+ role="menuitem"
241
+ disabled={action.disabled}
242
+ title={action.hint?.title}
243
+ aria-keyshortcuts={action.hint?.["aria-keyshortcuts"]}
244
+ onClick={() => {
245
+ close(true);
246
+ action.onClick();
247
+ }}
248
+ className="flex w-full items-center gap-3 px-3.5 py-2 text-left text-sm text-text hover:not-disabled:bg-surface-alt focus-visible:bg-surface-alt disabled:cursor-not-allowed disabled:opacity-40"
249
+ >
250
+ <Icon size={18} aria-hidden="true" className="shrink-0 text-text-muted" />
251
+ {action.label}
252
+ </button>
253
+ );
254
+ })}
255
+ </div>,
256
+ document.body,
257
+ )}
258
+ </>
259
+ );
260
+ }
261
+
262
+ /**
263
+ * A toolbar that fits the column it is in - never wider, never over another pane. It measures its own width (`ResizeObserver`) and shows every
264
+ * action with a caption when there is room; when there is not, the captions go first (each button keeps its tooltip and accessible name), then the
265
+ * least important actions move into a "More" menu (`layoutToolbar()`). Arrow keys, Home and End move between the buttons; the menu is a real
266
+ * `role="menu"`. `children` (a hidden file input, say) are rendered inside the toolbar's element but take no room.
267
+ */
268
+ export default function ResponsiveToolbar({ label, actions, leading, children }: { label: string; actions: ToolbarAction[]; leading?: ReactNode; children?: ReactNode }) {
269
+ const ref = useRef<HTMLDivElement>(null);
270
+ const width = useElementWidth(ref);
271
+ const layout = layoutToolbar(actions, width);
272
+ const ordered = [...actions].sort((a, b) => a.group - b.group);
273
+ const shown = ordered.filter((action) => layout.visible.includes(action.id));
274
+ const hidden = ordered.filter((action) => !layout.visible.includes(action.id));
275
+
276
+ function handleKeyDown(event: KeyboardEvent<HTMLDivElement>) {
277
+ if (!["ArrowLeft", "ArrowRight", "Home", "End"].includes(event.key) || (event.target as HTMLElement).closest('[role="menu"]')) {
278
+ return;
279
+ }
280
+ const items = Array.from(ref.current!.querySelectorAll<HTMLElement>("[data-toolbar-item]:not(:disabled)"));
281
+ const index = items.indexOf(event.target as HTMLElement);
282
+ if (index === -1) {
283
+ return;
284
+ }
285
+ event.preventDefault();
286
+ const next = event.key === "Home" ? 0 : event.key === "End" ? items.length - 1 : index + (event.key === "ArrowRight" ? 1 : -1);
287
+ items[(next + items.length) % items.length].focus();
288
+ }
289
+
290
+ return (
291
+ <div
292
+ ref={ref}
293
+ role="toolbar"
294
+ aria-label={label}
295
+ onKeyDown={handleKeyDown}
296
+ // `overflow-x-clip` is the guarantee: whatever the layout says, the bar can never paint outside its own column.
297
+ className="flex min-w-0 items-stretch gap-0.5 overflow-x-clip border-b border-border bg-surface-alt px-2 py-1"
298
+ >
299
+ {leading}
300
+ {shown.map((action, index) => (
301
+ <React.Fragment key={action.id}>
302
+ {index > 0 && shown[index - 1].group !== action.group && <div className="my-1 w-px shrink-0 self-stretch bg-border" aria-hidden="true" />}
303
+ <ToolbarButton action={action} labels={layout.labels} />
304
+ </React.Fragment>
305
+ ))}
306
+ {hidden.length > 0 && (
307
+ <>
308
+ <div className="my-1 w-px shrink-0 self-stretch bg-border" aria-hidden="true" />
309
+ <MoreMenu actions={hidden} />
310
+ </>
311
+ )}
312
+ {children}
313
+ </div>
314
+ );
315
+ }