@cratis/showrunner.notes.react 0.0.0-stage → 1.15.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 (297) hide show
  1. package/Buttons/NotesButton.tsx +117 -0
  2. package/Buttons/index.ts +6 -0
  3. package/Buttons/menuItems.ts +55 -0
  4. package/Buttons/notesDialogHeaderActions.tsx +33 -0
  5. package/Context/componentContext.ts +57 -0
  6. package/Context/formatLocation.ts +27 -0
  7. package/Context/index.ts +6 -0
  8. package/Context/noteContext.ts +139 -0
  9. package/Feedback/ComponentFeedbackDialog.tsx +150 -0
  10. package/Feedback/ComponentModeSwitch.tsx +39 -0
  11. package/Feedback/ContextSummary.tsx +31 -0
  12. package/Feedback/FeedbackDialog.tsx +64 -0
  13. package/Feedback/KindAndText.tsx +38 -0
  14. package/Feedback/SliceChooser.tsx +90 -0
  15. package/Feedback/SlicesFeedbackDialog.tsx +63 -0
  16. package/Feedback/index.ts +13 -0
  17. package/Feedback/kindOptions.ts +35 -0
  18. package/Feedback/propertySuggestions.ts +38 -0
  19. package/Feedback/sliceChoice.ts +73 -0
  20. package/Icons.tsx +29 -0
  21. package/Labels/NotesLabels.ts +185 -0
  22. package/Labels/defaultNotesLabels.ts +93 -0
  23. package/Labels/format.ts +13 -0
  24. package/Labels/index.ts +7 -0
  25. package/Labels/resolveLabels.ts +36 -0
  26. package/MyFeedback/MyFeedbackDialog.tsx +51 -0
  27. package/MyFeedback/MyFeedbackList.tsx +62 -0
  28. package/MyFeedback/index.ts +6 -0
  29. package/MyFeedback/noteStates.ts +75 -0
  30. package/Provider/NotesContext.ts +111 -0
  31. package/Provider/NotesProvider.tsx +122 -0
  32. package/Provider/index.ts +6 -0
  33. package/Provider/notesVisibility.ts +13 -0
  34. package/README.md +49 -2
  35. package/dist/cjs/Buttons/NotesButton.d.ts +8 -0
  36. package/dist/cjs/Buttons/NotesButton.d.ts.map +1 -0
  37. package/dist/cjs/Buttons/NotesButton.js +126 -0
  38. package/dist/cjs/Buttons/NotesButton.js.map +1 -0
  39. package/dist/cjs/Buttons/index.d.ts +4 -0
  40. package/dist/cjs/Buttons/index.d.ts.map +1 -0
  41. package/dist/cjs/Buttons/menuItems.d.ts +10 -0
  42. package/dist/cjs/Buttons/menuItems.d.ts.map +1 -0
  43. package/dist/cjs/Buttons/menuItems.js +57 -0
  44. package/dist/cjs/Buttons/menuItems.js.map +1 -0
  45. package/dist/cjs/Buttons/notesDialogHeaderActions.d.ts +4 -0
  46. package/dist/cjs/Buttons/notesDialogHeaderActions.d.ts.map +1 -0
  47. package/dist/cjs/Buttons/notesDialogHeaderActions.js +37 -0
  48. package/dist/cjs/Buttons/notesDialogHeaderActions.js.map +1 -0
  49. package/dist/cjs/Context/componentContext.d.ts +8 -0
  50. package/dist/cjs/Context/componentContext.d.ts.map +1 -0
  51. package/dist/cjs/Context/componentContext.js +56 -0
  52. package/dist/cjs/Context/componentContext.js.map +1 -0
  53. package/dist/cjs/Context/formatLocation.d.ts +7 -0
  54. package/dist/cjs/Context/formatLocation.d.ts.map +1 -0
  55. package/dist/cjs/Context/formatLocation.js +23 -0
  56. package/dist/cjs/Context/formatLocation.js.map +1 -0
  57. package/dist/cjs/Context/index.d.ts +4 -0
  58. package/dist/cjs/Context/index.d.ts.map +1 -0
  59. package/dist/cjs/Context/noteContext.d.ts +22 -0
  60. package/dist/cjs/Context/noteContext.d.ts.map +1 -0
  61. package/dist/cjs/Context/noteContext.js +117 -0
  62. package/dist/cjs/Context/noteContext.js.map +1 -0
  63. package/dist/cjs/Feedback/ComponentFeedbackDialog.d.ts +10 -0
  64. package/dist/cjs/Feedback/ComponentFeedbackDialog.d.ts.map +1 -0
  65. package/dist/cjs/Feedback/ComponentFeedbackDialog.js +183 -0
  66. package/dist/cjs/Feedback/ComponentFeedbackDialog.js.map +1 -0
  67. package/dist/cjs/Feedback/ComponentModeSwitch.d.ts +7 -0
  68. package/dist/cjs/Feedback/ComponentModeSwitch.d.ts.map +1 -0
  69. package/dist/cjs/Feedback/ComponentModeSwitch.js +29 -0
  70. package/dist/cjs/Feedback/ComponentModeSwitch.js.map +1 -0
  71. package/dist/cjs/Feedback/ContextSummary.d.ts +7 -0
  72. package/dist/cjs/Feedback/ContextSummary.d.ts.map +1 -0
  73. package/dist/cjs/Feedback/ContextSummary.js +31 -0
  74. package/dist/cjs/Feedback/ContextSummary.js.map +1 -0
  75. package/dist/cjs/Feedback/FeedbackDialog.d.ts +11 -0
  76. package/dist/cjs/Feedback/FeedbackDialog.d.ts.map +1 -0
  77. package/dist/cjs/Feedback/FeedbackDialog.js +55 -0
  78. package/dist/cjs/Feedback/FeedbackDialog.js.map +1 -0
  79. package/dist/cjs/Feedback/KindAndText.d.ts +7 -0
  80. package/dist/cjs/Feedback/KindAndText.d.ts.map +1 -0
  81. package/dist/cjs/Feedback/KindAndText.js +33 -0
  82. package/dist/cjs/Feedback/KindAndText.js.map +1 -0
  83. package/dist/cjs/Feedback/SliceChooser.d.ts +9 -0
  84. package/dist/cjs/Feedback/SliceChooser.d.ts.map +1 -0
  85. package/dist/cjs/Feedback/SliceChooser.js +113 -0
  86. package/dist/cjs/Feedback/SliceChooser.js.map +1 -0
  87. package/dist/cjs/Feedback/SlicesFeedbackDialog.d.ts +8 -0
  88. package/dist/cjs/Feedback/SlicesFeedbackDialog.d.ts.map +1 -0
  89. package/dist/cjs/Feedback/SlicesFeedbackDialog.js +74 -0
  90. package/dist/cjs/Feedback/SlicesFeedbackDialog.js.map +1 -0
  91. package/dist/cjs/Feedback/index.d.ts +11 -0
  92. package/dist/cjs/Feedback/index.d.ts.map +1 -0
  93. package/dist/cjs/Feedback/kindOptions.d.ts +9 -0
  94. package/dist/cjs/Feedback/kindOptions.d.ts.map +1 -0
  95. package/dist/cjs/Feedback/kindOptions.js +37 -0
  96. package/dist/cjs/Feedback/kindOptions.js.map +1 -0
  97. package/dist/cjs/Feedback/propertySuggestions.d.ts +6 -0
  98. package/dist/cjs/Feedback/propertySuggestions.d.ts.map +1 -0
  99. package/dist/cjs/Feedback/propertySuggestions.js +32 -0
  100. package/dist/cjs/Feedback/propertySuggestions.js.map +1 -0
  101. package/dist/cjs/Feedback/sliceChoice.d.ts +7 -0
  102. package/dist/cjs/Feedback/sliceChoice.d.ts.map +1 -0
  103. package/dist/cjs/Feedback/sliceChoice.js +71 -0
  104. package/dist/cjs/Feedback/sliceChoice.js.map +1 -0
  105. package/dist/cjs/Icons.d.ts +4 -0
  106. package/dist/cjs/Icons.d.ts.map +1 -0
  107. package/dist/cjs/Icons.js +53 -0
  108. package/dist/cjs/Icons.js.map +1 -0
  109. package/dist/cjs/Labels/NotesLabels.d.ts +90 -0
  110. package/dist/cjs/Labels/NotesLabels.d.ts.map +1 -0
  111. package/dist/cjs/Labels/defaultNotesLabels.d.ts +3 -0
  112. package/dist/cjs/Labels/defaultNotesLabels.d.ts.map +1 -0
  113. package/dist/cjs/Labels/defaultNotesLabels.js +94 -0
  114. package/dist/cjs/Labels/defaultNotesLabels.js.map +1 -0
  115. package/dist/cjs/Labels/format.d.ts +2 -0
  116. package/dist/cjs/Labels/format.d.ts.map +1 -0
  117. package/dist/cjs/Labels/format.js +15 -0
  118. package/dist/cjs/Labels/format.js.map +1 -0
  119. package/dist/cjs/Labels/index.d.ts +5 -0
  120. package/dist/cjs/Labels/index.d.ts.map +1 -0
  121. package/dist/cjs/Labels/resolveLabels.d.ts +3 -0
  122. package/dist/cjs/Labels/resolveLabels.d.ts.map +1 -0
  123. package/dist/cjs/Labels/resolveLabels.js +35 -0
  124. package/dist/cjs/Labels/resolveLabels.js.map +1 -0
  125. package/dist/cjs/MyFeedback/MyFeedbackDialog.d.ts +2 -0
  126. package/dist/cjs/MyFeedback/MyFeedbackDialog.d.ts.map +1 -0
  127. package/dist/cjs/MyFeedback/MyFeedbackDialog.js +55 -0
  128. package/dist/cjs/MyFeedback/MyFeedbackDialog.js.map +1 -0
  129. package/dist/cjs/MyFeedback/MyFeedbackList.d.ts +10 -0
  130. package/dist/cjs/MyFeedback/MyFeedbackList.d.ts.map +1 -0
  131. package/dist/cjs/MyFeedback/MyFeedbackList.js +62 -0
  132. package/dist/cjs/MyFeedback/MyFeedbackList.js.map +1 -0
  133. package/dist/cjs/MyFeedback/index.d.ts +4 -0
  134. package/dist/cjs/MyFeedback/index.d.ts.map +1 -0
  135. package/dist/cjs/MyFeedback/noteStates.d.ts +8 -0
  136. package/dist/cjs/MyFeedback/noteStates.d.ts.map +1 -0
  137. package/dist/cjs/MyFeedback/noteStates.js +90 -0
  138. package/dist/cjs/MyFeedback/noteStates.js.map +1 -0
  139. package/dist/cjs/Provider/NotesContext.d.ts +23 -0
  140. package/dist/cjs/Provider/NotesContext.d.ts.map +1 -0
  141. package/dist/cjs/Provider/NotesContext.js +51 -0
  142. package/dist/cjs/Provider/NotesContext.js.map +1 -0
  143. package/dist/cjs/Provider/NotesProvider.d.ts +11 -0
  144. package/dist/cjs/Provider/NotesProvider.d.ts.map +1 -0
  145. package/dist/cjs/Provider/NotesProvider.js +133 -0
  146. package/dist/cjs/Provider/NotesProvider.js.map +1 -0
  147. package/dist/cjs/Provider/index.d.ts +4 -0
  148. package/dist/cjs/Provider/index.d.ts.map +1 -0
  149. package/dist/cjs/Provider/notesVisibility.d.ts +2 -0
  150. package/dist/cjs/Provider/notesVisibility.d.ts.map +1 -0
  151. package/dist/cjs/Provider/notesVisibility.js +16 -0
  152. package/dist/cjs/Provider/notesVisibility.js.map +1 -0
  153. package/dist/cjs/index.d.ts +8 -0
  154. package/dist/cjs/index.d.ts.map +1 -0
  155. package/dist/cjs/index.js +85 -0
  156. package/dist/cjs/index.js.map +1 -0
  157. package/dist/cjs/package.json +3 -0
  158. package/dist/esm/Buttons/NotesButton.d.ts +8 -0
  159. package/dist/esm/Buttons/NotesButton.d.ts.map +1 -0
  160. package/dist/esm/Buttons/NotesButton.js +124 -0
  161. package/dist/esm/Buttons/NotesButton.js.map +1 -0
  162. package/dist/esm/Buttons/index.d.ts +4 -0
  163. package/dist/esm/Buttons/index.d.ts.map +1 -0
  164. package/dist/esm/Buttons/index.js +4 -0
  165. package/dist/esm/Buttons/index.js.map +1 -0
  166. package/dist/esm/Buttons/menuItems.d.ts +10 -0
  167. package/dist/esm/Buttons/menuItems.d.ts.map +1 -0
  168. package/dist/esm/Buttons/menuItems.js +54 -0
  169. package/dist/esm/Buttons/menuItems.js.map +1 -0
  170. package/dist/esm/Buttons/notesDialogHeaderActions.d.ts +4 -0
  171. package/dist/esm/Buttons/notesDialogHeaderActions.d.ts.map +1 -0
  172. package/dist/esm/Buttons/notesDialogHeaderActions.js +34 -0
  173. package/dist/esm/Buttons/notesDialogHeaderActions.js.map +1 -0
  174. package/dist/esm/Context/componentContext.d.ts +8 -0
  175. package/dist/esm/Context/componentContext.d.ts.map +1 -0
  176. package/dist/esm/Context/componentContext.js +51 -0
  177. package/dist/esm/Context/componentContext.js.map +1 -0
  178. package/dist/esm/Context/formatLocation.d.ts +7 -0
  179. package/dist/esm/Context/formatLocation.d.ts.map +1 -0
  180. package/dist/esm/Context/formatLocation.js +21 -0
  181. package/dist/esm/Context/formatLocation.js.map +1 -0
  182. package/dist/esm/Context/index.d.ts +4 -0
  183. package/dist/esm/Context/index.d.ts.map +1 -0
  184. package/dist/esm/Context/index.js +4 -0
  185. package/dist/esm/Context/index.js.map +1 -0
  186. package/dist/esm/Context/noteContext.d.ts +22 -0
  187. package/dist/esm/Context/noteContext.d.ts.map +1 -0
  188. package/dist/esm/Context/noteContext.js +110 -0
  189. package/dist/esm/Context/noteContext.js.map +1 -0
  190. package/dist/esm/Feedback/ComponentFeedbackDialog.d.ts +10 -0
  191. package/dist/esm/Feedback/ComponentFeedbackDialog.d.ts.map +1 -0
  192. package/dist/esm/Feedback/ComponentFeedbackDialog.js +181 -0
  193. package/dist/esm/Feedback/ComponentFeedbackDialog.js.map +1 -0
  194. package/dist/esm/Feedback/ComponentModeSwitch.d.ts +7 -0
  195. package/dist/esm/Feedback/ComponentModeSwitch.d.ts.map +1 -0
  196. package/dist/esm/Feedback/ComponentModeSwitch.js +27 -0
  197. package/dist/esm/Feedback/ComponentModeSwitch.js.map +1 -0
  198. package/dist/esm/Feedback/ContextSummary.d.ts +7 -0
  199. package/dist/esm/Feedback/ContextSummary.d.ts.map +1 -0
  200. package/dist/esm/Feedback/ContextSummary.js +29 -0
  201. package/dist/esm/Feedback/ContextSummary.js.map +1 -0
  202. package/dist/esm/Feedback/FeedbackDialog.d.ts +11 -0
  203. package/dist/esm/Feedback/FeedbackDialog.d.ts.map +1 -0
  204. package/dist/esm/Feedback/FeedbackDialog.js +53 -0
  205. package/dist/esm/Feedback/FeedbackDialog.js.map +1 -0
  206. package/dist/esm/Feedback/KindAndText.d.ts +7 -0
  207. package/dist/esm/Feedback/KindAndText.d.ts.map +1 -0
  208. package/dist/esm/Feedback/KindAndText.js +31 -0
  209. package/dist/esm/Feedback/KindAndText.js.map +1 -0
  210. package/dist/esm/Feedback/SliceChooser.d.ts +9 -0
  211. package/dist/esm/Feedback/SliceChooser.d.ts.map +1 -0
  212. package/dist/esm/Feedback/SliceChooser.js +111 -0
  213. package/dist/esm/Feedback/SliceChooser.js.map +1 -0
  214. package/dist/esm/Feedback/SlicesFeedbackDialog.d.ts +8 -0
  215. package/dist/esm/Feedback/SlicesFeedbackDialog.d.ts.map +1 -0
  216. package/dist/esm/Feedback/SlicesFeedbackDialog.js +72 -0
  217. package/dist/esm/Feedback/SlicesFeedbackDialog.js.map +1 -0
  218. package/dist/esm/Feedback/index.d.ts +11 -0
  219. package/dist/esm/Feedback/index.d.ts.map +1 -0
  220. package/dist/esm/Feedback/index.js +11 -0
  221. package/dist/esm/Feedback/index.js.map +1 -0
  222. package/dist/esm/Feedback/kindOptions.d.ts +9 -0
  223. package/dist/esm/Feedback/kindOptions.d.ts.map +1 -0
  224. package/dist/esm/Feedback/kindOptions.js +34 -0
  225. package/dist/esm/Feedback/kindOptions.js.map +1 -0
  226. package/dist/esm/Feedback/propertySuggestions.d.ts +6 -0
  227. package/dist/esm/Feedback/propertySuggestions.d.ts.map +1 -0
  228. package/dist/esm/Feedback/propertySuggestions.js +29 -0
  229. package/dist/esm/Feedback/propertySuggestions.js.map +1 -0
  230. package/dist/esm/Feedback/sliceChoice.d.ts +7 -0
  231. package/dist/esm/Feedback/sliceChoice.d.ts.map +1 -0
  232. package/dist/esm/Feedback/sliceChoice.js +65 -0
  233. package/dist/esm/Feedback/sliceChoice.js.map +1 -0
  234. package/dist/esm/Icons.d.ts +4 -0
  235. package/dist/esm/Icons.d.ts.map +1 -0
  236. package/dist/esm/Icons.js +49 -0
  237. package/dist/esm/Icons.js.map +1 -0
  238. package/dist/esm/Labels/NotesLabels.d.ts +90 -0
  239. package/dist/esm/Labels/NotesLabels.d.ts.map +1 -0
  240. package/dist/esm/Labels/NotesLabels.js +2 -0
  241. package/dist/esm/Labels/NotesLabels.js.map +1 -0
  242. package/dist/esm/Labels/defaultNotesLabels.d.ts +3 -0
  243. package/dist/esm/Labels/defaultNotesLabels.d.ts.map +1 -0
  244. package/dist/esm/Labels/defaultNotesLabels.js +92 -0
  245. package/dist/esm/Labels/defaultNotesLabels.js.map +1 -0
  246. package/dist/esm/Labels/format.d.ts +2 -0
  247. package/dist/esm/Labels/format.d.ts.map +1 -0
  248. package/dist/esm/Labels/format.js +13 -0
  249. package/dist/esm/Labels/format.js.map +1 -0
  250. package/dist/esm/Labels/index.d.ts +5 -0
  251. package/dist/esm/Labels/index.d.ts.map +1 -0
  252. package/dist/esm/Labels/index.js +5 -0
  253. package/dist/esm/Labels/index.js.map +1 -0
  254. package/dist/esm/Labels/resolveLabels.d.ts +3 -0
  255. package/dist/esm/Labels/resolveLabels.d.ts.map +1 -0
  256. package/dist/esm/Labels/resolveLabels.js +33 -0
  257. package/dist/esm/Labels/resolveLabels.js.map +1 -0
  258. package/dist/esm/MyFeedback/MyFeedbackDialog.d.ts +2 -0
  259. package/dist/esm/MyFeedback/MyFeedbackDialog.d.ts.map +1 -0
  260. package/dist/esm/MyFeedback/MyFeedbackDialog.js +53 -0
  261. package/dist/esm/MyFeedback/MyFeedbackDialog.js.map +1 -0
  262. package/dist/esm/MyFeedback/MyFeedbackList.d.ts +10 -0
  263. package/dist/esm/MyFeedback/MyFeedbackList.d.ts.map +1 -0
  264. package/dist/esm/MyFeedback/MyFeedbackList.js +60 -0
  265. package/dist/esm/MyFeedback/MyFeedbackList.js.map +1 -0
  266. package/dist/esm/MyFeedback/index.d.ts +4 -0
  267. package/dist/esm/MyFeedback/index.d.ts.map +1 -0
  268. package/dist/esm/MyFeedback/index.js +4 -0
  269. package/dist/esm/MyFeedback/index.js.map +1 -0
  270. package/dist/esm/MyFeedback/noteStates.d.ts +8 -0
  271. package/dist/esm/MyFeedback/noteStates.d.ts.map +1 -0
  272. package/dist/esm/MyFeedback/noteStates.js +84 -0
  273. package/dist/esm/MyFeedback/noteStates.js.map +1 -0
  274. package/dist/esm/Provider/NotesContext.d.ts +23 -0
  275. package/dist/esm/Provider/NotesContext.d.ts.map +1 -0
  276. package/dist/esm/Provider/NotesContext.js +44 -0
  277. package/dist/esm/Provider/NotesContext.js.map +1 -0
  278. package/dist/esm/Provider/NotesProvider.d.ts +11 -0
  279. package/dist/esm/Provider/NotesProvider.d.ts.map +1 -0
  280. package/dist/esm/Provider/NotesProvider.js +131 -0
  281. package/dist/esm/Provider/NotesProvider.js.map +1 -0
  282. package/dist/esm/Provider/index.d.ts +4 -0
  283. package/dist/esm/Provider/index.d.ts.map +1 -0
  284. package/dist/esm/Provider/index.js +4 -0
  285. package/dist/esm/Provider/index.js.map +1 -0
  286. package/dist/esm/Provider/notesVisibility.d.ts +2 -0
  287. package/dist/esm/Provider/notesVisibility.d.ts.map +1 -0
  288. package/dist/esm/Provider/notesVisibility.js +14 -0
  289. package/dist/esm/Provider/notesVisibility.js.map +1 -0
  290. package/dist/esm/index.d.ts +8 -0
  291. package/dist/esm/index.d.ts.map +1 -0
  292. package/dist/esm/index.js +27 -0
  293. package/dist/esm/index.js.map +1 -0
  294. package/dist/esm/package.json +3 -0
  295. package/index.ts +10 -0
  296. package/package.json +83 -4
  297. package/styles.css +192 -0
