@imfusion/web-ui 0.10.1-dev.2.gb6347f49 → 0.10.1-dev.34.gb01a818e
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/CHANGELOG.md +167 -0
- package/README.md +4 -2
- package/THIRD_PARTY_NOTICES.md +110 -0
- package/dist/code-NTcddiYk.js +139 -0
- package/dist/components/account-card/account-card.d.ts +9 -26
- package/dist/components/app-shell/app-shell.d.ts +21 -11
- package/dist/components/callout/callout.d.ts +1 -1
- package/dist/components/chip/chip.d.ts +1 -1
- package/dist/components/color-scheme-toggle/color-scheme-preference.d.ts +3 -0
- package/dist/components/color-scheme-toggle/color-scheme-toggle.d.ts +17 -0
- package/dist/components/color-scheme-toggle/color-scheme-toggle.meta.d.ts +2 -0
- package/dist/components/color-scheme-toggle/index.d.ts +2 -0
- package/dist/components/dialog/dialog.d.ts +148 -0
- package/dist/components/dialog/dialog.meta.d.ts +2 -0
- package/dist/components/dialog/index.d.ts +2 -0
- package/dist/components/drawer/drawer.d.ts +1 -1
- package/dist/components/scroll-area/index.d.ts +2 -0
- package/dist/components/scroll-area/scroll-area.d.ts +49 -0
- package/dist/components/scroll-area/scroll-area.meta.d.ts +2 -0
- package/dist/components/skeleton/skeleton.d.ts +17 -2
- package/dist/components/toggle/toggle.d.ts +8 -2
- package/dist/components/toggle-group/toggle-group-size.d.ts +3 -0
- package/dist/components/toggle-group/toggle-group.d.ts +7 -3
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2336 -1898
- package/dist/integrations/code-highlight.js +2 -2
- package/dist/integrations/frame-selection.js +1 -1
- package/dist/integrations/image-display-options.js +123 -113
- package/dist/{rolldown-runtime-Dy4uBu1J.js → resolve-state-props-DQf9WiGv.js} +12 -1
- package/dist/scroll-area-z9Lf9uIk.js +89 -0
- package/dist/slider-Bf274cMe.js +106 -0
- package/dist/style.css +1 -1
- package/dist/{tabs-DRyqtS04.js → tabs-CU46aGud.js} +106 -88
- package/docs/user-guide/UsagePatterns.mdx +4 -0
- package/package.json +2 -2
- package/src/docgen/doc.gen.json +1261 -47
- package/src/llms/llms.gen.txt +18 -1
- package/src/llms/skills/imf-web-ui-audit/SKILL.md +15 -10
- package/src/llms/skills/imf-web-ui-conventions/templates/AUDIT_CHECKLIST.md +3 -1
- package/src/llms/skills/imf-web-ui-conventions/topics/authentication.md +2 -3
- package/src/llms/skills/imf-web-ui-conventions/topics/components.md +4 -1
- package/src/llms/skills/imf-web-ui-conventions/topics/data.md +24 -5
- package/src/llms/skills/imf-web-ui-conventions/topics/git.md +5 -2
- package/src/llms/skills/imf-web-ui-conventions/topics/library-setup.md +3 -0
- package/src/llms/skills/imf-web-ui-conventions/topics/project-structure.md +11 -0
- package/src/llms/skills/imf-web-ui-conventions/topics/react.md +6 -4
- package/src/llms/skills/imf-web-ui-conventions/topics/styling.md +3 -1
- package/src/llms/skills/imf-web-ui-conventions/topics/tooling.md +2 -2
- package/src/llms/skills/imf-web-ui-conventions/topics/typescript.md +2 -0
- package/src/llms/skills/imf-web-ui-ux/SKILL.md +2 -1
- package/src/llms/tokens.gen.json +1 -1
- package/dist/code-BYkr5k55.js +0 -134
- package/dist/slider-Cqpreglu.js +0 -116
package/src/docgen/doc.gen.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"account-card": {
|
|
3
3
|
"root": {
|
|
4
4
|
"name": "AccountCard.Root",
|
|
5
|
-
"description": "AccountCard.Root — the signed-in person's
|
|
5
|
+
"description": "AccountCard.Root — the signed-in person's row, holding `AccountCard.Avatar`, `AccountCard.Title`, `AccountCard.Subtitle`,\n`AccountCard.Description`, `AccountCard.Role`, and, at its top right, `AccountCard.Action`. The row itself is not\ninteractive; the action's buttons are.",
|
|
6
6
|
"props": [
|
|
7
7
|
{
|
|
8
8
|
"name": "context",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"subComponents": [
|
|
24
24
|
{
|
|
25
25
|
"name": "AccountCard.Action",
|
|
26
|
-
"description": "AccountCard.Action —
|
|
26
|
+
"description": "AccountCard.Action — the card's top-right slot for ghost `IconButton`s, such as one that logs out. The\nbutton carries its own `aria-label` and its own `context`.",
|
|
27
27
|
"props": [
|
|
28
28
|
{
|
|
29
29
|
"name": "ref",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"name": "size",
|
|
50
50
|
"required": false,
|
|
51
51
|
"type": "\"sm\" | \"md\" | \"lg\" | null",
|
|
52
|
-
"defaultValue": "
|
|
52
|
+
"defaultValue": "sm",
|
|
53
53
|
"description": "The avatar size."
|
|
54
54
|
},
|
|
55
55
|
{
|
|
@@ -63,33 +63,7 @@
|
|
|
63
63
|
},
|
|
64
64
|
{
|
|
65
65
|
"name": "AccountCard.Description",
|
|
66
|
-
"description": "AccountCard.Description — the organization,
|
|
67
|
-
"props": [
|
|
68
|
-
{
|
|
69
|
-
"name": "ref",
|
|
70
|
-
"required": false,
|
|
71
|
-
"type": "Ref<HTMLDivElement>",
|
|
72
|
-
"defaultValue": null,
|
|
73
|
-
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
74
|
-
}
|
|
75
|
-
]
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
"name": "AccountCard.Group",
|
|
79
|
-
"description": "AccountCard.Group — a list of cards, such as accounts to switch between. Inside it a link with `aria-current=\"page\"`\nshows as current; a standalone card is always the signed-in account and shows no current state.",
|
|
80
|
-
"props": [
|
|
81
|
-
{
|
|
82
|
-
"name": "ref",
|
|
83
|
-
"required": false,
|
|
84
|
-
"type": "Ref<HTMLDivElement>",
|
|
85
|
-
"defaultValue": null,
|
|
86
|
-
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
87
|
-
}
|
|
88
|
-
]
|
|
89
|
-
},
|
|
90
|
-
{
|
|
91
|
-
"name": "AccountCard.Link",
|
|
92
|
-
"description": "AccountCard.Link — the link to the account, holding `AccountCard.Avatar`, `AccountCard.Title`,\n`AccountCard.Subtitle`, `AccountCard.Description`, and `AccountCard.Role`. Pass a router link through `render`. Its\naccessible name is its text; the avatar stays decorative.",
|
|
66
|
+
"description": "AccountCard.Description — the organization, set apart below the subtitle.",
|
|
93
67
|
"props": [
|
|
94
68
|
{
|
|
95
69
|
"name": "ref",
|
|
@@ -97,19 +71,12 @@
|
|
|
97
71
|
"type": "Ref<HTMLDivElement>",
|
|
98
72
|
"defaultValue": null,
|
|
99
73
|
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
"name": "render",
|
|
103
|
-
"required": false,
|
|
104
|
-
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, {}>",
|
|
105
|
-
"defaultValue": null,
|
|
106
|
-
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
107
74
|
}
|
|
108
75
|
]
|
|
109
76
|
},
|
|
110
77
|
{
|
|
111
78
|
"name": "AccountCard.Role",
|
|
112
|
-
"description": "AccountCard.Role — a mono uppercase label
|
|
79
|
+
"description": "AccountCard.Role — a mono uppercase label under the description, such as the person's role.",
|
|
113
80
|
"props": [
|
|
114
81
|
{
|
|
115
82
|
"name": "ref",
|
|
@@ -135,7 +102,7 @@
|
|
|
135
102
|
},
|
|
136
103
|
{
|
|
137
104
|
"name": "AccountCard.Title",
|
|
138
|
-
"description": "AccountCard.Title — the account's name, or the email's local part until a name exists.
|
|
105
|
+
"description": "AccountCard.Title — the account's name, or the email's local part until a name exists. Text wraps before an `@` and\nafter a dot.",
|
|
139
106
|
"props": [
|
|
140
107
|
{
|
|
141
108
|
"name": "ref",
|
|
@@ -167,6 +134,13 @@
|
|
|
167
134
|
"name": "AppShell.Aside",
|
|
168
135
|
"description": "Below `lg` the aside opens as a drawer: from the bottom on phones, from the inline end on tablets.",
|
|
169
136
|
"props": [
|
|
137
|
+
{
|
|
138
|
+
"name": "closeLabel",
|
|
139
|
+
"required": false,
|
|
140
|
+
"type": "string",
|
|
141
|
+
"defaultValue": "Close panel",
|
|
142
|
+
"description": "Accessible name of the close button shown while the aside is a drawer."
|
|
143
|
+
},
|
|
170
144
|
{
|
|
171
145
|
"name": "onOpenChange",
|
|
172
146
|
"required": false,
|
|
@@ -213,7 +187,7 @@
|
|
|
213
187
|
},
|
|
214
188
|
{
|
|
215
189
|
"name": "AppShell.Burger",
|
|
216
|
-
"description": "AppShell.Burger — the
|
|
190
|
+
"description": "AppShell.Burger — the menu toggle: three sheared bands that cross while the navbar drawer is open. With no props it\nopens and closes that drawer. Takes its color from the surface and hides from `md` up, where the navbar is docked, and\nsteps back while the drawer is open, so the drawer's own close is the only one shown.",
|
|
217
191
|
"props": [
|
|
218
192
|
{
|
|
219
193
|
"name": "className",
|
|
@@ -247,8 +221,8 @@
|
|
|
247
221
|
"name": "opened",
|
|
248
222
|
"required": false,
|
|
249
223
|
"type": "boolean",
|
|
250
|
-
"defaultValue":
|
|
251
|
-
"description": "
|
|
224
|
+
"defaultValue": null,
|
|
225
|
+
"description": "Draws the cross and sets `aria-expanded`. Defaults to whether the navbar drawer is open."
|
|
252
226
|
},
|
|
253
227
|
{
|
|
254
228
|
"name": "ref",
|
|
@@ -314,8 +288,22 @@
|
|
|
314
288
|
},
|
|
315
289
|
{
|
|
316
290
|
"name": "AppShell.Navbar",
|
|
317
|
-
"description": "`variant=\"branded\"` paints the primary
|
|
291
|
+
"description": "The navbar owns its frame: `logo` on top, the children (nav items) in the middle, `account` at the foot. Without a\nHeader the logo's bottom edge sits on the baseline of Main's first heading. `variant=\"branded\"` paints the primary\ncolor; children opt into on-color themselves. Below `md` the navbar opens as a drawer from the inline start, with its\nclose on the logo row.",
|
|
318
292
|
"props": [
|
|
293
|
+
{
|
|
294
|
+
"name": "account",
|
|
295
|
+
"required": false,
|
|
296
|
+
"type": "ReactNode",
|
|
297
|
+
"defaultValue": null,
|
|
298
|
+
"description": "The signed-in account at the foot of the rail, usually an `AccountCard`. Without it the foot is omitted."
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
"name": "logo",
|
|
302
|
+
"required": false,
|
|
303
|
+
"type": "ReactNode",
|
|
304
|
+
"defaultValue": "<ImFusionLogo variant={variant === \"branded\" ? \"oncolor\" : \"brand\"} size=\"sm\" />",
|
|
305
|
+
"description": "The brand at the top of the rail. Defaults to the ImFusion logo; `null` leaves the row empty."
|
|
306
|
+
},
|
|
319
307
|
{
|
|
320
308
|
"name": "onOpenChange",
|
|
321
309
|
"required": false,
|
|
@@ -348,7 +336,7 @@
|
|
|
348
336
|
},
|
|
349
337
|
{
|
|
350
338
|
"name": "AppShell.NavItem",
|
|
351
|
-
"description": "AppShell.NavItem — a navbar link: icon, mono label, and an optional description. Takes its color from the navbar;\n`aria-current=\"page\"`
|
|
339
|
+
"description": "AppShell.NavItem — a navbar link: icon, mono label, and an optional description. Takes its color from the navbar;\n`aria-current=\"page\"` underlines the label. Pass a router link through `render`.",
|
|
352
340
|
"props": [
|
|
353
341
|
{
|
|
354
342
|
"name": "description",
|
|
@@ -707,7 +695,7 @@
|
|
|
707
695
|
},
|
|
708
696
|
{
|
|
709
697
|
"name": "Callout.Title",
|
|
710
|
-
"description": "Callout.Title — an optional short heading, set in the
|
|
698
|
+
"description": "Callout.Title — an optional short heading, set in the mono UPPERCASE technical voice.",
|
|
711
699
|
"props": [
|
|
712
700
|
{
|
|
713
701
|
"name": "ref",
|
|
@@ -1389,6 +1377,99 @@
|
|
|
1389
1377
|
}
|
|
1390
1378
|
]
|
|
1391
1379
|
},
|
|
1380
|
+
"color-scheme-toggle": {
|
|
1381
|
+
"root": {
|
|
1382
|
+
"name": "ColorSchemeToggle",
|
|
1383
|
+
"description": "ColorSchemeToggle - lets the user pick Light, System, or Dark. It reads and stores the preference through\n`useColorScheme`, so placing it is enough. System stays pressed while the page follows the operating system.",
|
|
1384
|
+
"props": [
|
|
1385
|
+
{
|
|
1386
|
+
"name": "className",
|
|
1387
|
+
"required": false,
|
|
1388
|
+
"type": "string | ((state: ToggleGroupState) => string)",
|
|
1389
|
+
"defaultValue": null,
|
|
1390
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
"name": "darkLabel",
|
|
1394
|
+
"required": false,
|
|
1395
|
+
"type": "string",
|
|
1396
|
+
"defaultValue": "Dark",
|
|
1397
|
+
"description": "Text of the segment that picks the dark scheme."
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
"name": "disabled",
|
|
1401
|
+
"required": false,
|
|
1402
|
+
"type": "boolean",
|
|
1403
|
+
"defaultValue": "false",
|
|
1404
|
+
"description": "Whether the toggle group should ignore user interaction."
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
"name": "label",
|
|
1408
|
+
"required": false,
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"defaultValue": "Color scheme",
|
|
1411
|
+
"description": "Accessible name of the group."
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
"name": "lightLabel",
|
|
1415
|
+
"required": false,
|
|
1416
|
+
"type": "string",
|
|
1417
|
+
"defaultValue": "Light",
|
|
1418
|
+
"description": "Text of the segment that picks the light scheme."
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"name": "loopFocus",
|
|
1422
|
+
"required": false,
|
|
1423
|
+
"type": "boolean",
|
|
1424
|
+
"defaultValue": "true",
|
|
1425
|
+
"description": "Whether to loop keyboard focus back to the first item\nwhen the end of the list is reached while using the arrow keys."
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "orientation",
|
|
1429
|
+
"required": false,
|
|
1430
|
+
"type": "Orientation",
|
|
1431
|
+
"defaultValue": "horizontal",
|
|
1432
|
+
"description": ""
|
|
1433
|
+
},
|
|
1434
|
+
{
|
|
1435
|
+
"name": "ref",
|
|
1436
|
+
"required": false,
|
|
1437
|
+
"type": "Ref<HTMLDivElement>",
|
|
1438
|
+
"defaultValue": null,
|
|
1439
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
1442
|
+
"name": "render",
|
|
1443
|
+
"required": false,
|
|
1444
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ToggleGroupState>",
|
|
1445
|
+
"defaultValue": null,
|
|
1446
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"name": "size",
|
|
1450
|
+
"required": false,
|
|
1451
|
+
"type": "\"sm\" | \"md\" | null",
|
|
1452
|
+
"defaultValue": null,
|
|
1453
|
+
"description": ""
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "style",
|
|
1457
|
+
"required": false,
|
|
1458
|
+
"type": "| CSSProperties\n| ((state: ToggleGroupState) => CSSProperties)",
|
|
1459
|
+
"defaultValue": null,
|
|
1460
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
"name": "systemLabel",
|
|
1464
|
+
"required": false,
|
|
1465
|
+
"type": "string",
|
|
1466
|
+
"defaultValue": "System",
|
|
1467
|
+
"description": "Text of the segment that follows the operating system."
|
|
1468
|
+
}
|
|
1469
|
+
]
|
|
1470
|
+
},
|
|
1471
|
+
"subComponents": []
|
|
1472
|
+
},
|
|
1392
1473
|
"copy-button": {
|
|
1393
1474
|
"root": {
|
|
1394
1475
|
"name": "CopyButton",
|
|
@@ -1517,6 +1598,828 @@
|
|
|
1517
1598
|
},
|
|
1518
1599
|
"subComponents": []
|
|
1519
1600
|
},
|
|
1601
|
+
"dialog": {
|
|
1602
|
+
"root": {
|
|
1603
|
+
"name": "Dialog.Root",
|
|
1604
|
+
"description": "Dialog.Root — container that manages open/closed state.",
|
|
1605
|
+
"props": [
|
|
1606
|
+
{
|
|
1607
|
+
"name": "actionsRef",
|
|
1608
|
+
"required": false,
|
|
1609
|
+
"type": "RefObject<DialogRootActions | null>",
|
|
1610
|
+
"defaultValue": null,
|
|
1611
|
+
"description": "A ref to imperative actions.\n- `unmount`: Manually unmounts the dialog.\nCall this after any externally controlled closing animation finishes.\n- `close`: Closes the dialog imperatively when called."
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "children",
|
|
1615
|
+
"required": false,
|
|
1616
|
+
"type": "ReactNode | PayloadChildRenderFunction<Payload>",
|
|
1617
|
+
"defaultValue": null,
|
|
1618
|
+
"description": "The content of the dialog.\nThis can be a regular React node or a render function that receives the `payload` of the active trigger."
|
|
1619
|
+
},
|
|
1620
|
+
{
|
|
1621
|
+
"name": "defaultOpen",
|
|
1622
|
+
"required": false,
|
|
1623
|
+
"type": "boolean",
|
|
1624
|
+
"defaultValue": "false",
|
|
1625
|
+
"description": "Whether the dialog is initially open.\n\nTo render a controlled dialog, use the `open` prop instead."
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
"name": "defaultTriggerId",
|
|
1629
|
+
"required": false,
|
|
1630
|
+
"type": "string | null",
|
|
1631
|
+
"defaultValue": null,
|
|
1632
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `defaultOpen` prop to create an initially open dialog."
|
|
1633
|
+
},
|
|
1634
|
+
{
|
|
1635
|
+
"name": "disablePointerDismissal",
|
|
1636
|
+
"required": false,
|
|
1637
|
+
"type": "boolean",
|
|
1638
|
+
"defaultValue": "false",
|
|
1639
|
+
"description": "Whether to prevent the dialog from closing on outside presses.\nFor non-modal dialogs, this also prevents the dialog from closing when focus moves outside of it."
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"name": "handle",
|
|
1643
|
+
"required": false,
|
|
1644
|
+
"type": "DialogHandle<Payload>",
|
|
1645
|
+
"defaultValue": null,
|
|
1646
|
+
"description": "A handle to associate the dialog with a trigger.\nIf specified, allows external triggers to control the dialog's open state.\nCan be created with the Dialog.createHandle() method."
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"name": "modal",
|
|
1650
|
+
"required": false,
|
|
1651
|
+
"type": "boolean | \"trap-focus\"",
|
|
1652
|
+
"defaultValue": "true",
|
|
1653
|
+
"description": "Determines if the dialog enters a modal state when open.\n- `true`: user interaction is limited to just the dialog: focus is trapped, document page scroll is locked, and pointer interactions on outside elements are disabled.\n- `false`: user interaction with the rest of the document is allowed.\n- `'trap-focus'`: focus is trapped inside the dialog, but document page scroll is not locked and pointer interactions outside of it remain enabled.\n\nWhen `modal` is `true` or `'trap-focus'`, render `<Dialog.Close>` inside `<Dialog.Popup>` so\ntouch screen readers can escape the popup."
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"name": "onOpenChange",
|
|
1657
|
+
"required": false,
|
|
1658
|
+
"type": "(\n open: boolean,\n eventDetails: DialogRootChangeEventDetails\n) => void",
|
|
1659
|
+
"defaultValue": null,
|
|
1660
|
+
"description": "Event handler called when the dialog is opened or closed."
|
|
1661
|
+
},
|
|
1662
|
+
{
|
|
1663
|
+
"name": "onOpenChangeComplete",
|
|
1664
|
+
"required": false,
|
|
1665
|
+
"type": "(open: boolean) => void",
|
|
1666
|
+
"defaultValue": null,
|
|
1667
|
+
"description": "Event handler called after any animations complete when the dialog is opened or closed."
|
|
1668
|
+
},
|
|
1669
|
+
{
|
|
1670
|
+
"name": "open",
|
|
1671
|
+
"required": false,
|
|
1672
|
+
"type": "boolean",
|
|
1673
|
+
"defaultValue": null,
|
|
1674
|
+
"description": "Whether the dialog is currently open."
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"name": "triggerId",
|
|
1678
|
+
"required": false,
|
|
1679
|
+
"type": "string | null",
|
|
1680
|
+
"defaultValue": null,
|
|
1681
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `open` prop to create a controlled dialog.\nThere's no need to specify this prop when the dialog is uncontrolled (that is, when the `open` prop is not set)."
|
|
1682
|
+
}
|
|
1683
|
+
]
|
|
1684
|
+
},
|
|
1685
|
+
"subComponents": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "Dialog.Backdrop",
|
|
1688
|
+
"description": "Dialog.Backdrop — flat dark overlay that dims the page behind the dialog.",
|
|
1689
|
+
"props": [
|
|
1690
|
+
{
|
|
1691
|
+
"name": "className",
|
|
1692
|
+
"required": false,
|
|
1693
|
+
"type": "string | ((state: DialogBackdropState) => string)",
|
|
1694
|
+
"defaultValue": null,
|
|
1695
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"name": "forceRender",
|
|
1699
|
+
"required": false,
|
|
1700
|
+
"type": "boolean",
|
|
1701
|
+
"defaultValue": "false",
|
|
1702
|
+
"description": "Whether the backdrop is forced to render even when nested."
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "ref",
|
|
1706
|
+
"required": false,
|
|
1707
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1708
|
+
"defaultValue": null,
|
|
1709
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"name": "render",
|
|
1713
|
+
"required": false,
|
|
1714
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogBackdropState>",
|
|
1715
|
+
"defaultValue": null,
|
|
1716
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"name": "style",
|
|
1720
|
+
"required": false,
|
|
1721
|
+
"type": "| CSSProperties\n| ((state: DialogBackdropState) => CSSProperties)",
|
|
1722
|
+
"defaultValue": null,
|
|
1723
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
1724
|
+
}
|
|
1725
|
+
]
|
|
1726
|
+
},
|
|
1727
|
+
{
|
|
1728
|
+
"name": "Dialog.Body",
|
|
1729
|
+
"description": "Dialog.Body — the scrolling region between header and footer, a ScrollArea with the library's thumb and edge fades.",
|
|
1730
|
+
"props": [
|
|
1731
|
+
{
|
|
1732
|
+
"name": "className",
|
|
1733
|
+
"required": false,
|
|
1734
|
+
"type": "string | ((state: ScrollAreaRootState) => string)",
|
|
1735
|
+
"defaultValue": null,
|
|
1736
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"name": "orientation",
|
|
1740
|
+
"required": false,
|
|
1741
|
+
"type": "\"none\" | \"both\" | \"horizontal\" | \"vertical\"",
|
|
1742
|
+
"defaultValue": "vertical",
|
|
1743
|
+
"description": "Which scrollbars to render. `both` also adds the Corner; `none` scrolls and fades without a visible bar."
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "overflowEdgeThreshold",
|
|
1747
|
+
"required": false,
|
|
1748
|
+
"type": "| number\n| Partial<{\n xStart: number;\n xEnd: number;\n yStart: number;\n yEnd: number;\n }>",
|
|
1749
|
+
"defaultValue": "0",
|
|
1750
|
+
"description": "The threshold in pixels that must be passed before the overflow edge attributes are applied.\nAccepts a single number for all edges or an object to configure them individually."
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"name": "ref",
|
|
1754
|
+
"required": false,
|
|
1755
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1756
|
+
"defaultValue": null,
|
|
1757
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"name": "render",
|
|
1761
|
+
"required": false,
|
|
1762
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaRootState>",
|
|
1763
|
+
"defaultValue": null,
|
|
1764
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "style",
|
|
1768
|
+
"required": false,
|
|
1769
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaRootState) => CSSProperties)",
|
|
1770
|
+
"defaultValue": null,
|
|
1771
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
1772
|
+
}
|
|
1773
|
+
]
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "Dialog.Close",
|
|
1777
|
+
"description": "Dialog.Close — button that closes the dialog. With no `children` and no `render` it renders the library's ghost close\nbutton (an × icon labelled \"Close\"); otherwise render your own `Button`.",
|
|
1778
|
+
"props": [
|
|
1779
|
+
{
|
|
1780
|
+
"name": "className",
|
|
1781
|
+
"required": false,
|
|
1782
|
+
"type": "string | ((state: DialogCloseState) => string)",
|
|
1783
|
+
"defaultValue": null,
|
|
1784
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"name": "nativeButton",
|
|
1788
|
+
"required": false,
|
|
1789
|
+
"type": "boolean",
|
|
1790
|
+
"defaultValue": "true",
|
|
1791
|
+
"description": "Whether the component renders a native `<button>` element when replacing it\nvia the `render` prop.\nSet to `false` if the rendered element is not a button (for example, `<div>`)."
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"name": "ref",
|
|
1795
|
+
"required": false,
|
|
1796
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1797
|
+
"defaultValue": null,
|
|
1798
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
"name": "render",
|
|
1802
|
+
"required": false,
|
|
1803
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogCloseState>",
|
|
1804
|
+
"defaultValue": null,
|
|
1805
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
1806
|
+
},
|
|
1807
|
+
{
|
|
1808
|
+
"name": "style",
|
|
1809
|
+
"required": false,
|
|
1810
|
+
"type": "| CSSProperties\n| ((state: DialogCloseState) => CSSProperties)",
|
|
1811
|
+
"defaultValue": null,
|
|
1812
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
1813
|
+
}
|
|
1814
|
+
]
|
|
1815
|
+
},
|
|
1816
|
+
{
|
|
1817
|
+
"name": "Dialog.Description",
|
|
1818
|
+
"description": "Dialog.Description — supplementary paragraph that describes the dialog for screen readers, set as `Typo.P`.",
|
|
1819
|
+
"props": [
|
|
1820
|
+
{
|
|
1821
|
+
"name": "className",
|
|
1822
|
+
"required": false,
|
|
1823
|
+
"type": "| string\n| ((state: DialogDescriptionState) => string)",
|
|
1824
|
+
"defaultValue": null,
|
|
1825
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"name": "ref",
|
|
1829
|
+
"required": false,
|
|
1830
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1831
|
+
"defaultValue": null,
|
|
1832
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1833
|
+
},
|
|
1834
|
+
{
|
|
1835
|
+
"name": "render",
|
|
1836
|
+
"required": false,
|
|
1837
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogDescriptionState>",
|
|
1838
|
+
"defaultValue": null,
|
|
1839
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "style",
|
|
1843
|
+
"required": false,
|
|
1844
|
+
"type": "| CSSProperties\n| ((state: DialogDescriptionState) => CSSProperties)",
|
|
1845
|
+
"defaultValue": null,
|
|
1846
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
1847
|
+
}
|
|
1848
|
+
]
|
|
1849
|
+
},
|
|
1850
|
+
{
|
|
1851
|
+
"name": "Dialog.Footer",
|
|
1852
|
+
"description": "Dialog.Footer — row of actions pinned to the bottom of the popup.",
|
|
1853
|
+
"props": [
|
|
1854
|
+
{
|
|
1855
|
+
"name": "ref",
|
|
1856
|
+
"required": false,
|
|
1857
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1858
|
+
"defaultValue": null,
|
|
1859
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1860
|
+
}
|
|
1861
|
+
]
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"name": "Dialog.Header",
|
|
1865
|
+
"description": "Dialog.Header — band at the top of the popup that holds the title, description, and close button.",
|
|
1866
|
+
"props": [
|
|
1867
|
+
{
|
|
1868
|
+
"name": "ref",
|
|
1869
|
+
"required": false,
|
|
1870
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
1871
|
+
"defaultValue": null,
|
|
1872
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
1873
|
+
},
|
|
1874
|
+
{
|
|
1875
|
+
"name": "variant",
|
|
1876
|
+
"required": false,
|
|
1877
|
+
"type": "HeaderVariant",
|
|
1878
|
+
"defaultValue": "main",
|
|
1879
|
+
"description": "Colour of the header band. On `primary` the title, description, and close button turn light."
|
|
1880
|
+
}
|
|
1881
|
+
]
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"name": "Dialog.Inline",
|
|
1885
|
+
"description": "Dialog.Inline — like Dialog.Simple, but the trigger is text inside a sentence.",
|
|
1886
|
+
"props": [
|
|
1887
|
+
{
|
|
1888
|
+
"name": "actions",
|
|
1889
|
+
"required": false,
|
|
1890
|
+
"type": "ReactNode",
|
|
1891
|
+
"defaultValue": null,
|
|
1892
|
+
"description": "Content of the footer, usually buttons. The footer renders only when this is set."
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"name": "actionsRef",
|
|
1896
|
+
"required": false,
|
|
1897
|
+
"type": "RefObject<DialogRootActions | null>",
|
|
1898
|
+
"defaultValue": null,
|
|
1899
|
+
"description": "A ref to imperative actions.\n- `unmount`: Manually unmounts the dialog.\nCall this after any externally controlled closing animation finishes.\n- `close`: Closes the dialog imperatively when called."
|
|
1900
|
+
},
|
|
1901
|
+
{
|
|
1902
|
+
"name": "children",
|
|
1903
|
+
"required": false,
|
|
1904
|
+
"type": "ReactNode",
|
|
1905
|
+
"defaultValue": null,
|
|
1906
|
+
"description": "Content of the body."
|
|
1907
|
+
},
|
|
1908
|
+
{
|
|
1909
|
+
"name": "defaultOpen",
|
|
1910
|
+
"required": false,
|
|
1911
|
+
"type": "boolean",
|
|
1912
|
+
"defaultValue": "false",
|
|
1913
|
+
"description": "Whether the dialog is initially open.\n\nTo render a controlled dialog, use the `open` prop instead."
|
|
1914
|
+
},
|
|
1915
|
+
{
|
|
1916
|
+
"name": "defaultTriggerId",
|
|
1917
|
+
"required": false,
|
|
1918
|
+
"type": "string | null",
|
|
1919
|
+
"defaultValue": null,
|
|
1920
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `defaultOpen` prop to create an initially open dialog."
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"name": "description",
|
|
1924
|
+
"required": false,
|
|
1925
|
+
"type": "ReactNode",
|
|
1926
|
+
"defaultValue": null,
|
|
1927
|
+
"description": "Line of context under the title."
|
|
1928
|
+
},
|
|
1929
|
+
{
|
|
1930
|
+
"name": "disablePointerDismissal",
|
|
1931
|
+
"required": false,
|
|
1932
|
+
"type": "boolean",
|
|
1933
|
+
"defaultValue": "false",
|
|
1934
|
+
"description": "Whether to prevent the dialog from closing on outside presses.\nFor non-modal dialogs, this also prevents the dialog from closing when focus moves outside of it."
|
|
1935
|
+
},
|
|
1936
|
+
{
|
|
1937
|
+
"name": "eyebrow",
|
|
1938
|
+
"required": false,
|
|
1939
|
+
"type": "ReactNode",
|
|
1940
|
+
"defaultValue": null,
|
|
1941
|
+
"description": "Short uppercase label above the title."
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "handle",
|
|
1945
|
+
"required": false,
|
|
1946
|
+
"type": "DialogHandle<Payload>",
|
|
1947
|
+
"defaultValue": null,
|
|
1948
|
+
"description": "A handle to associate the dialog with a trigger.\nIf specified, allows external triggers to control the dialog's open state.\nCan be created with the Dialog.createHandle() method."
|
|
1949
|
+
},
|
|
1950
|
+
{
|
|
1951
|
+
"name": "headerVariant",
|
|
1952
|
+
"required": false,
|
|
1953
|
+
"type": "HeaderVariant",
|
|
1954
|
+
"defaultValue": "main",
|
|
1955
|
+
"description": "Colour of the header band."
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "modal",
|
|
1959
|
+
"required": false,
|
|
1960
|
+
"type": "boolean | \"trap-focus\"",
|
|
1961
|
+
"defaultValue": "true",
|
|
1962
|
+
"description": "Determines if the dialog enters a modal state when open.\n- `true`: user interaction is limited to just the dialog: focus is trapped, document page scroll is locked, and pointer interactions on outside elements are disabled.\n- `false`: user interaction with the rest of the document is allowed.\n- `'trap-focus'`: focus is trapped inside the dialog, but document page scroll is not locked and pointer interactions outside of it remain enabled.\n\nWhen `modal` is `true` or `'trap-focus'`, render `<Dialog.Close>` inside `<Dialog.Popup>` so\ntouch screen readers can escape the popup."
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "onOpenChange",
|
|
1966
|
+
"required": false,
|
|
1967
|
+
"type": "(\n open: boolean,\n eventDetails: DialogRootChangeEventDetails\n) => void",
|
|
1968
|
+
"defaultValue": null,
|
|
1969
|
+
"description": "Event handler called when the dialog is opened or closed."
|
|
1970
|
+
},
|
|
1971
|
+
{
|
|
1972
|
+
"name": "onOpenChangeComplete",
|
|
1973
|
+
"required": false,
|
|
1974
|
+
"type": "(open: boolean) => void",
|
|
1975
|
+
"defaultValue": null,
|
|
1976
|
+
"description": "Event handler called after any animations complete when the dialog is opened or closed."
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
"name": "open",
|
|
1980
|
+
"required": false,
|
|
1981
|
+
"type": "boolean",
|
|
1982
|
+
"defaultValue": null,
|
|
1983
|
+
"description": "Whether the dialog is currently open."
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
"name": "size",
|
|
1987
|
+
"required": false,
|
|
1988
|
+
"type": "\"sm\" | \"md\" | \"lg\" | \"full\"",
|
|
1989
|
+
"defaultValue": "md",
|
|
1990
|
+
"description": "Width of the window."
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "status",
|
|
1994
|
+
"required": false,
|
|
1995
|
+
"type": "| NonNullable<\n \"info\" | \"positive\" | \"warning\" | \"negative\" | null\n >\n| undefined",
|
|
1996
|
+
"defaultValue": null,
|
|
1997
|
+
"description": "Adds a `Dialog.Status` with this variant at the start of the popup."
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"name": "title",
|
|
2001
|
+
"required": true,
|
|
2002
|
+
"type": "ReactNode",
|
|
2003
|
+
"defaultValue": null,
|
|
2004
|
+
"description": "Heading of the dialog."
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "trigger",
|
|
2008
|
+
"required": true,
|
|
2009
|
+
"type": "ReactNode",
|
|
2010
|
+
"defaultValue": null,
|
|
2011
|
+
"description": "Text of the trigger, set as an inline term inside running prose."
|
|
2012
|
+
},
|
|
2013
|
+
{
|
|
2014
|
+
"name": "triggerId",
|
|
2015
|
+
"required": false,
|
|
2016
|
+
"type": "string | null",
|
|
2017
|
+
"defaultValue": null,
|
|
2018
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `open` prop to create a controlled dialog.\nThere's no need to specify this prop when the dialog is uncontrolled (that is, when the `open` prop is not set)."
|
|
2019
|
+
}
|
|
2020
|
+
]
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
"name": "Dialog.Popup",
|
|
2024
|
+
"description": "Dialog.Popup — the window. Holds Header, Body, and Footer, or any free content.",
|
|
2025
|
+
"props": [
|
|
2026
|
+
{
|
|
2027
|
+
"name": "className",
|
|
2028
|
+
"required": false,
|
|
2029
|
+
"type": "string | ((state: DialogPopupState) => string)",
|
|
2030
|
+
"defaultValue": null,
|
|
2031
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"name": "finalFocus",
|
|
2035
|
+
"required": false,
|
|
2036
|
+
"type": "| boolean\n| RefObject<HTMLElement | null>\n| ((\n closeType: InteractionType\n ) => boolean | void | HTMLElement | null)",
|
|
2037
|
+
"defaultValue": null,
|
|
2038
|
+
"description": "Determines the element to focus when the dialog is closed.\n\n- `false`: Do not move focus.\n- `true`: Move focus based on the default behavior (trigger or previously focused element).\n- `RefObject`: Move focus to the ref element.\n- `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`).\n Return an element to focus, `true` to use the default behavior, `null` to fall back to the default behavior, or `false`/`undefined` to do nothing."
|
|
2039
|
+
},
|
|
2040
|
+
{
|
|
2041
|
+
"name": "initialFocus",
|
|
2042
|
+
"required": false,
|
|
2043
|
+
"type": "| boolean\n| RefObject<HTMLElement | null>\n| ((\n openType: InteractionType\n ) => boolean | void | HTMLElement | null)",
|
|
2044
|
+
"defaultValue": null,
|
|
2045
|
+
"description": "Determines the element to focus when the dialog is opened.\nBy default, focus moves to the first tabbable element inside the popup, except when the dialog\nis opened by touch — then the popup itself is focused to avoid opening the virtual keyboard.\n\n- `false`: Do not move focus.\n- `true`: Move focus based on the default behavior (first tabbable element or popup).\n- `RefObject`: Move focus to the ref element.\n- `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`).\n Return an element to focus, `true` to use the default behavior, `null` to fall back to the default behavior, or `false`/`undefined` to do nothing."
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "ref",
|
|
2049
|
+
"required": false,
|
|
2050
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2051
|
+
"defaultValue": null,
|
|
2052
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "render",
|
|
2056
|
+
"required": false,
|
|
2057
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogPopupState>",
|
|
2058
|
+
"defaultValue": null,
|
|
2059
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
2060
|
+
},
|
|
2061
|
+
{
|
|
2062
|
+
"name": "size",
|
|
2063
|
+
"required": false,
|
|
2064
|
+
"type": "\"sm\" | \"md\" | \"lg\" | \"full\"",
|
|
2065
|
+
"defaultValue": "md",
|
|
2066
|
+
"description": "Width of the window. `full` fills the screen minus a margin."
|
|
2067
|
+
},
|
|
2068
|
+
{
|
|
2069
|
+
"name": "style",
|
|
2070
|
+
"required": false,
|
|
2071
|
+
"type": "| CSSProperties\n| ((state: DialogPopupState) => CSSProperties)",
|
|
2072
|
+
"defaultValue": null,
|
|
2073
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
2074
|
+
}
|
|
2075
|
+
]
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "Dialog.Portal",
|
|
2079
|
+
"description": "Dialog.Portal — renders backdrop and popup in a portal outside the main document flow.",
|
|
2080
|
+
"props": [
|
|
2081
|
+
{
|
|
2082
|
+
"name": "className",
|
|
2083
|
+
"required": false,
|
|
2084
|
+
"type": "string | ((state: DialogPortalState) => string)",
|
|
2085
|
+
"defaultValue": null,
|
|
2086
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
2087
|
+
},
|
|
2088
|
+
{
|
|
2089
|
+
"name": "container",
|
|
2090
|
+
"required": false,
|
|
2091
|
+
"type": "| HTMLElement\n| ShadowRoot\n| RefObject<HTMLElement | ShadowRoot | null>\n| null",
|
|
2092
|
+
"defaultValue": null,
|
|
2093
|
+
"description": "A parent element to render the portal element into."
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "keepMounted",
|
|
2097
|
+
"required": false,
|
|
2098
|
+
"type": "boolean",
|
|
2099
|
+
"defaultValue": "false",
|
|
2100
|
+
"description": "Whether to keep the portal mounted in the DOM while the popup is hidden."
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "ref",
|
|
2104
|
+
"required": false,
|
|
2105
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2106
|
+
"defaultValue": null,
|
|
2107
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2108
|
+
},
|
|
2109
|
+
{
|
|
2110
|
+
"name": "render",
|
|
2111
|
+
"required": false,
|
|
2112
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogPortalState>",
|
|
2113
|
+
"defaultValue": null,
|
|
2114
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
2115
|
+
},
|
|
2116
|
+
{
|
|
2117
|
+
"name": "style",
|
|
2118
|
+
"required": false,
|
|
2119
|
+
"type": "| CSSProperties\n| ((state: DialogPortalState) => CSSProperties)",
|
|
2120
|
+
"defaultValue": null,
|
|
2121
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
2122
|
+
}
|
|
2123
|
+
]
|
|
2124
|
+
},
|
|
2125
|
+
{
|
|
2126
|
+
"name": "Dialog.Simple",
|
|
2127
|
+
"description": "Dialog.Simple — pre-composed dialog: trigger, header with title, description, optional status and close button, a\nscrolling body, and an optional footer. Root props pass through.",
|
|
2128
|
+
"props": [
|
|
2129
|
+
{
|
|
2130
|
+
"name": "actions",
|
|
2131
|
+
"required": false,
|
|
2132
|
+
"type": "ReactNode",
|
|
2133
|
+
"defaultValue": null,
|
|
2134
|
+
"description": "Content of the footer, usually buttons. The footer renders only when this is set."
|
|
2135
|
+
},
|
|
2136
|
+
{
|
|
2137
|
+
"name": "actionsRef",
|
|
2138
|
+
"required": false,
|
|
2139
|
+
"type": "RefObject<DialogRootActions | null>",
|
|
2140
|
+
"defaultValue": null,
|
|
2141
|
+
"description": "A ref to imperative actions.\n- `unmount`: Manually unmounts the dialog.\nCall this after any externally controlled closing animation finishes.\n- `close`: Closes the dialog imperatively when called."
|
|
2142
|
+
},
|
|
2143
|
+
{
|
|
2144
|
+
"name": "children",
|
|
2145
|
+
"required": false,
|
|
2146
|
+
"type": "ReactNode",
|
|
2147
|
+
"defaultValue": null,
|
|
2148
|
+
"description": "Content of the body."
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "defaultOpen",
|
|
2152
|
+
"required": false,
|
|
2153
|
+
"type": "boolean",
|
|
2154
|
+
"defaultValue": "false",
|
|
2155
|
+
"description": "Whether the dialog is initially open.\n\nTo render a controlled dialog, use the `open` prop instead."
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
"name": "defaultTriggerId",
|
|
2159
|
+
"required": false,
|
|
2160
|
+
"type": "string | null",
|
|
2161
|
+
"defaultValue": null,
|
|
2162
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `defaultOpen` prop to create an initially open dialog."
|
|
2163
|
+
},
|
|
2164
|
+
{
|
|
2165
|
+
"name": "description",
|
|
2166
|
+
"required": false,
|
|
2167
|
+
"type": "ReactNode",
|
|
2168
|
+
"defaultValue": null,
|
|
2169
|
+
"description": "Line of context under the title."
|
|
2170
|
+
},
|
|
2171
|
+
{
|
|
2172
|
+
"name": "disablePointerDismissal",
|
|
2173
|
+
"required": false,
|
|
2174
|
+
"type": "boolean",
|
|
2175
|
+
"defaultValue": "false",
|
|
2176
|
+
"description": "Whether to prevent the dialog from closing on outside presses.\nFor non-modal dialogs, this also prevents the dialog from closing when focus moves outside of it."
|
|
2177
|
+
},
|
|
2178
|
+
{
|
|
2179
|
+
"name": "eyebrow",
|
|
2180
|
+
"required": false,
|
|
2181
|
+
"type": "ReactNode",
|
|
2182
|
+
"defaultValue": null,
|
|
2183
|
+
"description": "Short uppercase label above the title."
|
|
2184
|
+
},
|
|
2185
|
+
{
|
|
2186
|
+
"name": "handle",
|
|
2187
|
+
"required": false,
|
|
2188
|
+
"type": "DialogHandle<Payload>",
|
|
2189
|
+
"defaultValue": null,
|
|
2190
|
+
"description": "A handle to associate the dialog with a trigger.\nIf specified, allows external triggers to control the dialog's open state.\nCan be created with the Dialog.createHandle() method."
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "headerVariant",
|
|
2194
|
+
"required": false,
|
|
2195
|
+
"type": "HeaderVariant",
|
|
2196
|
+
"defaultValue": "main",
|
|
2197
|
+
"description": "Colour of the header band."
|
|
2198
|
+
},
|
|
2199
|
+
{
|
|
2200
|
+
"name": "modal",
|
|
2201
|
+
"required": false,
|
|
2202
|
+
"type": "boolean | \"trap-focus\"",
|
|
2203
|
+
"defaultValue": "true",
|
|
2204
|
+
"description": "Determines if the dialog enters a modal state when open.\n- `true`: user interaction is limited to just the dialog: focus is trapped, document page scroll is locked, and pointer interactions on outside elements are disabled.\n- `false`: user interaction with the rest of the document is allowed.\n- `'trap-focus'`: focus is trapped inside the dialog, but document page scroll is not locked and pointer interactions outside of it remain enabled.\n\nWhen `modal` is `true` or `'trap-focus'`, render `<Dialog.Close>` inside `<Dialog.Popup>` so\ntouch screen readers can escape the popup."
|
|
2205
|
+
},
|
|
2206
|
+
{
|
|
2207
|
+
"name": "onOpenChange",
|
|
2208
|
+
"required": false,
|
|
2209
|
+
"type": "(\n open: boolean,\n eventDetails: DialogRootChangeEventDetails\n) => void",
|
|
2210
|
+
"defaultValue": null,
|
|
2211
|
+
"description": "Event handler called when the dialog is opened or closed."
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"name": "onOpenChangeComplete",
|
|
2215
|
+
"required": false,
|
|
2216
|
+
"type": "(open: boolean) => void",
|
|
2217
|
+
"defaultValue": null,
|
|
2218
|
+
"description": "Event handler called after any animations complete when the dialog is opened or closed."
|
|
2219
|
+
},
|
|
2220
|
+
{
|
|
2221
|
+
"name": "open",
|
|
2222
|
+
"required": false,
|
|
2223
|
+
"type": "boolean",
|
|
2224
|
+
"defaultValue": null,
|
|
2225
|
+
"description": "Whether the dialog is currently open."
|
|
2226
|
+
},
|
|
2227
|
+
{
|
|
2228
|
+
"name": "size",
|
|
2229
|
+
"required": false,
|
|
2230
|
+
"type": "\"sm\" | \"md\" | \"lg\" | \"full\"",
|
|
2231
|
+
"defaultValue": "md",
|
|
2232
|
+
"description": "Width of the window."
|
|
2233
|
+
},
|
|
2234
|
+
{
|
|
2235
|
+
"name": "status",
|
|
2236
|
+
"required": false,
|
|
2237
|
+
"type": "| NonNullable<\n \"info\" | \"positive\" | \"warning\" | \"negative\" | null\n >\n| undefined",
|
|
2238
|
+
"defaultValue": null,
|
|
2239
|
+
"description": "Adds a `Dialog.Status` with this variant at the start of the popup."
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "title",
|
|
2243
|
+
"required": true,
|
|
2244
|
+
"type": "ReactNode",
|
|
2245
|
+
"defaultValue": null,
|
|
2246
|
+
"description": "Heading of the dialog."
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
"name": "trigger",
|
|
2250
|
+
"required": false,
|
|
2251
|
+
"type": "ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n>",
|
|
2252
|
+
"defaultValue": null,
|
|
2253
|
+
"description": "Element rendered as the trigger, such as a `Button`. Omit it for a controlled dialog."
|
|
2254
|
+
},
|
|
2255
|
+
{
|
|
2256
|
+
"name": "triggerId",
|
|
2257
|
+
"required": false,
|
|
2258
|
+
"type": "string | null",
|
|
2259
|
+
"defaultValue": null,
|
|
2260
|
+
"description": "ID of the trigger that the dialog is associated with.\nThis is useful in conjunction with the `open` prop to create a controlled dialog.\nThere's no need to specify this prop when the dialog is uncontrolled (that is, when the `open` prop is not set)."
|
|
2261
|
+
}
|
|
2262
|
+
]
|
|
2263
|
+
},
|
|
2264
|
+
{
|
|
2265
|
+
"name": "Dialog.Status",
|
|
2266
|
+
"description": "Dialog.Status — a tinted column at the start of the popup, spanning its full height, that marks the dialog's\nstatus with the variant's glyph. Place it first inside `Dialog.Popup`. Pass children to replace the glyph.\nDecorative (`aria-hidden`); the title carries the status.",
|
|
2267
|
+
"props": [
|
|
2268
|
+
{
|
|
2269
|
+
"name": "ref",
|
|
2270
|
+
"required": false,
|
|
2271
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2272
|
+
"defaultValue": null,
|
|
2273
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2274
|
+
},
|
|
2275
|
+
{
|
|
2276
|
+
"name": "variant",
|
|
2277
|
+
"required": false,
|
|
2278
|
+
"type": "| \"info\"\n| \"positive\"\n| \"warning\"\n| \"negative\"\n| null",
|
|
2279
|
+
"defaultValue": "info",
|
|
2280
|
+
"description": ""
|
|
2281
|
+
}
|
|
2282
|
+
]
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"name": "Dialog.Title",
|
|
2286
|
+
"description": "Dialog.Title — heading that names the dialog for screen readers, set as `Typo.H2`. Light on a `primary` header.",
|
|
2287
|
+
"props": [
|
|
2288
|
+
{
|
|
2289
|
+
"name": "className",
|
|
2290
|
+
"required": false,
|
|
2291
|
+
"type": "string | ((state: DialogTitleState) => string)",
|
|
2292
|
+
"defaultValue": null,
|
|
2293
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
2294
|
+
},
|
|
2295
|
+
{
|
|
2296
|
+
"name": "ref",
|
|
2297
|
+
"required": false,
|
|
2298
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2299
|
+
"defaultValue": null,
|
|
2300
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2301
|
+
},
|
|
2302
|
+
{
|
|
2303
|
+
"name": "render",
|
|
2304
|
+
"required": false,
|
|
2305
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogTitleState>",
|
|
2306
|
+
"defaultValue": null,
|
|
2307
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
2308
|
+
},
|
|
2309
|
+
{
|
|
2310
|
+
"name": "style",
|
|
2311
|
+
"required": false,
|
|
2312
|
+
"type": "| CSSProperties\n| ((state: DialogTitleState) => CSSProperties)",
|
|
2313
|
+
"defaultValue": null,
|
|
2314
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
2315
|
+
}
|
|
2316
|
+
]
|
|
2317
|
+
},
|
|
2318
|
+
{
|
|
2319
|
+
"name": "Dialog.Trigger",
|
|
2320
|
+
"description": "Dialog.Trigger — button that opens the dialog. `inline` styles it as a dashed-underlined term inside running text.",
|
|
2321
|
+
"props": [
|
|
2322
|
+
{
|
|
2323
|
+
"name": "className",
|
|
2324
|
+
"required": false,
|
|
2325
|
+
"type": "string | ((state: DialogTriggerState) => string)",
|
|
2326
|
+
"defaultValue": null,
|
|
2327
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
2328
|
+
},
|
|
2329
|
+
{
|
|
2330
|
+
"name": "handle",
|
|
2331
|
+
"required": false,
|
|
2332
|
+
"type": "DialogHandle<unknown>",
|
|
2333
|
+
"defaultValue": null,
|
|
2334
|
+
"description": "A handle to associate the trigger with a dialog.\nCan be created with the Dialog.createHandle() method."
|
|
2335
|
+
},
|
|
2336
|
+
{
|
|
2337
|
+
"name": "id",
|
|
2338
|
+
"required": false,
|
|
2339
|
+
"type": "string",
|
|
2340
|
+
"defaultValue": null,
|
|
2341
|
+
"description": "ID of the trigger. In addition to being forwarded to the rendered element,\nit is also used to specify the active trigger for the dialog in controlled mode (with the DialogRoot `triggerId` prop)."
|
|
2342
|
+
},
|
|
2343
|
+
{
|
|
2344
|
+
"name": "inline",
|
|
2345
|
+
"required": false,
|
|
2346
|
+
"type": "boolean | null",
|
|
2347
|
+
"defaultValue": "false",
|
|
2348
|
+
"description": ""
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"name": "nativeButton",
|
|
2352
|
+
"required": false,
|
|
2353
|
+
"type": "boolean",
|
|
2354
|
+
"defaultValue": "true",
|
|
2355
|
+
"description": "Whether the component renders a native `<button>` element when replacing it\nvia the `render` prop.\nSet to `false` if the rendered element is not a button (for example, `<div>`)."
|
|
2356
|
+
},
|
|
2357
|
+
{
|
|
2358
|
+
"name": "payload",
|
|
2359
|
+
"required": false,
|
|
2360
|
+
"type": "unknown",
|
|
2361
|
+
"defaultValue": null,
|
|
2362
|
+
"description": "A payload to pass to the dialog when it is opened."
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"name": "ref",
|
|
2366
|
+
"required": false,
|
|
2367
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2368
|
+
"defaultValue": null,
|
|
2369
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
"name": "render",
|
|
2373
|
+
"required": false,
|
|
2374
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogTriggerState>",
|
|
2375
|
+
"defaultValue": null,
|
|
2376
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"name": "style",
|
|
2380
|
+
"required": false,
|
|
2381
|
+
"type": "| CSSProperties\n| ((state: DialogTriggerState) => CSSProperties)",
|
|
2382
|
+
"defaultValue": null,
|
|
2383
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
2384
|
+
}
|
|
2385
|
+
]
|
|
2386
|
+
},
|
|
2387
|
+
{
|
|
2388
|
+
"name": "Dialog.Viewport",
|
|
2389
|
+
"description": "Dialog.Viewport — full-screen container that centres the popup.",
|
|
2390
|
+
"props": [
|
|
2391
|
+
{
|
|
2392
|
+
"name": "className",
|
|
2393
|
+
"required": false,
|
|
2394
|
+
"type": "string | ((state: DialogViewportState) => string)",
|
|
2395
|
+
"defaultValue": null,
|
|
2396
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "ref",
|
|
2400
|
+
"required": false,
|
|
2401
|
+
"type": "((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly)) | RefObject<...> | null",
|
|
2402
|
+
"defaultValue": null,
|
|
2403
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
"name": "render",
|
|
2407
|
+
"required": false,
|
|
2408
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, DialogViewportState>",
|
|
2409
|
+
"defaultValue": null,
|
|
2410
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
2411
|
+
},
|
|
2412
|
+
{
|
|
2413
|
+
"name": "style",
|
|
2414
|
+
"required": false,
|
|
2415
|
+
"type": "| CSSProperties\n| ((state: DialogViewportState) => CSSProperties)",
|
|
2416
|
+
"defaultValue": null,
|
|
2417
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
2418
|
+
}
|
|
2419
|
+
]
|
|
2420
|
+
}
|
|
2421
|
+
]
|
|
2422
|
+
},
|
|
1520
2423
|
"drawer": {
|
|
1521
2424
|
"root": {
|
|
1522
2425
|
"name": "Drawer.Root",
|
|
@@ -5356,6 +6259,283 @@
|
|
|
5356
6259
|
},
|
|
5357
6260
|
"subComponents": []
|
|
5358
6261
|
},
|
|
6262
|
+
"scroll-area": {
|
|
6263
|
+
"root": {
|
|
6264
|
+
"name": "ScrollArea.Root",
|
|
6265
|
+
"description": "ScrollArea.Root — groups the viewport and its scrollbars. Give it a height or max-height.",
|
|
6266
|
+
"props": [
|
|
6267
|
+
{
|
|
6268
|
+
"name": "className",
|
|
6269
|
+
"required": false,
|
|
6270
|
+
"type": "string | ((state: ScrollAreaRootState) => string)",
|
|
6271
|
+
"defaultValue": null,
|
|
6272
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6273
|
+
},
|
|
6274
|
+
{
|
|
6275
|
+
"name": "overflowEdgeThreshold",
|
|
6276
|
+
"required": false,
|
|
6277
|
+
"type": "| number\n| Partial<{\n xStart: number;\n xEnd: number;\n yStart: number;\n yEnd: number;\n }>",
|
|
6278
|
+
"defaultValue": "0",
|
|
6279
|
+
"description": "The threshold in pixels that must be passed before the overflow edge attributes are applied.\nAccepts a single number for all edges or an object to configure them individually."
|
|
6280
|
+
},
|
|
6281
|
+
{
|
|
6282
|
+
"name": "ref",
|
|
6283
|
+
"required": false,
|
|
6284
|
+
"type": "Ref<HTMLDivElement>",
|
|
6285
|
+
"defaultValue": null,
|
|
6286
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6287
|
+
},
|
|
6288
|
+
{
|
|
6289
|
+
"name": "render",
|
|
6290
|
+
"required": false,
|
|
6291
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaRootState>",
|
|
6292
|
+
"defaultValue": null,
|
|
6293
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6294
|
+
},
|
|
6295
|
+
{
|
|
6296
|
+
"name": "style",
|
|
6297
|
+
"required": false,
|
|
6298
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaRootState) => CSSProperties)",
|
|
6299
|
+
"defaultValue": null,
|
|
6300
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6301
|
+
}
|
|
6302
|
+
]
|
|
6303
|
+
},
|
|
6304
|
+
"subComponents": [
|
|
6305
|
+
{
|
|
6306
|
+
"name": "ScrollArea.Auto",
|
|
6307
|
+
"description": "ScrollArea.Auto — Root, Viewport, Content, and the scrollbars for `orientation`, around `children`.",
|
|
6308
|
+
"props": [
|
|
6309
|
+
{
|
|
6310
|
+
"name": "className",
|
|
6311
|
+
"required": false,
|
|
6312
|
+
"type": "string | ((state: ScrollAreaRootState) => string)",
|
|
6313
|
+
"defaultValue": null,
|
|
6314
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6315
|
+
},
|
|
6316
|
+
{
|
|
6317
|
+
"name": "orientation",
|
|
6318
|
+
"required": false,
|
|
6319
|
+
"type": "\"none\" | \"both\" | \"horizontal\" | \"vertical\"",
|
|
6320
|
+
"defaultValue": "vertical",
|
|
6321
|
+
"description": "Which scrollbars to render. `both` also adds the Corner; `none` scrolls and fades without a visible bar."
|
|
6322
|
+
},
|
|
6323
|
+
{
|
|
6324
|
+
"name": "overflowEdgeThreshold",
|
|
6325
|
+
"required": false,
|
|
6326
|
+
"type": "| number\n| Partial<{\n xStart: number;\n xEnd: number;\n yStart: number;\n yEnd: number;\n }>",
|
|
6327
|
+
"defaultValue": "0",
|
|
6328
|
+
"description": "The threshold in pixels that must be passed before the overflow edge attributes are applied.\nAccepts a single number for all edges or an object to configure them individually."
|
|
6329
|
+
},
|
|
6330
|
+
{
|
|
6331
|
+
"name": "ref",
|
|
6332
|
+
"required": false,
|
|
6333
|
+
"type": "Ref<HTMLDivElement>",
|
|
6334
|
+
"defaultValue": null,
|
|
6335
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6336
|
+
},
|
|
6337
|
+
{
|
|
6338
|
+
"name": "render",
|
|
6339
|
+
"required": false,
|
|
6340
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaRootState>",
|
|
6341
|
+
"defaultValue": null,
|
|
6342
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6343
|
+
},
|
|
6344
|
+
{
|
|
6345
|
+
"name": "style",
|
|
6346
|
+
"required": false,
|
|
6347
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaRootState) => CSSProperties)",
|
|
6348
|
+
"defaultValue": null,
|
|
6349
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6350
|
+
}
|
|
6351
|
+
]
|
|
6352
|
+
},
|
|
6353
|
+
{
|
|
6354
|
+
"name": "ScrollArea.Content",
|
|
6355
|
+
"description": "ScrollArea.Content — wraps the scrolled content so the viewport can measure it.",
|
|
6356
|
+
"props": [
|
|
6357
|
+
{
|
|
6358
|
+
"name": "className",
|
|
6359
|
+
"required": false,
|
|
6360
|
+
"type": "| string\n| ((state: ScrollAreaContentState) => string)",
|
|
6361
|
+
"defaultValue": null,
|
|
6362
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6363
|
+
},
|
|
6364
|
+
{
|
|
6365
|
+
"name": "ref",
|
|
6366
|
+
"required": false,
|
|
6367
|
+
"type": "Ref<HTMLDivElement>",
|
|
6368
|
+
"defaultValue": null,
|
|
6369
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6370
|
+
},
|
|
6371
|
+
{
|
|
6372
|
+
"name": "render",
|
|
6373
|
+
"required": false,
|
|
6374
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaContentState>",
|
|
6375
|
+
"defaultValue": null,
|
|
6376
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6377
|
+
},
|
|
6378
|
+
{
|
|
6379
|
+
"name": "style",
|
|
6380
|
+
"required": false,
|
|
6381
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaContentState) => CSSProperties)",
|
|
6382
|
+
"defaultValue": null,
|
|
6383
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6384
|
+
}
|
|
6385
|
+
]
|
|
6386
|
+
},
|
|
6387
|
+
{
|
|
6388
|
+
"name": "ScrollArea.Corner",
|
|
6389
|
+
"description": "ScrollArea.Corner — the square where a vertical and a horizontal scrollbar meet.",
|
|
6390
|
+
"props": [
|
|
6391
|
+
{
|
|
6392
|
+
"name": "className",
|
|
6393
|
+
"required": false,
|
|
6394
|
+
"type": "| string\n| ((state: ScrollAreaCornerState) => string)",
|
|
6395
|
+
"defaultValue": null,
|
|
6396
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6397
|
+
},
|
|
6398
|
+
{
|
|
6399
|
+
"name": "ref",
|
|
6400
|
+
"required": false,
|
|
6401
|
+
"type": "Ref<HTMLDivElement>",
|
|
6402
|
+
"defaultValue": null,
|
|
6403
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6404
|
+
},
|
|
6405
|
+
{
|
|
6406
|
+
"name": "render",
|
|
6407
|
+
"required": false,
|
|
6408
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaCornerState>",
|
|
6409
|
+
"defaultValue": null,
|
|
6410
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6411
|
+
},
|
|
6412
|
+
{
|
|
6413
|
+
"name": "style",
|
|
6414
|
+
"required": false,
|
|
6415
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaCornerState) => CSSProperties)",
|
|
6416
|
+
"defaultValue": null,
|
|
6417
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6418
|
+
}
|
|
6419
|
+
]
|
|
6420
|
+
},
|
|
6421
|
+
{
|
|
6422
|
+
"name": "ScrollArea.Scrollbar",
|
|
6423
|
+
"description": "ScrollArea.Scrollbar — overlay bar that shows while the area is hovered or scrolling.",
|
|
6424
|
+
"props": [
|
|
6425
|
+
{
|
|
6426
|
+
"name": "className",
|
|
6427
|
+
"required": false,
|
|
6428
|
+
"type": "| string\n| ((state: ScrollAreaScrollbarState) => string)",
|
|
6429
|
+
"defaultValue": null,
|
|
6430
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6431
|
+
},
|
|
6432
|
+
{
|
|
6433
|
+
"name": "keepMounted",
|
|
6434
|
+
"required": false,
|
|
6435
|
+
"type": "boolean",
|
|
6436
|
+
"defaultValue": "false",
|
|
6437
|
+
"description": "Whether to keep the HTML element in the DOM when the viewport isn't scrollable."
|
|
6438
|
+
},
|
|
6439
|
+
{
|
|
6440
|
+
"name": "orientation",
|
|
6441
|
+
"required": false,
|
|
6442
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
6443
|
+
"defaultValue": "vertical",
|
|
6444
|
+
"description": "Whether the scrollbar controls vertical or horizontal scroll."
|
|
6445
|
+
},
|
|
6446
|
+
{
|
|
6447
|
+
"name": "ref",
|
|
6448
|
+
"required": false,
|
|
6449
|
+
"type": "Ref<HTMLDivElement>",
|
|
6450
|
+
"defaultValue": null,
|
|
6451
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6452
|
+
},
|
|
6453
|
+
{
|
|
6454
|
+
"name": "render",
|
|
6455
|
+
"required": false,
|
|
6456
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaScrollbarState>",
|
|
6457
|
+
"defaultValue": null,
|
|
6458
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6459
|
+
},
|
|
6460
|
+
{
|
|
6461
|
+
"name": "style",
|
|
6462
|
+
"required": false,
|
|
6463
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaScrollbarState) => CSSProperties)",
|
|
6464
|
+
"defaultValue": null,
|
|
6465
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6466
|
+
}
|
|
6467
|
+
]
|
|
6468
|
+
},
|
|
6469
|
+
{
|
|
6470
|
+
"name": "ScrollArea.Thumb",
|
|
6471
|
+
"description": "ScrollArea.Thumb — the draggable part of the scrollbar.",
|
|
6472
|
+
"props": [
|
|
6473
|
+
{
|
|
6474
|
+
"name": "className",
|
|
6475
|
+
"required": false,
|
|
6476
|
+
"type": "| string\n| ((state: ScrollAreaThumbState) => string)",
|
|
6477
|
+
"defaultValue": null,
|
|
6478
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6479
|
+
},
|
|
6480
|
+
{
|
|
6481
|
+
"name": "ref",
|
|
6482
|
+
"required": false,
|
|
6483
|
+
"type": "Ref<HTMLDivElement>",
|
|
6484
|
+
"defaultValue": null,
|
|
6485
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6486
|
+
},
|
|
6487
|
+
{
|
|
6488
|
+
"name": "render",
|
|
6489
|
+
"required": false,
|
|
6490
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaThumbState>",
|
|
6491
|
+
"defaultValue": null,
|
|
6492
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6493
|
+
},
|
|
6494
|
+
{
|
|
6495
|
+
"name": "style",
|
|
6496
|
+
"required": false,
|
|
6497
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaThumbState) => CSSProperties)",
|
|
6498
|
+
"defaultValue": null,
|
|
6499
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6500
|
+
}
|
|
6501
|
+
]
|
|
6502
|
+
},
|
|
6503
|
+
{
|
|
6504
|
+
"name": "ScrollArea.Viewport",
|
|
6505
|
+
"description": "ScrollArea.Viewport — the scrolling box. It fades its content out at each edge with more to scroll.",
|
|
6506
|
+
"props": [
|
|
6507
|
+
{
|
|
6508
|
+
"name": "className",
|
|
6509
|
+
"required": false,
|
|
6510
|
+
"type": "| string\n| ((state: ScrollAreaViewportState) => string)",
|
|
6511
|
+
"defaultValue": null,
|
|
6512
|
+
"description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
|
|
6513
|
+
},
|
|
6514
|
+
{
|
|
6515
|
+
"name": "ref",
|
|
6516
|
+
"required": false,
|
|
6517
|
+
"type": "Ref<HTMLDivElement>",
|
|
6518
|
+
"defaultValue": null,
|
|
6519
|
+
"description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
|
|
6520
|
+
},
|
|
6521
|
+
{
|
|
6522
|
+
"name": "render",
|
|
6523
|
+
"required": false,
|
|
6524
|
+
"type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, ScrollAreaViewportState>",
|
|
6525
|
+
"defaultValue": null,
|
|
6526
|
+
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
6527
|
+
},
|
|
6528
|
+
{
|
|
6529
|
+
"name": "style",
|
|
6530
|
+
"required": false,
|
|
6531
|
+
"type": "| CSSProperties\n| ((state: ScrollAreaViewportState) => CSSProperties)",
|
|
6532
|
+
"defaultValue": null,
|
|
6533
|
+
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
|
|
6534
|
+
}
|
|
6535
|
+
]
|
|
6536
|
+
}
|
|
6537
|
+
]
|
|
6538
|
+
},
|
|
5359
6539
|
"select": {
|
|
5360
6540
|
"root": {
|
|
5361
6541
|
"name": "Select.Root",
|
|
@@ -6396,7 +7576,7 @@
|
|
|
6396
7576
|
"skeleton": {
|
|
6397
7577
|
"root": {
|
|
6398
7578
|
"name": "Skeleton.Root",
|
|
6399
|
-
"description": "Skeleton.Root — marks a region as loading. The view inside renders for real; bones stand in for the data. While\n`loading`, sets `aria-busy` and announces `label` once, however many bones it holds. When `loading` turns false, the\ndata fades in
|
|
7579
|
+
"description": "Skeleton.Root — marks a region as loading. The view inside renders for real; bones stand in for the data. While\n`loading`, sets `aria-busy` and announces `label` once, however many bones it holds. When `loading` turns false, the\ndata fades in.",
|
|
6400
7580
|
"props": [
|
|
6401
7581
|
{
|
|
6402
7582
|
"name": "animation",
|
|
@@ -6470,6 +7650,26 @@
|
|
|
6470
7650
|
}
|
|
6471
7651
|
]
|
|
6472
7652
|
},
|
|
7653
|
+
{
|
|
7654
|
+
"name": "Skeleton.Suspense",
|
|
7655
|
+
"description": "Skeleton.Suspense — a Suspense boundary whose fallback is bones in a busy Root. When the children mount after the\nfallback showed, they fade in over it. Content that was ready without suspending mounts without a fade.",
|
|
7656
|
+
"props": [
|
|
7657
|
+
{
|
|
7658
|
+
"name": "fallback",
|
|
7659
|
+
"required": true,
|
|
7660
|
+
"type": "ReactNode",
|
|
7661
|
+
"defaultValue": null,
|
|
7662
|
+
"description": "Bones shown while the children suspend."
|
|
7663
|
+
},
|
|
7664
|
+
{
|
|
7665
|
+
"name": "label",
|
|
7666
|
+
"required": true,
|
|
7667
|
+
"type": "string",
|
|
7668
|
+
"defaultValue": null,
|
|
7669
|
+
"description": "Announced once through a visually hidden status while the fallback shows."
|
|
7670
|
+
}
|
|
7671
|
+
]
|
|
7672
|
+
},
|
|
6473
7673
|
{
|
|
6474
7674
|
"name": "Skeleton.Text",
|
|
6475
7675
|
"description": "Skeleton.Text — a text bar exactly one line of the parent's font tall. Place it inside the real Typo element so the\nrow keeps the loaded row's height.",
|
|
@@ -8183,6 +9383,13 @@
|
|
|
8183
9383
|
"defaultValue": null,
|
|
8184
9384
|
"description": "Key hint shown in the top corner at the end of the line, such as `\"P\"` or `\"Ctrl Z\"`. It also sets\n`aria-keyshortcuts` in its notation (`Control+Z`), which an explicit\n`aria-keyshortcuts` prop overrides. Display only: bind the key in the app, for example with `useHotkey` from TanStack Hotkeys."
|
|
8185
9385
|
},
|
|
9386
|
+
{
|
|
9387
|
+
"name": "size",
|
|
9388
|
+
"required": false,
|
|
9389
|
+
"type": "\"sm\" | \"md\" | null",
|
|
9390
|
+
"defaultValue": null,
|
|
9391
|
+
"description": "Defaults to the enclosing `ToggleGroup`'s `size`, or `\"md\"` standalone."
|
|
9392
|
+
},
|
|
8186
9393
|
{
|
|
8187
9394
|
"name": "style",
|
|
8188
9395
|
"required": false,
|
|
@@ -8204,7 +9411,7 @@
|
|
|
8204
9411
|
"toggle-group": {
|
|
8205
9412
|
"root": {
|
|
8206
9413
|
"name": "ToggleGroup",
|
|
8207
|
-
"description": "ToggleGroup - a set of connected `Toggle`s sharing one value. Single-select by\ndefault (a segmented control); set `multiple` for multi-select. Compose one\n`Toggle` per segment, each with a `value`.",
|
|
9414
|
+
"description": "ToggleGroup - a set of connected `Toggle`s sharing one value. Single-select by\ndefault (a segmented control); set `multiple` for multi-select. Compose one\n`Toggle` per segment, each with a `value`. `size` applies to every toggle in the group.",
|
|
8208
9415
|
"props": [
|
|
8209
9416
|
{
|
|
8210
9417
|
"name": "className",
|
|
@@ -8269,6 +9476,13 @@
|
|
|
8269
9476
|
"defaultValue": null,
|
|
8270
9477
|
"description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
|
|
8271
9478
|
},
|
|
9479
|
+
{
|
|
9480
|
+
"name": "size",
|
|
9481
|
+
"required": false,
|
|
9482
|
+
"type": "\"sm\" | \"md\" | null",
|
|
9483
|
+
"defaultValue": "md",
|
|
9484
|
+
"description": ""
|
|
9485
|
+
},
|
|
8272
9486
|
{
|
|
8273
9487
|
"name": "style",
|
|
8274
9488
|
"required": false,
|