@estiva-app/ui 0.98.0 → 0.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/AppProvider.d.ts +6 -3
- package/dist/AppProvider.d.ts.map +1 -1
- package/dist/ArchiveDialog.d.ts +35 -0
- package/dist/ArchiveDialog.d.ts.map +1 -0
- package/dist/AttachedCard.d.ts +13 -2
- package/dist/AttachedCard.d.ts.map +1 -1
- package/dist/Card.d.ts +6 -1
- package/dist/Card.d.ts.map +1 -1
- package/dist/ChipInput.d.ts +3 -1
- package/dist/ChipInput.d.ts.map +1 -1
- package/dist/CollapsibleSection.d.ts +27 -2
- package/dist/CollapsibleSection.d.ts.map +1 -1
- package/dist/CommentBox.d.ts +2 -2
- package/dist/CommentBox.d.ts.map +1 -1
- package/dist/ConfirmDialog.d.ts +15 -2
- package/dist/ConfirmDialog.d.ts.map +1 -1
- package/dist/ConversationCard.d.ts +6 -1
- package/dist/ConversationCard.d.ts.map +1 -1
- package/dist/ConversationLayout.d.ts +19 -4
- package/dist/ConversationLayout.d.ts.map +1 -1
- package/dist/ConversationPlace.d.ts +17 -0
- package/dist/ConversationPlace.d.ts.map +1 -0
- package/dist/DocumentEditor.d.ts +38 -0
- package/dist/DocumentEditor.d.ts.map +1 -1
- package/dist/DocumentField.d.ts +50 -0
- package/dist/DocumentField.d.ts.map +1 -0
- package/dist/EditableText.d.ts +38 -4
- package/dist/EditableText.d.ts.map +1 -1
- package/dist/EmptyState.d.ts +10 -5
- package/dist/EmptyState.d.ts.map +1 -1
- package/dist/FormDialog.d.ts +38 -0
- package/dist/FormDialog.d.ts.map +1 -0
- package/dist/InlineText.d.ts.map +1 -1
- package/dist/MoveDialog.d.ts +61 -0
- package/dist/MoveDialog.d.ts.map +1 -0
- package/dist/NavItem.d.ts +9 -2
- package/dist/NavItem.d.ts.map +1 -1
- package/dist/NavTree.d.ts +16 -3
- package/dist/NavTree.d.ts.map +1 -1
- package/dist/PinnedComment.d.ts +3 -1
- package/dist/PinnedComment.d.ts.map +1 -1
- package/dist/ReactionHorizon.d.ts +5 -1
- package/dist/ReactionHorizon.d.ts.map +1 -1
- package/dist/ResolveDialog.d.ts +3 -1
- package/dist/ResolveDialog.d.ts.map +1 -1
- package/dist/SelectionToolbar.d.ts +2 -2
- package/dist/Thread.d.ts +6 -3
- package/dist/Thread.d.ts.map +1 -1
- package/dist/commentBoxFrame.d.ts.map +1 -1
- package/dist/conversation.examples.d.ts +4 -1
- package/dist/conversation.examples.d.ts.map +1 -1
- package/dist/conversationScroll.d.ts +80 -0
- package/dist/conversationScroll.d.ts.map +1 -0
- package/dist/editor.d.ts +1 -0
- package/dist/editor.d.ts.map +1 -1
- package/dist/editor.js +228 -69
- package/dist/editor.js.map +4 -4
- package/dist/eslint/index.js +2 -2
- package/dist/eslint/index.js.map +2 -2
- package/dist/eslint/no-field-outside-a-form.d.ts +2 -2
- package/dist/eslint/no-field-outside-a-form.d.ts.map +1 -1
- package/dist/eslint/no-native-title.d.ts +1 -1
- package/dist/eslint/no-native-title.d.ts.map +1 -1
- package/dist/formBusy.d.ts +5 -2
- package/dist/formBusy.d.ts.map +1 -1
- package/dist/index.d.ts +14 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2210 -1458
- package/dist/index.js.map +4 -4
- package/dist/looks.d.ts +8 -0
- package/dist/looks.d.ts.map +1 -1
- package/dist/seenOnScreen.d.ts +27 -0
- package/dist/seenOnScreen.d.ts.map +1 -0
- package/dist/showInConversation.d.ts +31 -0
- package/dist/showInConversation.d.ts.map +1 -0
- package/dist/threadCard.d.ts +13 -0
- package/dist/threadCard.d.ts.map +1 -1
- package/package.json +1 -1
- package/registry.json +904 -139
- package/src/AppProvider.mdx +4 -0
- package/src/AppProvider.test.tsx +34 -2
- package/src/AppProvider.tsx +17 -6
- package/src/ArchiveDialog.mdx +70 -0
- package/src/ArchiveDialog.stories.tsx +64 -0
- package/src/ArchiveDialog.test.tsx +90 -0
- package/src/ArchiveDialog.tsx +70 -0
- package/src/AttachedCard.mdx +6 -0
- package/src/AttachedCard.stories.tsx +9 -1
- package/src/AttachedCard.test.tsx +111 -2
- package/src/AttachedCard.tsx +77 -7
- package/src/Card.mdx +20 -1
- package/src/Card.stories.tsx +20 -0
- package/src/Card.test.tsx +87 -1
- package/src/Card.tsx +51 -3
- package/src/ChipInput.mdx +7 -1
- package/src/ChipInput.stories.tsx +9 -0
- package/src/ChipInput.test.tsx +42 -0
- package/src/ChipInput.tsx +7 -3
- package/src/CollapsibleSection.mdx +20 -1
- package/src/CollapsibleSection.stories.tsx +19 -1
- package/src/CollapsibleSection.test.tsx +85 -2
- package/src/CollapsibleSection.tsx +54 -15
- package/src/CommentBox.mdx +2 -1
- package/src/CommentBox.test.tsx +81 -1
- package/src/CommentBox.tsx +32 -11
- package/src/ConfirmDialog.mdx +25 -3
- package/src/ConfirmDialog.stories.tsx +27 -0
- package/src/ConfirmDialog.test.tsx +87 -1
- package/src/ConfirmDialog.tsx +39 -8
- package/src/ConversationCard.mdx +4 -0
- package/src/ConversationCard.stories.tsx +11 -1
- package/src/ConversationCard.test.tsx +116 -0
- package/src/ConversationCard.tsx +53 -36
- package/src/ConversationLayout.mdx +30 -4
- package/src/ConversationLayout.scroll.test.tsx +411 -0
- package/src/ConversationLayout.stories.tsx +79 -1
- package/src/ConversationLayout.test.tsx +79 -0
- package/src/ConversationLayout.tsx +136 -15
- package/src/ConversationPlace.mdx +53 -0
- package/src/ConversationPlace.stories.tsx +48 -0
- package/src/ConversationPlace.test.tsx +51 -0
- package/src/ConversationPlace.tsx +30 -0
- package/src/DocumentEditor.mdx +2 -1
- package/src/DocumentEditor.tsx +118 -64
- package/src/DocumentField.mdx +83 -0
- package/src/DocumentField.stories.tsx +110 -0
- package/src/DocumentField.test.tsx +281 -0
- package/src/DocumentField.tsx +199 -0
- package/src/EditableText.buttons.test.tsx +318 -0
- package/src/EditableText.mdx +50 -2
- package/src/EditableText.stories.tsx +96 -2
- package/src/EditableText.tsx +189 -5
- package/src/EmptyState.mdx +33 -8
- package/src/EmptyState.stories.tsx +26 -1
- package/src/EmptyState.test.tsx +63 -2
- package/src/EmptyState.tsx +28 -6
- package/src/Form.mdx +3 -1
- package/src/FormDialog.mdx +78 -0
- package/src/FormDialog.stories.tsx +90 -0
- package/src/FormDialog.test.tsx +183 -0
- package/src/FormDialog.tsx +93 -0
- package/src/InlineText.mdx +1 -0
- package/src/InlineText.tsx +2 -1
- package/src/MoveDialog.mdx +74 -0
- package/src/MoveDialog.stories.tsx +121 -0
- package/src/MoveDialog.test.tsx +203 -0
- package/src/MoveDialog.tsx +183 -0
- package/src/NavItem.mdx +15 -0
- package/src/NavItem.stories.tsx +15 -0
- package/src/NavItem.test.tsx +64 -1
- package/src/NavItem.tsx +10 -2
- package/src/NavTree.mdx +26 -4
- package/src/NavTree.stories.tsx +59 -0
- package/src/NavTree.test.tsx +232 -2
- package/src/NavTree.tsx +93 -43
- package/src/PinnedComment.mdx +6 -1
- package/src/PinnedComment.stories.tsx +11 -1
- package/src/PinnedComment.tsx +15 -2
- package/src/ReactionHorizon.mdx +3 -0
- package/src/ReactionHorizon.stories.tsx +3 -0
- package/src/ReactionHorizon.test.tsx +55 -0
- package/src/ReactionHorizon.tsx +30 -11
- package/src/ReplyCard.mdx +3 -0
- package/src/ReplyCard.stories.tsx +19 -1
- package/src/ResolveDialog.mdx +2 -0
- package/src/ResolveDialog.test.tsx +21 -0
- package/src/ResolveDialog.tsx +11 -39
- package/src/SelectionToolbar.tsx +2 -2
- package/src/Textarea.mdx +1 -0
- package/src/Thread.mdx +18 -1
- package/src/Thread.stories.tsx +55 -3
- package/src/Thread.test.tsx +11 -0
- package/src/Thread.tsx +53 -11
- package/src/commentBoxFrame.tsx +2 -2
- package/src/conversation.examples.tsx +10 -2
- package/src/conversationScroll.ts +155 -0
- package/src/editor.ts +1 -0
- package/src/editorSelection.test.tsx +53 -0
- package/src/eslint/no-field-outside-a-form.test.ts +4 -0
- package/src/eslint/no-field-outside-a-form.ts +2 -2
- package/src/eslint/no-native-title.ts +1 -1
- package/src/formBusy.ts +5 -2
- package/src/index.ts +16 -6
- package/src/looks.ts +10 -0
- package/src/registry/registry.test.ts +12 -6
- package/src/seenOnScreen.test.tsx +182 -0
- package/src/seenOnScreen.ts +146 -0
- package/src/showInConversation.test.tsx +168 -0
- package/src/showInConversation.ts +93 -0
- package/src/threadCard.ts +16 -0
- package/stories/Choosing.mdx +7 -2
- package/tailwind-preset.js +7 -0
package/registry.json
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
"kind": "package",
|
|
5
5
|
"repo": "estiva-ui",
|
|
6
6
|
"package": "@estiva-app/ui",
|
|
7
|
-
"packageVersion": "0.
|
|
8
|
-
"exports":
|
|
9
|
-
"typeExports":
|
|
7
|
+
"packageVersion": "0.99.0",
|
|
8
|
+
"exports": 243,
|
|
9
|
+
"typeExports": 249,
|
|
10
10
|
"files": null
|
|
11
11
|
},
|
|
12
12
|
"storybook": {
|
|
@@ -294,6 +294,95 @@
|
|
|
294
294
|
"overflow-hidden rounded-2xl bg-bg-surface signal:border signal:border-border-subtle signal:shadow-highlight-inset"
|
|
295
295
|
]
|
|
296
296
|
},
|
|
297
|
+
{
|
|
298
|
+
"name": "ArchiveDialog",
|
|
299
|
+
"repo": "estiva-ui",
|
|
300
|
+
"kind": "component",
|
|
301
|
+
"importPath": "@estiva-app/ui",
|
|
302
|
+
"sourceFile": "src/ArchiveDialog.tsx",
|
|
303
|
+
"purpose": "The question asked before archiving a file or a Folder: what goes out of the lists with it, counted, and an optional resolution.",
|
|
304
|
+
"purposeFrom": "page",
|
|
305
|
+
"props": [
|
|
306
|
+
{
|
|
307
|
+
"name": "title",
|
|
308
|
+
"takes": "text",
|
|
309
|
+
"required": true,
|
|
310
|
+
"note": "The file's name, for the title."
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "what",
|
|
314
|
+
"takes": "text",
|
|
315
|
+
"required": true,
|
|
316
|
+
"note": "What it is, in a word: \"topic\", \"project\", \"issue\", \"folder\"."
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "hides",
|
|
320
|
+
"takes": "readonly string[] | null",
|
|
321
|
+
"required": true,
|
|
322
|
+
"note": "What goes out of the lists with it, already counted and worded — \"14 issues\"."
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "staysVisible",
|
|
326
|
+
"takes": "readonly string[]",
|
|
327
|
+
"required": false,
|
|
328
|
+
"note": "What it lists that stays visible somewhere else, worded — \"2 files also in Steer\"."
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "apps",
|
|
332
|
+
"takes": "readonly string[]",
|
|
333
|
+
"required": true,
|
|
334
|
+
"note": "The apps whose lists it goes out of, in the order to name them: `['Peek', 'Ship']` reads \"in Peek and in Ship\"."
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "getBack",
|
|
338
|
+
"takes": "text",
|
|
339
|
+
"required": true,
|
|
340
|
+
"note": "The last line, in the app's words: that nothing is deleted, and how to get it back there."
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "onClose",
|
|
344
|
+
"takes": "a handler",
|
|
345
|
+
"required": true,
|
|
346
|
+
"note": null
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "onArchive",
|
|
350
|
+
"takes": "a handler",
|
|
351
|
+
"required": true,
|
|
352
|
+
"note": "With the resolution, trimmed (`''` for none)."
|
|
353
|
+
}
|
|
354
|
+
],
|
|
355
|
+
"variants": [],
|
|
356
|
+
"ownsBehaviours": [
|
|
357
|
+
{
|
|
358
|
+
"id": "portal",
|
|
359
|
+
"behaviour": "Floats on top of the page"
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"id": "press-outside",
|
|
363
|
+
"behaviour": "Closes on a press outside"
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"id": "page-keys",
|
|
367
|
+
"behaviour": "Takes its keys by itself"
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"id": "focus",
|
|
371
|
+
"behaviour": "Holds focus inside while open, and gives it back"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"id": "scroll-lock",
|
|
375
|
+
"behaviour": "Stops the page behind it scrolling"
|
|
376
|
+
}
|
|
377
|
+
],
|
|
378
|
+
"status": "stable",
|
|
379
|
+
"migrationStage": null,
|
|
380
|
+
"docsId": "menus-windows-archivedialog--docs",
|
|
381
|
+
"storyId": "menus-windows-archivedialog--a-project",
|
|
382
|
+
"docPage": "src/ArchiveDialog.mdx",
|
|
383
|
+
"app": null,
|
|
384
|
+
"looks": []
|
|
385
|
+
},
|
|
297
386
|
{
|
|
298
387
|
"name": "archivedLine",
|
|
299
388
|
"repo": "estiva-ui",
|
|
@@ -1131,6 +1220,12 @@
|
|
|
1131
1220
|
"required": false,
|
|
1132
1221
|
"note": "What is inside is cut to the card's rounded corners: a strip or a picture that runs edge to edge (UIG-9, 17 September; the apps passed `overflow-hidden`)."
|
|
1133
1222
|
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "onPress",
|
|
1225
|
+
"takes": "a handler",
|
|
1226
|
+
"required": false,
|
|
1227
|
+
"note": "Pressing the card opens what it stands for: a click anywhere on it but on what acts by itself inside it, and Enter or Space on the card itself, which is a Tab stop."
|
|
1228
|
+
},
|
|
1134
1229
|
{
|
|
1135
1230
|
"name": "children",
|
|
1136
1231
|
"takes": "anything",
|
|
@@ -1494,6 +1589,12 @@
|
|
|
1494
1589
|
"takes": "text",
|
|
1495
1590
|
"required": false,
|
|
1496
1591
|
"note": "The id of what names the field on the page — a visible \"To:\", say."
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"name": "single",
|
|
1595
|
+
"takes": "true/false",
|
|
1596
|
+
"required": false,
|
|
1597
|
+
"note": "It holds one — an owner, an assignee: a later pick replaces the chosen one rather than adding a second."
|
|
1497
1598
|
}
|
|
1498
1599
|
],
|
|
1499
1600
|
"variants": [],
|
|
@@ -1539,7 +1640,7 @@
|
|
|
1539
1640
|
"app": null,
|
|
1540
1641
|
"looks": [
|
|
1541
1642
|
"bg-bg-elevated border border-border-subtle rounded-md",
|
|
1542
|
-
"bg-bg-field border border-border-field shadow-field hover:border-border-strong rounded-lg transition-colors focus-within:border-border-focus focus-within:hover:border-border-focus
|
|
1643
|
+
"bg-bg-field border border-border-field shadow-field hover:border-border-strong rounded-lg transition-colors focus-within:border-border-focus focus-within:hover:border-border-focus signal:transition-shadow signal:focus-within:shadow-focus-ring cursor-text",
|
|
1543
1644
|
"text-body-2 border-none bg-transparent text-text-primary placeholder:text-text-muted outline-none"
|
|
1544
1645
|
]
|
|
1545
1646
|
},
|
|
@@ -2450,7 +2551,13 @@
|
|
|
2450
2551
|
"name": "onClose",
|
|
2451
2552
|
"takes": "a handler",
|
|
2452
2553
|
"required": true,
|
|
2453
|
-
"note":
|
|
2554
|
+
"note": "Cancel, Escape, the ✕, and an action that went through: once, when it was closed while the action ran."
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"name": "alternative",
|
|
2558
|
+
"takes": "ConfirmDialogAlternative",
|
|
2559
|
+
"required": false,
|
|
2560
|
+
"note": "A third, safer answer — \"Archive instead\" — drawn after the words, under its sentence, and switched off while the confirm runs (Peek's, 2 November)."
|
|
2454
2561
|
}
|
|
2455
2562
|
],
|
|
2456
2563
|
"variants": [],
|
|
@@ -2718,6 +2825,12 @@
|
|
|
2718
2825
|
"required": true,
|
|
2719
2826
|
"note": "When it was written, in the app's words (\"11:08 AM\")."
|
|
2720
2827
|
},
|
|
2828
|
+
{
|
|
2829
|
+
"name": "at",
|
|
2830
|
+
"takes": "number",
|
|
2831
|
+
"required": false,
|
|
2832
|
+
"note": "When it was written, as a moment (ms since 1970): the time then says the exact date and time under the pointer."
|
|
2833
|
+
},
|
|
2721
2834
|
{
|
|
2722
2835
|
"name": "timeHref",
|
|
2723
2836
|
"takes": "text",
|
|
@@ -2888,6 +3001,12 @@
|
|
|
2888
3001
|
"required": false,
|
|
2889
3002
|
"note": "The id of the comment whose thread is open."
|
|
2890
3003
|
},
|
|
3004
|
+
{
|
|
3005
|
+
"name": "aside",
|
|
3006
|
+
"takes": "anything",
|
|
3007
|
+
"required": false,
|
|
3008
|
+
"note": "Two columns: what the 384px column holds while no thread is open, the page's own panel beside its comments (an overview)."
|
|
3009
|
+
},
|
|
2891
3010
|
{
|
|
2892
3011
|
"name": "onOpenChange",
|
|
2893
3012
|
"takes": "a handler",
|
|
@@ -2930,11 +3049,17 @@
|
|
|
2930
3049
|
"required": false,
|
|
2931
3050
|
"note": "What an empty conversation says: words, or the app's own `EmptyState` (a read that failed says so)."
|
|
2932
3051
|
},
|
|
3052
|
+
{
|
|
3053
|
+
"name": "rememberAs",
|
|
3054
|
+
"takes": "text",
|
|
3055
|
+
"required": false,
|
|
3056
|
+
"note": "Two columns: the conversation's own name in the app (its address)."
|
|
3057
|
+
},
|
|
2933
3058
|
{
|
|
2934
3059
|
"name": "bodyRef",
|
|
2935
3060
|
"takes": "Ref<HTMLDivElement>",
|
|
2936
3061
|
"required": false,
|
|
2937
|
-
"note": "Two columns: the comments' scrolling box
|
|
3062
|
+
"note": "Two columns: the comments' scrolling box."
|
|
2938
3063
|
},
|
|
2939
3064
|
{
|
|
2940
3065
|
"name": "onBodyScroll",
|
|
@@ -2942,6 +3067,12 @@
|
|
|
2942
3067
|
"required": false,
|
|
2943
3068
|
"note": "Two columns: the comments' box scrolled."
|
|
2944
3069
|
},
|
|
3070
|
+
{
|
|
3071
|
+
"name": "seen",
|
|
3072
|
+
"takes": "SeenOnScreen",
|
|
3073
|
+
"required": false,
|
|
3074
|
+
"note": "What `useSeenOnScreen` made for this conversation: the layout watches its comments, and says in it which were seen."
|
|
3075
|
+
},
|
|
2945
3076
|
{
|
|
2946
3077
|
"name": "header",
|
|
2947
3078
|
"takes": "anything",
|
|
@@ -3104,6 +3235,44 @@
|
|
|
3104
3235
|
"app": null,
|
|
3105
3236
|
"looks": []
|
|
3106
3237
|
},
|
|
3238
|
+
{
|
|
3239
|
+
"name": "ConversationPlace",
|
|
3240
|
+
"repo": "estiva-ui",
|
|
3241
|
+
"kind": "component",
|
|
3242
|
+
"importPath": "@estiva-app/ui",
|
|
3243
|
+
"sourceFile": "src/ConversationPlace.tsx",
|
|
3244
|
+
"purpose": "Above a conversation shown away from where it was said: how it is related, and where it was said.",
|
|
3245
|
+
"purposeFrom": "page",
|
|
3246
|
+
"props": [
|
|
3247
|
+
{
|
|
3248
|
+
"name": "relation",
|
|
3249
|
+
"takes": "text",
|
|
3250
|
+
"required": true,
|
|
3251
|
+
"note": "How the conversation is related to the page it is shown on, in the app's words: \"Mentioned in\"."
|
|
3252
|
+
},
|
|
3253
|
+
{
|
|
3254
|
+
"name": "place",
|
|
3255
|
+
"takes": "text",
|
|
3256
|
+
"required": false,
|
|
3257
|
+
"note": "Where it was said: the place's name. Absent or empty while it resolves, and then nothing is drawn for it."
|
|
3258
|
+
},
|
|
3259
|
+
{
|
|
3260
|
+
"name": "children",
|
|
3261
|
+
"takes": "anything",
|
|
3262
|
+
"required": false,
|
|
3263
|
+
"note": "The conversation, as the app draws it: its card."
|
|
3264
|
+
}
|
|
3265
|
+
],
|
|
3266
|
+
"variants": [],
|
|
3267
|
+
"ownsBehaviours": [],
|
|
3268
|
+
"status": "stable",
|
|
3269
|
+
"migrationStage": null,
|
|
3270
|
+
"docsId": "conversation-conversationplace--docs",
|
|
3271
|
+
"storyId": "conversation-conversationplace--mentioned-in",
|
|
3272
|
+
"docPage": "src/ConversationPlace.mdx",
|
|
3273
|
+
"app": null,
|
|
3274
|
+
"looks": []
|
|
3275
|
+
},
|
|
3107
3276
|
{
|
|
3108
3277
|
"name": "deleteBlock",
|
|
3109
3278
|
"repo": "estiva-ui",
|
|
@@ -3517,6 +3686,112 @@
|
|
|
3517
3686
|
"app": null,
|
|
3518
3687
|
"looks": []
|
|
3519
3688
|
},
|
|
3689
|
+
{
|
|
3690
|
+
"name": "DocumentField",
|
|
3691
|
+
"repo": "estiva-ui",
|
|
3692
|
+
"kind": "component",
|
|
3693
|
+
"importPath": "@estiva-app/ui/editor",
|
|
3694
|
+
"sourceFile": "src/DocumentField.tsx",
|
|
3695
|
+
"purpose": "A form's field that holds a document: the document editor's blocks, marks, `[`, `@` and `/`, in a field's box.",
|
|
3696
|
+
"purposeFrom": "page",
|
|
3697
|
+
"props": [
|
|
3698
|
+
{
|
|
3699
|
+
"name": "value",
|
|
3700
|
+
"takes": "text",
|
|
3701
|
+
"required": true,
|
|
3702
|
+
"note": "What the field holds, in `format`; `''` when nothing is written."
|
|
3703
|
+
},
|
|
3704
|
+
{
|
|
3705
|
+
"name": "format",
|
|
3706
|
+
"takes": "text",
|
|
3707
|
+
"required": true,
|
|
3708
|
+
"note": "The format `value` is in, handed to `codec.read`."
|
|
3709
|
+
},
|
|
3710
|
+
{
|
|
3711
|
+
"name": "codec",
|
|
3712
|
+
"takes": "DocumentCodec",
|
|
3713
|
+
"required": true,
|
|
3714
|
+
"note": "How the app's text and the editor's document turn into each other: `DocumentEditor`'s."
|
|
3715
|
+
},
|
|
3716
|
+
{
|
|
3717
|
+
"name": "onChange",
|
|
3718
|
+
"takes": "a handler",
|
|
3719
|
+
"required": true,
|
|
3720
|
+
"note": "Every edit, as it is typed: the text and its format, or `''` once it is emptied or holds only spaces and blank lines."
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"name": "label",
|
|
3724
|
+
"takes": "text",
|
|
3725
|
+
"required": true,
|
|
3726
|
+
"note": "The editor's accessible name: the label of the `Field` around it."
|
|
3727
|
+
},
|
|
3728
|
+
{
|
|
3729
|
+
"name": "placeholder",
|
|
3730
|
+
"takes": "anything",
|
|
3731
|
+
"required": false,
|
|
3732
|
+
"note": "Muted words in the empty field."
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
"name": "references",
|
|
3736
|
+
"takes": "DocumentReferences",
|
|
3737
|
+
"required": false,
|
|
3738
|
+
"note": "`[` and `/` → File."
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"name": "mentions",
|
|
3742
|
+
"takes": "DocumentMentions",
|
|
3743
|
+
"required": false,
|
|
3744
|
+
"note": "`@` and `/` → Mention."
|
|
3745
|
+
},
|
|
3746
|
+
{
|
|
3747
|
+
"name": "linkChips",
|
|
3748
|
+
"takes": "LinkChipsOptions",
|
|
3749
|
+
"required": false,
|
|
3750
|
+
"note": "A pasted app URL drawn as the chip of what it names (`LinkChips`)."
|
|
3751
|
+
},
|
|
3752
|
+
{
|
|
3753
|
+
"name": "readMarkdown",
|
|
3754
|
+
"takes": "a handler",
|
|
3755
|
+
"required": false,
|
|
3756
|
+
"note": "Plain text pasted as the blocks it spells: the app's reader of markdown, as the editor's document."
|
|
3757
|
+
},
|
|
3758
|
+
{
|
|
3759
|
+
"name": "referenceView",
|
|
3760
|
+
"takes": "ComponentType<ReferenceViewProps>",
|
|
3761
|
+
"required": false,
|
|
3762
|
+
"note": "Draws a link: the app's own, which resolves what it names."
|
|
3763
|
+
},
|
|
3764
|
+
{
|
|
3765
|
+
"name": "attachmentView",
|
|
3766
|
+
"takes": "ComponentType<AttachmentViewProps>",
|
|
3767
|
+
"required": false,
|
|
3768
|
+
"note": "Draws a placed file: the app's own card."
|
|
3769
|
+
},
|
|
3770
|
+
{
|
|
3771
|
+
"name": "extensions",
|
|
3772
|
+
"takes": "readonly AnyExtension[]",
|
|
3773
|
+
"required": false,
|
|
3774
|
+
"note": "More of the app's own extensions."
|
|
3775
|
+
},
|
|
3776
|
+
{
|
|
3777
|
+
"name": "aria-required",
|
|
3778
|
+
"takes": "boolean | 'true' | 'false'",
|
|
3779
|
+
"required": false,
|
|
3780
|
+
"note": "Set by a required `Field` around it, for a screen reader."
|
|
3781
|
+
}
|
|
3782
|
+
],
|
|
3783
|
+
"variants": [],
|
|
3784
|
+
"ownsBehaviours": [],
|
|
3785
|
+
"status": "stable",
|
|
3786
|
+
"migrationStage": null,
|
|
3787
|
+
"docsId": "writing-documentfield--docs",
|
|
3788
|
+
"storyId": "writing-documentfield--empty",
|
|
3789
|
+
"docPage": "src/DocumentField.mdx",
|
|
3790
|
+
"app": null,
|
|
3791
|
+
"looks": [
|
|
3792
|
+
"bg-bg-field border border-border-field shadow-field hover:border-border-strong rounded-lg transition-colors focus-within:border-border-focus focus-within:hover:border-border-focus signal:transition-shadow signal:focus-within:shadow-focus-ring cursor-text"
|
|
3793
|
+
]
|
|
3794
|
+
},
|
|
3520
3795
|
{
|
|
3521
3796
|
"name": "duplicateBlock",
|
|
3522
3797
|
"repo": "estiva-ui",
|
|
@@ -3555,7 +3830,7 @@
|
|
|
3555
3830
|
"name": "placeholder",
|
|
3556
3831
|
"takes": "text",
|
|
3557
3832
|
"required": true,
|
|
3558
|
-
"note":
|
|
3833
|
+
"note": "What shows, muted, while the value is empty; in `buttons`, as the kit's empty line for one part of a page (12px)."
|
|
3559
3834
|
},
|
|
3560
3835
|
{
|
|
3561
3836
|
"name": "onCommit",
|
|
@@ -3598,51 +3873,99 @@
|
|
|
3598
3873
|
"takes": "true/false",
|
|
3599
3874
|
"required": false,
|
|
3600
3875
|
"note": "Show the value only — no edit affordance."
|
|
3601
|
-
}
|
|
3602
|
-
],
|
|
3603
|
-
"variants": [],
|
|
3604
|
-
"ownsBehaviours": [
|
|
3876
|
+
},
|
|
3605
3877
|
{
|
|
3606
|
-
"
|
|
3607
|
-
"
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
"migrationStage": null,
|
|
3612
|
-
"docsId": "forms-fields-editabletext--docs",
|
|
3613
|
-
"storyId": "forms-fields-editabletext--title",
|
|
3614
|
-
"docPage": "src/EditableText.mdx",
|
|
3615
|
-
"app": null,
|
|
3616
|
-
"looks": [
|
|
3617
|
-
"rounded-md border border-border-strong bg-bg-inset text-text-primary outline-none",
|
|
3618
|
-
"rounded-md border border-border-strong bg-bg-inset text-text-primary outline-none resize-none",
|
|
3619
|
-
"rounded-md border border-transparent text-left transition-colors hover:border-border-default text-text-primary",
|
|
3620
|
-
"rounded-md border border-transparent text-left transition-colors hover:border-border-default text-text-muted",
|
|
3621
|
-
"rounded-md border border-transparent text-left transition-colors hover:border-border-default whitespace-pre-wrap text-text-primary",
|
|
3622
|
-
"rounded-md border border-transparent text-left transition-colors hover:border-border-default whitespace-pre-wrap text-text-muted",
|
|
3623
|
-
"rounded-md border border-transparent text-left transition-colors hover:border-border-default"
|
|
3624
|
-
]
|
|
3625
|
-
},
|
|
3626
|
-
{
|
|
3627
|
-
"name": "EditedMarker",
|
|
3628
|
-
"repo": "estiva-ui",
|
|
3629
|
-
"kind": "component",
|
|
3630
|
-
"importPath": "@estiva-app/ui",
|
|
3631
|
-
"sourceFile": "src/EditedMarker.tsx",
|
|
3632
|
-
"purpose": "\"(edited)\" beside a time, with when it was edited on hover.",
|
|
3633
|
-
"purposeFrom": "page",
|
|
3634
|
-
"props": [
|
|
3878
|
+
"name": "manner",
|
|
3879
|
+
"takes": "inline | buttons",
|
|
3880
|
+
"required": false,
|
|
3881
|
+
"note": "How it is edited. `inline`, the default: the text is the button, and leaving the field saves."
|
|
3882
|
+
},
|
|
3635
3883
|
{
|
|
3636
|
-
"name": "
|
|
3884
|
+
"name": "editLabel",
|
|
3637
3885
|
"takes": "text",
|
|
3638
3886
|
"required": false,
|
|
3639
|
-
"note": "
|
|
3640
|
-
}
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3887
|
+
"note": "`buttons`: the words on the button that opens the field — \"Rename\"."
|
|
3888
|
+
},
|
|
3889
|
+
{
|
|
3890
|
+
"name": "addLabel",
|
|
3891
|
+
"takes": "text",
|
|
3892
|
+
"required": false,
|
|
3893
|
+
"note": "`buttons`: its words while the value is empty, with a plus — \"Add a summary\"."
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
"name": "fieldPlaceholder",
|
|
3897
|
+
"takes": "text",
|
|
3898
|
+
"required": false,
|
|
3899
|
+
"note": "`buttons`: the field's own placeholder, while it is edited."
|
|
3900
|
+
},
|
|
3901
|
+
{
|
|
3902
|
+
"name": "required",
|
|
3903
|
+
"takes": "true/false",
|
|
3904
|
+
"required": false,
|
|
3905
|
+
"note": "`buttons`: an empty value cannot be saved, as a name cannot."
|
|
3906
|
+
},
|
|
3907
|
+
{
|
|
3908
|
+
"name": "clean",
|
|
3909
|
+
"takes": "a handler",
|
|
3910
|
+
"required": false,
|
|
3911
|
+
"note": "`buttons`: what a draft becomes before it is compared and saved — one line, say."
|
|
3912
|
+
},
|
|
3913
|
+
{
|
|
3914
|
+
"name": "draftNote",
|
|
3915
|
+
"takes": "a handler",
|
|
3916
|
+
"required": false,
|
|
3917
|
+
"note": "`buttons`: said between the field and its buttons as it is typed — a count past a limit."
|
|
3918
|
+
},
|
|
3919
|
+
{
|
|
3920
|
+
"name": "defaultEditing",
|
|
3921
|
+
"takes": "true/false",
|
|
3922
|
+
"required": false,
|
|
3923
|
+
"note": "`buttons`: opens as the field, holding the value — a menu's Rename."
|
|
3924
|
+
}
|
|
3925
|
+
],
|
|
3926
|
+
"variants": [
|
|
3927
|
+
{
|
|
3928
|
+
"prop": "manner",
|
|
3929
|
+
"values": [
|
|
3930
|
+
"inline",
|
|
3931
|
+
"buttons"
|
|
3932
|
+
]
|
|
3933
|
+
}
|
|
3934
|
+
],
|
|
3935
|
+
"ownsBehaviours": [
|
|
3936
|
+
{
|
|
3937
|
+
"id": "base-ui",
|
|
3938
|
+
"behaviour": "Is built on Base UI"
|
|
3939
|
+
}
|
|
3940
|
+
],
|
|
3941
|
+
"status": "stable",
|
|
3942
|
+
"migrationStage": null,
|
|
3943
|
+
"docsId": "forms-fields-editabletext--docs",
|
|
3944
|
+
"storyId": "forms-fields-editabletext--title",
|
|
3945
|
+
"docPage": "src/EditableText.mdx",
|
|
3946
|
+
"app": null,
|
|
3947
|
+
"looks": []
|
|
3948
|
+
},
|
|
3949
|
+
{
|
|
3950
|
+
"name": "EditedMarker",
|
|
3951
|
+
"repo": "estiva-ui",
|
|
3952
|
+
"kind": "component",
|
|
3953
|
+
"importPath": "@estiva-app/ui",
|
|
3954
|
+
"sourceFile": "src/EditedMarker.tsx",
|
|
3955
|
+
"purpose": "\"(edited)\" beside a time, with when it was edited on hover.",
|
|
3956
|
+
"purposeFrom": "page",
|
|
3957
|
+
"props": [
|
|
3958
|
+
{
|
|
3959
|
+
"name": "edited",
|
|
3960
|
+
"takes": "text",
|
|
3961
|
+
"required": false,
|
|
3962
|
+
"note": "When it was edited, in the app's words for the tooltip (\"Edited 11:20 AM\")."
|
|
3963
|
+
}
|
|
3964
|
+
],
|
|
3965
|
+
"variants": [],
|
|
3966
|
+
"ownsBehaviours": [],
|
|
3967
|
+
"status": "stable",
|
|
3968
|
+
"migrationStage": null,
|
|
3646
3969
|
"docsId": "conversation-editedmarker--docs",
|
|
3647
3970
|
"storyId": "conversation-editedmarker--edited",
|
|
3648
3971
|
"docPage": "src/EditedMarker.mdx",
|
|
@@ -3746,7 +4069,7 @@
|
|
|
3746
4069
|
"kind": "component",
|
|
3747
4070
|
"importPath": "@estiva-app/ui",
|
|
3748
4071
|
"sourceFile": "src/EmptyState.tsx",
|
|
3749
|
-
"purpose": "The place where content will be once there is some, in
|
|
4072
|
+
"purpose": "The place where content will be once there is some, in three manners: a 16px icon over a centred line when the whole page is empty, the line alone and left-aligned when one section of a page is, and that line in a row's inset in place of a sidebar's rows.",
|
|
3750
4073
|
"purposeFrom": "page",
|
|
3751
4074
|
"props": [
|
|
3752
4075
|
{
|
|
@@ -3763,9 +4086,9 @@
|
|
|
3763
4086
|
},
|
|
3764
4087
|
{
|
|
3765
4088
|
"name": "scope",
|
|
3766
|
-
"takes": "page | section",
|
|
4089
|
+
"takes": "page | section | rows",
|
|
3767
4090
|
"required": false,
|
|
3768
|
-
"note": "`page` when the whole page is empty; `section` when one part of it is."
|
|
4091
|
+
"note": "`page` when the whole page is empty; `section` when one part of it is; `rows` in place of rows that pad themselves, a sidebar's."
|
|
3769
4092
|
},
|
|
3770
4093
|
{
|
|
3771
4094
|
"name": "action",
|
|
@@ -3785,7 +4108,8 @@
|
|
|
3785
4108
|
"prop": "scope",
|
|
3786
4109
|
"values": [
|
|
3787
4110
|
"page",
|
|
3788
|
-
"section"
|
|
4111
|
+
"section",
|
|
4112
|
+
"rows"
|
|
3789
4113
|
]
|
|
3790
4114
|
}
|
|
3791
4115
|
],
|
|
@@ -4236,6 +4560,103 @@
|
|
|
4236
4560
|
"app": null,
|
|
4237
4561
|
"looks": []
|
|
4238
4562
|
},
|
|
4563
|
+
{
|
|
4564
|
+
"name": "FormDialog",
|
|
4565
|
+
"repo": "estiva-ui",
|
|
4566
|
+
"kind": "component",
|
|
4567
|
+
"importPath": "@estiva-app/ui",
|
|
4568
|
+
"sourceFile": "src/FormDialog.tsx",
|
|
4569
|
+
"purpose": "A dialog that sends a form: the words and fields you give it, then Cancel and the button that sends it, waiting together while it sends.",
|
|
4570
|
+
"purposeFrom": "page",
|
|
4571
|
+
"props": [
|
|
4572
|
+
{
|
|
4573
|
+
"name": "title",
|
|
4574
|
+
"takes": "text",
|
|
4575
|
+
"required": true,
|
|
4576
|
+
"note": "The dialog's heading."
|
|
4577
|
+
},
|
|
4578
|
+
{
|
|
4579
|
+
"name": "submitLabel",
|
|
4580
|
+
"takes": "text",
|
|
4581
|
+
"required": true,
|
|
4582
|
+
"note": "The words on the button that sends the form: \"Move\", \"Create\"."
|
|
4583
|
+
},
|
|
4584
|
+
{
|
|
4585
|
+
"name": "busyLabel",
|
|
4586
|
+
"takes": "text",
|
|
4587
|
+
"required": false,
|
|
4588
|
+
"note": "Its words while the form sends — \"Moving…\"."
|
|
4589
|
+
},
|
|
4590
|
+
{
|
|
4591
|
+
"name": "submitVariant",
|
|
4592
|
+
"takes": "primary | resolve",
|
|
4593
|
+
"required": false,
|
|
4594
|
+
"note": "How the sending button looks: `primary`, or `resolve` for a Resolve."
|
|
4595
|
+
},
|
|
4596
|
+
{
|
|
4597
|
+
"name": "ready",
|
|
4598
|
+
"takes": "true/false",
|
|
4599
|
+
"required": false,
|
|
4600
|
+
"note": "Whether there is enough to send. While it is not, the button is greyed and Enter sends nothing."
|
|
4601
|
+
},
|
|
4602
|
+
{
|
|
4603
|
+
"name": "onSubmit",
|
|
4604
|
+
"takes": "a handler",
|
|
4605
|
+
"required": true,
|
|
4606
|
+
"note": "Sends the form. Answer `false` to keep the dialog open (you have said why); anything else closes it."
|
|
4607
|
+
},
|
|
4608
|
+
{
|
|
4609
|
+
"name": "onClose",
|
|
4610
|
+
"takes": "a handler",
|
|
4611
|
+
"required": true,
|
|
4612
|
+
"note": "Cancel, Escape, the ✕, a press outside, and a send that went through: once, when it was closed while it sent."
|
|
4613
|
+
},
|
|
4614
|
+
{
|
|
4615
|
+
"name": "children",
|
|
4616
|
+
"takes": "anything",
|
|
4617
|
+
"required": true,
|
|
4618
|
+
"note": "What the form holds: the words before the fields, then the fields."
|
|
4619
|
+
}
|
|
4620
|
+
],
|
|
4621
|
+
"variants": [
|
|
4622
|
+
{
|
|
4623
|
+
"prop": "submitVariant",
|
|
4624
|
+
"values": [
|
|
4625
|
+
"primary",
|
|
4626
|
+
"resolve"
|
|
4627
|
+
]
|
|
4628
|
+
}
|
|
4629
|
+
],
|
|
4630
|
+
"ownsBehaviours": [
|
|
4631
|
+
{
|
|
4632
|
+
"id": "portal",
|
|
4633
|
+
"behaviour": "Floats on top of the page"
|
|
4634
|
+
},
|
|
4635
|
+
{
|
|
4636
|
+
"id": "press-outside",
|
|
4637
|
+
"behaviour": "Closes on a press outside"
|
|
4638
|
+
},
|
|
4639
|
+
{
|
|
4640
|
+
"id": "page-keys",
|
|
4641
|
+
"behaviour": "Takes its keys by itself"
|
|
4642
|
+
},
|
|
4643
|
+
{
|
|
4644
|
+
"id": "focus",
|
|
4645
|
+
"behaviour": "Holds focus inside while open, and gives it back"
|
|
4646
|
+
},
|
|
4647
|
+
{
|
|
4648
|
+
"id": "scroll-lock",
|
|
4649
|
+
"behaviour": "Stops the page behind it scrolling"
|
|
4650
|
+
}
|
|
4651
|
+
],
|
|
4652
|
+
"status": "stable",
|
|
4653
|
+
"migrationStage": null,
|
|
4654
|
+
"docsId": "menus-windows-formdialog--docs",
|
|
4655
|
+
"storyId": "menus-windows-formdialog--new-folder",
|
|
4656
|
+
"docPage": "src/FormDialog.mdx",
|
|
4657
|
+
"app": null,
|
|
4658
|
+
"looks": []
|
|
4659
|
+
},
|
|
4239
4660
|
{
|
|
4240
4661
|
"name": "hueFor",
|
|
4241
4662
|
"repo": "estiva-ui",
|
|
@@ -4858,6 +5279,25 @@
|
|
|
4858
5279
|
"app": null,
|
|
4859
5280
|
"looks": []
|
|
4860
5281
|
},
|
|
5282
|
+
{
|
|
5283
|
+
"name": "isPlainClick",
|
|
5284
|
+
"repo": "estiva-ui",
|
|
5285
|
+
"kind": "helper",
|
|
5286
|
+
"importPath": "@estiva-app/ui",
|
|
5287
|
+
"sourceFile": "src/AppProvider.tsx",
|
|
5288
|
+
"purpose": "Whether a click is a plain one, the browser's to follow in this tab: the main button, with no Ctrl, Cmd, Shift or Alt — what every link part checks before it keeps a click in the app.",
|
|
5289
|
+
"purposeFrom": "comment",
|
|
5290
|
+
"props": [],
|
|
5291
|
+
"variants": [],
|
|
5292
|
+
"ownsBehaviours": [],
|
|
5293
|
+
"status": "stable",
|
|
5294
|
+
"migrationStage": null,
|
|
5295
|
+
"docsId": "app-frame-appprovider--docs",
|
|
5296
|
+
"storyId": "app-frame-appprovider--pictures",
|
|
5297
|
+
"docPage": null,
|
|
5298
|
+
"app": null,
|
|
5299
|
+
"looks": []
|
|
5300
|
+
},
|
|
4861
5301
|
{
|
|
4862
5302
|
"name": "isReferenceMenuOpen",
|
|
4863
5303
|
"repo": "estiva-ui",
|
|
@@ -6458,129 +6898,273 @@
|
|
|
6458
6898
|
"purposeFrom": "comment",
|
|
6459
6899
|
"props": [
|
|
6460
6900
|
{
|
|
6461
|
-
"name": "label",
|
|
6901
|
+
"name": "label",
|
|
6902
|
+
"takes": "text",
|
|
6903
|
+
"required": true,
|
|
6904
|
+
"note": "The trigger row's label."
|
|
6905
|
+
},
|
|
6906
|
+
{
|
|
6907
|
+
"name": "leading",
|
|
6908
|
+
"takes": "anything",
|
|
6909
|
+
"required": false,
|
|
6910
|
+
"note": null
|
|
6911
|
+
},
|
|
6912
|
+
{
|
|
6913
|
+
"name": "selected",
|
|
6914
|
+
"takes": "true/false",
|
|
6915
|
+
"required": false,
|
|
6916
|
+
"note": "Mark the trigger row as holding a current value."
|
|
6917
|
+
},
|
|
6918
|
+
{
|
|
6919
|
+
"name": "children",
|
|
6920
|
+
"takes": "anything",
|
|
6921
|
+
"required": true,
|
|
6922
|
+
"note": "The submenu's rows."
|
|
6923
|
+
},
|
|
6924
|
+
{
|
|
6925
|
+
"name": "className",
|
|
6926
|
+
"takes": "text",
|
|
6927
|
+
"required": false,
|
|
6928
|
+
"note": "On the submenu panel."
|
|
6929
|
+
}
|
|
6930
|
+
],
|
|
6931
|
+
"variants": [],
|
|
6932
|
+
"ownsBehaviours": [
|
|
6933
|
+
{
|
|
6934
|
+
"id": "base-ui",
|
|
6935
|
+
"behaviour": "Is built on Base UI"
|
|
6936
|
+
},
|
|
6937
|
+
{
|
|
6938
|
+
"id": "role",
|
|
6939
|
+
"behaviour": "Says what it is to assistive technology"
|
|
6940
|
+
}
|
|
6941
|
+
],
|
|
6942
|
+
"status": "stable",
|
|
6943
|
+
"migrationStage": null,
|
|
6944
|
+
"docsId": "menus-windows-menu--docs",
|
|
6945
|
+
"storyId": "menus-windows-menu--items",
|
|
6946
|
+
"docPage": null,
|
|
6947
|
+
"app": null,
|
|
6948
|
+
"looks": []
|
|
6949
|
+
},
|
|
6950
|
+
{
|
|
6951
|
+
"name": "MetaText",
|
|
6952
|
+
"repo": "estiva-ui",
|
|
6953
|
+
"kind": "component",
|
|
6954
|
+
"importPath": "@estiva-app/ui",
|
|
6955
|
+
"sourceFile": "src/MetaText.tsx",
|
|
6956
|
+
"purpose": "The small figure beside a name: a time, a resolve line's time, a count.",
|
|
6957
|
+
"purposeFrom": "page",
|
|
6958
|
+
"props": [
|
|
6959
|
+
{
|
|
6960
|
+
"name": "children",
|
|
6961
|
+
"takes": "anything",
|
|
6962
|
+
"required": true,
|
|
6963
|
+
"note": null
|
|
6964
|
+
},
|
|
6965
|
+
{
|
|
6966
|
+
"name": "tone",
|
|
6967
|
+
"takes": "keyof typeof TONE_CLASSES",
|
|
6968
|
+
"required": false,
|
|
6969
|
+
"note": "`muted` for a time; `secondary` and `success` for counts of open and resolved."
|
|
6970
|
+
},
|
|
6971
|
+
{
|
|
6972
|
+
"name": "size",
|
|
6973
|
+
"takes": "caption | chip",
|
|
6974
|
+
"required": false,
|
|
6975
|
+
"note": "`chip` beside a small name, as in a thread's resolve line."
|
|
6976
|
+
},
|
|
6977
|
+
{
|
|
6978
|
+
"name": "className",
|
|
6979
|
+
"takes": "text",
|
|
6980
|
+
"required": false,
|
|
6981
|
+
"note": "Placement only: `shrink-0`, `contents`."
|
|
6982
|
+
}
|
|
6983
|
+
],
|
|
6984
|
+
"variants": [
|
|
6985
|
+
{
|
|
6986
|
+
"prop": "size",
|
|
6987
|
+
"values": [
|
|
6988
|
+
"caption",
|
|
6989
|
+
"chip"
|
|
6990
|
+
]
|
|
6991
|
+
}
|
|
6992
|
+
],
|
|
6993
|
+
"ownsBehaviours": [],
|
|
6994
|
+
"status": "stable",
|
|
6995
|
+
"migrationStage": null,
|
|
6996
|
+
"docsId": "conversation-metatext--docs",
|
|
6997
|
+
"storyId": "conversation-metatext--time",
|
|
6998
|
+
"docPage": "src/MetaText.mdx",
|
|
6999
|
+
"app": null,
|
|
7000
|
+
"looks": [
|
|
7001
|
+
"text-chip font-normal text-text-muted whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
7002
|
+
"text-chip font-normal text-text-secondary whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
7003
|
+
"text-chip font-normal text-success-default whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
7004
|
+
"text-caption text-text-muted whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
7005
|
+
"text-caption text-text-secondary whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
7006
|
+
"text-caption text-success-default whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums"
|
|
7007
|
+
]
|
|
7008
|
+
},
|
|
7009
|
+
{
|
|
7010
|
+
"name": "moveBlock",
|
|
7011
|
+
"repo": "estiva-ui",
|
|
7012
|
+
"kind": "helper",
|
|
7013
|
+
"importPath": "@estiva-app/ui/editor",
|
|
7014
|
+
"sourceFile": "src/EditorBlockHandle.tsx",
|
|
7015
|
+
"purpose": "Moves the block at `from` to `to` (a position between top-level blocks), the caret in it: what a drop in the gutter does, where the editor has no drop of its own.",
|
|
7016
|
+
"purposeFrom": "comment",
|
|
7017
|
+
"props": [],
|
|
7018
|
+
"variants": [],
|
|
7019
|
+
"ownsBehaviours": [],
|
|
7020
|
+
"status": "stable",
|
|
7021
|
+
"migrationStage": null,
|
|
7022
|
+
"docsId": "writing-editorblockhandle--docs",
|
|
7023
|
+
"storyId": "writing-editorblockhandle--default",
|
|
7024
|
+
"docPage": null,
|
|
7025
|
+
"app": null,
|
|
7026
|
+
"looks": []
|
|
7027
|
+
},
|
|
7028
|
+
{
|
|
7029
|
+
"name": "MoveDialog",
|
|
7030
|
+
"repo": "estiva-ui",
|
|
7031
|
+
"kind": "component",
|
|
7032
|
+
"importPath": "@estiva-app/ui",
|
|
7033
|
+
"sourceFile": "src/MoveDialog.tsx",
|
|
7034
|
+
"purpose": "Move a file to another Folder, under another file there, or both: the Folder first, then what it goes under, read when the Folder is picked.",
|
|
7035
|
+
"purposeFrom": "page",
|
|
7036
|
+
"props": [
|
|
7037
|
+
{
|
|
7038
|
+
"name": "title",
|
|
7039
|
+
"takes": "text",
|
|
7040
|
+
"required": true,
|
|
7041
|
+
"note": "The file's name, said above the choice."
|
|
7042
|
+
},
|
|
7043
|
+
{
|
|
7044
|
+
"name": "description",
|
|
7045
|
+
"takes": "text",
|
|
7046
|
+
"required": true,
|
|
7047
|
+
"note": "The sentence under the name, in the app's words: \"Everyone who can read it now still can.\""
|
|
7048
|
+
},
|
|
7049
|
+
{
|
|
7050
|
+
"name": "from",
|
|
7051
|
+
"takes": "text",
|
|
7052
|
+
"required": true,
|
|
7053
|
+
"note": "The Folder it is in now."
|
|
7054
|
+
},
|
|
7055
|
+
{
|
|
7056
|
+
"name": "folders",
|
|
7057
|
+
"takes": "readonly MoveFolder[] | undefined",
|
|
7058
|
+
"required": true,
|
|
7059
|
+
"note": "The Folders it may go to. Undefined while they are still read: the list says \"Reading…\"."
|
|
7060
|
+
},
|
|
7061
|
+
{
|
|
7062
|
+
"name": "places",
|
|
7063
|
+
"takes": "readonly MovePlace[]",
|
|
7064
|
+
"required": false,
|
|
7065
|
+
"note": "Where it may go in `from`, already read."
|
|
7066
|
+
},
|
|
7067
|
+
{
|
|
7068
|
+
"name": "placesIn",
|
|
7069
|
+
"takes": "a handler",
|
|
7070
|
+
"required": false,
|
|
7071
|
+
"note": "Where it may go in another Folder, read when that Folder is picked; a rejection is said beside a Try again."
|
|
7072
|
+
},
|
|
7073
|
+
{
|
|
7074
|
+
"name": "startAtTop",
|
|
7075
|
+
"takes": "true/false",
|
|
7076
|
+
"required": false,
|
|
7077
|
+
"note": "Choose the top for the person when a Folder offers it: where a file that may sit at any Folder's top lands."
|
|
7078
|
+
},
|
|
7079
|
+
{
|
|
7080
|
+
"name": "topLabel",
|
|
7081
|
+
"takes": "text",
|
|
7082
|
+
"required": false,
|
|
7083
|
+
"note": "What the place with an empty `id` says. \"The top of\" the Folder when absent; \"None — under none of these\" for a file whose parent is one kind."
|
|
7084
|
+
},
|
|
7085
|
+
{
|
|
7086
|
+
"name": "startIn",
|
|
7087
|
+
"takes": "text",
|
|
7088
|
+
"required": false,
|
|
7089
|
+
"note": "The Folder it opens on, when that is not the one it is in."
|
|
7090
|
+
},
|
|
7091
|
+
{
|
|
7092
|
+
"name": "heading",
|
|
6462
7093
|
"takes": "text",
|
|
6463
|
-
"required":
|
|
6464
|
-
"note": "The
|
|
7094
|
+
"required": false,
|
|
7095
|
+
"note": "The dialog's heading. \"Move\" when absent."
|
|
6465
7096
|
},
|
|
6466
7097
|
{
|
|
6467
|
-
"name": "
|
|
6468
|
-
"takes": "
|
|
7098
|
+
"name": "folderLabel",
|
|
7099
|
+
"takes": "text",
|
|
6469
7100
|
"required": false,
|
|
6470
|
-
"note":
|
|
7101
|
+
"note": "The Folder field's label. \"Folder\" when absent."
|
|
6471
7102
|
},
|
|
6472
7103
|
{
|
|
6473
|
-
"name": "
|
|
6474
|
-
"takes": "
|
|
7104
|
+
"name": "noFolder",
|
|
7105
|
+
"takes": "text",
|
|
6475
7106
|
"required": false,
|
|
6476
|
-
"note": "
|
|
7107
|
+
"note": "Said when no Folder is offered. \"There is no other folder it can be moved to.\" when absent."
|
|
6477
7108
|
},
|
|
6478
7109
|
{
|
|
6479
|
-
"name": "
|
|
6480
|
-
"takes": "
|
|
7110
|
+
"name": "onMove",
|
|
7111
|
+
"takes": "a handler",
|
|
6481
7112
|
"required": true,
|
|
6482
|
-
"note": "
|
|
7113
|
+
"note": "Answer `false` to keep the dialog open (you have said why); anything else closes it."
|
|
6483
7114
|
},
|
|
6484
7115
|
{
|
|
6485
|
-
"name": "
|
|
6486
|
-
"takes": "
|
|
6487
|
-
"required":
|
|
6488
|
-
"note":
|
|
7116
|
+
"name": "onClose",
|
|
7117
|
+
"takes": "a handler",
|
|
7118
|
+
"required": true,
|
|
7119
|
+
"note": null
|
|
6489
7120
|
}
|
|
6490
7121
|
],
|
|
6491
7122
|
"variants": [],
|
|
6492
7123
|
"ownsBehaviours": [
|
|
6493
7124
|
{
|
|
6494
|
-
"id": "
|
|
6495
|
-
"behaviour": "
|
|
7125
|
+
"id": "portal",
|
|
7126
|
+
"behaviour": "Floats on top of the page"
|
|
6496
7127
|
},
|
|
6497
7128
|
{
|
|
6498
|
-
"id": "
|
|
6499
|
-
"behaviour": "
|
|
6500
|
-
}
|
|
6501
|
-
],
|
|
6502
|
-
"status": "stable",
|
|
6503
|
-
"migrationStage": null,
|
|
6504
|
-
"docsId": "menus-windows-menu--docs",
|
|
6505
|
-
"storyId": "menus-windows-menu--items",
|
|
6506
|
-
"docPage": null,
|
|
6507
|
-
"app": null,
|
|
6508
|
-
"looks": []
|
|
6509
|
-
},
|
|
6510
|
-
{
|
|
6511
|
-
"name": "MetaText",
|
|
6512
|
-
"repo": "estiva-ui",
|
|
6513
|
-
"kind": "component",
|
|
6514
|
-
"importPath": "@estiva-app/ui",
|
|
6515
|
-
"sourceFile": "src/MetaText.tsx",
|
|
6516
|
-
"purpose": "The small figure beside a name: a time, a resolve line's time, a count.",
|
|
6517
|
-
"purposeFrom": "page",
|
|
6518
|
-
"props": [
|
|
6519
|
-
{
|
|
6520
|
-
"name": "children",
|
|
6521
|
-
"takes": "anything",
|
|
6522
|
-
"required": true,
|
|
6523
|
-
"note": null
|
|
7129
|
+
"id": "press-outside",
|
|
7130
|
+
"behaviour": "Closes on a press outside"
|
|
6524
7131
|
},
|
|
6525
7132
|
{
|
|
6526
|
-
"
|
|
6527
|
-
"
|
|
6528
|
-
"required": false,
|
|
6529
|
-
"note": "`muted` for a time; `secondary` and `success` for counts of open and resolved."
|
|
7133
|
+
"id": "page-keys",
|
|
7134
|
+
"behaviour": "Takes its keys by itself"
|
|
6530
7135
|
},
|
|
6531
7136
|
{
|
|
6532
|
-
"
|
|
6533
|
-
"
|
|
6534
|
-
"required": false,
|
|
6535
|
-
"note": "`chip` beside a small name, as in a thread's resolve line."
|
|
7137
|
+
"id": "focus",
|
|
7138
|
+
"behaviour": "Holds focus inside while open, and gives it back"
|
|
6536
7139
|
},
|
|
6537
7140
|
{
|
|
6538
|
-
"
|
|
6539
|
-
"
|
|
6540
|
-
"required": false,
|
|
6541
|
-
"note": "Placement only: `shrink-0`, `contents`."
|
|
6542
|
-
}
|
|
6543
|
-
],
|
|
6544
|
-
"variants": [
|
|
6545
|
-
{
|
|
6546
|
-
"prop": "size",
|
|
6547
|
-
"values": [
|
|
6548
|
-
"caption",
|
|
6549
|
-
"chip"
|
|
6550
|
-
]
|
|
7141
|
+
"id": "scroll-lock",
|
|
7142
|
+
"behaviour": "Stops the page behind it scrolling"
|
|
6551
7143
|
}
|
|
6552
7144
|
],
|
|
6553
|
-
"ownsBehaviours": [],
|
|
6554
7145
|
"status": "stable",
|
|
6555
7146
|
"migrationStage": null,
|
|
6556
|
-
"docsId": "
|
|
6557
|
-
"storyId": "
|
|
6558
|
-
"docPage": "src/
|
|
7147
|
+
"docsId": "menus-windows-movedialog--docs",
|
|
7148
|
+
"storyId": "menus-windows-movedialog--topic",
|
|
7149
|
+
"docPage": "src/MoveDialog.mdx",
|
|
6559
7150
|
"app": null,
|
|
6560
|
-
"looks": [
|
|
6561
|
-
"text-chip font-normal text-text-muted whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
6562
|
-
"text-chip font-normal text-text-secondary whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
6563
|
-
"text-chip font-normal text-success-default whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
6564
|
-
"text-caption text-text-muted whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
6565
|
-
"text-caption text-text-secondary whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums",
|
|
6566
|
-
"text-caption text-success-default whitespace-nowrap signal:font-mono signal:text-small signal:tracking-wide signal:tabular-nums"
|
|
6567
|
-
]
|
|
7151
|
+
"looks": []
|
|
6568
7152
|
},
|
|
6569
7153
|
{
|
|
6570
|
-
"name": "
|
|
7154
|
+
"name": "NAV_TREE_PENDING_MS",
|
|
6571
7155
|
"repo": "estiva-ui",
|
|
6572
7156
|
"kind": "helper",
|
|
6573
|
-
"importPath": "@estiva-app/ui
|
|
6574
|
-
"sourceFile": "src/
|
|
6575
|
-
"purpose": "
|
|
7157
|
+
"importPath": "@estiva-app/ui",
|
|
7158
|
+
"sourceFile": "src/NavTree.tsx",
|
|
7159
|
+
"purpose": "How long a `pending` group waits shut for its rows before it opens on the skeleton (Peek's Folders, OPT-11: a cold read is ~0.9s).",
|
|
6576
7160
|
"purposeFrom": "comment",
|
|
6577
7161
|
"props": [],
|
|
6578
7162
|
"variants": [],
|
|
6579
7163
|
"ownsBehaviours": [],
|
|
6580
7164
|
"status": "stable",
|
|
6581
7165
|
"migrationStage": null,
|
|
6582
|
-
"docsId": "
|
|
6583
|
-
"storyId": "
|
|
7166
|
+
"docsId": "app-frame-navtree--docs",
|
|
7167
|
+
"storyId": "app-frame-navtree--default",
|
|
6584
7168
|
"docPage": null,
|
|
6585
7169
|
"app": null,
|
|
6586
7170
|
"looks": []
|
|
@@ -6702,6 +7286,12 @@
|
|
|
6702
7286
|
"required": false,
|
|
6703
7287
|
"note": "With `children`: the current item, when it sits under this row."
|
|
6704
7288
|
},
|
|
7289
|
+
{
|
|
7290
|
+
"name": "onPlainClick",
|
|
7291
|
+
"takes": "a handler",
|
|
7292
|
+
"required": false,
|
|
7293
|
+
"note": "A plain click on the row — the main button, no Ctrl, Cmd, Shift or Alt, to this app's own address: the app opens it its own way, with what it knows, in place of following the link (the row prevents it, and `navigate` is not called)."
|
|
7294
|
+
},
|
|
6705
7295
|
{
|
|
6706
7296
|
"name": "className",
|
|
6707
7297
|
"takes": "text",
|
|
@@ -6776,6 +7366,12 @@
|
|
|
6776
7366
|
"required": false,
|
|
6777
7367
|
"note": "The row the current one sits under, while the tree does not draw the current one: its rows are not read yet, or it is not a row here."
|
|
6778
7368
|
},
|
|
7369
|
+
{
|
|
7370
|
+
"name": "selectedGroup",
|
|
7371
|
+
"takes": "text",
|
|
7372
|
+
"required": false,
|
|
7373
|
+
"note": "The group a link led to — a folder's own link: each time it names a new group, the group opens, as `selected` opens a row's — closed by hand too, once — and is remembered open as a click would be, open already or not, so it stays open when the reader goes on to a row in another group; and the column scrolls to it at once."
|
|
7374
|
+
},
|
|
6779
7375
|
{
|
|
6780
7376
|
"name": "onSelect",
|
|
6781
7377
|
"takes": "a handler",
|
|
@@ -6824,7 +7420,7 @@
|
|
|
6824
7420
|
"name": "id",
|
|
6825
7421
|
"takes": "text",
|
|
6826
7422
|
"required": false,
|
|
6827
|
-
"note": "Marks the group's box as `data-nav-group
|
|
7423
|
+
"note": "Marks the group's box as `data-nav-group`: the tree finds it by it for `selectedGroup` (opens it, remembers it open, scrolls to it), and tests and photo runs do."
|
|
6828
7424
|
},
|
|
6829
7425
|
{
|
|
6830
7426
|
"name": "message",
|
|
@@ -7470,6 +8066,12 @@
|
|
|
7470
8066
|
"required": true,
|
|
7471
8067
|
"note": "When it was written, in the app's words, with its day: no day line stands above it here."
|
|
7472
8068
|
},
|
|
8069
|
+
{
|
|
8070
|
+
"name": "at",
|
|
8071
|
+
"takes": "number",
|
|
8072
|
+
"required": false,
|
|
8073
|
+
"note": "When it was written, as a moment (ms since 1970): the time then says the exact date and time under the pointer, as a comment's does."
|
|
8074
|
+
},
|
|
7473
8075
|
{
|
|
7474
8076
|
"name": "words",
|
|
7475
8077
|
"takes": "anything",
|
|
@@ -8155,6 +8757,18 @@
|
|
|
8155
8757
|
"takes": "true/false",
|
|
8156
8758
|
"required": false,
|
|
8157
8759
|
"note": "Some reactions may be missing: the read was cut short."
|
|
8760
|
+
},
|
|
8761
|
+
{
|
|
8762
|
+
"name": "noun",
|
|
8763
|
+
"takes": "text",
|
|
8764
|
+
"required": false,
|
|
8765
|
+
"note": "What the app calls what is said, in the plural: \"messages\" in Peek."
|
|
8766
|
+
},
|
|
8767
|
+
{
|
|
8768
|
+
"name": "keepRoom",
|
|
8769
|
+
"takes": "true/false",
|
|
8770
|
+
"required": false,
|
|
8771
|
+
"note": "Older comments are still being read and the whole read will need the line: its room is kept, unseen, so nothing moves when it lands."
|
|
8158
8772
|
}
|
|
8159
8773
|
],
|
|
8160
8774
|
"variants": [],
|
|
@@ -8597,6 +9211,12 @@
|
|
|
8597
9211
|
"purpose": "One reply in a thread: the same pieces as a comment, without replies of its own or Resolve.",
|
|
8598
9212
|
"purposeFrom": "page",
|
|
8599
9213
|
"props": [
|
|
9214
|
+
{
|
|
9215
|
+
"name": "id",
|
|
9216
|
+
"takes": "text",
|
|
9217
|
+
"required": false,
|
|
9218
|
+
"note": "Its id, on the card as `data-reply-id`: what a link to it shows (`showInConversation`), and what `Thread` watches to say it was seen."
|
|
9219
|
+
},
|
|
8600
9220
|
{
|
|
8601
9221
|
"name": "author",
|
|
8602
9222
|
"takes": "ConversationPerson",
|
|
@@ -8609,6 +9229,12 @@
|
|
|
8609
9229
|
"required": true,
|
|
8610
9230
|
"note": "When it was written, in the app's words (\"11:08 AM\")."
|
|
8611
9231
|
},
|
|
9232
|
+
{
|
|
9233
|
+
"name": "at",
|
|
9234
|
+
"takes": "number",
|
|
9235
|
+
"required": false,
|
|
9236
|
+
"note": "When it was written, as a moment (ms since 1970): the time then says the exact date and time under the pointer."
|
|
9237
|
+
},
|
|
8612
9238
|
{
|
|
8613
9239
|
"name": "timeHref",
|
|
8614
9240
|
"takes": "text",
|
|
@@ -8771,7 +9397,7 @@
|
|
|
8771
9397
|
"name": "onCancel",
|
|
8772
9398
|
"takes": "a handler",
|
|
8773
9399
|
"required": true,
|
|
8774
|
-
"note":
|
|
9400
|
+
"note": "Cancel, Escape, the ✕ — and a resolve that was not refused, which closes it."
|
|
8775
9401
|
},
|
|
8776
9402
|
{
|
|
8777
9403
|
"name": "refused",
|
|
@@ -9465,6 +10091,25 @@
|
|
|
9465
10091
|
"app": null,
|
|
9466
10092
|
"looks": []
|
|
9467
10093
|
},
|
|
10094
|
+
{
|
|
10095
|
+
"name": "sendsInLayout",
|
|
10096
|
+
"repo": "estiva-ui",
|
|
10097
|
+
"kind": "helper",
|
|
10098
|
+
"importPath": "@estiva-app/ui",
|
|
10099
|
+
"sourceFile": "src/conversationScroll.ts",
|
|
10100
|
+
"purpose": "Set by ConversationLayout round its own box, read by CommentBox: the reader's own comment brings them down to it as it is drawn, before the relay has answered (Peek's OPT-6), and a refusal leaves where they actually are to decide.",
|
|
10101
|
+
"purposeFrom": "comment",
|
|
10102
|
+
"props": [],
|
|
10103
|
+
"variants": [],
|
|
10104
|
+
"ownsBehaviours": [],
|
|
10105
|
+
"status": "stable",
|
|
10106
|
+
"migrationStage": null,
|
|
10107
|
+
"docsId": null,
|
|
10108
|
+
"storyId": null,
|
|
10109
|
+
"docPage": null,
|
|
10110
|
+
"app": null,
|
|
10111
|
+
"looks": []
|
|
10112
|
+
},
|
|
9468
10113
|
{
|
|
9469
10114
|
"name": "setCommentAnchors",
|
|
9470
10115
|
"repo": "estiva-ui",
|
|
@@ -9541,6 +10186,44 @@
|
|
|
9541
10186
|
"app": null,
|
|
9542
10187
|
"looks": []
|
|
9543
10188
|
},
|
|
10189
|
+
{
|
|
10190
|
+
"name": "showInConversation",
|
|
10191
|
+
"repo": "estiva-ui",
|
|
10192
|
+
"kind": "helper",
|
|
10193
|
+
"importPath": "@estiva-app/ui",
|
|
10194
|
+
"sourceFile": "src/showInConversation.ts",
|
|
10195
|
+
"purpose": "Scrolls a comment or reply drawn by the kit into the middle of the view and flashes it.",
|
|
10196
|
+
"purposeFrom": "comment",
|
|
10197
|
+
"props": [],
|
|
10198
|
+
"variants": [],
|
|
10199
|
+
"ownsBehaviours": [],
|
|
10200
|
+
"status": "stable",
|
|
10201
|
+
"migrationStage": null,
|
|
10202
|
+
"docsId": null,
|
|
10203
|
+
"storyId": null,
|
|
10204
|
+
"docPage": null,
|
|
10205
|
+
"app": null,
|
|
10206
|
+
"looks": []
|
|
10207
|
+
},
|
|
10208
|
+
{
|
|
10209
|
+
"name": "showInConversationWhenDrawn",
|
|
10210
|
+
"repo": "estiva-ui",
|
|
10211
|
+
"kind": "helper",
|
|
10212
|
+
"importPath": "@estiva-app/ui",
|
|
10213
|
+
"sourceFile": "src/showInConversation.ts",
|
|
10214
|
+
"purpose": "The same, for one that may not be drawn yet: its thread was just asked to open, and the page draws it a moment later.",
|
|
10215
|
+
"purposeFrom": "comment",
|
|
10216
|
+
"props": [],
|
|
10217
|
+
"variants": [],
|
|
10218
|
+
"ownsBehaviours": [],
|
|
10219
|
+
"status": "stable",
|
|
10220
|
+
"migrationStage": null,
|
|
10221
|
+
"docsId": null,
|
|
10222
|
+
"storyId": null,
|
|
10223
|
+
"docPage": null,
|
|
10224
|
+
"app": null,
|
|
10225
|
+
"looks": []
|
|
10226
|
+
},
|
|
9544
10227
|
{
|
|
9545
10228
|
"name": "ShowMore",
|
|
9546
10229
|
"repo": "estiva-ui",
|
|
@@ -10239,7 +10922,7 @@
|
|
|
10239
10922
|
"name": "children",
|
|
10240
10923
|
"takes": "anything",
|
|
10241
10924
|
"required": false,
|
|
10242
|
-
"note": "Its replies, in time order: `ReplyCard`s."
|
|
10925
|
+
"note": "Its replies, in time order: `ReplyCard`s, each keyed by its own id."
|
|
10243
10926
|
},
|
|
10244
10927
|
{
|
|
10245
10928
|
"name": "loading",
|
|
@@ -10299,7 +10982,13 @@
|
|
|
10299
10982
|
"name": "bodyRef",
|
|
10300
10983
|
"takes": "Ref<HTMLDivElement>",
|
|
10301
10984
|
"required": false,
|
|
10302
|
-
"note": "
|
|
10985
|
+
"note": "Beside: the column's scrolling box. Where it scrolls is the thread's: it opens at the newest reply and goes to each new one."
|
|
10986
|
+
},
|
|
10987
|
+
{
|
|
10988
|
+
"name": "seen",
|
|
10989
|
+
"takes": "SeenOnScreen",
|
|
10990
|
+
"required": false,
|
|
10991
|
+
"note": "Beside: what `useSeenOnScreen` made for this thread: it watches its replies (each `ReplyCard`'s `id`), and says in it which were seen."
|
|
10303
10992
|
},
|
|
10304
10993
|
{
|
|
10305
10994
|
"name": "className",
|
|
@@ -11277,6 +11966,82 @@
|
|
|
11277
11966
|
"app": null,
|
|
11278
11967
|
"looks": []
|
|
11279
11968
|
},
|
|
11969
|
+
{
|
|
11970
|
+
"name": "useFormBusy",
|
|
11971
|
+
"repo": "estiva-ui",
|
|
11972
|
+
"kind": "hook",
|
|
11973
|
+
"importPath": "@estiva-app/ui",
|
|
11974
|
+
"sourceFile": "src/formBusy.ts",
|
|
11975
|
+
"purpose": "Whether a `Form` around this is sending: its fields and buttons wait.",
|
|
11976
|
+
"purposeFrom": "comment",
|
|
11977
|
+
"props": [],
|
|
11978
|
+
"variants": [],
|
|
11979
|
+
"ownsBehaviours": [],
|
|
11980
|
+
"status": "stable",
|
|
11981
|
+
"migrationStage": null,
|
|
11982
|
+
"docsId": null,
|
|
11983
|
+
"storyId": null,
|
|
11984
|
+
"docPage": null,
|
|
11985
|
+
"app": null,
|
|
11986
|
+
"looks": []
|
|
11987
|
+
},
|
|
11988
|
+
{
|
|
11989
|
+
"name": "useLeftAt",
|
|
11990
|
+
"repo": "estiva-ui",
|
|
11991
|
+
"kind": "hook",
|
|
11992
|
+
"importPath": "@estiva-app/ui",
|
|
11993
|
+
"sourceFile": "src/conversationScroll.ts",
|
|
11994
|
+
"purpose": "When the reader last left the conversation `key` (a `ConversationLayout`'s `rememberAs`) away from its newest comment, in ms since 1970: what an app draws its \"New\" line from, over the first comment written since.",
|
|
11995
|
+
"purposeFrom": "comment",
|
|
11996
|
+
"props": [],
|
|
11997
|
+
"variants": [],
|
|
11998
|
+
"ownsBehaviours": [],
|
|
11999
|
+
"status": "stable",
|
|
12000
|
+
"migrationStage": null,
|
|
12001
|
+
"docsId": null,
|
|
12002
|
+
"storyId": null,
|
|
12003
|
+
"docPage": null,
|
|
12004
|
+
"app": null,
|
|
12005
|
+
"looks": []
|
|
12006
|
+
},
|
|
12007
|
+
{
|
|
12008
|
+
"name": "useRememberedOpen",
|
|
12009
|
+
"repo": "estiva-ui",
|
|
12010
|
+
"kind": "hook",
|
|
12011
|
+
"importPath": "@estiva-app/ui",
|
|
12012
|
+
"sourceFile": "src/CollapsibleSection.tsx",
|
|
12013
|
+
"purpose": "Open or closed as this browser remembers it under `storageKey`, else `fallback`, for an app that must know before it draws what is inside — a fold whose rows are read only once it is open (Peek's Folders, FOL-21).",
|
|
12014
|
+
"purposeFrom": "comment",
|
|
12015
|
+
"props": [],
|
|
12016
|
+
"variants": [],
|
|
12017
|
+
"ownsBehaviours": [],
|
|
12018
|
+
"status": "stable",
|
|
12019
|
+
"migrationStage": null,
|
|
12020
|
+
"docsId": "page-structure-collapsiblesection--docs",
|
|
12021
|
+
"storyId": "page-structure-collapsiblesection--default",
|
|
12022
|
+
"docPage": null,
|
|
12023
|
+
"app": null,
|
|
12024
|
+
"looks": []
|
|
12025
|
+
},
|
|
12026
|
+
{
|
|
12027
|
+
"name": "useSeenOnScreen",
|
|
12028
|
+
"repo": "estiva-ui",
|
|
12029
|
+
"kind": "hook",
|
|
12030
|
+
"importPath": "@estiva-app/ui",
|
|
12031
|
+
"sourceFile": "src/seenOnScreen.ts",
|
|
12032
|
+
"purpose": "The comments or replies that have been on screen for a moment: what reads them (Katerina, 30 October).",
|
|
12033
|
+
"purposeFrom": "comment",
|
|
12034
|
+
"props": [],
|
|
12035
|
+
"variants": [],
|
|
12036
|
+
"ownsBehaviours": [],
|
|
12037
|
+
"status": "stable",
|
|
12038
|
+
"migrationStage": null,
|
|
12039
|
+
"docsId": null,
|
|
12040
|
+
"storyId": null,
|
|
12041
|
+
"docPage": null,
|
|
12042
|
+
"app": null,
|
|
12043
|
+
"looks": []
|
|
12044
|
+
},
|
|
11280
12045
|
{
|
|
11281
12046
|
"name": "useSidebarFold",
|
|
11282
12047
|
"repo": "estiva-ui",
|