@@ -0,0 +1,117 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { Button, IconButton } from '@cratis/components/Common';
5
+ import { DialogHeaderContext } from '@cratis/components/Dialogs';
6
+ import { KeyboardEvent, useEffect, useId, useRef, useState } from 'react';
7
+ import { ChevronIcon, FeedbackIcon } from '../Icons.js';
8
+ import { useNotesContext } from '../Provider/NotesContext.js';
9
+ import { menuItems, nextMenuIndex, NotesMenuAction } from './menuItems.js';
10
+
11
+ /**
12
+ * Props for {@link NotesButton}.
13
+ */
14
+ export interface NotesButtonProps {
15
+ /** `large` shows the icon and the text; `small` shows the icon, with the text as tooltip and accessible name. Defaults to `large`. */
16
+ size?: 'large' | 'small';
17
+
18
+ /** The dialog the button is in; the feedback is about the dialog and its slice when given. */
19
+ dialog?: DialogHeaderContext;
20
+
21
+ /** Additional class name for the button. */
22
+ className?: string;
23
+ }
24
+
25
+ /**
26
+ * The feedback button, a split button. Its main action gives feedback on what the user is looking at; its drop-down offers
27
+ * feedback on specific slices, on this screen, on a component the user points at, and the user's own feedback. It
28
+ * renders nothing unless the user is signed in and Notes is switched on. Place it in any top bar.
29
+ */
30
+ export const NotesButton = ({ size = 'large', dialog, className }: NotesButtonProps) => {
31
+ const notes = useNotesContext();
32
+ const { labels } = notes;
33
+ const [isOpen, setIsOpen] = useState(false);
34
+ const root = useRef<HTMLSpanElement>(null);
35
+ const menuId = useId();
36
+
37
+ useEffect(() => {
38
+ if (!isOpen) {
39
+ return;
40
+ }
41
+
42
+ const dismiss = (event: PointerEvent) => {
43
+ if (!root.current?.contains(event.target as Node)) {
44
+ setIsOpen(false);
45
+ }
46
+ };
47
+
48
+ document.addEventListener('pointerdown', dismiss);
49
+ return () => document.removeEventListener('pointerdown', dismiss);
50
+ }, [isOpen]);
51
+
52
+ useEffect(() => {
53
+ if (isOpen) {
54
+ root.current?.querySelector<HTMLElement>('[role="menuitem"]:not([disabled])')?.focus();
55
+ }
56
+ }, [isOpen]);
57
+
58
+ if (!notes.isAvailable) {
59
+ return null;
60
+ }
61
+
62
+ const items = menuItems(labels, notes.isPicking);
63
+ const choose = (action: NotesMenuAction) => {
64
+ setIsOpen(false);
65
+ switch (action) {
66
+ case 'slices': return notes.giveFeedbackOnSlices(dialog);
67
+ case 'screen': return notes.giveFeedbackOnScreen(dialog);
68
+ case 'component': return notes.pointAtSomething(dialog);
69
+ default: return notes.showMyFeedback();
70
+ }
71
+ };
72
+
73
+ const onMenuKeyDown = (event: KeyboardEvent<HTMLUListElement>) => {
74
+ if (event.key === 'Escape') {
75
+ event.preventDefault();
76
+ event.stopPropagation();
77
+ setIsOpen(false);
78
+ root.current?.querySelector<HTMLElement>('[data-notes-toggle]')?.focus();
79
+ return;
80
+ }
81
+
82
+ const elements = Array.from(event.currentTarget.querySelectorAll<HTMLElement>('[role="menuitem"]'));
83
+ const next = nextMenuIndex(event.key, elements.indexOf(document.activeElement as HTMLElement), elements.length);
84
+ if (next !== undefined) {
85
+ event.preventDefault();
86
+ elements[next].focus();
87
+ }
88
+ };
89
+
90
+ return (
91
+ <span ref={root} className={['notes-button', className].filter(Boolean).join(' ')} data-size={size}>
92
+ {size === 'small'
93
+ ? <IconButton variant='ghost' icon={<FeedbackIcon />} aria-label={labels.button.giveFeedback} tooltip={labels.button.giveFeedback} onClick={() => notes.giveFeedback(dialog)} />
94
+ : <Button variant='outline' icon={<FeedbackIcon />} label={labels.button.giveFeedback} onClick={() => notes.giveFeedback(dialog)} />}
95
+ <IconButton
96
+ variant='ghost'
97
+ icon={<ChevronIcon />}
98
+ aria-label={labels.button.moreOptions}
99
+ aria-haspopup='menu'
100
+ aria-expanded={isOpen}
101
+ aria-controls={isOpen ? menuId : undefined}
102
+ data-notes-toggle=''
103
+ onClick={() => setIsOpen(open => !open)} />
104
+ {isOpen && (
105
+ <ul id={menuId} className='notes-button__menu' role='menu' aria-label={labels.button.moreOptions} onKeyDown={onMenuKeyDown}>
106
+ {items.map(item => (
107
+ <li key={item.action} role='none'>
108
+ <button type='button' role='menuitem' className='notes-button__item' disabled={item.disabled} onClick={() => choose(item.action)}>
109
+ {item.label}
110
+ </button>
111
+ </li>
112
+ ))}
113
+ </ul>
114
+ )}
115
+ </span>
116
+ );
117
+ };
@@ -0,0 +1,6 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ export * from './menuItems.js';
5
+ export * from './NotesButton.js';
6
+ export * from './notesDialogHeaderActions.js';
@@ -0,0 +1,55 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { NotesLabels } from '../Labels/index.js';
5
+
6
+ /**
7
+ * What a drop-down item of the feedback button does.
8
+ */
9
+ export type NotesMenuAction = 'slices' | 'screen' | 'component' | 'myFeedback';
10
+
11
+ /**
12
+ * One item of the drop-down of the feedback button.
13
+ */
14
+ export interface NotesMenuItem {
15
+ /** What the item does. */
16
+ readonly action: NotesMenuAction;
17
+
18
+ /** The text. */
19
+ readonly label: string;
20
+
21
+ /** Whether the item is switched off, such as pointing at something while the user is already pointing. */
22
+ readonly disabled: boolean;
23
+ }
24
+
25
+ /**
26
+ * Gets the items of the drop-down: specific slices, this screen, pointing at a component, and the user's own feedback.
27
+ * @param labels The labels to show.
28
+ * @param isPicking Whether the user is pointing at a component already.
29
+ * @returns The {@link NotesMenuItem}s in the order they are shown.
30
+ */
31
+ export function menuItems(labels: NotesLabels, isPicking: boolean): NotesMenuItem[] {
32
+ return [
33
+ { action: 'slices', label: labels.button.aboutSlices, disabled: false },
34
+ { action: 'screen', label: labels.button.aboutScreen, disabled: false },
35
+ { action: 'component', label: labels.button.pointAtSomething, disabled: isPicking },
36
+ { action: 'myFeedback', label: labels.button.myFeedback, disabled: false }
37
+ ];
38
+ }
39
+
40
+ /**
41
+ * Gets which item a key moves to in an open drop-down.
42
+ * @param key The key.
43
+ * @param current The index of the item that has focus; -1 when none has.
44
+ * @param count How many items there are.
45
+ * @returns The index to move focus to; undefined when the key does not move focus.
46
+ */
47
+ export function nextMenuIndex(key: string, current: number, count: number): number | undefined {
48
+ switch (key) {
49
+ case 'ArrowDown': return (current + 1) % count;
50
+ case 'ArrowUp': return current <= 0 ? count - 1 : current - 1;
51
+ case 'Home': return 0;
52
+ case 'End': return count - 1;
53
+ default: return undefined;
54
+ }
55
+ }
@@ -0,0 +1,33 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { DialogHeaderActionsRenderer, DialogHeaderContext } from '@cratis/components/Dialogs';
5
+ import { useNotesContext } from '../Provider/NotesContext.js';
6
+ import { NotesButton } from './NotesButton.js';
7
+
8
+ /**
9
+ * Decides whether a dialog gets the feedback button in its header: only a dialog that has a slice location, and only when
10
+ * `<NotesProvider enabled>` turned it on.
11
+ * @param dialog The dialog.
12
+ * @param enabled Whether the provider turned the header button on.
13
+ * @returns True when the dialog shows the button.
14
+ */
15
+ export function showsFeedbackButton(dialog: DialogHeaderContext, enabled: boolean): boolean {
16
+ const location = dialog.sliceLocation;
17
+ return enabled && location !== undefined && (!!location.module || !!location.feature || !!location.slice);
18
+ }
19
+
20
+ const NotesDialogHeaderButton = ({ dialog }: { dialog: DialogHeaderContext }) => {
21
+ const { showsInDialogHeaders } = useNotesContext();
22
+ return showsFeedbackButton(dialog, showsInDialogHeaders)
23
+ ? <NotesButton size='small' dialog={dialog} />
24
+ : null;
25
+ };
26
+
27
+ /**
28
+ * The renderer to pass to `CratisComponentsProvider` as `dialogHeaderActions`: it puts the feedback button in the header of
29
+ * every dialog that belongs to a slice. The context it captures is the dialog's location.
30
+ * @param dialog What the dialog tells about itself.
31
+ * @returns The button, or nothing for a dialog without a slice.
32
+ */
33
+ export const notesDialogHeaderActions: DialogHeaderActionsRenderer = dialog => <NotesDialogHeaderButton dialog={dialog} />;
@@ -0,0 +1,57 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { PickedComponent as PickedByUser } from '@cratis/components/ComponentPicker';
5
+ import { PickedComponent } from '@cratis/showrunner.notes';
6
+ import { LocationParts } from './formatLocation.js';
7
+ import { toSliceLocation } from './noteContext.js';
8
+
9
+ /**
10
+ * The key of what the picker's resolver adds to a picked component: the slice its element belongs to.
11
+ */
12
+ export const sliceContextKey = 'slice';
13
+
14
+ /**
15
+ * Reads the slice location Arc marks an element with, when `<Arc sliceMarkers>` is on.
16
+ * @param element The element.
17
+ * @returns The location of the closest slice marker; undefined when there is none.
18
+ */
19
+ export function sliceMarkedOn(element: Element): LocationParts | undefined {
20
+ const marker = element.closest('[data-cratis-module]');
21
+ if (!marker) {
22
+ return undefined;
23
+ }
24
+
25
+ return {
26
+ module: marker.getAttribute('data-cratis-module') ?? '',
27
+ feature: marker.getAttribute('data-cratis-feature') ?? '',
28
+ slice: marker.getAttribute('data-cratis-slice') ?? ''
29
+ };
30
+ }
31
+
32
+ /**
33
+ * The picker's `resolve`: tells the slice of a picked component from the closest Arc slice marker.
34
+ * @param element The root element of the picked component.
35
+ * @returns The context to add to the picked component; undefined when the element is in no marked slice.
36
+ */
37
+ export function resolveComponentContext(element: Element): Record<string, unknown> | undefined {
38
+ const slice = sliceMarkedOn(element);
39
+ return slice ? { [sliceContextKey]: slice } : undefined;
40
+ }
41
+
42
+ /**
43
+ * Makes the component a note carries from what the picker found.
44
+ * @param picked What the picker found.
45
+ * @param focused The focused location, used when the component's slice is not known.
46
+ * @returns The {@link PickedComponent}.
47
+ */
48
+ export function toNotePickedComponent(picked: PickedByUser, focused: LocationParts): PickedComponent {
49
+ const slice = picked.context[sliceContextKey] as LocationParts | undefined;
50
+ return Object.assign(new PickedComponent(), {
51
+ componentName: picked.component,
52
+ componentId: picked.id ?? '',
53
+ part: picked.part ?? '',
54
+ ancestors: picked.ancestors.map(ancestor => ancestor.component),
55
+ location: toSliceLocation(slice ?? focused)
56
+ });
57
+ }
@@ -0,0 +1,27 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ /**
5
+ * The parts of where in the application something is.
6
+ */
7
+ export interface LocationParts {
8
+ /** The module. */
9
+ readonly module: string;
10
+ /** The feature within the module. */
11
+ readonly feature: string;
12
+ /** The slice within the feature. */
13
+ readonly slice: string;
14
+ }
15
+
16
+ /**
17
+ * Formats a location for people, such as `Orders › Editing › Change order`.
18
+ * @param location The location; parts that are empty are left out.
19
+ * @param separator What separates the parts.
20
+ * @param unknown What to show when no part is known.
21
+ * @returns The formatted location.
22
+ */
23
+ export function formatLocation(location: LocationParts | undefined, separator: string, unknown: string): string {
24
+ const parts = [location?.module, location?.feature, location?.slice]
25
+ .filter((part): part is string => typeof part === 'string' && part.length > 0);
26
+ return parts.length > 0 ? parts.join(separator) : unknown;
27
+ }
@@ -0,0 +1,6 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ export * from './componentContext.js';
5
+ export * from './formatLocation.js';
6
+ export * from './noteContext.js';
@@ -0,0 +1,139 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { ApplicationContextSnapshot } from '@cratis/arc.react';
5
+ import { Guid } from '@cratis/fundamentals';
6
+ import { NoteContext, NoteDialog, NoteScreen, SliceLocation } from '@cratis/showrunner.notes';
7
+ import { format, NotesLabels } from '../Labels/index.js';
8
+ import { formatLocation, LocationParts } from './formatLocation.js';
9
+
10
+ /**
11
+ * The key of the Arc application context contributions that holds the identifiers of model elements.
12
+ */
13
+ export const modelReferencesKey = 'modelReferences';
14
+
15
+ /**
16
+ * The dialog a note is given from.
17
+ */
18
+ export interface DialogReference {
19
+ /** The title of the dialog. */
20
+ readonly title: string;
21
+
22
+ /** Where the dialog belongs. */
23
+ readonly location: LocationParts;
24
+ }
25
+
26
+ /**
27
+ * What {@link buildNoteContext} reads besides the application context.
28
+ */
29
+ export interface NoteContextInput {
30
+ /** What the user is looking at, from Arc's `useApplicationContext()`. */
31
+ readonly snapshot: ApplicationContextSnapshot;
32
+
33
+ /** The route of the browser. */
34
+ readonly route: string;
35
+
36
+ /** The correlation id to send. */
37
+ readonly correlationId: Guid;
38
+
39
+ /** The dialog the note is given from; the topmost open dialog of the snapshot when not given. */
40
+ readonly dialog?: DialogReference;
41
+ }
42
+
43
+ /**
44
+ * Makes a location of the contract from the parts of one.
45
+ * @param parts The parts; an absent part is empty.
46
+ * @returns The {@link SliceLocation}.
47
+ */
48
+ export function toSliceLocation(parts?: LocationParts): SliceLocation {
49
+ return Object.assign(new SliceLocation(), {
50
+ module: parts?.module ?? '',
51
+ feature: parts?.feature ?? '',
52
+ slice: parts?.slice ?? ''
53
+ });
54
+ }
55
+
56
+ /**
57
+ * Reads the identifiers of model elements the host contributed to the Arc application context.
58
+ * @param contributions The contributions of the application context.
59
+ * @returns The identifiers by what they identify; empty when the host contributed none.
60
+ */
61
+ export function modelReferencesOf(contributions: Readonly<Record<string, unknown>>): Record<string, string> {
62
+ const value = contributions[modelReferencesKey];
63
+ if (typeof value !== 'object' || value === null || Array.isArray(value)) {
64
+ return {};
65
+ }
66
+
67
+ return Object.fromEntries(Object.entries(value)
68
+ .filter(([, reference]) => reference !== undefined && reference !== null)
69
+ .map(([key, reference]) => [key, String(reference)]));
70
+ }
71
+
72
+ /**
73
+ * Builds the context every Notes command carries from what the user is looking at.
74
+ * @param input The {@link NoteContextInput}.
75
+ * @returns The {@link NoteContext}; when a dialog is the subject its location is the focused location.
76
+ */
77
+ export function buildNoteContext(input: NoteContextInput): NoteContext {
78
+ const { snapshot } = input;
79
+ const dialog = input.dialog ?? openDialogOf(snapshot);
80
+
81
+ return Object.assign(new NoteContext(), {
82
+ location: toSliceLocation(dialog?.location ?? snapshot.location),
83
+ activeSlices: snapshot.activeSlices.map(toSliceLocation),
84
+ screen: Object.assign(new NoteScreen(), {
85
+ screenId: snapshot.screen.id,
86
+ screenName: snapshot.screen.name,
87
+ screenPath: snapshot.screen.path
88
+ }),
89
+ route: input.route,
90
+ dialog: Object.assign(new NoteDialog(), {
91
+ dialogTitle: dialog?.title ?? '',
92
+ location: toSliceLocation(dialog?.location)
93
+ }),
94
+ modelReferences: modelReferencesOf(snapshot.contributions),
95
+ correlationId: input.correlationId
96
+ });
97
+ }
98
+
99
+ function openDialogOf(snapshot: ApplicationContextSnapshot): DialogReference | undefined {
100
+ const dialog = snapshot.dialogs.at(-1);
101
+ return dialog ? { title: dialog.title ?? '', location: dialog.location } : undefined;
102
+ }
103
+
104
+ /**
105
+ * Says in plain language what a note context is about, such as `Orders › Editing › Change order, on screen Order details`.
106
+ * @param context The context.
107
+ * @param labels The labels to show.
108
+ * @returns The sentence.
109
+ */
110
+ export function describeContext(context: NoteContext, labels: NotesLabels): string {
111
+ const location = formatLocation(context.location, labels.common.locationSeparator, labels.common.unknownLocation);
112
+ const screen = context.screen.screenName || context.screen.screenPath;
113
+ const dialog = context.dialog.dialogTitle;
114
+
115
+ if (dialog) {
116
+ return format(labels.context.inDialog, { location, dialog, screen: screen || labels.common.unknownLocation });
117
+ }
118
+
119
+ if (screen && !isEmpty(context.location)) {
120
+ return format(labels.context.onScreen, { location, screen });
121
+ }
122
+
123
+ return screen ? format(labels.context.screenOnly, { screen }) : format(labels.context.atLocation, { location });
124
+ }
125
+
126
+ /**
127
+ * Says in plain language where a screen note is given.
128
+ * @param context The context.
129
+ * @param labels The labels to show.
130
+ * @returns The sentence.
131
+ */
132
+ export function describeScreen(context: NoteContext, labels: NotesLabels): string {
133
+ const screen = context.screen.screenName || context.screen.screenPath;
134
+ return format(labels.context.screenOnly, { screen: screen || labels.common.unknownLocation });
135
+ }
136
+
137
+ function isEmpty(location: LocationParts): boolean {
138
+ return !location.module && !location.feature && !location.slice;
139
+ }
@@ -0,0 +1,150 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { DialogResult, useDialogContext } from '@cratis/arc.react/dialogs';
5
+ import { CommandDialog } from '@cratis/components/CommandDialog';
6
+ import { ComponentHighlight, PickedComponent as PickedByUser, PresentationChange, PresentationPropertyEditor } from '@cratis/components/ComponentPicker';
7
+ import { Dialog, DialogInitialFocus } from '@cratis/components/Dialogs';
8
+ import { Guid } from '@cratis/fundamentals';
9
+ import { GiveNoteOnComponent, NoteContext, SuggestComponentPropertyChange } from '@cratis/showrunner.notes';
10
+ import { useMemo, useRef, useState } from 'react';
11
+ import { describeContext, toNotePickedComponent } from '../Context/index.js';
12
+ import { format } from '../Labels/index.js';
13
+ import { useNotesContext } from '../Provider/NotesContext.js';
14
+ import { ComponentFeedbackMode, ComponentModeSwitch } from './ComponentModeSwitch.js';
15
+ import { ContextSummary } from './ContextSummary.js';
16
+ import { FeedbackGiven } from './FeedbackDialog.js';
17
+ import { defaultKind } from './kindOptions.js';
18
+ import { KindAndText } from './KindAndText.js';
19
+ import { propertySuggestions } from './propertySuggestions.js';
20
+
21
+ /**
22
+ * Props for {@link ComponentFeedbackDialog}.
23
+ */
24
+ export interface ComponentFeedbackDialogProps {
25
+ /** What the user was looking at when they chose to point at something. */
26
+ context: NoteContext;
27
+
28
+ /** The component the user picked. */
29
+ picked: PickedByUser;
30
+
31
+ /** The mode to open in. Defaults to describing the component. */
32
+ initialMode?: ComponentFeedbackMode;
33
+ }
34
+
35
+ /**
36
+ * The give feedback on a component dialog. The picked component stays highlighted while it is open. The user either
37
+ * describes it (`GiveNoteOnComponent`) or changes it: the property editor previews each change live and reverts it when
38
+ * the dialog closes, and one `SuggestComponentPropertyChange` is sent per changed property. Open it with `useDialog`.
39
+ */
40
+ export const ComponentFeedbackDialog = ({ context, picked, initialMode = 'describe' }: ComponentFeedbackDialogProps) => {
41
+ const { labels } = useNotesContext();
42
+ const [noteId] = useState(() => Guid.create());
43
+ const [mode, setMode] = useState<ComponentFeedbackMode>(initialMode);
44
+ const component = useMemo(() => toNotePickedComponent(picked, context.location), [picked, context]);
45
+ const switchMode = <ComponentModeSwitch mode={mode} onChange={setMode} />;
46
+ const summary = <ContextSummary text={format(labels.component.about, { component: picked.id ? `${picked.component} (${picked.id})` : picked.component })}>
47
+ <span className='notes-context-summary__text'>{describeContext(context, labels)}</span>
48
+ </ContextSummary>;
49
+
50
+ return (
51
+ <>
52
+ <ComponentHighlight target={picked} />
53
+ {mode === 'describe'
54
+ ? <DescribeComponent context={context} component={component} noteId={noteId} header={<>{switchMode}{summary}</>} />
55
+ : <ChangeComponent context={context} picked={picked} component={component} noteId={noteId} header={<>{switchMode}{summary}</>} />}
56
+ </>
57
+ );
58
+ };
59
+
60
+ interface ModeProps {
61
+ context: NoteContext;
62
+ component: ReturnType<typeof toNotePickedComponent>;
63
+ noteId: Guid;
64
+ header: React.ReactNode;
65
+ }
66
+
67
+ const DescribeComponent = ({ context, component, noteId, header }: ModeProps) => {
68
+ const { labels } = useNotesContext();
69
+ const { closeDialog } = useDialogContext<ComponentFeedbackDialogProps, FeedbackGiven>();
70
+
71
+ return (
72
+ <CommandDialog<GiveNoteOnComponent>
73
+ command={GiveNoteOnComponent}
74
+ title={labels.component.title}
75
+ okLabel={labels.feedback.send}
76
+ cancelLabel={labels.common.cancel}
77
+ closeAriaLabel={labels.common.close}
78
+ width='600px'
79
+ initialFocus={DialogInitialFocus.Content}
80
+ initialValues={{ context, component, noteId, kind: defaultKind }}
81
+ onSuccess={() => closeDialog(DialogResult.Ok, { noteId })}>
82
+ <div className='notes-feedback-form'>
83
+ {header}
84
+ <KindAndText<GiveNoteOnComponent> />
85
+ </div>
86
+ </CommandDialog>
87
+ );
88
+ };
89
+
90
+ const ChangeComponent = ({ context, picked, component, noteId, header }: ModeProps & { picked: PickedByUser }) => {
91
+ const { labels } = useNotesContext();
92
+ const [changes, setChanges] = useState<PresentationChange[]>([]);
93
+ const [isSending, setIsSending] = useState(false);
94
+ const [failed, setFailed] = useState(0);
95
+ const sending = useRef(false);
96
+ const [suggestion, setSuggestion] = SuggestComponentPropertyChange.use();
97
+
98
+ const send = async (): Promise<boolean> => {
99
+ if (sending.current || changes.length === 0) {
100
+ return false;
101
+ }
102
+
103
+ sending.current = true;
104
+ setIsSending(true);
105
+ setFailed(0);
106
+ let failures = 0;
107
+ try {
108
+ for (const values of propertySuggestions(changes, context, component, noteId)) {
109
+ setSuggestion(values);
110
+ const result = await suggestion.execute();
111
+ if (!result.isSuccess) {
112
+ failures++;
113
+ }
114
+ }
115
+ } finally {
116
+ sending.current = false;
117
+ setIsSending(false);
118
+ }
119
+
120
+ setFailed(failures);
121
+ return failures === 0;
122
+ };
123
+
124
+ return (
125
+ <Dialog
126
+ title={labels.component.title}
127
+ okLabel={labels.component.sendChanges}
128
+ cancelLabel={labels.common.cancel}
129
+ closeAriaLabel={labels.common.close}
130
+ width='600px'
131
+ initialFocus={DialogInitialFocus.Content}
132
+ isValid={changes.length > 0}
133
+ isBusy={isSending}
134
+ onConfirm={send}>
135
+ <div className='notes-feedback-form'>
136
+ {header}
137
+ {picked.presentationProperties.length === 0
138
+ ? <p className='notes-change-notice'>{labels.component.nothingToChange}</p>
139
+ : (
140
+ <>
141
+ <p className='notes-change-notice'>{labels.component.previewNotice}</p>
142
+ <PresentationPropertyEditor picked={picked} preview onChange={setChanges} />
143
+ {changes.length === 0 && <p className='notes-change-notice' role='status'>{labels.component.noChanges}</p>}
144
+ </>
145
+ )}
146
+ {failed > 0 && <p className='notes-change-failure' role='alert'>{format(labels.component.failed, { count: failed })}</p>}
147
+ </div>
148
+ </Dialog>
149
+ );
150
+ };
@@ -0,0 +1,39 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { ToggleGroup } from '@cratis/components/Common';
5
+ import { useNotesLabels } from '../Provider/NotesContext.js';
6
+
7
+ /**
8
+ * How feedback on a component is given.
9
+ */
10
+ export type ComponentFeedbackMode = 'describe' | 'change';
11
+
12
+ /**
13
+ * Props for {@link ComponentModeSwitch}.
14
+ */
15
+ export interface ComponentModeSwitchProps {
16
+ /** The mode. */
17
+ mode: ComponentFeedbackMode;
18
+
19
+ /** Called with the mode the user chooses. */
20
+ onChange: (mode: ComponentFeedbackMode) => void;
21
+ }
22
+
23
+ /**
24
+ * Switches between describing a component and changing it.
25
+ */
26
+ export const ComponentModeSwitch = ({ mode, onChange }: ComponentModeSwitchProps) => {
27
+ const labels = useNotesLabels();
28
+
29
+ return (
30
+ <ToggleGroup
31
+ aria-label={labels.component.mode}
32
+ value={mode}
33
+ options={[
34
+ { value: 'describe', label: labels.component.describe },
35
+ { value: 'change', label: labels.component.change }
36
+ ]}
37
+ onChange={value => onChange(value as ComponentFeedbackMode)} />
38
+ );
39
+ };
@@ -0,0 +1,31 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { ReactNode } from 'react';
5
+ import { useNotesLabels } from '../Provider/NotesContext.js';
6
+
7
+ /**
8
+ * Props for {@link ContextSummary}.
9
+ */
10
+ export interface ContextSummaryProps {
11
+ /** What the note is about, in plain language. */
12
+ text: string;
13
+
14
+ /** More to show under it. */
15
+ children?: ReactNode;
16
+ }
17
+
18
+ /**
19
+ * Tells the user in plain language what their note is about, before they write it.
20
+ */
21
+ export const ContextSummary = ({ text, children }: ContextSummaryProps) => {
22
+ const labels = useNotesLabels();
23
+
24
+ return (
25
+ <div className='notes-context-summary' role='group' aria-label={labels.common.aboutHeading}>
26
+ <span className='notes-context-summary__heading'>{labels.common.aboutHeading}</span>
27
+ <span className='notes-context-summary__text'>{text}</span>
28
+ {children}
29
+ </div>
30
+ );
31
+ };