@epam/ai-dial-ui-kit 0.15.0-dev.5 → 0.15.0-dev.51
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 +194 -1
- package/dist/CHANGELOG.md +88 -0
- package/dist/{DateCellRenderer-BVM-Q8yx.cjs → DateCellRenderer-CZNa4jVJ.cjs} +31 -31
- package/dist/DateCellRenderer-CmgeZvYm.cjs +1 -0
- package/dist/IconButton-DHOFapLo.cjs +1 -0
- package/dist/JsonEditor-Bxui5wJH.cjs +1 -0
- package/dist/{MarkdownEditor-C9-ZMRVi.cjs → MarkdownEditor-BKtFs714.cjs} +1 -1
- package/dist/MarkdownEditor-Bapd1ycU.cjs +1 -0
- package/dist/MarkdownEditorContainer-B5aHwoYF.cjs +1 -0
- package/dist/{Switch-CUKClcEz.cjs → Switch-DE6MrcqJ.cjs} +1 -1
- package/dist/components/Button/constants.js +9 -8
- package/dist/components/Dropdown/Dropdown.js +70 -65
- package/dist/components/Dropdown/DropdownSubMenuItem.js +63 -55
- package/dist/components/Dropdown/constants.js +16 -14
- package/dist/components/DropdownIcon/DropdownIcon.js +43 -32
- package/dist/components/FileManager/FileManager.js +373 -372
- package/dist/components/FileManager/FileManagerProvider.js +266 -264
- package/dist/components/FileManager/hooks/use-grid-context-menu.js +59 -59
- package/dist/components/MarkdownEditor/MarkdownEditor.js +23 -21
- package/dist/components/MarkdownEditor/MarkdownEditorContainer.js +27 -27
- package/dist/components/New/Accordion/Accordion.js +87 -71
- package/dist/components/New/AutocompleteTagInput/AutocompleteTagInput.js +207 -0
- package/dist/components/New/AutocompleteTagInput/utils.js +11 -0
- package/dist/components/New/Avatar/Avatar.js +70 -0
- package/dist/components/New/Badge/Badge.js +45 -0
- package/dist/components/New/BottomSheet/BottomSheet.js +128 -0
- package/dist/components/New/Breadcrumbs/Breadcrumbs.js +159 -0
- package/dist/components/New/Breadcrumbs/constants.js +41 -0
- package/dist/components/New/Button/Button.js +32 -32
- package/dist/components/New/Button/ButtonWrappers.js +103 -37
- package/dist/components/New/Button/constants.js +3 -0
- package/dist/components/New/Button/utils.js +18 -8
- package/dist/components/New/ButtonDropdown/ButtonDropdown.js +26 -16
- package/dist/components/New/Calendar/Calendar.js +253 -222
- package/dist/components/New/Calendar/constants.js +5 -5
- package/dist/components/New/CaptionText/CaptionText.js +18 -15
- package/dist/components/New/CardShell/CardShell.js +5 -3
- package/dist/components/New/Checkbox/Checkbox.js +67 -56
- package/dist/components/New/Checkbox/CheckboxBox.js +5 -3
- package/dist/components/New/CloseButton/CloseButton.js +18 -16
- package/dist/components/New/CollapsibleSidebar/CollapsibleSidebar.js +39 -34
- package/dist/components/New/ConfirmationPopup/ConfirmationPopup.js +38 -37
- package/dist/components/New/ConfirmationPopup/constants.js +8 -11
- package/dist/components/New/Dropdown/Dropdown.js +112 -105
- package/dist/components/New/Dropdown/DropdownSubMenuItem.js +17 -17
- package/dist/components/New/Dropdown/constants.js +22 -17
- package/dist/components/New/EllipsisTooltip/EllipsisTooltip.js +20 -18
- package/dist/components/New/EntityIdentity/EntityIdentity.js +135 -0
- package/dist/components/New/FileDropzone/FileDropzone.js +27 -25
- package/dist/components/New/FileIcon/FileIcon.js +55 -0
- package/dist/components/New/FileIcon/constants.js +134 -0
- package/dist/components/New/FileIcon/icons/FileGlyph.js +150 -0
- package/dist/components/New/FileIcon/icons/FolderGlyph.js +50 -0
- package/dist/components/New/FileName/FileName.js +78 -0
- package/dist/components/New/FilterChips/FilterChips.js +43 -0
- package/dist/components/New/FilterChips/constants.js +5 -0
- package/dist/components/New/FolderName/FolderName.js +16 -0
- package/dist/components/New/FolderPath/FolderPath.js +29 -28
- package/dist/components/New/Highlight/Highlight.js +23 -30
- package/dist/components/New/IconButton/IconButton.js +30 -28
- package/dist/components/New/InfoButton/InfoButton.js +13 -11
- package/dist/components/New/InlineSelect/InlineSelect.js +74 -56
- package/dist/components/New/InteractiveTooltip/InteractiveTooltip.js +67 -61
- package/dist/components/New/InteractiveTooltip/constants.js +2 -2
- package/dist/components/New/Label/Label.js +13 -8
- package/dist/components/New/MarkdownEditor/MarkdownEditor.js +29 -27
- package/dist/components/New/MenuItem/MenuItem.js +29 -27
- package/dist/components/New/MenuItem/constants.js +9 -8
- package/dist/components/New/NoDataContent/NoDataContent.js +21 -19
- package/dist/components/New/Notification/Notification.js +33 -29
- package/dist/components/New/NumberInput/NumberInput.js +42 -33
- package/dist/components/New/PasswordInput/PasswordInput.js +41 -35
- package/dist/components/New/Popup/Popup.js +46 -44
- package/dist/components/New/Popup/constants.js +3 -3
- package/dist/components/New/Radio/Radio.js +75 -64
- package/dist/components/New/RadioGroup/RadioGroup.js +76 -65
- package/dist/components/New/RadioGroupPopupField/RadioGroupPopupField.js +117 -106
- package/dist/components/New/ResizableContainer/ResizableContainer.js +42 -40
- package/dist/components/New/SchemaRenderer/SchemaRenderer.js +164 -0
- package/dist/components/New/SchemaRenderer/components/SchemaAnyOfEditor.js +65 -0
- package/dist/components/New/SchemaRenderer/components/SchemaArrayEditor.js +109 -0
- package/dist/components/New/SchemaRenderer/components/SchemaField.js +83 -0
- package/dist/components/New/SchemaRenderer/components/SchemaFieldContent.js +72 -0
- package/dist/components/New/SchemaRenderer/components/SchemaJsonEditor.js +41 -0
- package/dist/components/New/SchemaRenderer/components/SchemaKeyValueEditor.js +250 -0
- package/dist/components/New/SchemaRenderer/components/SchemaObjectEditor.js +36 -0
- package/dist/components/New/SchemaRenderer/components/SchemaOneOfEditor.js +163 -0
- package/dist/components/New/SchemaRenderer/components/SchemaPrimitiveField.js +150 -0
- package/dist/components/New/SchemaRenderer/components/SchemaSection.js +135 -0
- package/dist/components/New/SchemaRenderer/context.js +17 -0
- package/dist/components/New/Search/Search.js +29 -27
- package/dist/components/New/SegmentedControl/SegmentedControl.js +29 -23
- package/dist/components/New/Select/CollapsedSelectTags.js +127 -0
- package/dist/components/New/Select/MultiSelectTags.js +18 -15
- package/dist/components/New/Select/Select.js +219 -197
- package/dist/components/New/Select/constants.js +23 -20
- package/dist/components/New/SharedEntityIndicator/SharedEntityIndicator.js +34 -0
- package/dist/components/New/SideDrawer/SideDrawer.js +148 -0
- package/dist/components/New/Slider/Slider.js +151 -90
- package/dist/components/New/Slider/utils.js +12 -0
- package/dist/components/New/Switch/Switch.js +69 -58
- package/dist/components/New/Tabs/Tabs.js +125 -61
- package/dist/components/New/Tag/Tag.js +42 -40
- package/dist/components/New/TagInput/TagInput.js +48 -44
- package/dist/components/New/Textarea/Textarea.js +21 -20
- package/dist/components/New/ToggleIconButton/ToggleIconButton.js +26 -24
- package/dist/components/New/Tooltip/TooltipContent.js +11 -9
- package/dist/components/New/Tooltip/constants.js +1 -1
- package/dist/components/New/TransferQueue/TransferQueue.js +124 -0
- package/dist/components/New/TransferQueue/TransferQueueHeader.js +71 -0
- package/dist/components/New/TransferQueue/TransferQueueRow.js +119 -0
- package/dist/components/New/TransferQueue/constants.js +24 -0
- package/dist/components/New/constants/overlay.js +17 -9
- package/dist/components/Popup/constants.js +8 -8
- package/dist/components/ProgressBar/ProgressBar.js +45 -33
- package/dist/components/SchemaRenderer/SchemaRenderer.js +16 -15
- package/dist/components/SchemaRenderer/components/SchemaAdditionalPropertiesEditor.js +46 -31
- package/dist/components/SchemaRenderer/components/SchemaAnyOfEditor.js +2 -2
- package/dist/components/SchemaRenderer/components/SchemaArrayEditor.js +1 -1
- package/dist/components/SchemaRenderer/components/SchemaField.js +23 -23
- package/dist/components/SchemaRenderer/components/SchemaFieldContent.js +19 -19
- package/dist/components/SchemaRenderer/components/SchemaKeyValueEditor.js +223 -135
- package/dist/components/SchemaRenderer/components/SchemaObjectEditor.js +1 -1
- package/dist/components/SchemaRenderer/components/SchemaOneOfEditor.js +13 -13
- package/dist/components/SchemaRenderer/components/SchemaPrimitiveField.js +5 -5
- package/dist/components/Skeleton/Skeleton.js +25 -19
- package/dist/components/Spinner/Spinner.js +7 -5
- package/dist/components/Tooltip/TooltipContent.js +11 -11
- package/dist/components-manifest.json +1851 -77
- package/dist/constants/public-class-names.js +218 -0
- package/dist/constants/schema-renderer.js +33 -0
- package/dist/dial-ui-kit.cjs +2 -2
- package/dist/dial-ui-kit.js +357 -307
- package/dist/editors.cjs +1 -1
- package/dist/file-manager.cjs +1 -1
- package/dist/grid.cjs +1 -1
- package/dist/index.css +2 -2
- package/dist/lazy-_W6FYhKg.cjs +1 -0
- package/dist/merge-classes-BEJXjzkx.cjs +1 -0
- package/dist/migration-guides/0.15.0/legacy-theme-variable-fallbacks-removal.md +69 -0
- package/dist/migration-guides/0.15.0/slider-redesign.md +110 -0
- package/dist/migration-guides/README.md +2 -0
- package/dist/node_modules/tailwind-merge/dist/bundle-mjs.js +419 -399
- package/dist/src/components/FileManager/FileManager.d.ts +2 -0
- package/dist/src/components/FileManager/FileManagerContext.d.ts +1 -0
- package/dist/src/components/FileManager/hooks/use-grid-context-menu.d.ts +2 -1
- package/dist/src/components/MarkdownEditor/MarkdownEditor.d.ts +2 -0
- package/dist/src/components/MarkdownEditor/MarkdownEditorContainer.d.ts +2 -0
- package/dist/src/components/New/Accordion/Accordion.d.ts +6 -1
- package/dist/src/components/New/AutocompleteTagInput/AutocompleteTagInput.d.ts +97 -0
- package/dist/src/components/New/AutocompleteTagInput/utils.d.ts +17 -0
- package/dist/src/components/New/AutocompleteTagInput/utils.spec.d.ts +1 -0
- package/dist/src/components/New/Avatar/Avatar.d.ts +55 -0
- package/dist/src/components/New/Badge/Badge.d.ts +47 -0
- package/dist/src/components/New/BottomSheet/BottomSheet.d.ts +84 -0
- package/dist/src/components/New/Breadcrumbs/Breadcrumbs.d.ts +94 -0
- package/dist/src/components/New/Breadcrumbs/constants.d.ts +60 -0
- package/dist/src/components/New/Button/Button.d.ts +4 -1
- package/dist/src/components/New/Button/ButtonWrappers.d.ts +21 -0
- package/dist/src/components/New/Button/utils.d.ts +15 -0
- package/dist/src/components/New/ButtonDropdown/ButtonDropdown.d.ts +4 -0
- package/dist/src/components/New/Calendar/constants.d.ts +1 -1
- package/dist/src/components/New/ConfirmationPopup/constants.d.ts +0 -1
- package/dist/src/components/New/Dropdown/Dropdown.d.ts +9 -1
- package/dist/src/components/New/Dropdown/constants.d.ts +3 -0
- package/dist/src/components/New/EntityIdentity/EntityIdentity.d.ts +85 -0
- package/dist/src/components/New/FileIcon/FileIcon.d.ts +61 -0
- package/dist/src/components/New/FileIcon/constants.d.ts +16 -0
- package/dist/src/components/New/FileIcon/icons/FileGlyph.d.ts +18 -0
- package/dist/src/components/New/FileIcon/icons/FolderGlyph.d.ts +17 -0
- package/dist/src/components/New/FileName/FileName.d.ts +79 -0
- package/dist/src/components/New/FilterChips/FilterChips.d.ts +69 -0
- package/dist/src/components/New/FilterChips/constants.d.ts +13 -0
- package/dist/src/components/New/FolderName/FolderName.d.ts +37 -0
- package/dist/src/components/New/InlineSelect/InlineSelect.d.ts +16 -1
- package/dist/src/components/New/InteractiveTooltip/InteractiveTooltip.d.ts +13 -2
- package/dist/src/components/New/InteractiveTooltip/constants.d.ts +5 -4
- package/dist/src/components/New/MarkdownEditor/MarkdownEditor.d.ts +3 -0
- package/dist/src/components/New/Notification/Notification.d.ts +18 -0
- package/dist/src/components/New/Popup/constants.d.ts +1 -1
- package/dist/src/components/New/SchemaRenderer/SchemaRenderer.d.ts +38 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaAnyOfEditor.d.ts +37 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaArrayEditor.d.ts +35 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaField.d.ts +33 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaFieldContent.d.ts +30 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaJsonEditor.d.ts +29 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaKeyValueEditor.d.ts +37 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaObjectEditor.d.ts +32 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaOneOfEditor.d.ts +39 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaPrimitiveField.d.ts +38 -0
- package/dist/src/components/New/SchemaRenderer/components/SchemaSection.d.ts +39 -0
- package/dist/src/components/New/SchemaRenderer/context.d.ts +8 -0
- package/dist/src/components/New/SchemaRenderer/types.d.ts +76 -0
- package/dist/src/components/New/Select/CollapsedSelectTags.d.ts +22 -0
- package/dist/src/components/New/Select/MultiSelectTags.d.ts +5 -0
- package/dist/src/components/New/Select/Select.d.ts +9 -0
- package/dist/src/components/New/Select/constants.d.ts +3 -2
- package/dist/src/components/New/SharedEntityIndicator/SharedEntityIndicator.d.ts +35 -0
- package/dist/src/components/New/SideDrawer/SideDrawer.d.ts +100 -0
- package/dist/src/components/New/Slider/Slider.d.ts +20 -1
- package/dist/src/components/New/Slider/utils.d.ts +6 -0
- package/dist/src/components/New/Slider/utils.spec.d.ts +1 -0
- package/dist/src/components/New/Tabs/Tabs.d.ts +54 -6
- package/dist/src/components/New/Tooltip/constants.d.ts +5 -3
- package/dist/src/components/New/TransferQueue/TransferQueue.d.ts +139 -0
- package/dist/src/components/New/TransferQueue/TransferQueueHeader.d.ts +16 -0
- package/dist/src/components/New/TransferQueue/TransferQueueRow.d.ts +10 -0
- package/dist/src/components/New/TransferQueue/constants.d.ts +6 -0
- package/dist/src/components/New/constants/overlay.d.ts +13 -0
- package/dist/src/components/Popup/constants.d.ts +1 -1
- package/dist/src/components/SchemaRenderer/types.d.ts +5 -82
- package/dist/src/components/SchemaRenderer/utils.d.ts +1 -13
- package/dist/src/constants/public-class-names.d.ts +209 -0
- package/dist/src/constants/schema-renderer.d.ts +2 -0
- package/dist/src/index.d.ts +40 -3
- package/dist/src/models/json-schema.d.ts +71 -0
- package/dist/src/types/accordion.d.ts +7 -0
- package/dist/src/types/avatar.d.ts +7 -0
- package/dist/src/types/badge.d.ts +16 -0
- package/dist/src/types/breadcrumbs.d.ts +9 -0
- package/dist/src/types/button.d.ts +1 -0
- package/dist/src/types/entity-type.d.ts +9 -0
- package/dist/src/types/json-schema.d.ts +22 -0
- package/dist/src/types/tooltip.d.ts +4 -0
- package/dist/src/types/transfer-queue.d.ts +10 -0
- package/dist/src/utils/__tests__/avatar.spec.d.ts +1 -0
- package/dist/src/utils/avatar.d.ts +12 -0
- package/dist/src/utils/json-schema.d.ts +23 -0
- package/dist/src/utils/sub-menu-floating.d.ts +7 -4
- package/dist/types/accordion.js +4 -0
- package/dist/types/avatar.js +4 -0
- package/dist/types/badge.js +5 -0
- package/dist/types/breadcrumbs.js +4 -0
- package/dist/types/button.js +3 -3
- package/dist/types/entity-type.js +4 -0
- package/dist/types/json-schema.js +7 -0
- package/dist/types/tooltip.js +3 -2
- package/dist/types/transfer-queue.js +4 -0
- package/dist/use-file-manager-tabs-Bzzwwcgk.cjs +3 -0
- package/dist/utils/avatar.js +22 -0
- package/dist/{components/SchemaRenderer/utils.js → utils/json-schema.js} +122 -95
- package/dist/utils/merge-classes.js +12 -5
- package/dist/utils/sub-menu-floating.js +99 -54
- package/package.json +4 -9
- package/dist/DateCellRenderer-ssp7eaZY.cjs +0 -1
- package/dist/IconButton-DWqoaBWf.cjs +0 -1
- package/dist/JsonEditor-D2jSlRFi.cjs +0 -1
- package/dist/MarkdownEditor-BzEbdj7R.cjs +0 -1
- package/dist/MarkdownEditorContainer-BvwJjkiZ.cjs +0 -1
- package/dist/components/SchemaRenderer/types.js +0 -27
- package/dist/editor-_174x-qy.cjs +0 -1
- package/dist/lazy-DM-7dL0Y.cjs +0 -1
- package/dist/merge-classes-Dipy1Ih1.cjs +0 -1
- package/dist/use-file-manager-tabs-DjdR_mYM.cjs +0 -3
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.15.0-dev.
|
|
3
|
-
"generatedAt": "2026-
|
|
2
|
+
"version": "0.15.0-dev.51",
|
|
3
|
+
"generatedAt": "2026-10-08T09:20:27.087Z",
|
|
4
4
|
"kit": {
|
|
5
5
|
"name": "@epam/ai-dial-ui-kit",
|
|
6
6
|
"description": "A modern UI kit for building AI DIAL interfaces with React",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"setupNotes": "## Next.js Integration\n1. Install the package. React is the only peer you have to supply — everything\n the kit renders with, it installs itself.\n\n``` bash\nnpm install @epam/ai-dial-ui-kit\nnpm install react react-dom\n```\n\nAdd the editor packages only if you use the `@epam/ai-dial-ui-kit/editors`\nsubpath. They are optional peers, so `npm install` stays quiet without them, and\nthe kit only reaches for them when a `Lazy*` editor actually mounts:\n\n``` bash\nnpm install monaco-editor @monaco-editor/react @uiw/react-md-editor\n```\n\n2. Import style in the root layout of the project:\n\n```tsx\n// app/layout.tsx\nimport \"@epam/ai-dial-ui-kit/styles.css\";\n```\n\n3. Usage example\n\n```tsx\n// app/page.tsx\n\"use client\";\nimport { DialPrimaryButton } from \"@epam/ai-dial-ui-kit\";\n\nexport default function Home() {\n return (\n <div className=\"w-full h-full flex flex-col gap-3 items-center justify-center\">\n <h1>Test library</h1>\n <DialPrimaryButton onClick={() => alert('Hello AI DIAL!')} />\n </div>\n );\n}\n```\nSee \"🎨 Theming & Customization\" section in README."
|
|
18
18
|
},
|
|
19
19
|
"styles": "# Typography CSS Utility Classes\n\n## Design-system-compliant classes (`dial-*-text`)\n\nUse these by default. They follow the design system type scale.\n\n| Class | Design name | Weight | Size / Line-height |\n| --------------------------------- | --------------------------- | -------- | ----------------------------------- |\n| `.dial-display1-text` | Display 1 | semibold | 32px / 48px |\n| `.dial-display2-text` | Display 2 | semibold | 28px / 40px |\n| `.dial-display3-text` | Display 3 | semibold | 22px / 32px |\n| `.dial-h1-text` | Heading 1 | semibold | 20px / 28px |\n| `.dial-h2-text` | Heading 2 | semibold | 18px / 26px |\n| `.dial-h3-text` | Heading 3 | semibold | 16px / 24px |\n| `.dial-body-text` | Body Text | normal | 16px / 24px |\n| `.dial-body-semi-text` | Body Text (Semi Bold) | semibold | 16px / 24px |\n| `.dial-body-paragraph-text` | Body Paragraph | normal | 16px / 26px |\n| `.dial-body-paragraph-semi-text` | Body Paragraph (Semi Bold) | semibold | 16px / 26px |\n| `.dial-small-text` | Small Text | normal | 14px / 20px |\n| `.dial-small-semi-text` | Small Text (Semi Bold) | semibold | 14px / 20px |\n| `.dial-small-paragraph-text` | Small Paragraph | normal | 14px / 24px |\n| `.dial-small-paragraph-semi-text` | Small Paragraph (Semi Bold) | semibold | 14px / 24px |\n| `.dial-tiny-text` | Tiny Text | normal | 12px / 16px |\n| `.dial-tiny-lead-text` | Tiny Text Lead | normal | 12px / 16px (+0.03em, uppercase) |\n| `.dial-tiny-semi-text` | Tiny Text (Semi Bold) | semibold | 12px / 16px |\n| `.dial-tiny-lead-semi-text` | Tiny Text Lead (Semi Bold) | semibold | 12px / 16px (+0.03em, uppercase) |\n| `.dial-caption-text` | Caption | normal | 10px / 12px |\n| `.dial-caption-lead-semi-text` | Caption Lead (Semi Bold) | semibold | 10px / 12px (+0.06em, uppercase) |\n| `.dial-code-text` | Code | normal | 14px / 20px (Fira Code / monospace) |\n| `.dial-italic-text` | Italic | normal | 18px / 22px (serif, italic) |\n| `.dial-small-italic-text` | Small Italic | normal | 14px / 20px (serif, italic) |\n| `.dial-tiny-italic-text` | Tiny Italic | normal | 12px / 16px (serif, italic) |\n| `.dial-caption-italic-text` | Caption Italic | normal | 10px / 12px (serif, italic) |\n\nThe three `*-lead-*` classes apply `text-transform: uppercase` themselves — pass them the sentence-case string, not a pre-uppercased one, so the accessible name stays readable.\n\n`.dial-code-text` resolves its family through `var(--theme-font-mono, var(--font-fira-code, 'Fira Code'))` before falling back to the system monospace stack. The kit ships no font file; the host provides the face.\n\nThe `*-italic-text` classes use a serif italic face and are intended for mathematical and formula symbols. Their line-heights follow the corresponding typography size; the default 18px variant uses a fixed 22px line-height to keep standalone symbols vertically aligned without changing their container's height.\n\n## Legacy classes (avoid in new code)\n\nClasses like `dial-h1`, `dial-h2`, `dial-body`, `dial-small*`, `dial-tiny*`, `dial-caption` are legacy. They can be used in legacy projects if user explicidly specify they need legacy typography.\n\n## Raw SCSS source\n",
|
|
20
|
-
"theming": "# Theming & CSS Variable Tokens\n\nAI DIAL UI Kit uses CSS custom properties (variables) for theming.\nDark and light themes are switched by setting different values for these variables on `:root` or a theme wrapper element.\n\n## Usage in Tailwind\n\nThe Tailwind config maps CSS variables to utility classes.\nUse these classes in your components:\n\n```tsx\n// Backgrounds\n<div className=\"bg-layer-0\" /> // darkest background\n<div className=\"bg-layer-1\" /> // main content area\n<div className=\"bg-layer-2\" /> // elevated panels\n\n// Text\n<span className=\"text-primary\" /> // main text color\n<span className=\"text-secondary\" /> // muted text\n<span className=\"text-error\" /> // error state\n\n// Borders\n<div className=\"border border-primary\" /> // standard border\n<div className=\"border border-error\" /> // error border\n```\n\n## Override CSS Variables\n\n```css\n:root {\n --bg-layer-0: #000000;\n --bg-layer-1: #0c101d;\n --bg-layer-2: #161b2d;\n --bg-layer-3: #1d2439;\n --text-primary: #eef1f7;\n --text-secondary: #9fa6bd;\n --text-error: #f76464;\n --stroke-primary: #696e7c;\n --controls-bg-accent-primary: #3664e2;\n /* ... see tailwind.config.js for full list */\n}\n```\n\n## Token Reference\n\n\n### backgroundsColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-sunken` | `var(--bg-layer-sunken)` | `#EEF1F7` |\n| `layer-base` | `var(--bg-layer-base)` | `#F5F7FA` |\n| `layer-raised` | `var(--bg-layer-raised)` | `#FCFCFC` |\n| `gradient-1` | `var(--bg-gradient-1)` | `#1D4ED8` |\n| `gradient-1-hover` | `var(--bg-gradient-1-hover)` | `#6785FB` |\n| `gradient-1-active` | `var(--bg-gradient-1-active)` | `#1D4ED8` |\n| `gradient-2` | `var(--bg-gradient-2)` | `#885DF2` |\n| `gradient-2-hover` | `var(--bg-gradient-2-hover)` | `#885DF2` |\n| `gradient-2-active` | `var(--bg-gradient-2-active)` | `#7C3AED` |\n| `control-accent-alpha` | `var(--bg-control-accent-alpha)` | `#2764D90F` |\n| `control-accent-alpha-hover` | `var(--bg-control-accent-alpha-hover)` | `#2764D924` |\n| `control-accent-alpha-active` | `var(--bg-control-accent-alpha-active)` | `#2764D933` |\n| `control-accent` | `var(--bg-control-accent)` | `#1D4ED8` |\n| `control-accent-hover` | `var(--bg-control-accent-hover)` | `#5976E9` |\n| `control-neutral` | `var(--bg-control-neutral)` | `#FCFCFC` |\n| `control-neutral-hover-strong` | `var(--bg-control-neutral-hover-strong)` | `#848E9C` |\n| `control-neutral-active` | `var(--bg-control-neutral-active)` | `#D1DBEA` |\n| `control-neutral-default` | `var(--bg-control-neutral-default)` | `#ACB3C3` |\n| `control-inverted` | `var(--bg-control-inverted)` | `#57647A` |\n| `control-error` | `var(--bg-control-error)` | `#AE2F2F` |\n| `control-error-hover` | `var(--bg-control-error-hover)` | `#BF3939` |\n| `control-error-active` | `var(--bg-control-error-active)` | `#CC4545` |\n| `control-error-alpha-hover` | `var(--bg-control-error-alpha-hover)` | `#F764641A` |\n| `control-error-alpha-active` | `var(--bg-control-error-alpha-active)` | `#F7646433` |\n| `control-disable-primary` | `var(--bg-control-disable-primary)` | `#DCE0E8` |\n| `control-disable-secondary` | `var(--bg-control-disable-secondary)` | `#ACB3C3` |\n| `green-1` | `var(--bg-visual-green-1)` | `#CDE8E5` |\n| `green-2` | `var(--bg-visual-green-2)` | `#D1F0DC` |\n| `violet-1` | `var(--bg-visual-violet-1)` | `#DDE3F9` |\n| `violet-2` | `var(--bg-visual-violet-2)` | `#F1E9FF` |\n\n### shadowColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `xs-1` | `var(--shadow-xs-1)` | `#2764D933` |\n| `xs-2` | `var(--shadow-xs-2)` | `#161B2D08` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-alpha` | `var(--stroke-accent-alpha)` | `#2764D933` |\n| `gradient-1` | `var(--stroke-gradient-1)` | `#5976E9` |\n| `gradient-2` | `var(--stroke-gradient-2)` | `#885DF2` |\n| `accent-focus` | `var(--stroke-accent-focus)` | `#6785FB` |\n| `error-alpha` | `var(--stroke-error-alpha)` | `#AE2F2F73` |\n| `control-disable-primary` | `var(--stroke-control-disable-primary)` | `#848E9C` |\n\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `warning-icon` | `var(--text-warning-icon)` | `#EEC840` |\n| `green-1` | `var(--text-visual-green-1)` | `#059669` |\n| `green-2` | `var(--text-visual-green-2)` | `#0D6E72` |\n| `green-3` | `var(--text-visual-green-3)` | `#065F46` |\n| `brown-1` | `var(--text-visual-brown-1)` | `#D36817` |\n| `brown-2` | `var(--text-visual-brown-2)` | `#B45309` |\n| `violet-1` | `var(--text-visual-violet-1)` | `#7C3AED` |\n| `violet-2` | `var(--text-visual-violet-2)` | `#3730B7` |\n| `control-permanent` | `var(--text-control-permanent)` | `#FCFCFC` |\n| `control-inverted` | `var(--text-control-inverted)` | `#FCFCFC` |\n| `control-disable-primary` | `var(--text-control-disable-primary)` | `#848E9C` |\n| `control-disable-secondary` | `var(--text-control-disable-secondary)` | `#DCE0E8` |\n| `control-accent-hover` | `var(--text-control-accent-hover)` | `#5976E9` |\n| `control-accent-active` | `var(--text-control-accent-active)` | `#6785FB` |\n\n### backgroundsColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-0` | `var(--bg-layer-0)` | `#FCFCFC` |\n| `layer-1` | `var(--bg-layer-1)` | `#E0E6F0` |\n| `layer-2` | `var(--bg-layer-2)` | `#EEF1F7` |\n| `layer-3` | `var(--bg-layer-3)` | `#FCFCFC` |\n| `layer-4` | `var(--bg-layer-4)` | `#D1DBEA` |\n| `accent-primary-alpha` | `var(--bg-accent-primary-alpha)` | `#7DA4FF26` |\n| `accent-secondary-alpha` | `var(--bg-accent-secondary-alpha)` | `#37BABC2E` |\n| `accent-tertiary-alpha` | `var(--bg-accent-tertiary-alpha)` | `#A972FF2E` |\n| `accent-primary` | `var(--bg-accent-primary)` | `#5C8DEA` |\n| `accent-secondary` | `var(--bg-accent-secondary)` | `#37BABC` |\n| `red-400` | `var(--bg-red-400)` | `#F76464` |\n| `controls-accent-primary` | `var(--controls-bg-accent-primary)` | `#124ACE` |\n| `controls-accent-primary-hover` | `var(--controls-bg-accent-primary-hover)` | `#2656D9` |\n| `controls-accent-primary-active` | `var(--controls-bg-accent-primary-active)` | `#3664E2` |\n| `controls-accent-primary-alpha-active` | `var(--controls-bg-accent-primary-alpha-active)` | `#7DA4FF5C` |\n| `controls-accent-secondary-alpha-active` | `var(--controls-bg-accent-secondary-alpha-active)` | `#37BABC5C` |\n| `controls-accent-tertiary-alpha-active` | `var(--controls-bg-accent-tertiary-alpha-active)` | `#A972FF5C` |\n| `controls-error` | `var(--controls-bg-error)` | `#AE2F2F` |\n| `controls-error-hover` | `var(--controls-bg-error-hover)` | `#BF3939` |\n| `controls-error-active` | `var(--controls-bg-error-active)` | `#CC4545` |\n| `controls-error-alpha-active` | `var(--controls-bg-error-alpha-active)` | `#F764645C` |\n| `controls-disable-accent` | `var(--controls-bg-disable-accent)` | `#7C8293` |\n| `controls-disable` | `var(--controls-bg-disable)` | `#D1DBEA` |\n| `controls-neutral-hover` | `var(--controls-bg-neutral-hover)` | `#D1DBEA` |\n| `controls-neutral-active` | `var(--controls-bg-neutral-active)` | `#9FA6BD` |\n| `controls-accent-success-alpha-hover` | `var(--controls-bg-accent-success-alpha-hover)` | `#37BABC2E` |\n| `controls-accent-success-alpha-active` | `var(--controls-bg-accent-success-alpha-active)` | `#37BABC5C` |\n| `controls-enable-primary` | `var(--controls-enable-primary)` | `#FCFCFC` |\n\n### borderColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--stroke-accent-primary)` | `#124ACE` |\n| `accent-secondary` | `var(--stroke-accent-secondary)` | `#007274` |\n| `controls-accent` | `var(--controls-bg-accent)` | `#5C8DEA` |\n| `red-900` | `var(--red-900)` | `#402027` |\n\n### textColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--text-accent-primary)` | `#7DA4FF` |\n| `accent-secondary` | `var(--text-accent-secondary)` | `#37BABC` |\n| `accent-tertiary` | `var(--text-accent-tertiary)` | `#A972FF` |\n| `controls-permanent` | `var(--controls-text-permanent)` | `#FCFCFC` |\n| `controls-accent-disable` | `var(--controls-text-accent-disable)` | `#D1DBEA` |\n| `controls-primary-disable` | `var(--controls-text-primary-disable)` | `#696E7C` |\n| `controls-secondary-disable` | `var(--controls-text-secondary-disable)` | `#9FA6BD` |\n| `controls-neutral` | `var(--controls-text-neutral)` | `#161B2D` |\n| `controls-accent-primary-hover` | `var(--controls-text-accent-primary-hover)` | `#3664E2` |\n| `controls-accent-primary-active` | `var(--controls-text-accent-primary-active)` | `#7DA4FF` |",
|
|
20
|
+
"theming": "# Theming & CSS Variable Tokens\n\nAI DIAL UI Kit uses CSS custom properties (variables) for theming.\nDark and light themes are switched by setting different values for these variables on `:root` or a theme wrapper element.\n\n## Usage in Tailwind\n\nThe Tailwind config maps CSS variables to utility classes.\nUse these classes in your components:\n\n```tsx\n// Backgrounds\n<div className=\"bg-layer-0\" /> // darkest background\n<div className=\"bg-layer-1\" /> // main content area\n<div className=\"bg-layer-2\" /> // elevated panels\n\n// Text\n<span className=\"text-primary\" /> // main text color\n<span className=\"text-secondary\" /> // muted text\n<span className=\"text-error\" /> // error state\n\n// Borders\n<div className=\"border border-primary\" /> // standard border\n<div className=\"border border-error\" /> // error border\n```\n\n## Override CSS Variables\n\n```css\n:root {\n --bg-layer-0: #000000;\n --bg-layer-1: #0c101d;\n --bg-layer-2: #161b2d;\n --bg-layer-3: #1d2439;\n --text-primary: #eef1f7;\n --text-secondary: #9fa6bd;\n --text-error: #f76464;\n --stroke-primary: #696e7c;\n --controls-bg-accent-primary: #3664e2;\n /* ... see tailwind.config.js for full list */\n}\n```\n\n## Overlay stacking\n\nPortalled overlays stack on a ladder driven by one variable, `--z-overlay`\n(default `52`): `z-popup` (base — `Popup` backdrop), `z-floating` (+1 —\n`Dropdown`/`Select` overlays, submenus, `Calendar`), `z-interactive-tooltip`\n(+2 — `InteractiveTooltip`), `z-tooltip` (+3 — `Tooltip`). To lift every\noverlay above a host's own sticky header or modal, set the base once on `:root`\n(or in a `ThemeScope` class) — the steps move together, so their order is kept:\n\n```css\n:root {\n --z-overlay: 1000;\n}\n```\n\nDo not override `[role='menu']` or hardcode `z-[53]` in a host. To move one\noverlay only, pass a `z-*` utility through its class prop (`listClassName`,\n`overlayClassName`, `contentClassName`, `panelClassName`) — `mergeClasses`\nreplaces the layer's step with it.\n\n## Token Reference\n\n\n### backgroundsColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-sunken` | `var(--bg-layer-sunken)` | `#EEF1F7` |\n| `layer-base` | `var(--bg-layer-base)` | `#F5F7FA` |\n| `layer-raised` | `var(--bg-layer-raised)` | `#FCFCFC` |\n| `gradient-1` | `var(--bg-gradient-1)` | `#1D4ED8` |\n| `gradient-1-hover` | `var(--bg-gradient-1-hover)` | `#6785FB` |\n| `gradient-1-active` | `var(--bg-gradient-1-active)` | `#1D4ED8` |\n| `gradient-2` | `var(--bg-gradient-2)` | `#885DF2` |\n| `gradient-2-hover` | `var(--bg-gradient-2-hover)` | `#885DF2` |\n| `gradient-2-active` | `var(--bg-gradient-2-active)` | `#7C3AED` |\n| `control-accent-alpha` | `var(--bg-control-accent-alpha)` | `#2764D90F` |\n| `control-accent-alpha-hover` | `var(--bg-control-accent-alpha-hover)` | `#2764D924` |\n| `control-accent-alpha-hover-subtle` | `var(--bg-control-accent-alpha-hover-subtle)` | `#2764D90A` |\n| `control-accent-alpha-active` | `var(--bg-control-accent-alpha-active)` | `#2764D933` |\n| `control-accent-alpha-active-subtle` | `var(--bg-control-accent-alpha-active-subtle)` | `#2764D914` |\n| `control-accent` | `var(--bg-control-accent)` | `#1D4ED8` |\n| `control-accent-muted` | `var(--bg-control-accent-muted)` | `#E1EAF9` |\n| `control-accent-hover` | `var(--bg-control-accent-hover)` | `#5976E9` |\n| `control-neutral` | `var(--bg-control-neutral)` | `#FCFCFC` |\n| `control-neutral-hover-strong` | `var(--bg-control-neutral-hover-strong)` | `#848E9C` |\n| `control-neutral-hover-muted` | `var(--bg-control-neutral-hover-muted)` | `#E0E6F0` |\n| `control-neutral-active` | `var(--bg-control-neutral-active)` | `#D1DBEA` |\n| `control-neutral-default` | `var(--bg-control-neutral-default)` | `#ACB3C3` |\n| `control-inverted` | `var(--bg-control-inverted)` | `#57647A` |\n| `control-error` | `var(--bg-control-error)` | `#AE2F2F` |\n| `control-error-hover` | `var(--bg-control-error-hover)` | `#BF3939` |\n| `control-error-active` | `var(--bg-control-error-active)` | `#CC4545` |\n| `control-error-alpha-hover` | `var(--bg-control-error-alpha-hover)` | `#F764641A` |\n| `control-error-alpha-active` | `var(--bg-control-error-alpha-active)` | `#F7646433` |\n| `control-disable-primary` | `var(--bg-control-disable-primary)` | `#DCE0E8` |\n| `control-disable-secondary` | `var(--bg-control-disable-secondary)` | `#ACB3C3` |\n| `green-1` | `var(--bg-visual-green-1)` | `#CDE8E5` |\n| `green-2` | `var(--bg-visual-green-2)` | `#D1F0DC` |\n| `violet-1` | `var(--bg-visual-violet-1)` | `#DDE3F9` |\n| `violet-2` | `var(--bg-visual-violet-2)` | `#F1E9FF` |\n\n### shadowColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `xs-1` | `var(--shadow-xs-1)` | `#2764D933` |\n| `xs-2` | `var(--shadow-xs-2)` | `#161B2D08` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-alpha` | `var(--stroke-accent-alpha)` | `#2764D933` |\n| `gradient-1` | `var(--stroke-gradient-1)` | `#5976E9` |\n| `gradient-2` | `var(--stroke-gradient-2)` | `#885DF2` |\n| `accent-focus` | `var(--stroke-accent-focus)` | `#6785FB` |\n| `error-alpha` | `var(--stroke-error-alpha)` | `#AE2F2F73` |\n| `control-disable-primary` | `var(--stroke-control-disable-primary)` | `#848E9C` |\n\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `warning-icon` | `var(--text-warning-icon)` | `#EEC840` |\n| `green-1` | `var(--text-visual-green-1)` | `#059669` |\n| `green-2` | `var(--text-visual-green-2)` | `#0D6E72` |\n| `green-3` | `var(--text-visual-green-3)` | `#065F46` |\n| `brown-1` | `var(--text-visual-brown-1)` | `#D36817` |\n| `brown-2` | `var(--text-visual-brown-2)` | `#B45309` |\n| `violet-1` | `var(--text-visual-violet-1)` | `#7C3AED` |\n| `violet-2` | `var(--text-visual-violet-2)` | `#3730B7` |\n| `control-permanent` | `var(--text-control-permanent)` | `#FCFCFC` |\n| `control-inverted` | `var(--text-control-inverted)` | `#FCFCFC` |\n| `control-disable-primary` | `var(--text-control-disable-primary)` | `#848E9C` |\n| `control-disable-secondary` | `var(--text-control-disable-secondary)` | `#DCE0E8` |\n| `control-accent-hover` | `var(--text-control-accent-hover)` | `#5976E9` |\n| `control-accent-active` | `var(--text-control-accent-active)` | `#6785FB` |\n\n### backgroundsColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-0` | `var(--bg-layer-0)` | `#FCFCFC` |\n| `layer-1` | `var(--bg-layer-1)` | `#E0E6F0` |\n| `layer-2` | `var(--bg-layer-2)` | `#EEF1F7` |\n| `layer-3` | `var(--bg-layer-3)` | `#FCFCFC` |\n| `layer-4` | `var(--bg-layer-4)` | `#D1DBEA` |\n| `accent-primary-alpha` | `var(--bg-accent-primary-alpha)` | `#7DA4FF26` |\n| `accent-secondary-alpha` | `var(--bg-accent-secondary-alpha)` | `#37BABC2E` |\n| `accent-tertiary-alpha` | `var(--bg-accent-tertiary-alpha)` | `#A972FF2E` |\n| `accent-primary` | `var(--bg-accent-primary)` | `#5C8DEA` |\n| `accent-secondary` | `var(--bg-accent-secondary)` | `#37BABC` |\n| `red-400` | `var(--bg-red-400)` | `#F76464` |\n| `controls-accent-primary` | `var(--controls-bg-accent-primary)` | `#124ACE` |\n| `controls-accent-primary-hover` | `var(--controls-bg-accent-primary-hover)` | `#2656D9` |\n| `controls-accent-primary-active` | `var(--controls-bg-accent-primary-active)` | `#3664E2` |\n| `controls-accent-primary-alpha-active` | `var(--controls-bg-accent-primary-alpha-active)` | `#7DA4FF5C` |\n| `controls-accent-secondary-alpha-active` | `var(--controls-bg-accent-secondary-alpha-active)` | `#37BABC5C` |\n| `controls-accent-tertiary-alpha-active` | `var(--controls-bg-accent-tertiary-alpha-active)` | `#A972FF5C` |\n| `controls-error` | `var(--controls-bg-error)` | `#AE2F2F` |\n| `controls-error-hover` | `var(--controls-bg-error-hover)` | `#BF3939` |\n| `controls-error-active` | `var(--controls-bg-error-active)` | `#CC4545` |\n| `controls-error-alpha-active` | `var(--controls-bg-error-alpha-active)` | `#F764645C` |\n| `controls-disable-accent` | `var(--controls-bg-disable-accent)` | `#7C8293` |\n| `controls-disable` | `var(--controls-bg-disable)` | `#D1DBEA` |\n| `controls-neutral-hover` | `var(--controls-bg-neutral-hover)` | `#D1DBEA` |\n| `controls-neutral-active` | `var(--controls-bg-neutral-active)` | `#9FA6BD` |\n| `controls-accent-success-alpha-hover` | `var(--controls-bg-accent-success-alpha-hover)` | `#37BABC2E` |\n| `controls-accent-success-alpha-active` | `var(--controls-bg-accent-success-alpha-active)` | `#37BABC5C` |\n| `controls-enable-primary` | `var(--controls-enable-primary)` | `#FCFCFC` |\n\n### borderColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--stroke-accent-primary)` | `#124ACE` |\n| `accent-secondary` | `var(--stroke-accent-secondary)` | `#007274` |\n| `controls-accent` | `var(--controls-bg-accent)` | `#5C8DEA` |\n| `red-900` | `var(--red-900)` | `#402027` |\n\n### textColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--text-accent-primary)` | `#7DA4FF` |\n| `accent-secondary` | `var(--text-accent-secondary)` | `#37BABC` |\n| `accent-tertiary` | `var(--text-accent-tertiary)` | `#A972FF` |\n| `controls-permanent` | `var(--controls-text-permanent)` | `#FCFCFC` |\n| `controls-accent-disable` | `var(--controls-text-accent-disable)` | `#D1DBEA` |\n| `controls-primary-disable` | `var(--controls-text-primary-disable)` | `#696E7C` |\n| `controls-secondary-disable` | `var(--controls-text-secondary-disable)` | `#9FA6BD` |\n| `controls-neutral` | `var(--controls-text-neutral)` | `#161B2D` |\n| `controls-accent-primary-hover` | `var(--controls-text-accent-primary-hover)` | `#3664E2` |\n| `controls-accent-primary-active` | `var(--controls-text-accent-primary-active)` | `#7DA4FF` |",
|
|
21
21
|
"components": [
|
|
22
22
|
{
|
|
23
23
|
"name": "Spinner",
|
|
@@ -180,6 +180,17 @@
|
|
|
180
180
|
],
|
|
181
181
|
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
182
182
|
},
|
|
183
|
+
{
|
|
184
|
+
"name": "SchemaRenderer",
|
|
185
|
+
"category": "Name",
|
|
186
|
+
"generation": "2.0",
|
|
187
|
+
"description": "Renders a JSON Schema as a form, with collapsible sections, required-field\nvalidation and default values.\naliases: SchemaRenderer|JsonSchemaForm|SchemaForm\nDesign system 2.0\n\nBuilt only from 2.0 controls: `Input`, `NumberInput`, `PasswordInput`,\n`Select`, `Switch` and `RadioGroup`. A value the schema does not describe —\na key absent from `properties`, or an object with no fixed properties — is\nedited as raw JSON in a monospace `Textarea`.",
|
|
188
|
+
"props": [],
|
|
189
|
+
"examples": [
|
|
190
|
+
"<SchemaRenderer\n schema={mySchema}\n onChange={(v) => console.log(v)}\n onDefaultValues={(defaults) => console.log(defaults)}\n/>"
|
|
191
|
+
],
|
|
192
|
+
"sourceFile": "components/New/SchemaRenderer/SchemaRenderer.tsx"
|
|
193
|
+
},
|
|
183
194
|
{
|
|
184
195
|
"name": "Notification",
|
|
185
196
|
"category": "Components_2_0",
|
|
@@ -212,6 +223,12 @@
|
|
|
212
223
|
"required": true,
|
|
213
224
|
"description": "Message text to display inside the alert"
|
|
214
225
|
},
|
|
226
|
+
{
|
|
227
|
+
"name": "action",
|
|
228
|
+
"type": "ReactNode",
|
|
229
|
+
"required": false,
|
|
230
|
+
"description": "Optional control (typically a small `Button`) rendered at the inline end, after the text and before the close button; the caller supplies its accessible name"
|
|
231
|
+
},
|
|
215
232
|
{
|
|
216
233
|
"name": "closable",
|
|
217
234
|
"type": "boolean",
|
|
@@ -247,7 +264,7 @@
|
|
|
247
264
|
}
|
|
248
265
|
],
|
|
249
266
|
"examples": [
|
|
250
|
-
"<Notification\n variant={NotificationVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<Notification\n variant={NotificationVariant.Success}\n title=\"Saved\"\n message=\"Changes saved successfully.\"\n/>\n\n<Notification\n variant={NotificationVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<Notification\n variant={NotificationVariant.Loading}\n title=\"Processing\"\n message=\"Please wait...\"\n/>\n\n<Notification\n variant={NotificationVariant.General}\n type={NotificationType.SectionMessage}\n title=\"Title\"\n message=\"Description text example\"\n/>"
|
|
267
|
+
"<Notification\n variant={NotificationVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<Notification\n variant={NotificationVariant.Success}\n title=\"Saved\"\n message=\"Changes saved successfully.\"\n/>\n\n<Notification\n variant={NotificationVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<Notification\n variant={NotificationVariant.Loading}\n title=\"Processing\"\n message=\"Please wait...\"\n/>\n\n<Notification\n variant={NotificationVariant.General}\n type={NotificationType.SectionMessage}\n title=\"Title\"\n message=\"Description text example\"\n/>\n\n<Notification\n variant={NotificationVariant.Error}\n type={NotificationType.SectionMessage}\n title=\"Couldn't finish this response\"\n message=\"Something went wrong. Try again in a moment.\"\n action={\n <Button\n variant={ButtonVariant.Neutral}\n appearance={ButtonAppearance.Outlined}\n size={ElementSize.Small}\n label=\"Try again\"\n onClick={handleRetry}\n />\n }\n/>"
|
|
251
268
|
],
|
|
252
269
|
"sourceFile": "components/New/Notification/Notification.tsx"
|
|
253
270
|
},
|
|
@@ -556,6 +573,71 @@
|
|
|
556
573
|
],
|
|
557
574
|
"sourceFile": "components/New/FolderPath/FolderPath.tsx"
|
|
558
575
|
},
|
|
576
|
+
{
|
|
577
|
+
"name": "Breadcrumbs",
|
|
578
|
+
"category": "Components_2_0",
|
|
579
|
+
"generation": "2.0",
|
|
580
|
+
"description": "A navigation trail: where the user is, and every level they can step back to.\naliases: Breadcrumb|NavigationPath|BreadcrumbTrail\nDesign system 2.0\n\nThe last item is the current page — drawn semibold and primary, and never a\ncontrol, since a link to the page you are already on does nothing. Every\nearlier item with an `href` or an `onClick` is a link; one with neither is\ndrawn as plain text, which is how a read-only location path is built.\n\nThe trail never wraps. Segments truncate instead, each revealing its full\nlabel in a tooltip only once it is actually clipped, and a trail longer than\n`maxVisibleItems` collapses its middle behind an ellipsis menu — the root and\nthe current page, the two segments that carry the most meaning, always stay\non screen.\n\na11y: an `<ol>` inside a named `<nav>`, with `aria-current=\"page\"` on the last\nsegment. Separators are decorative and hidden from assistive tech, so the\ntrail is announced as a list of links rather than a string of chevrons.\n\nThe trail is drawn at `dial-small-text` by default; `size` switches it to\n`dial-h2-text` for a trail that doubles as the page heading, where the\ntoken's own semibold weight applies to every segment.\n\nLabels are the caller's to translate; the two accessible names default to\nEnglish and take an override.",
|
|
581
|
+
"props": [
|
|
582
|
+
{
|
|
583
|
+
"name": "items",
|
|
584
|
+
"type": "BreadcrumbsItem[]",
|
|
585
|
+
"required": true,
|
|
586
|
+
"description": "The trail, outermost first; the last entry is the current page"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "maxVisibleItems",
|
|
590
|
+
"type": "number",
|
|
591
|
+
"required": false,
|
|
592
|
+
"defaultValue": "DEFAULT_MAX_VISIBLE_ITEMS",
|
|
593
|
+
"description": "Segments drawn before the middle collapses behind an ellipsis menu"
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "size",
|
|
597
|
+
"type": "BreadcrumbsSize",
|
|
598
|
+
"required": false,
|
|
599
|
+
"defaultValue": "BreadcrumbsSize.Small",
|
|
600
|
+
"description": "The trail's type scale: `dial-small-text` or `dial-h2-text`"
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "separator",
|
|
604
|
+
"type": "ReactNode",
|
|
605
|
+
"required": false,
|
|
606
|
+
"defaultValue": "defaultSeparator",
|
|
607
|
+
"description": "Node drawn between two segments; defaults to a right chevron"
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"name": "ariaLabel",
|
|
611
|
+
"type": "string",
|
|
612
|
+
"required": false,
|
|
613
|
+
"defaultValue": "'Breadcrumb'",
|
|
614
|
+
"description": "Accessible name for the `<nav>`"
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "overflowAriaLabel",
|
|
618
|
+
"type": "string",
|
|
619
|
+
"required": false,
|
|
620
|
+
"defaultValue": "'Show hidden path segments'",
|
|
621
|
+
"description": "Accessible name for the ellipsis button"
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "className",
|
|
625
|
+
"type": "string",
|
|
626
|
+
"required": false,
|
|
627
|
+
"description": "Additional CSS classes for the `<nav>`"
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "itemClassName",
|
|
631
|
+
"type": "string",
|
|
632
|
+
"required": false,
|
|
633
|
+
"description": "Additional CSS classes applied to every segment"
|
|
634
|
+
}
|
|
635
|
+
],
|
|
636
|
+
"examples": [
|
|
637
|
+
"<Breadcrumbs\n ariaLabel={t('File path')}\n items={[\n { label: t('My files'), onClick: () => open('/') },\n { label: 'DK Test', onClick: () => open('/DK Test') },\n { label: 'DK Test with nested' },\n ]}\n/>"
|
|
638
|
+
],
|
|
639
|
+
"sourceFile": "components/New/Breadcrumbs/Breadcrumbs.tsx"
|
|
640
|
+
},
|
|
559
641
|
{
|
|
560
642
|
"name": "DangerButton",
|
|
561
643
|
"category": "Components_2_0",
|
|
@@ -623,6 +705,17 @@
|
|
|
623
705
|
],
|
|
624
706
|
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
625
707
|
},
|
|
708
|
+
{
|
|
709
|
+
"name": "StarterButton",
|
|
710
|
+
"category": "Components_2_0",
|
|
711
|
+
"generation": "2.0",
|
|
712
|
+
"description": "A Starter Button component — a conversation starter: an outlined neutral\npill whose icons are stroked with the accent gradient\nDesign system 2.0\n\n`iconBefore` defaults to a sparkles icon; pass `null` for a label-only pill.\n\nAn SVG stroke cannot take a CSS gradient, so the button renders its own\n`linearGradient` with a per-instance id and hands it to its icons through\nthe `--dial-kit-starter-icon-stroke` custom property. Any icon that strokes\nwith `currentColor`, as Tabler icons do, picks it up.",
|
|
713
|
+
"props": [],
|
|
714
|
+
"examples": [
|
|
715
|
+
"<StarterButton\n label=\"Summarize this document\"\n onClick={handleClick}\n/>"
|
|
716
|
+
],
|
|
717
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
718
|
+
},
|
|
626
719
|
{
|
|
627
720
|
"name": "DangerIconButton",
|
|
628
721
|
"category": "Components_2_0",
|
|
@@ -732,7 +825,7 @@
|
|
|
732
825
|
"name": "tooltipProps",
|
|
733
826
|
"type": "ButtonTooltipProps",
|
|
734
827
|
"required": false,
|
|
735
|
-
"description": "Props of the 2.0 wrapping the button"
|
|
828
|
+
"description": "Props of the 2.0 wrapping the button.\nA disabled button with a visible tooltip is marked `aria-disabled` rather\nthan natively `disabled`, so it stays focusable and hoverable and the\ntooltip can still explain why it is unavailable; its click does nothing."
|
|
736
829
|
},
|
|
737
830
|
{
|
|
738
831
|
"name": "href",
|
|
@@ -839,6 +932,12 @@
|
|
|
839
932
|
"type": "DropdownItem[]",
|
|
840
933
|
"required": true,
|
|
841
934
|
"description": "DropdownItems with actions"
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "dropdownProps",
|
|
938
|
+
"type": "Pick<DropdownProps, 'listClassName' | 'matchReferenceWidth'>",
|
|
939
|
+
"required": false,
|
|
940
|
+
"description": "`listClassName` and `matchReferenceWidth` forwarded to the menu `Dropdown`"
|
|
842
941
|
}
|
|
843
942
|
],
|
|
844
943
|
"examples": [
|
|
@@ -908,6 +1007,13 @@
|
|
|
908
1007
|
"type": "string",
|
|
909
1008
|
"required": false,
|
|
910
1009
|
"description": "Accessible name for the underlying textarea"
|
|
1010
|
+
},
|
|
1011
|
+
{
|
|
1012
|
+
"name": "showDragbar",
|
|
1013
|
+
"type": "boolean",
|
|
1014
|
+
"required": false,
|
|
1015
|
+
"defaultValue": "true",
|
|
1016
|
+
"description": "Whether to show the bottom drag bar that resizes the editor height"
|
|
911
1017
|
}
|
|
912
1018
|
],
|
|
913
1019
|
"examples": [
|
|
@@ -974,10 +1080,35 @@
|
|
|
974
1080
|
"type": "string",
|
|
975
1081
|
"required": false
|
|
976
1082
|
},
|
|
1083
|
+
{
|
|
1084
|
+
"name": "listStyle",
|
|
1085
|
+
"type": "CSSProperties",
|
|
1086
|
+
"required": false
|
|
1087
|
+
},
|
|
977
1088
|
{
|
|
978
1089
|
"name": "ariaLabel",
|
|
979
1090
|
"type": "string",
|
|
980
1091
|
"required": false
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "triggerClassName",
|
|
1095
|
+
"type": "string",
|
|
1096
|
+
"required": false
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
"name": "triggerLabelClassName",
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"required": false
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "open",
|
|
1105
|
+
"type": "boolean",
|
|
1106
|
+
"required": false
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "onOpenChange",
|
|
1110
|
+
"type": "(open: boolean) => void",
|
|
1111
|
+
"required": false
|
|
981
1112
|
}
|
|
982
1113
|
],
|
|
983
1114
|
"examples": [
|
|
@@ -1006,6 +1137,11 @@
|
|
|
1006
1137
|
"type": "boolean",
|
|
1007
1138
|
"required": false,
|
|
1008
1139
|
"defaultValue": "false"
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "labelClassName",
|
|
1143
|
+
"type": "string",
|
|
1144
|
+
"required": false
|
|
1009
1145
|
}
|
|
1010
1146
|
],
|
|
1011
1147
|
"examples": [],
|
|
@@ -1132,6 +1268,13 @@
|
|
|
1132
1268
|
"defaultValue": "'Select all'",
|
|
1133
1269
|
"description": "Label for the \"Select All\" checkbox."
|
|
1134
1270
|
},
|
|
1271
|
+
{
|
|
1272
|
+
"name": "collapseTagOverflow",
|
|
1273
|
+
"type": "boolean",
|
|
1274
|
+
"required": false,
|
|
1275
|
+
"defaultValue": "false",
|
|
1276
|
+
"description": "Keep a multi-select's tags on one row, folding those that do not fit into a `+N` counter by the width available; the hover panel lists them and removes them."
|
|
1277
|
+
},
|
|
1135
1278
|
{
|
|
1136
1279
|
"name": "selectedOptionMark",
|
|
1137
1280
|
"type": "| MenuItemMark.Tint\n | MenuItemMark.Check\n | MenuItemMark.Highlight",
|
|
@@ -1285,6 +1428,12 @@
|
|
|
1285
1428
|
"type": "(\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void",
|
|
1286
1429
|
"required": false,
|
|
1287
1430
|
"description": "Called with the value whose tag was removed; when omitted the tags are not removable"
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"name": "tagClassName",
|
|
1434
|
+
"type": "string",
|
|
1435
|
+
"required": false,
|
|
1436
|
+
"description": "Additional classes for every tag"
|
|
1288
1437
|
}
|
|
1289
1438
|
],
|
|
1290
1439
|
"examples": [],
|
|
@@ -2005,6 +2154,12 @@
|
|
|
2005
2154
|
"required": false,
|
|
2006
2155
|
"description": "Additional CSS classes applied to the floating overlay"
|
|
2007
2156
|
},
|
|
2157
|
+
{
|
|
2158
|
+
"name": "listStyle",
|
|
2159
|
+
"type": "CSSProperties",
|
|
2160
|
+
"required": false,
|
|
2161
|
+
"description": "Inline style applied to the floating overlay, under the dropdown's own positioning styles"
|
|
2162
|
+
},
|
|
2008
2163
|
{
|
|
2009
2164
|
"name": "outsidePressIgnoreRef",
|
|
2010
2165
|
"type": "RefObject<HTMLElement | null>",
|
|
@@ -2199,7 +2354,7 @@
|
|
|
2199
2354
|
"name": "Accordion",
|
|
2200
2355
|
"category": "Components_2_0",
|
|
2201
2356
|
"generation": "2.0",
|
|
2202
|
-
"description": "A collapsible panel that toggles its content when the header is clicked.\naliases: Collapse|Disclosure|ExpandablePanel\nDesign system 2.0\n\nWorks as a controlled component when `expanded` is provided, otherwise it manages\nits own state from `defaultExpanded`. The header shows a caret that rotates when\nexpanded, a title, and an optional description stacked beneath it.\n\nThe revealed content is a labelled `region`, so assistive tech announces it by the\nheader it belongs to. `nonCollapsible` renders the header as static text instead of\na permanently disabled button, which keeps a decorative panel out of the tab order.",
|
|
2357
|
+
"description": "A collapsible panel that toggles its content when the header is clicked.\naliases: Collapse|Disclosure|ExpandablePanel\nDesign system 2.0\n\nWorks as a controlled component when `expanded` is provided, otherwise it manages\nits own state from `defaultExpanded`. The header shows a caret that rotates when\nexpanded, a title, and an optional description stacked beneath it.\n\nThe revealed content is a labelled `region`, so assistive tech announces it by the\nheader it belongs to. It stays mounted while collapsed so it can slide open and shut,\nand is `inert` then, out of both the tab order and the accessibility tree. `nonCollapsible` renders the header as static text instead of\na permanently disabled button, which keeps a decorative panel out of the tab order.",
|
|
2203
2358
|
"props": [
|
|
2204
2359
|
{
|
|
2205
2360
|
"name": "title",
|
|
@@ -2256,6 +2411,13 @@
|
|
|
2256
2411
|
"required": false,
|
|
2257
2412
|
"description": "Fired when the header is clicked. Receives the next expanded state."
|
|
2258
2413
|
},
|
|
2414
|
+
{
|
|
2415
|
+
"name": "caretPosition",
|
|
2416
|
+
"type": "AccordionCaretPosition",
|
|
2417
|
+
"required": false,
|
|
2418
|
+
"defaultValue": "AccordionCaretPosition.End",
|
|
2419
|
+
"description": "Where the header draws its caret: before or after the title."
|
|
2420
|
+
},
|
|
2259
2421
|
{
|
|
2260
2422
|
"name": "className",
|
|
2261
2423
|
"type": "string",
|
|
@@ -2854,7 +3016,7 @@
|
|
|
2854
3016
|
"name": "Tabs",
|
|
2855
3017
|
"category": "Components_2_0",
|
|
2856
3018
|
"generation": "2.0",
|
|
2857
|
-
"description": "A
|
|
3019
|
+
"description": "A row or rail of tabs, marking the active one and showing optional icons and count badges.\naliases: TabRow|TabNavigation|TabBar|VerticalTabs|SettingsNav|SideNav\nDesign system 2.0\n\nFollows the ARIA tabs pattern with automatic activation: only the active tab is\nin the tab order, and the arrow keys move both focus and selection. `Home` and\n`End` jump to the first and last tab, and the arrows wrap around the ends.\nTabs marked `disabled` are greyed out, cannot be clicked, and are skipped by\nkeyboard navigation.\n\n`TabOrientation.Horizontal` draws the default row: the active tab takes a\ngradient underline, and `ArrowLeft` / `ArrowRight` move along it.\n`TabOrientation.Vertical` draws the settings-page rail instead — full-width\nrows with the active one on a tinted pill rather than an underline, driven by\n`ArrowUp` / `ArrowDown`. The rail is the shape to reach for when the tabs\nlabel whole pages of a settings surface; the row, when they filter one.\n\n`className` lands on whichever element is outermost: the heading wrapper when\n`sectionLabel` is set, the `role=\"tablist\"` itself when it is not.\n\nThe component renders the tabs only; the panels stay with the consumer.",
|
|
2858
3020
|
"props": [
|
|
2859
3021
|
{
|
|
2860
3022
|
"name": "tabs",
|
|
@@ -2874,6 +3036,19 @@
|
|
|
2874
3036
|
"required": true,
|
|
2875
3037
|
"description": "Fired with the tab's `id` when the user selects a tab."
|
|
2876
3038
|
},
|
|
3039
|
+
{
|
|
3040
|
+
"name": "orientation",
|
|
3041
|
+
"type": "TabOrientation",
|
|
3042
|
+
"required": false,
|
|
3043
|
+
"defaultValue": "TabOrientation.Horizontal",
|
|
3044
|
+
"description": "Layout direction of the tab list."
|
|
3045
|
+
},
|
|
3046
|
+
{
|
|
3047
|
+
"name": "sectionLabel",
|
|
3048
|
+
"type": "string",
|
|
3049
|
+
"required": false,
|
|
3050
|
+
"description": "Heading rendered above the tabs, which also names the tab list."
|
|
3051
|
+
},
|
|
2877
3052
|
{
|
|
2878
3053
|
"name": "ariaLabel",
|
|
2879
3054
|
"type": "string",
|
|
@@ -2884,20 +3059,92 @@
|
|
|
2884
3059
|
"name": "className",
|
|
2885
3060
|
"type": "string",
|
|
2886
3061
|
"required": false,
|
|
2887
|
-
"description": "Additional CSS classes for the
|
|
3062
|
+
"description": "Additional CSS classes for the root element."
|
|
3063
|
+
},
|
|
3064
|
+
{
|
|
3065
|
+
"name": "tabListClassName",
|
|
3066
|
+
"type": "string",
|
|
3067
|
+
"required": false,
|
|
3068
|
+
"description": "Additional CSS classes for the `role=\"tablist\"`."
|
|
2888
3069
|
},
|
|
2889
3070
|
{
|
|
2890
3071
|
"name": "tabClassName",
|
|
2891
3072
|
"type": "string",
|
|
2892
3073
|
"required": false,
|
|
2893
3074
|
"description": "Additional CSS classes applied to every tab."
|
|
3075
|
+
},
|
|
3076
|
+
{
|
|
3077
|
+
"name": "sectionLabelClassName",
|
|
3078
|
+
"type": "string",
|
|
3079
|
+
"required": false,
|
|
3080
|
+
"description": "Additional CSS classes for the `sectionLabel` heading."
|
|
2894
3081
|
}
|
|
2895
3082
|
],
|
|
2896
3083
|
"examples": [
|
|
2897
|
-
"<Tabs\n ariaLabel=\"Conversation views\"\n tabs={[\n { id: 'all', label: 'All', count: 12 },\n { id: 'shared', label: 'Shared with me' },\n ]}\n activeTabId={activeTabId}\n onTabChange={setActiveTabId}\n/>"
|
|
3084
|
+
"<Tabs\n ariaLabel=\"Conversation views\"\n tabs={[\n { id: 'all', label: 'All', count: 12 },\n { id: 'shared', label: 'Shared with me' },\n ]}\n activeTabId={activeTabId}\n onTabChange={setActiveTabId}\n/>",
|
|
3085
|
+
"<Tabs\norientation={TabOrientation.Vertical}\nsectionLabel={t('Settings')}\nclassName=\"w-[240px] shrink-0 border-e border-e-tertiary\"\ntabs={[\n{ id: 'preferences', label: t('Preferences'), icon: <IconSettings size={18} /> },\n{ id: 'usage', label: t('Usage'), icon: <IconChartBar size={18} /> },\n]}\nactiveTabId={activeTabId}\nonTabChange={setActiveTabId}\n/>"
|
|
2898
3086
|
],
|
|
2899
3087
|
"sourceFile": "components/New/Tabs/Tabs.tsx"
|
|
2900
3088
|
},
|
|
3089
|
+
{
|
|
3090
|
+
"name": "FilterChips",
|
|
3091
|
+
"category": "Components_2_0",
|
|
3092
|
+
"generation": "2.0",
|
|
3093
|
+
"description": "A row of filter chips that picks one value out of a few.\naliases: FilterChipRow|ChipTabs|TagTabs|FilterTabs\nDesign system 2.0\n\nThe chip-shaped sibling of the kit's other single-select rows, and the one to\nreach for when the options label a *subset of a list* — \"All\", \"Shared\",\n\"Mine\" above a history panel. `Tabs` underlines the active option and reads\nas navigation between panels; `SegmentedControl` sinks equal segments into a\ntrack and reads as a view switch. This one draws `TagAppearance.Selectable`\nchips: no fill until selected, and a semibold label once it is. Selecting a\nchip therefore widens it by the difference between the regular and semibold\nlabel — give the row `stretch`, or the chips a width, if that shift matters.\n\nEach chip is a toggle button carrying its state on `aria-pressed`, wrapped in\na named `role=\"group\"` — the pattern `Tag` is built for. That makes every\nchip its own tab stop, which is what a filter row wants: unlike a\n`radiogroup`, arrowing onto a chip never changes the filter by accident.\nName the group through `aria-label` or `aria-labelledby`, or the chips are\nannounced as a handful of unrelated toggles.\n\nThere is no disabled chip. An option the user must not pick is left out of\n`items` — a chip that renders but cannot be activated is a label and nothing\nelse, and `Tag` drops its button role when disabled, so it would not even\nannounce as unavailable.\n\nLabels are the caller's to translate — the component ships no English\ndefaults.",
|
|
3094
|
+
"props": [
|
|
3095
|
+
{
|
|
3096
|
+
"name": "items",
|
|
3097
|
+
"type": "FilterChipItem<T>[]",
|
|
3098
|
+
"required": true,
|
|
3099
|
+
"description": "Chips to render, in order; each needs a unique `value` and a `label`"
|
|
3100
|
+
},
|
|
3101
|
+
{
|
|
3102
|
+
"name": "value",
|
|
3103
|
+
"type": "T",
|
|
3104
|
+
"required": true,
|
|
3105
|
+
"description": "The `value` of the selected chip"
|
|
3106
|
+
},
|
|
3107
|
+
{
|
|
3108
|
+
"name": "onChange",
|
|
3109
|
+
"type": "(value: T) => void",
|
|
3110
|
+
"required": true,
|
|
3111
|
+
"description": "Called with the `value` of the chip the user picked. A click on the already-selected chip fires it again, so a row that clears back to a default handles that itself"
|
|
3112
|
+
},
|
|
3113
|
+
{
|
|
3114
|
+
"name": "stretch",
|
|
3115
|
+
"type": "boolean",
|
|
3116
|
+
"required": false,
|
|
3117
|
+
"defaultValue": "false",
|
|
3118
|
+
"description": "Grows the chips to share the row width equally instead of hugging their labels"
|
|
3119
|
+
},
|
|
3120
|
+
{
|
|
3121
|
+
"name": "className",
|
|
3122
|
+
"type": "string",
|
|
3123
|
+
"required": false,
|
|
3124
|
+
"description": "Additional classes for the row, e.g. its padding or `flex-wrap`"
|
|
3125
|
+
},
|
|
3126
|
+
{
|
|
3127
|
+
"name": "chipClassName",
|
|
3128
|
+
"type": "string",
|
|
3129
|
+
"required": false,
|
|
3130
|
+
"description": "Additional classes for every chip. A panel too narrow for the chips' default padding can tighten it here"
|
|
3131
|
+
},
|
|
3132
|
+
{
|
|
3133
|
+
"name": "'aria-label'",
|
|
3134
|
+
"type": "string",
|
|
3135
|
+
"required": false
|
|
3136
|
+
},
|
|
3137
|
+
{
|
|
3138
|
+
"name": "'aria-labelledby'",
|
|
3139
|
+
"type": "string",
|
|
3140
|
+
"required": false
|
|
3141
|
+
}
|
|
3142
|
+
],
|
|
3143
|
+
"examples": [
|
|
3144
|
+
"<FilterChips\n aria-label={t('Filter chats')}\n value={tab}\n onChange={setTab}\n items={[\n { value: 'all', label: t('All') },\n { value: 'mine', label: t('My chats') },\n { value: 'shared', label: t('Shared') },\n ]}\n/>"
|
|
3145
|
+
],
|
|
3146
|
+
"sourceFile": "components/New/FilterChips/FilterChips.tsx"
|
|
3147
|
+
},
|
|
2901
3148
|
{
|
|
2902
3149
|
"name": "FileDropzone",
|
|
2903
3150
|
"category": "Components_2_0",
|
|
@@ -2991,92 +3238,959 @@
|
|
|
2991
3238
|
"sourceFile": "components/New/FileDropzone/FileDropzone.tsx"
|
|
2992
3239
|
},
|
|
2993
3240
|
{
|
|
2994
|
-
"name": "
|
|
3241
|
+
"name": "FileIcon",
|
|
2995
3242
|
"category": "Components_2_0",
|
|
2996
3243
|
"generation": "2.0",
|
|
2997
|
-
"description": "
|
|
3244
|
+
"description": "The icon of a file or folder row in a file manager: a file-type glyph picked\nby extension, or a folder, with an optional shared badge and loading state.\naliases: FileTypeIcon|EntityIcon\nDesign system 2.0\n\nThe root is a `role=\"img\"` whose name says what the item is, and that it is\nshared — the badge itself is drawn inside the image, so its tooltip is a\npointer-only hint and never the only place the state is conveyed. While\n`loading`, the root drops the role and holds a `Spinner`, which announces\nitself as a status. Pass `decorative` when the row already names the item.",
|
|
2998
3245
|
"props": [
|
|
2999
3246
|
{
|
|
3000
|
-
"name": "
|
|
3001
|
-
"type": "
|
|
3247
|
+
"name": "type",
|
|
3248
|
+
"type": "DialItemType",
|
|
3002
3249
|
"required": true,
|
|
3003
|
-
"description": "
|
|
3250
|
+
"description": "Whether the item is a file or a folder"
|
|
3004
3251
|
},
|
|
3005
3252
|
{
|
|
3006
|
-
"name": "
|
|
3007
|
-
"type": "
|
|
3008
|
-
"required":
|
|
3009
|
-
"description": "
|
|
3253
|
+
"name": "name",
|
|
3254
|
+
"type": "string",
|
|
3255
|
+
"required": true,
|
|
3256
|
+
"description": "Item name; a file's extension is read from it"
|
|
3010
3257
|
},
|
|
3011
3258
|
{
|
|
3012
|
-
"name": "
|
|
3013
|
-
"type": "
|
|
3259
|
+
"name": "fileExtension",
|
|
3260
|
+
"type": "string",
|
|
3014
3261
|
"required": false,
|
|
3015
|
-
"
|
|
3016
|
-
"description": "`outlined` is the filled chip on the raised\nlayer; `selectable` is the unfilled filter chip that tints and turns semibold when selected."
|
|
3262
|
+
"description": "Extension overriding the one in `name`"
|
|
3017
3263
|
},
|
|
3018
3264
|
{
|
|
3019
|
-
"name": "
|
|
3265
|
+
"name": "shared",
|
|
3020
3266
|
"type": "boolean",
|
|
3021
3267
|
"required": false,
|
|
3022
3268
|
"defaultValue": "false",
|
|
3023
|
-
"description": "
|
|
3269
|
+
"description": "Draws the shared badge"
|
|
3024
3270
|
},
|
|
3025
3271
|
{
|
|
3026
|
-
"name": "
|
|
3272
|
+
"name": "loading",
|
|
3027
3273
|
"type": "boolean",
|
|
3028
3274
|
"required": false,
|
|
3029
3275
|
"defaultValue": "false",
|
|
3030
|
-
"description": "
|
|
3276
|
+
"description": "Replaces the glyph with a spinner"
|
|
3031
3277
|
},
|
|
3032
3278
|
{
|
|
3033
|
-
"name": "
|
|
3279
|
+
"name": "size",
|
|
3280
|
+
"type": "number",
|
|
3281
|
+
"required": false,
|
|
3282
|
+
"defaultValue": "DIAL_ICON_SIZE.MD",
|
|
3283
|
+
"description": "Glyph size in px"
|
|
3284
|
+
},
|
|
3285
|
+
{
|
|
3286
|
+
"name": "className",
|
|
3287
|
+
"type": "string",
|
|
3288
|
+
"required": false,
|
|
3289
|
+
"description": "Additional CSS classes for the root element"
|
|
3290
|
+
},
|
|
3291
|
+
{
|
|
3292
|
+
"name": "decorative",
|
|
3034
3293
|
"type": "boolean",
|
|
3035
3294
|
"required": false,
|
|
3036
3295
|
"defaultValue": "false",
|
|
3037
|
-
"description": "
|
|
3296
|
+
"description": "Hides the icon from assistive technology"
|
|
3038
3297
|
},
|
|
3039
3298
|
{
|
|
3040
|
-
"name": "
|
|
3299
|
+
"name": "label",
|
|
3041
3300
|
"type": "string",
|
|
3042
3301
|
"required": false,
|
|
3043
|
-
"description": "Accessible name
|
|
3302
|
+
"description": "Accessible name, overriding the generated one"
|
|
3044
3303
|
},
|
|
3045
3304
|
{
|
|
3046
|
-
"name": "
|
|
3047
|
-
"type": "
|
|
3305
|
+
"name": "loadingLabel",
|
|
3306
|
+
"type": "string",
|
|
3048
3307
|
"required": false,
|
|
3049
|
-
"
|
|
3308
|
+
"defaultValue": "'Loading'",
|
|
3309
|
+
"description": "Accessible name of the spinner"
|
|
3310
|
+
},
|
|
3311
|
+
{
|
|
3312
|
+
"name": "sharedIndicatorClassName",
|
|
3313
|
+
"type": "string",
|
|
3314
|
+
"required": false,
|
|
3315
|
+
"description": "Additional CSS classes for the shared badge"
|
|
3316
|
+
},
|
|
3317
|
+
{
|
|
3318
|
+
"name": "sharedIndicatorTooltip",
|
|
3319
|
+
"type": "ReactNode",
|
|
3320
|
+
"required": false,
|
|
3321
|
+
"description": "Tooltip shown over the shared badge"
|
|
3050
3322
|
}
|
|
3051
3323
|
],
|
|
3052
3324
|
"examples": [
|
|
3053
|
-
"<
|
|
3325
|
+
"<FileIcon name=\"report.pdf\" type={DialItemType.File} shared />\n<FileIcon name=\"Projects\" type={DialItemType.Folder} loading />"
|
|
3054
3326
|
],
|
|
3055
|
-
"sourceFile": "components/New/
|
|
3327
|
+
"sourceFile": "components/New/FileIcon/FileIcon.tsx"
|
|
3056
3328
|
},
|
|
3057
3329
|
{
|
|
3058
|
-
"name": "
|
|
3330
|
+
"name": "FileName",
|
|
3059
3331
|
"category": "Components_2_0",
|
|
3060
3332
|
"generation": "2.0",
|
|
3061
|
-
"description": "A
|
|
3333
|
+
"description": "A file or folder name with its type icon, truncated with a tooltip when it\ndoes not fit.\naliases: FileDisplay|NameDisplay\nDesign system 2.0\n\nThe visible name already says what the item is, so the icon is decorative;\nthe shared state, which only the badge shows, is announced by a\nvisually-hidden `sharedLabel` after the name instead.\n\nWhile `loading` the icon is swapped for a `Spinner`, which is left in the\naccessibility tree so the busy state is announced.\n\nWith `details` the text switches to two lines — the name, then the metadata.",
|
|
3062
3334
|
"props": [
|
|
3063
3335
|
{
|
|
3064
|
-
"name": "
|
|
3336
|
+
"name": "name",
|
|
3065
3337
|
"type": "string",
|
|
3066
|
-
"required":
|
|
3067
|
-
"description": "
|
|
3338
|
+
"required": true,
|
|
3339
|
+
"description": "Full item name, with or without an extension"
|
|
3068
3340
|
},
|
|
3069
3341
|
{
|
|
3070
|
-
"name": "
|
|
3071
|
-
"type": "
|
|
3342
|
+
"name": "type",
|
|
3343
|
+
"type": "DialItemType",
|
|
3072
3344
|
"required": false,
|
|
3073
|
-
"
|
|
3345
|
+
"defaultValue": "DialItemType.File",
|
|
3346
|
+
"description": "Whether the item is a file or a folder"
|
|
3074
3347
|
},
|
|
3075
3348
|
{
|
|
3076
|
-
"name": "
|
|
3077
|
-
"type": "string
|
|
3349
|
+
"name": "fileExtension",
|
|
3350
|
+
"type": "string",
|
|
3078
3351
|
"required": false,
|
|
3079
|
-
"description": "
|
|
3352
|
+
"description": "Extension overriding the one in `name`"
|
|
3353
|
+
},
|
|
3354
|
+
{
|
|
3355
|
+
"name": "shared",
|
|
3356
|
+
"type": "boolean",
|
|
3357
|
+
"required": false,
|
|
3358
|
+
"defaultValue": "false",
|
|
3359
|
+
"description": "Draws the shared badge on the icon"
|
|
3360
|
+
},
|
|
3361
|
+
{
|
|
3362
|
+
"name": "loading",
|
|
3363
|
+
"type": "boolean",
|
|
3364
|
+
"required": false,
|
|
3365
|
+
"defaultValue": "false",
|
|
3366
|
+
"description": "Replaces the icon with a spinner"
|
|
3367
|
+
},
|
|
3368
|
+
{
|
|
3369
|
+
"name": "loadingLabel",
|
|
3370
|
+
"type": "string",
|
|
3371
|
+
"required": false,
|
|
3372
|
+
"description": "Accessible name of the spinner"
|
|
3373
|
+
},
|
|
3374
|
+
{
|
|
3375
|
+
"name": "iconSize",
|
|
3376
|
+
"type": "number",
|
|
3377
|
+
"required": false,
|
|
3378
|
+
"description": "Icon size in px"
|
|
3379
|
+
},
|
|
3380
|
+
{
|
|
3381
|
+
"name": "details",
|
|
3382
|
+
"type": "ReactNode",
|
|
3383
|
+
"required": false,
|
|
3384
|
+
"description": "Metadata under the name"
|
|
3385
|
+
},
|
|
3386
|
+
{
|
|
3387
|
+
"name": "isInvalidName",
|
|
3388
|
+
"type": "boolean",
|
|
3389
|
+
"required": false,
|
|
3390
|
+
"defaultValue": "false",
|
|
3391
|
+
"description": "Mutes the name, marking it as invalid"
|
|
3392
|
+
},
|
|
3393
|
+
{
|
|
3394
|
+
"name": "className",
|
|
3395
|
+
"type": "string",
|
|
3396
|
+
"required": false,
|
|
3397
|
+
"description": "Additional CSS classes for the root element"
|
|
3398
|
+
},
|
|
3399
|
+
{
|
|
3400
|
+
"name": "nameClassName",
|
|
3401
|
+
"type": "string",
|
|
3402
|
+
"required": false,
|
|
3403
|
+
"description": "Additional CSS classes for the name text"
|
|
3404
|
+
},
|
|
3405
|
+
{
|
|
3406
|
+
"name": "sharedIndicatorClassName",
|
|
3407
|
+
"type": "string",
|
|
3408
|
+
"required": false,
|
|
3409
|
+
"description": "Additional CSS classes for the shared badge"
|
|
3410
|
+
},
|
|
3411
|
+
{
|
|
3412
|
+
"name": "sharedIndicatorTooltip",
|
|
3413
|
+
"type": "ReactNode",
|
|
3414
|
+
"required": false,
|
|
3415
|
+
"description": "Tooltip shown over the shared badge"
|
|
3416
|
+
},
|
|
3417
|
+
{
|
|
3418
|
+
"name": "sharedLabel",
|
|
3419
|
+
"type": "string",
|
|
3420
|
+
"required": false,
|
|
3421
|
+
"defaultValue": "'Shared'",
|
|
3422
|
+
"description": "Screen-reader text announcing the shared state"
|
|
3423
|
+
},
|
|
3424
|
+
{
|
|
3425
|
+
"name": "hideTooltip",
|
|
3426
|
+
"type": "boolean",
|
|
3427
|
+
"required": false,
|
|
3428
|
+
"defaultValue": "false",
|
|
3429
|
+
"description": "Suppresses the full-name tooltip"
|
|
3430
|
+
},
|
|
3431
|
+
{
|
|
3432
|
+
"name": "tooltipContent",
|
|
3433
|
+
"type": "ReactNode",
|
|
3434
|
+
"required": false,
|
|
3435
|
+
"description": "Shown instead of the full name while truncated"
|
|
3436
|
+
}
|
|
3437
|
+
],
|
|
3438
|
+
"examples": [
|
|
3439
|
+
"<FileName name=\"Document.pdf\" shared />\n<FileName\n name=\"Document.pdf\"\n details={<span className=\"dial-tiny-text text-secondary\">24 KB · Jul 20</span>}\n/>"
|
|
3440
|
+
],
|
|
3441
|
+
"sourceFile": "components/New/FileName/FileName.tsx"
|
|
3442
|
+
},
|
|
3443
|
+
{
|
|
3444
|
+
"name": "FolderName",
|
|
3445
|
+
"category": "Components_2_0",
|
|
3446
|
+
"generation": "2.0",
|
|
3447
|
+
"description": "A folder name with the folder icon, truncated with a tooltip when it does\nnot fit.\naliases: FolderDisplay|DirectoryName\nDesign system 2.0\n\nA `FileName` fixed to `DialItemType.Folder`, so it shares every behaviour of\nit — decorative icon, visually-hidden shared label, `details` line and the\n`loading` spinner. Its root carries `dial-kit-folder-name` on top of\n`dial-kit-file-name`.",
|
|
3448
|
+
"props": [],
|
|
3449
|
+
"examples": [
|
|
3450
|
+
"<FolderName name=\"Organization\" shared />\n<FolderName name=\"Uploads\" loading />"
|
|
3451
|
+
],
|
|
3452
|
+
"sourceFile": "components/New/FolderName/FolderName.tsx"
|
|
3453
|
+
},
|
|
3454
|
+
{
|
|
3455
|
+
"name": "SharedEntityIndicator",
|
|
3456
|
+
"category": "Components_2_0",
|
|
3457
|
+
"generation": "2.0",
|
|
3458
|
+
"description": "A small arrow badge marking an entity as shared.\naliases: SharedIcon|AccessIndicator\nDesign system 2.0\n\nA `role=\"img\"` named by `label`, so it can stand on its own. Placed inside a\nlarger `role=\"img\"` — as `FileIcon` does — its name is folded into the\nparent's, which is why `FileIcon` names the shared state itself. The tooltip\nis a pointer-only hint: the badge is not focusable, and the tooltip never\nreaches assistive technology, so `label` is what carries the meaning.",
|
|
3459
|
+
"props": [
|
|
3460
|
+
{
|
|
3461
|
+
"name": "label",
|
|
3462
|
+
"type": "string",
|
|
3463
|
+
"required": false,
|
|
3464
|
+
"defaultValue": "'Shared'",
|
|
3465
|
+
"description": "Accessible name of the badge"
|
|
3466
|
+
},
|
|
3467
|
+
{
|
|
3468
|
+
"name": "tooltip",
|
|
3469
|
+
"type": "ReactNode",
|
|
3470
|
+
"required": false,
|
|
3471
|
+
"description": "Tooltip shown while the badge is hovered"
|
|
3472
|
+
},
|
|
3473
|
+
{
|
|
3474
|
+
"name": "size",
|
|
3475
|
+
"type": "number",
|
|
3476
|
+
"required": false,
|
|
3477
|
+
"defaultValue": "12",
|
|
3478
|
+
"description": "Arrow size in px"
|
|
3479
|
+
},
|
|
3480
|
+
{
|
|
3481
|
+
"name": "className",
|
|
3482
|
+
"type": "string",
|
|
3483
|
+
"required": false,
|
|
3484
|
+
"description": "Additional CSS classes for the badge"
|
|
3485
|
+
}
|
|
3486
|
+
],
|
|
3487
|
+
"examples": [
|
|
3488
|
+
"<SharedEntityIndicator />\n<SharedEntityIndicator tooltip=\"Shared with 3 people\" className=\"absolute -bottom-0.5 -left-0.5\" />"
|
|
3489
|
+
],
|
|
3490
|
+
"sourceFile": "components/New/SharedEntityIndicator/SharedEntityIndicator.tsx"
|
|
3491
|
+
},
|
|
3492
|
+
{
|
|
3493
|
+
"name": "BottomSheet",
|
|
3494
|
+
"category": "Components_2_0",
|
|
3495
|
+
"generation": "2.0",
|
|
3496
|
+
"description": "A panel that slides up from the bottom edge over a dimmed page — the mobile\ncounterpart of `Popup`.\naliases: ActionSheet|Drawer|MobileSheet|BottomDrawer\nDesign system 2.0\n\nIt is a modal dialog: focus moves into it on open and stays there, returns\nto where it came from on close, and the page behind it does not scroll.\nEscape, the close button and a press on the backdrop all call `onClose`;\nthe sheet itself stays controlled by `open`.\n\nWith a `title` the header shows it centred, a close button at the end and,\nwhen `onBack` is set, a back button at the start for a sheet that drills\ninto pages of its own; the title also names the dialog. Without one there is\nno header, and `ariaLabel` names the sheet instead. The body scrolls once\nthe content is taller than 85% of the viewport.",
|
|
3497
|
+
"props": [
|
|
3498
|
+
{
|
|
3499
|
+
"name": "open",
|
|
3500
|
+
"type": "boolean",
|
|
3501
|
+
"required": true,
|
|
3502
|
+
"description": "Whether the sheet is shown"
|
|
3503
|
+
},
|
|
3504
|
+
{
|
|
3505
|
+
"name": "onClose",
|
|
3506
|
+
"type": "() => void",
|
|
3507
|
+
"required": true,
|
|
3508
|
+
"description": "Called when the sheet asks to close"
|
|
3509
|
+
},
|
|
3510
|
+
{
|
|
3511
|
+
"name": "title",
|
|
3512
|
+
"type": "string",
|
|
3513
|
+
"required": false,
|
|
3514
|
+
"description": "Title of the header; without it the sheet has no header"
|
|
3515
|
+
},
|
|
3516
|
+
{
|
|
3517
|
+
"name": "ariaLabel",
|
|
3518
|
+
"type": "string",
|
|
3519
|
+
"required": false,
|
|
3520
|
+
"description": "Accessible name when there is no `title`"
|
|
3521
|
+
},
|
|
3522
|
+
{
|
|
3523
|
+
"name": "onBack",
|
|
3524
|
+
"type": "() => void",
|
|
3525
|
+
"required": false,
|
|
3526
|
+
"description": "Shows a back button at the start of the header"
|
|
3527
|
+
},
|
|
3528
|
+
{
|
|
3529
|
+
"name": "backAriaLabel",
|
|
3530
|
+
"type": "string",
|
|
3531
|
+
"required": false,
|
|
3532
|
+
"defaultValue": "'Back'",
|
|
3533
|
+
"description": "Accessible name of the back button"
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
"name": "closeAriaLabel",
|
|
3537
|
+
"type": "string",
|
|
3538
|
+
"required": false,
|
|
3539
|
+
"defaultValue": "'Close'",
|
|
3540
|
+
"description": "Accessible name of the close button"
|
|
3541
|
+
},
|
|
3542
|
+
{
|
|
3543
|
+
"name": "closeOnOutsideClick",
|
|
3544
|
+
"type": "boolean",
|
|
3545
|
+
"required": false,
|
|
3546
|
+
"defaultValue": "true",
|
|
3547
|
+
"description": "Whether a press on the backdrop closes the sheet"
|
|
3548
|
+
},
|
|
3549
|
+
{
|
|
3550
|
+
"name": "children",
|
|
3551
|
+
"type": "ReactNode",
|
|
3552
|
+
"required": false,
|
|
3553
|
+
"description": "Content of the sheet"
|
|
3554
|
+
},
|
|
3555
|
+
{
|
|
3556
|
+
"name": "className",
|
|
3557
|
+
"type": "string",
|
|
3558
|
+
"required": false,
|
|
3559
|
+
"description": "Additional CSS classes for the sheet panel"
|
|
3560
|
+
},
|
|
3561
|
+
{
|
|
3562
|
+
"name": "overlayClassName",
|
|
3563
|
+
"type": "string",
|
|
3564
|
+
"required": false,
|
|
3565
|
+
"description": "Additional CSS classes for the backdrop"
|
|
3566
|
+
},
|
|
3567
|
+
{
|
|
3568
|
+
"name": "headerClassName",
|
|
3569
|
+
"type": "string",
|
|
3570
|
+
"required": false,
|
|
3571
|
+
"description": "Additional CSS classes for the header row"
|
|
3572
|
+
},
|
|
3573
|
+
{
|
|
3574
|
+
"name": "style",
|
|
3575
|
+
"type": "CSSProperties",
|
|
3576
|
+
"required": false,
|
|
3577
|
+
"description": "Inline style for the panel, e.g. custom properties"
|
|
3578
|
+
},
|
|
3579
|
+
{
|
|
3580
|
+
"name": "overlayStyle",
|
|
3581
|
+
"type": "CSSProperties",
|
|
3582
|
+
"required": false,
|
|
3583
|
+
"description": "Inline style for the backdrop"
|
|
3584
|
+
},
|
|
3585
|
+
{
|
|
3586
|
+
"name": "bodyClassName",
|
|
3587
|
+
"type": "string",
|
|
3588
|
+
"required": false,
|
|
3589
|
+
"description": "Additional CSS classes for the scrolling body"
|
|
3590
|
+
},
|
|
3591
|
+
{
|
|
3592
|
+
"name": "titleClassName",
|
|
3593
|
+
"type": "string",
|
|
3594
|
+
"required": false,
|
|
3595
|
+
"description": "Type-scale class for the title"
|
|
3596
|
+
},
|
|
3597
|
+
{
|
|
3598
|
+
"name": "portalId",
|
|
3599
|
+
"type": "string",
|
|
3600
|
+
"required": false,
|
|
3601
|
+
"description": "Id of the element to portal into"
|
|
3602
|
+
}
|
|
3603
|
+
],
|
|
3604
|
+
"examples": [
|
|
3605
|
+
"<BottomSheet open={isOpen} title=\"Select model\" onClose={() => setIsOpen(false)}>\n <ModelList />\n</BottomSheet>"
|
|
3606
|
+
],
|
|
3607
|
+
"sourceFile": "components/New/BottomSheet/BottomSheet.tsx"
|
|
3608
|
+
},
|
|
3609
|
+
{
|
|
3610
|
+
"name": "Badge",
|
|
3611
|
+
"category": "Components_2_0",
|
|
3612
|
+
"generation": "2.0",
|
|
3613
|
+
"description": "A short, static label: a topic, a category, or a status that is not a\ncontrol.\naliases: Label|StatusLabel|Pill|Chip\nDesign system 2.0\n\nUnlike `Tag`, a badge never responds to the pointer and never removes\nitself — reach for `Tag` when the label is something to select, filter by or\ndismiss. The badge is 24px tall and does not wrap; a long label keeps its\nwidth, so give the badge a `max-w-*` and a truncating `textClassName` where\nthat matters.\n\n`BadgeVariant.Outlined` is the neutral label, bordered on the sunken layer.\n`BadgeVariant.Filled` is a pill in one of the theme's visual colours, for\nlabels that are told apart by colour — so pair the colour with text that\nsays the same thing, since colour alone does not reach every reader. The\nfilled variant's type scale is a lead style, which uppercases itself: pass\nthe label in sentence case.",
|
|
3614
|
+
"props": [
|
|
3615
|
+
{
|
|
3616
|
+
"name": "label",
|
|
3617
|
+
"type": "string",
|
|
3618
|
+
"required": true,
|
|
3619
|
+
"description": "Text of the badge"
|
|
3620
|
+
},
|
|
3621
|
+
{
|
|
3622
|
+
"name": "variant",
|
|
3623
|
+
"type": "BadgeVariant",
|
|
3624
|
+
"required": false,
|
|
3625
|
+
"defaultValue": "BadgeVariant.Outlined",
|
|
3626
|
+
"description": "How the badge is drawn"
|
|
3627
|
+
},
|
|
3628
|
+
{
|
|
3629
|
+
"name": "color",
|
|
3630
|
+
"type": "BadgeColor",
|
|
3631
|
+
"required": false,
|
|
3632
|
+
"defaultValue": "BadgeColor.Blue",
|
|
3633
|
+
"description": "Visual colour of a filled badge"
|
|
3634
|
+
},
|
|
3635
|
+
{
|
|
3636
|
+
"name": "icon",
|
|
3637
|
+
"type": "ReactNode",
|
|
3638
|
+
"required": false,
|
|
3639
|
+
"description": "Decorative icon before the label"
|
|
3640
|
+
},
|
|
3641
|
+
{
|
|
3642
|
+
"name": "textClassName",
|
|
3643
|
+
"type": "string",
|
|
3644
|
+
"required": false,
|
|
3645
|
+
"description": "Type-scale class for the label, replacing the variant's own"
|
|
3646
|
+
}
|
|
3647
|
+
],
|
|
3648
|
+
"examples": [
|
|
3649
|
+
"<Badge label=\"Translation\" />\n<Badge label=\"Featured\" variant={BadgeVariant.Filled} color={BadgeColor.Green} />"
|
|
3650
|
+
],
|
|
3651
|
+
"sourceFile": "components/New/Badge/Badge.tsx"
|
|
3652
|
+
},
|
|
3653
|
+
{
|
|
3654
|
+
"name": "Avatar",
|
|
3655
|
+
"category": "Components_2_0",
|
|
3656
|
+
"generation": "2.0",
|
|
3657
|
+
"description": "A person's or an entity's picture, or its initials on a colour picked from\nits name.\naliases: UserAvatar|InitialsAvatar|ProfilePicture\nDesign system 2.0\n\nThe same name always gets the same colour, drawn from the theme's visual\ntokens, so a list of avatars stays stable between renders and sessions. An\nimage that is missing or fails to load falls back to the initials; a new\n`src` tries the image again.\n\nAn avatar with an `alt` is a `role=\"img\"` named by it, whether it shows the\nimage or the initials. Without one it is decorative and hidden from\nassistive technology, which is right when a visible name sits beside it.",
|
|
3658
|
+
"props": [
|
|
3659
|
+
{
|
|
3660
|
+
"name": "name",
|
|
3661
|
+
"type": "string",
|
|
3662
|
+
"required": true,
|
|
3663
|
+
"description": "Display name the initials and the colour are derived from"
|
|
3664
|
+
},
|
|
3665
|
+
{
|
|
3666
|
+
"name": "initials",
|
|
3667
|
+
"type": "string",
|
|
3668
|
+
"required": false,
|
|
3669
|
+
"description": "Initials to show instead of the ones derived from `name`"
|
|
3670
|
+
},
|
|
3671
|
+
{
|
|
3672
|
+
"name": "src",
|
|
3673
|
+
"type": "string",
|
|
3674
|
+
"required": false,
|
|
3675
|
+
"description": "Image URL; the initials show while it is missing or broken"
|
|
3676
|
+
},
|
|
3677
|
+
{
|
|
3678
|
+
"name": "alt",
|
|
3679
|
+
"type": "string",
|
|
3680
|
+
"required": false,
|
|
3681
|
+
"defaultValue": "''",
|
|
3682
|
+
"description": "Accessible name; empty makes the avatar decorative"
|
|
3683
|
+
},
|
|
3684
|
+
{
|
|
3685
|
+
"name": "size",
|
|
3686
|
+
"type": "number",
|
|
3687
|
+
"required": false,
|
|
3688
|
+
"defaultValue": "32",
|
|
3689
|
+
"description": "Width and height in px"
|
|
3690
|
+
},
|
|
3691
|
+
{
|
|
3692
|
+
"name": "shape",
|
|
3693
|
+
"type": "AvatarShape",
|
|
3694
|
+
"required": false,
|
|
3695
|
+
"defaultValue": "AvatarShape.Circle",
|
|
3696
|
+
"description": "Outline of the avatar"
|
|
3697
|
+
},
|
|
3698
|
+
{
|
|
3699
|
+
"name": "className",
|
|
3700
|
+
"type": "string",
|
|
3701
|
+
"required": false,
|
|
3702
|
+
"description": "Additional CSS classes for the avatar"
|
|
3703
|
+
},
|
|
3704
|
+
{
|
|
3705
|
+
"name": "textClassName",
|
|
3706
|
+
"type": "string",
|
|
3707
|
+
"required": false,
|
|
3708
|
+
"description": "Type-scale class for the initials, replacing the size-derived font size"
|
|
3709
|
+
},
|
|
3710
|
+
{
|
|
3711
|
+
"name": "onImageError",
|
|
3712
|
+
"type": "(event: SyntheticEvent<HTMLImageElement>) => void",
|
|
3713
|
+
"required": false,
|
|
3714
|
+
"description": "Called when the image fails to load"
|
|
3715
|
+
}
|
|
3716
|
+
],
|
|
3717
|
+
"examples": [
|
|
3718
|
+
"<Avatar name=\"Ada Lovelace\" src={photoUrl} alt=\"Ada Lovelace\" />\n<Avatar name=\"Summarizer\" shape={AvatarShape.Square} size={36} />"
|
|
3719
|
+
],
|
|
3720
|
+
"sourceFile": "components/New/Avatar/Avatar.tsx"
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"name": "EntityIdentity",
|
|
3724
|
+
"category": "Components_2_0",
|
|
3725
|
+
"generation": "2.0",
|
|
3726
|
+
"description": "The identity block of a DIAL entity: its icon, a coloured type label, the\nname and the version, with an optional featured chip.\naliases: EntityHeader|ModelHeader|AppIdentity\nDesign system 2.0\n\nThe type label is plain uppercase text coloured by `item.type`. The icon is\na square `Avatar`, so a missing or broken image falls back to the initials of\nthe name. The icon is decorative: the name next to it already names the\nentity.",
|
|
3727
|
+
"props": [
|
|
3728
|
+
{
|
|
3729
|
+
"name": "item",
|
|
3730
|
+
"type": "EntityIdentityItem",
|
|
3731
|
+
"required": true,
|
|
3732
|
+
"description": "The entity to display"
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
"name": "labels",
|
|
3736
|
+
"type": "EntityIdentityLabels",
|
|
3737
|
+
"required": false,
|
|
3738
|
+
"description": "User-visible strings"
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"name": "showVersion",
|
|
3742
|
+
"type": "boolean",
|
|
3743
|
+
"required": false,
|
|
3744
|
+
"defaultValue": "true",
|
|
3745
|
+
"description": "Whether to show the version"
|
|
3746
|
+
},
|
|
3747
|
+
{
|
|
3748
|
+
"name": "hasFeaturedTag",
|
|
3749
|
+
"type": "boolean",
|
|
3750
|
+
"required": false,
|
|
3751
|
+
"defaultValue": "true",
|
|
3752
|
+
"description": "Whether to show the featured chip for a featured entity"
|
|
3753
|
+
},
|
|
3754
|
+
{
|
|
3755
|
+
"name": "iconSize",
|
|
3756
|
+
"type": "number",
|
|
3757
|
+
"required": false,
|
|
3758
|
+
"defaultValue": "48",
|
|
3759
|
+
"description": "Icon size in px"
|
|
3760
|
+
},
|
|
3761
|
+
{
|
|
3762
|
+
"name": "headingLevel",
|
|
3763
|
+
"type": "number",
|
|
3764
|
+
"required": false,
|
|
3765
|
+
"defaultValue": "3",
|
|
3766
|
+
"description": "Heading level of the name"
|
|
3767
|
+
},
|
|
3768
|
+
{
|
|
3769
|
+
"name": "query",
|
|
3770
|
+
"type": "string",
|
|
3771
|
+
"required": false,
|
|
3772
|
+
"description": "Search query highlighted in the name"
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
"name": "footer",
|
|
3776
|
+
"type": "ReactNode",
|
|
3777
|
+
"required": false,
|
|
3778
|
+
"description": "Content pinned to the bottom of the text column"
|
|
3779
|
+
},
|
|
3780
|
+
{
|
|
3781
|
+
"name": "statusBadge",
|
|
3782
|
+
"type": "ReactNode",
|
|
3783
|
+
"required": false,
|
|
3784
|
+
"description": "Badge in the top-end corner"
|
|
3785
|
+
},
|
|
3786
|
+
{
|
|
3787
|
+
"name": "className",
|
|
3788
|
+
"type": "string",
|
|
3789
|
+
"required": false
|
|
3790
|
+
},
|
|
3791
|
+
{
|
|
3792
|
+
"name": "nameClassName",
|
|
3793
|
+
"type": "string",
|
|
3794
|
+
"required": false,
|
|
3795
|
+
"defaultValue": "'dial-h3-text'"
|
|
3796
|
+
},
|
|
3797
|
+
{
|
|
3798
|
+
"name": "typeClassName",
|
|
3799
|
+
"type": "string",
|
|
3800
|
+
"required": false,
|
|
3801
|
+
"defaultValue": "'dial-caption-lead-semi-text'"
|
|
3802
|
+
},
|
|
3803
|
+
{
|
|
3804
|
+
"name": "versionClassName",
|
|
3805
|
+
"type": "string",
|
|
3806
|
+
"required": false,
|
|
3807
|
+
"defaultValue": "'dial-tiny-text'"
|
|
3808
|
+
},
|
|
3809
|
+
{
|
|
3810
|
+
"name": "iconClassName",
|
|
3811
|
+
"type": "string",
|
|
3812
|
+
"required": false
|
|
3813
|
+
},
|
|
3814
|
+
{
|
|
3815
|
+
"name": "featuredChipClassName",
|
|
3816
|
+
"type": "string",
|
|
3817
|
+
"required": false
|
|
3818
|
+
}
|
|
3819
|
+
],
|
|
3820
|
+
"examples": [
|
|
3821
|
+
"<EntityIdentity\n item={{ type: EntityType.Model, name: 'GPT-4o', version: '2024-11-20' }}\n labels={{ type: t('Model') }}\n/>"
|
|
3822
|
+
],
|
|
3823
|
+
"sourceFile": "components/New/EntityIdentity/EntityIdentity.tsx"
|
|
3824
|
+
},
|
|
3825
|
+
{
|
|
3826
|
+
"name": "SideDrawer",
|
|
3827
|
+
"category": "Components_2_0",
|
|
3828
|
+
"generation": "2.0",
|
|
3829
|
+
"description": "A full-height panel that slides in from the inline end over a dimmed page.\naliases: Drawer|SidePanel|SideSheet|DetailsPanel\nDesign system 2.0\n\nIt is a modal dialog while open: focus moves to the panel and stays inside,\nreturns to where it came from on close, and the page behind it does not\nscroll. Escape, the close button and a press on the backdrop all call\n`onClose`; the drawer stays controlled by `open`.\n\nThe panel stays mounted while closed, so it can slide out as well as in and\nkeep the state of whatever it holds. Closed, it is `inert` — out of both\nthe tab order and the accessibility tree — and the backdrop lets pointer\nevents through. On desktop the drawer is 540px wide with a rounded,\nbordered leading edge; on mobile it takes the full width. It slides from\nthe end in either direction, and not at all under `prefers-reduced-motion`.\n\nThe header follows `Popup`: an optional back button, the title,\n`headerActions`, and the close button. A string `header` renders an `<h2>`\nthat names the dialog; for a node, pass `ariaLabel`.",
|
|
3830
|
+
"props": [
|
|
3831
|
+
{
|
|
3832
|
+
"name": "open",
|
|
3833
|
+
"type": "boolean",
|
|
3834
|
+
"required": true,
|
|
3835
|
+
"description": "Whether the drawer is open"
|
|
3836
|
+
},
|
|
3837
|
+
{
|
|
3838
|
+
"name": "onClose",
|
|
3839
|
+
"type": "() => void",
|
|
3840
|
+
"required": true,
|
|
3841
|
+
"description": "Called when the drawer asks to close"
|
|
3842
|
+
},
|
|
3843
|
+
{
|
|
3844
|
+
"name": "header",
|
|
3845
|
+
"type": "ReactNode",
|
|
3846
|
+
"required": false,
|
|
3847
|
+
"description": "Header title; a string also names the dialog"
|
|
3848
|
+
},
|
|
3849
|
+
{
|
|
3850
|
+
"name": "ariaLabel",
|
|
3851
|
+
"type": "string",
|
|
3852
|
+
"required": false,
|
|
3853
|
+
"description": "Accessible name when `header` is not a string"
|
|
3854
|
+
},
|
|
3855
|
+
{
|
|
3856
|
+
"name": "headerActions",
|
|
3857
|
+
"type": "ReactNode",
|
|
3858
|
+
"required": false,
|
|
3859
|
+
"description": "Controls between the title and the close button"
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"name": "onBack",
|
|
3863
|
+
"type": "() => void",
|
|
3864
|
+
"required": false,
|
|
3865
|
+
"description": "Shows a back button at the start of the header"
|
|
3866
|
+
},
|
|
3867
|
+
{
|
|
3868
|
+
"name": "backAriaLabel",
|
|
3869
|
+
"type": "string",
|
|
3870
|
+
"required": false,
|
|
3871
|
+
"defaultValue": "'Back'",
|
|
3872
|
+
"description": "Accessible name of the back button"
|
|
3873
|
+
},
|
|
3874
|
+
{
|
|
3875
|
+
"name": "backDisabled",
|
|
3876
|
+
"type": "boolean",
|
|
3877
|
+
"required": false,
|
|
3878
|
+
"defaultValue": "false",
|
|
3879
|
+
"description": "Whether the back button is disabled"
|
|
3880
|
+
},
|
|
3881
|
+
{
|
|
3882
|
+
"name": "closeAriaLabel",
|
|
3883
|
+
"type": "string",
|
|
3884
|
+
"required": false,
|
|
3885
|
+
"defaultValue": "'Close'",
|
|
3886
|
+
"description": "Accessible name of the close button"
|
|
3887
|
+
},
|
|
3888
|
+
{
|
|
3889
|
+
"name": "closeDisabled",
|
|
3890
|
+
"type": "boolean",
|
|
3891
|
+
"required": false,
|
|
3892
|
+
"defaultValue": "false",
|
|
3893
|
+
"description": "Whether the close button is disabled"
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
"name": "hideClose",
|
|
3897
|
+
"type": "boolean",
|
|
3898
|
+
"required": false,
|
|
3899
|
+
"defaultValue": "false",
|
|
3900
|
+
"description": "Whether the close button is left out"
|
|
3901
|
+
},
|
|
3902
|
+
{
|
|
3903
|
+
"name": "closeOnOutsideClick",
|
|
3904
|
+
"type": "boolean",
|
|
3905
|
+
"required": false,
|
|
3906
|
+
"defaultValue": "true",
|
|
3907
|
+
"description": "Whether a press on the backdrop closes the drawer"
|
|
3908
|
+
},
|
|
3909
|
+
{
|
|
3910
|
+
"name": "children",
|
|
3911
|
+
"type": "ReactNode",
|
|
3912
|
+
"required": false,
|
|
3913
|
+
"description": "Content of the drawer"
|
|
3914
|
+
},
|
|
3915
|
+
{
|
|
3916
|
+
"name": "className",
|
|
3917
|
+
"type": "string",
|
|
3918
|
+
"required": false,
|
|
3919
|
+
"description": "Additional CSS classes for the drawer panel"
|
|
3920
|
+
},
|
|
3921
|
+
{
|
|
3922
|
+
"name": "overlayClassName",
|
|
3923
|
+
"type": "string",
|
|
3924
|
+
"required": false,
|
|
3925
|
+
"description": "Additional CSS classes for the backdrop"
|
|
3926
|
+
},
|
|
3927
|
+
{
|
|
3928
|
+
"name": "headerClassName",
|
|
3929
|
+
"type": "string",
|
|
3930
|
+
"required": false,
|
|
3931
|
+
"description": "Additional CSS classes for the header row"
|
|
3932
|
+
},
|
|
3933
|
+
{
|
|
3934
|
+
"name": "style",
|
|
3935
|
+
"type": "CSSProperties",
|
|
3936
|
+
"required": false,
|
|
3937
|
+
"description": "Inline style for the panel, e.g. custom properties"
|
|
3938
|
+
},
|
|
3939
|
+
{
|
|
3940
|
+
"name": "overlayStyle",
|
|
3941
|
+
"type": "CSSProperties",
|
|
3942
|
+
"required": false,
|
|
3943
|
+
"description": "Inline style for the backdrop"
|
|
3944
|
+
},
|
|
3945
|
+
{
|
|
3946
|
+
"name": "bodyClassName",
|
|
3947
|
+
"type": "string",
|
|
3948
|
+
"required": false,
|
|
3949
|
+
"description": "Additional CSS classes for the scrolling body"
|
|
3950
|
+
},
|
|
3951
|
+
{
|
|
3952
|
+
"name": "titleClassName",
|
|
3953
|
+
"type": "string",
|
|
3954
|
+
"required": false,
|
|
3955
|
+
"description": "Type-scale class for a string title"
|
|
3956
|
+
},
|
|
3957
|
+
{
|
|
3958
|
+
"name": "portalId",
|
|
3959
|
+
"type": "string",
|
|
3960
|
+
"required": false,
|
|
3961
|
+
"description": "Id of the element to portal into"
|
|
3962
|
+
}
|
|
3963
|
+
],
|
|
3964
|
+
"examples": [
|
|
3965
|
+
"<SideDrawer open={isOpen} header=\"Publish\" onClose={() => setIsOpen(false)}>\n <PublishForm />\n</SideDrawer>"
|
|
3966
|
+
],
|
|
3967
|
+
"sourceFile": "components/New/SideDrawer/SideDrawer.tsx"
|
|
3968
|
+
},
|
|
3969
|
+
{
|
|
3970
|
+
"name": "Tag",
|
|
3971
|
+
"category": "Components_2_0",
|
|
3972
|
+
"generation": "2.0",
|
|
3973
|
+
"description": "A compact label element used for selections, filters, or categories.\naliases: Chip|Pill\nDesign system 2.0\n\nThe tag has one height — the 32px pill of the 2.0 design. There is no `size`\nprop: a tag sizes itself, and a caller that needs a different height is\nusually reaching for a button.\n\nThe label truncates rather than wrapping, and carries a native `title` so the\nfull text stays reachable when it does.\n\nA tag with `onClick` becomes a `role=\"button\"` operable with Enter and Space.\nIts remove control is a real nested `<button>`, so keep the two roles apart in\nthe caller: a clickable tag that is also closable gives a screen reader two\nactions with no way to tell which one it landed on.\n\nNo tag draws a rim; the two appearances are told apart by their fill.\n`TagAppearance.Selectable` is the filter chip of the 2.0 design: no fill\nat all until it is selected, one hover tint shared by both states, a semibold\nlabel once selected, and the state carried on `aria-pressed` rather than by\nthe tint alone. Give it an `onClick` — a selectable tag that cannot be\nactivated is a colour and nothing else.\n\nSelecting one therefore changes its width by the difference between the\nregular and semibold label. In a wrapping filter row that is what the design\nasks for; if a fixed width matters, give the chip one.",
|
|
3974
|
+
"props": [
|
|
3975
|
+
{
|
|
3976
|
+
"name": "label",
|
|
3977
|
+
"type": "string",
|
|
3978
|
+
"required": true,
|
|
3979
|
+
"description": "Text content displayed inside the tag."
|
|
3980
|
+
},
|
|
3981
|
+
{
|
|
3982
|
+
"name": "icon",
|
|
3983
|
+
"type": "ReactNode",
|
|
3984
|
+
"required": false,
|
|
3985
|
+
"description": "Icon rendered before the label."
|
|
3986
|
+
},
|
|
3987
|
+
{
|
|
3988
|
+
"name": "appearance",
|
|
3989
|
+
"type": "TagAppearance",
|
|
3990
|
+
"required": false,
|
|
3991
|
+
"defaultValue": "TagAppearance.Outlined",
|
|
3992
|
+
"description": "`outlined` is the filled chip on the raised\nlayer; `selectable` is the unfilled filter chip that tints and turns semibold when selected."
|
|
3993
|
+
},
|
|
3994
|
+
{
|
|
3995
|
+
"name": "selected",
|
|
3996
|
+
"type": "boolean",
|
|
3997
|
+
"required": false,
|
|
3998
|
+
"defaultValue": "false",
|
|
3999
|
+
"description": "Applies the accent-tinted selected styling."
|
|
4000
|
+
},
|
|
4001
|
+
{
|
|
4002
|
+
"name": "disabled",
|
|
4003
|
+
"type": "boolean",
|
|
4004
|
+
"required": false,
|
|
4005
|
+
"defaultValue": "false",
|
|
4006
|
+
"description": "Stops the tag responding: no click handling, no remove control. The design defines no disabled tag, so the colours stay put."
|
|
4007
|
+
},
|
|
4008
|
+
{
|
|
4009
|
+
"name": "closable",
|
|
4010
|
+
"type": "boolean",
|
|
4011
|
+
"required": false,
|
|
4012
|
+
"defaultValue": "false",
|
|
4013
|
+
"description": "Renders the remove button. Needs `onRemove` to appear."
|
|
4014
|
+
},
|
|
4015
|
+
{
|
|
4016
|
+
"name": "removeLabel",
|
|
4017
|
+
"type": "string",
|
|
4018
|
+
"required": false,
|
|
4019
|
+
"description": "Accessible name of the remove button; defaults to `Remove <label>`."
|
|
4020
|
+
},
|
|
4021
|
+
{
|
|
4022
|
+
"name": "onRemove",
|
|
4023
|
+
"type": "(event: MouseEvent<HTMLButtonElement>) => void",
|
|
4024
|
+
"required": false,
|
|
4025
|
+
"description": "Called when the remove button is clicked. The click does not bubble to `onClick`."
|
|
4026
|
+
}
|
|
4027
|
+
],
|
|
4028
|
+
"examples": [
|
|
4029
|
+
"<Tag label=\"TypeScript\" />\n<Tag label=\"TypeScript\" closable onRemove={() => remove('TypeScript')} />\n<Tag label=\"Drafts\" selected onClick={() => toggle('Drafts')} />\n<Tag\n label=\"Drafts\"\n appearance={TagAppearance.Selectable}\n selected={isSelected}\n onClick={() => toggle('Drafts')}\n/>"
|
|
4030
|
+
],
|
|
4031
|
+
"sourceFile": "components/New/Tag/Tag.tsx"
|
|
4032
|
+
},
|
|
4033
|
+
{
|
|
4034
|
+
"name": "TagInput",
|
|
4035
|
+
"category": "Components_2_0",
|
|
4036
|
+
"generation": "2.0",
|
|
4037
|
+
"description": "A tag input field: type a value and commit it with Enter or comma.\naliases: MultiTag|TagField|ChipInput\nDesign system 2.0\n\nThe field is an , so it carries the 2.0 field styling, sizes,\nlabel, caption and error states, and the tags render as s in its\ncontent slot. The field grows as tags wrap, unless `collapseTagOverflow` keeps\nthem on one line behind a `+N` chip.\n\nWorks controlled (`value` + `onChange`) or uncontrolled (`defaultValue`).\nDuplicate tags are ignored. Backspace on an empty input removes the last tag.",
|
|
4038
|
+
"props": [
|
|
4039
|
+
{
|
|
4040
|
+
"name": "id",
|
|
4041
|
+
"type": "string",
|
|
4042
|
+
"required": false,
|
|
4043
|
+
"description": "The id of the text input, linked to the label."
|
|
4044
|
+
},
|
|
4045
|
+
{
|
|
4046
|
+
"name": "value",
|
|
4047
|
+
"type": "string[]",
|
|
4048
|
+
"required": false,
|
|
4049
|
+
"description": "Controlled tag list."
|
|
4050
|
+
},
|
|
4051
|
+
{
|
|
4052
|
+
"name": "defaultValue",
|
|
4053
|
+
"type": "string[]",
|
|
4054
|
+
"required": false,
|
|
4055
|
+
"description": "Initial tag list when uncontrolled."
|
|
4056
|
+
},
|
|
4057
|
+
{
|
|
4058
|
+
"name": "size",
|
|
4059
|
+
"type": "ElementSize",
|
|
4060
|
+
"required": false,
|
|
4061
|
+
"defaultValue": "ElementSize.Standard",
|
|
4062
|
+
"description": "Field height: standard is 40px, small is 24px."
|
|
4063
|
+
},
|
|
4064
|
+
{
|
|
4065
|
+
"name": "labelProps",
|
|
4066
|
+
"type": "LabelProps",
|
|
4067
|
+
"required": false,
|
|
4068
|
+
"description": "Props of the rendered above the field."
|
|
4069
|
+
},
|
|
4070
|
+
{
|
|
4071
|
+
"name": "placeholder",
|
|
4072
|
+
"type": "string",
|
|
4073
|
+
"required": false,
|
|
4074
|
+
"description": "Placeholder shown while there are no tags."
|
|
4075
|
+
},
|
|
4076
|
+
{
|
|
4077
|
+
"name": "caption",
|
|
4078
|
+
"type": "string",
|
|
4079
|
+
"required": false,
|
|
4080
|
+
"description": "Helper text rendered below the field when there is no `error`."
|
|
4081
|
+
},
|
|
4082
|
+
{
|
|
4083
|
+
"name": "error",
|
|
4084
|
+
"type": "string",
|
|
4085
|
+
"required": false,
|
|
4086
|
+
"description": "Error message rendered below the field (pass `invalid` too for error styling)."
|
|
4087
|
+
},
|
|
4088
|
+
{
|
|
4089
|
+
"name": "invalid",
|
|
4090
|
+
"type": "boolean",
|
|
4091
|
+
"required": false,
|
|
4092
|
+
"description": "Applies the field's error styling."
|
|
4093
|
+
},
|
|
4094
|
+
{
|
|
4095
|
+
"name": "disabled",
|
|
4096
|
+
"type": "boolean",
|
|
4097
|
+
"required": false,
|
|
4098
|
+
"defaultValue": "false",
|
|
4099
|
+
"description": "Disables typing and tag removal."
|
|
4100
|
+
},
|
|
4101
|
+
{
|
|
4102
|
+
"name": "readOnly",
|
|
4103
|
+
"type": "boolean",
|
|
4104
|
+
"required": false,
|
|
4105
|
+
"defaultValue": "false",
|
|
4106
|
+
"description": "Shows the tags without allowing new ones or removal."
|
|
4107
|
+
},
|
|
4108
|
+
{
|
|
4109
|
+
"name": "collapseTagOverflow",
|
|
4110
|
+
"type": "boolean",
|
|
4111
|
+
"required": false,
|
|
4112
|
+
"defaultValue": "false",
|
|
4113
|
+
"description": "Keep the tags on one line, replacing the ones that do not fit with a `+N` chip."
|
|
4114
|
+
},
|
|
4115
|
+
{
|
|
4116
|
+
"name": "ariaLabel",
|
|
4117
|
+
"type": "string",
|
|
4118
|
+
"required": false,
|
|
4119
|
+
"description": "Accessible name for the text input; use it when there is no visible label."
|
|
4120
|
+
},
|
|
4121
|
+
{
|
|
4122
|
+
"name": "tagListLabel",
|
|
4123
|
+
"type": "string",
|
|
4124
|
+
"required": false,
|
|
4125
|
+
"defaultValue": "'Tags'",
|
|
4126
|
+
"description": "Accessible name of the tag list."
|
|
4127
|
+
},
|
|
4128
|
+
{
|
|
4129
|
+
"name": "className",
|
|
4130
|
+
"type": "string",
|
|
4131
|
+
"required": false,
|
|
4132
|
+
"description": "Additional CSS classes for the outer container."
|
|
4133
|
+
},
|
|
4134
|
+
{
|
|
4135
|
+
"name": "fieldClassName",
|
|
4136
|
+
"type": "string",
|
|
4137
|
+
"required": false,
|
|
4138
|
+
"description": "Additional CSS classes for the field itself."
|
|
4139
|
+
},
|
|
4140
|
+
{
|
|
4141
|
+
"name": "tagClassName",
|
|
4142
|
+
"type": "string",
|
|
4143
|
+
"required": false,
|
|
4144
|
+
"description": "Additional CSS classes applied to every tag."
|
|
4145
|
+
},
|
|
4146
|
+
{
|
|
4147
|
+
"name": "onChange",
|
|
4148
|
+
"type": "(tags: string[]) => void",
|
|
4149
|
+
"required": false,
|
|
4150
|
+
"description": "Called with the new list whenever a tag is added or removed."
|
|
4151
|
+
}
|
|
4152
|
+
],
|
|
4153
|
+
"examples": [
|
|
4154
|
+
"const [tags, setTags] = useState<string[]>(['React']);\n\n<TagInput\n id=\"skills\"\n labelProps={{ label: 'Skills' }}\n placeholder=\"Add a skill\"\n caption=\"Press Enter or comma to add\"\n value={tags}\n onChange={setTags}\n/>"
|
|
4155
|
+
],
|
|
4156
|
+
"sourceFile": "components/New/TagInput/TagInput.tsx"
|
|
4157
|
+
},
|
|
4158
|
+
{
|
|
4159
|
+
"name": "AutocompleteTagInput",
|
|
4160
|
+
"category": "Components_2_0",
|
|
4161
|
+
"generation": "2.0",
|
|
4162
|
+
"description": "A tag input that suggests values while typing and also accepts its own.\naliases: Autocomplete|Combobox|TagAutocomplete|ChipAutocomplete|MultiValueAutocomplete\nDesign system 2.0\n\nTyping opens a list of the `suggestions` that match the text (by label, value\nor description) and are not already tags, capped at `maxSuggestions`, with the\nfirst one highlighted. Enter or comma adds the highlighted suggestion, or the\ntyped text when nothing matches; clicking a suggestion adds it too. The arrow\nkeys move the highlight and wrap at the ends; Escape and leaving the field\nclose the list without adding what was typed. Backspace on an empty input\nremoves the last tag, and duplicate tags are ignored. Entered text is not\nvalidated — say what format is expected through `caption`.\n\nReach for when there is nothing to suggest, and for a\nmultiple `Select` when only listed values are allowed.\n\nThe input follows the ARIA combobox pattern: it keeps focus while the list is\nopen, and the highlighted suggestion is announced through\n`aria-activedescendant`. The tags are a list named by `tagListLabel`, and each\nremove button is named after its tag.\n\nWorks controlled (`value` + `onChange`) or uncontrolled (`defaultValue`).",
|
|
4163
|
+
"props": [
|
|
4164
|
+
{
|
|
4165
|
+
"name": "id",
|
|
4166
|
+
"type": "string",
|
|
4167
|
+
"required": false,
|
|
4168
|
+
"description": "The id of the text input, linked to the label."
|
|
4169
|
+
},
|
|
4170
|
+
{
|
|
4171
|
+
"name": "value",
|
|
4172
|
+
"type": "string[]",
|
|
4173
|
+
"required": false,
|
|
4174
|
+
"description": "Controlled tag list."
|
|
4175
|
+
},
|
|
4176
|
+
{
|
|
4177
|
+
"name": "defaultValue",
|
|
4178
|
+
"type": "string[]",
|
|
4179
|
+
"required": false,
|
|
4180
|
+
"description": "Initial tag list when uncontrolled."
|
|
4181
|
+
},
|
|
4182
|
+
{
|
|
4183
|
+
"name": "suggestions",
|
|
4184
|
+
"type": "AutocompleteTagInputSuggestion[]",
|
|
4185
|
+
"required": true,
|
|
4186
|
+
"description": "Values offered while typing."
|
|
4187
|
+
},
|
|
4188
|
+
{
|
|
4189
|
+
"name": "maxSuggestions",
|
|
4190
|
+
"type": "number",
|
|
4191
|
+
"required": false,
|
|
4192
|
+
"defaultValue": "DEFAULT_MAX_SUGGESTIONS",
|
|
4193
|
+
"description": "How many matching suggestions the list shows at most."
|
|
3080
4194
|
},
|
|
3081
4195
|
{
|
|
3082
4196
|
"name": "size",
|
|
@@ -3113,7 +4227,8 @@
|
|
|
3113
4227
|
"name": "invalid",
|
|
3114
4228
|
"type": "boolean",
|
|
3115
4229
|
"required": false,
|
|
3116
|
-
"
|
|
4230
|
+
"defaultValue": "false",
|
|
4231
|
+
"description": "Applies the field's error styling and marks the input `aria-invalid`."
|
|
3117
4232
|
},
|
|
3118
4233
|
{
|
|
3119
4234
|
"name": "disabled",
|
|
@@ -3129,18 +4244,11 @@
|
|
|
3129
4244
|
"defaultValue": "false",
|
|
3130
4245
|
"description": "Shows the tags without allowing new ones or removal."
|
|
3131
4246
|
},
|
|
3132
|
-
{
|
|
3133
|
-
"name": "collapseTagOverflow",
|
|
3134
|
-
"type": "boolean",
|
|
3135
|
-
"required": false,
|
|
3136
|
-
"defaultValue": "false",
|
|
3137
|
-
"description": "Keep the tags on one line, replacing the ones that do not fit with a `+N` chip."
|
|
3138
|
-
},
|
|
3139
4247
|
{
|
|
3140
4248
|
"name": "ariaLabel",
|
|
3141
4249
|
"type": "string",
|
|
3142
4250
|
"required": false,
|
|
3143
|
-
"description": "Accessible name for the
|
|
4251
|
+
"description": "Accessible name for the input; use it when there is no visible label."
|
|
3144
4252
|
},
|
|
3145
4253
|
{
|
|
3146
4254
|
"name": "tagListLabel",
|
|
@@ -3149,6 +4257,12 @@
|
|
|
3149
4257
|
"defaultValue": "'Tags'",
|
|
3150
4258
|
"description": "Accessible name of the tag list."
|
|
3151
4259
|
},
|
|
4260
|
+
{
|
|
4261
|
+
"name": "getRemoveTagLabel",
|
|
4262
|
+
"type": "(tag: string) => string",
|
|
4263
|
+
"required": false,
|
|
4264
|
+
"description": "Accessible name of a tag's remove button, given the tag; pass a translated one, as the default is the English `Remove <tag>`."
|
|
4265
|
+
},
|
|
3152
4266
|
{
|
|
3153
4267
|
"name": "className",
|
|
3154
4268
|
"type": "string",
|
|
@@ -3167,6 +4281,12 @@
|
|
|
3167
4281
|
"required": false,
|
|
3168
4282
|
"description": "Additional CSS classes applied to every tag."
|
|
3169
4283
|
},
|
|
4284
|
+
{
|
|
4285
|
+
"name": "listClassName",
|
|
4286
|
+
"type": "string",
|
|
4287
|
+
"required": false,
|
|
4288
|
+
"description": "Additional CSS classes for the floating suggestion list."
|
|
4289
|
+
},
|
|
3170
4290
|
{
|
|
3171
4291
|
"name": "onChange",
|
|
3172
4292
|
"type": "(tags: string[]) => void",
|
|
@@ -3175,9 +4295,9 @@
|
|
|
3175
4295
|
}
|
|
3176
4296
|
],
|
|
3177
4297
|
"examples": [
|
|
3178
|
-
"const [
|
|
4298
|
+
"const [types, setTypes] = useState<string[]>([]);\n\n<AutocompleteTagInput\n id=\"attachment-types\"\n labelProps={{ label: 'Attachment types', required: true }}\n caption=\"Choose a suggested MIME type or add one as <type>/<subtype>\"\n suggestions={[\n { value: 'image/png', label: 'PNG', description: 'image/png' },\n { value: 'application/pdf', label: 'PDF', description: 'application/pdf' },\n ]}\n value={types}\n onChange={setTypes}\n/>"
|
|
3179
4299
|
],
|
|
3180
|
-
"sourceFile": "components/New/
|
|
4300
|
+
"sourceFile": "components/New/AutocompleteTagInput/AutocompleteTagInput.tsx"
|
|
3181
4301
|
},
|
|
3182
4302
|
{
|
|
3183
4303
|
"name": "Search",
|
|
@@ -3269,6 +4389,32 @@
|
|
|
3269
4389
|
"defaultValue": "false",
|
|
3270
4390
|
"description": "Renders the current value at the end of the label row"
|
|
3271
4391
|
},
|
|
4392
|
+
{
|
|
4393
|
+
"name": "showTooltip",
|
|
4394
|
+
"type": "boolean",
|
|
4395
|
+
"required": false,
|
|
4396
|
+
"defaultValue": "false",
|
|
4397
|
+
"description": "Renders the current value in a bubble above the thumb; hidden while disabled"
|
|
4398
|
+
},
|
|
4399
|
+
{
|
|
4400
|
+
"name": "showTicks",
|
|
4401
|
+
"type": "boolean",
|
|
4402
|
+
"required": false,
|
|
4403
|
+
"defaultValue": "false",
|
|
4404
|
+
"description": "Renders a tick mark at every step on the unfilled track; hidden while disabled"
|
|
4405
|
+
},
|
|
4406
|
+
{
|
|
4407
|
+
"name": "leftContent",
|
|
4408
|
+
"type": "ReactNode",
|
|
4409
|
+
"required": false,
|
|
4410
|
+
"description": "Content before the track, vertically centred on it"
|
|
4411
|
+
},
|
|
4412
|
+
{
|
|
4413
|
+
"name": "rightContent",
|
|
4414
|
+
"type": "ReactNode",
|
|
4415
|
+
"required": false,
|
|
4416
|
+
"description": "Content after the track, vertically centred on it"
|
|
4417
|
+
},
|
|
3272
4418
|
{
|
|
3273
4419
|
"name": "caption",
|
|
3274
4420
|
"type": "string",
|
|
@@ -3409,7 +4555,7 @@
|
|
|
3409
4555
|
"name": "InteractiveTooltip",
|
|
3410
4556
|
"category": "Components_2_0",
|
|
3411
4557
|
"generation": "2.0",
|
|
3412
|
-
"description": "A hover panel that, unlike , can hold its own interactive\ncontent.\naliases: HoverCard|InfoPopover\nDesign system 2.0\n\nOpens next to the trigger on hover or focus, the way a tooltip does, but\nstays open while the pointer moves into the panel so its content — links,\nbuttons, anything — can be hovered and clicked. It carries no `role`, since\nARIA's `tooltip` role forbids focusable content and this is meant to hold\nsome; a panel with meaningfully interactive content should still be\nreachable without a mouse (Tab from the trigger reaches it), but a purely\ndecorative one is fine to leave out of the tab order entirely.\n\nRenders nothing on a mobile screen, where there is no hover to reveal it —\nso, as with , a control must never depend on this panel alone\nto be understood or operated.",
|
|
4558
|
+
"description": "A hover panel that, unlike , can hold its own interactive\ncontent.\naliases: HoverCard|InfoPopover\nDesign system 2.0\n\nOpens next to the trigger on hover or focus, the way a tooltip does, but\nstays open while the pointer moves into the panel so its content — links,\nbuttons, anything — can be hovered and clicked. It carries no `role`, since\nARIA's `tooltip` role forbids focusable content and this is meant to hold\nsome; a panel with meaningfully interactive content should still be\nreachable without a mouse (Tab from the trigger reaches it), but a purely\ndecorative one is fine to leave out of the tab order entirely.\n\nRenders nothing on a mobile screen, where there is no hover to reveal it —\nso, as with , a control must never depend on this panel alone\nto be understood or operated. A trigger whose only job is to reveal the\npanel, such as an info chip, sets `trigger={InteractiveTooltipTrigger.Click}`\ninstead: the panel then opens on click or tap, works on every screen size,\nand no longer reacts to hover or focus. Do not use it on a trigger that has\nan action of its own, since the same tap would run both.",
|
|
3413
4559
|
"props": [
|
|
3414
4560
|
{
|
|
3415
4561
|
"name": "content",
|
|
@@ -3451,6 +4597,12 @@
|
|
|
3451
4597
|
"defaultValue": "false",
|
|
3452
4598
|
"description": "Whether the panel starts open (uncontrolled only)"
|
|
3453
4599
|
},
|
|
4600
|
+
{
|
|
4601
|
+
"name": "trigger",
|
|
4602
|
+
"type": "InteractiveTooltipTrigger",
|
|
4603
|
+
"required": false,
|
|
4604
|
+
"description": "What opens the panel: hover or focus, or a click or tap that keeps it open until dismissed"
|
|
4605
|
+
},
|
|
3454
4606
|
{
|
|
3455
4607
|
"name": "open",
|
|
3456
4608
|
"type": "boolean",
|
|
@@ -3805,6 +4957,67 @@
|
|
|
3805
4957
|
],
|
|
3806
4958
|
"sourceFile": "components/New/NoDataContent/NoDataContent.tsx"
|
|
3807
4959
|
},
|
|
4960
|
+
{
|
|
4961
|
+
"name": "TransferQueue",
|
|
4962
|
+
"category": "Components_2_0",
|
|
4963
|
+
"generation": "2.0",
|
|
4964
|
+
"description": "A floating panel listing the files of an upload, download, import or export\nwith a live status per row.\naliases: UploadQueue|ImportQueue|ExportQueue|UploadProgress|ProgressToast\nDesign system 2.0\n\nEach row shows the file's `FileIcon` and name, and a trailing status: a\nspinner (with a cancel control on hover or focus) while in progress, a check\non success, a warning or error icon whose reason is both its tooltip and its\naccessible name, or \"Canceled\". The header carries the host's title, a count\nof failed items, and collapse and close controls. Collapsed while work runs,\nthe rows are replaced by one aggregate `ProgressBar`.\n\nClosing while an item is in progress or has failed asks for confirmation\nfirst. Once every item has succeeded the queue closes itself after\n`autoCloseDelay`; a warned or canceled row keeps it open so it can be read.\n\nThe root is a polite `role=\"status\"` live region. Positioning is left to\nthe host — wrap it in a fixed container at the screen corner.",
|
|
4965
|
+
"props": [
|
|
4966
|
+
{
|
|
4967
|
+
"name": "title",
|
|
4968
|
+
"type": "string",
|
|
4969
|
+
"required": true,
|
|
4970
|
+
"description": "Heading, rendered verbatim"
|
|
4971
|
+
},
|
|
4972
|
+
{
|
|
4973
|
+
"name": "items",
|
|
4974
|
+
"type": "TransferQueueItem[]",
|
|
4975
|
+
"required": true,
|
|
4976
|
+
"description": "Items to show, in display order"
|
|
4977
|
+
},
|
|
4978
|
+
{
|
|
4979
|
+
"name": "onClose",
|
|
4980
|
+
"type": "() => void",
|
|
4981
|
+
"required": true,
|
|
4982
|
+
"description": "Called when the queue should close"
|
|
4983
|
+
},
|
|
4984
|
+
{
|
|
4985
|
+
"name": "onCancelItem",
|
|
4986
|
+
"type": "(id: string) => void",
|
|
4987
|
+
"required": false,
|
|
4988
|
+
"description": "Called with an item's id when the user cancels it"
|
|
4989
|
+
},
|
|
4990
|
+
{
|
|
4991
|
+
"name": "labels",
|
|
4992
|
+
"type": "Partial<TransferQueueLabels>",
|
|
4993
|
+
"required": false,
|
|
4994
|
+
"description": "Overrides for the English default strings"
|
|
4995
|
+
},
|
|
4996
|
+
{
|
|
4997
|
+
"name": "autoCloseDelay",
|
|
4998
|
+
"type": "number",
|
|
4999
|
+
"required": false,
|
|
5000
|
+
"defaultValue": "TRANSFER_QUEUE_AUTO_CLOSE_DELAY_MS",
|
|
5001
|
+
"description": "Delay before an all-succeeded queue closes itself; `0` disables"
|
|
5002
|
+
},
|
|
5003
|
+
{
|
|
5004
|
+
"name": "className",
|
|
5005
|
+
"type": "string",
|
|
5006
|
+
"required": false,
|
|
5007
|
+
"description": "Additional CSS classes for the root panel"
|
|
5008
|
+
},
|
|
5009
|
+
{
|
|
5010
|
+
"name": "bodyClassName",
|
|
5011
|
+
"type": "string",
|
|
5012
|
+
"required": false,
|
|
5013
|
+
"description": "Additional CSS classes for the list of rows"
|
|
5014
|
+
}
|
|
5015
|
+
],
|
|
5016
|
+
"examples": [
|
|
5017
|
+
"<TransferQueue\n title=\"Importing 2 files\"\n items={[\n { id: '1', name: 'report.pdf', status: TransferQueueItemStatus.Success },\n { id: '2', name: 'data.csv', status: TransferQueueItemStatus.InProgress, percent: 40 },\n ]}\n onClose={handleClose}\n onCancelItem={handleCancel}\n/>"
|
|
5018
|
+
],
|
|
5019
|
+
"sourceFile": "components/New/TransferQueue/TransferQueue.tsx"
|
|
5020
|
+
},
|
|
3808
5021
|
{
|
|
3809
5022
|
"name": "Grid",
|
|
3810
5023
|
"category": "Components_2_0",
|
|
@@ -5493,7 +6706,8 @@
|
|
|
5493
6706
|
"examples": [
|
|
5494
6707
|
"<DialFileIcon extension=\".pdf\" />\n<DialFileIcon extension=\"tsx\" size={28} stroke={1.25} />\n<DialFileIcon extension=\"unknown\" decorative /> // decorative, hidden from AT"
|
|
5495
6708
|
],
|
|
5496
|
-
"sourceFile": "components/FileIcon/FileIcon.tsx"
|
|
6709
|
+
"sourceFile": "components/FileIcon/FileIcon.tsx",
|
|
6710
|
+
"supersededBy": "FileIcon"
|
|
5497
6711
|
},
|
|
5498
6712
|
{
|
|
5499
6713
|
"name": "DialFormItem",
|
|
@@ -5611,7 +6825,8 @@
|
|
|
5611
6825
|
"examples": [
|
|
5612
6826
|
"<DialSharedEntityIndicator />\n<DialSharedEntityIndicator size={12} label=\"Opens in new window\" />"
|
|
5613
6827
|
],
|
|
5614
|
-
"sourceFile": "components/SharedEntityIndicator/SharedEntityIndicator.tsx"
|
|
6828
|
+
"sourceFile": "components/SharedEntityIndicator/SharedEntityIndicator.tsx",
|
|
6829
|
+
"supersededBy": "SharedEntityIndicator"
|
|
5615
6830
|
},
|
|
5616
6831
|
{
|
|
5617
6832
|
"name": "DialFileName",
|
|
@@ -5691,7 +6906,8 @@
|
|
|
5691
6906
|
"examples": [
|
|
5692
6907
|
"// Without details\n<DialFileName name=\"Document.pdf\" />\n\n// With details (file size and updated date)\n<DialFileName\n name=\"Document.pdf\"\n details={<span className=\"text-secondary\">24 KB · Jul 20, 2025</span>}\n/>"
|
|
5693
6908
|
],
|
|
5694
|
-
"sourceFile": "components/FileName/FileName.tsx"
|
|
6909
|
+
"sourceFile": "components/FileName/FileName.tsx",
|
|
6910
|
+
"supersededBy": "FileName"
|
|
5695
6911
|
},
|
|
5696
6912
|
{
|
|
5697
6913
|
"name": "DialFolderName",
|
|
@@ -5768,7 +6984,8 @@
|
|
|
5768
6984
|
"examples": [
|
|
5769
6985
|
"<DialFolderName name=\"Organization\" />"
|
|
5770
6986
|
],
|
|
5771
|
-
"sourceFile": "components/FolderName/FolderName.tsx"
|
|
6987
|
+
"sourceFile": "components/FolderName/FolderName.tsx",
|
|
6988
|
+
"supersededBy": "FolderName"
|
|
5772
6989
|
},
|
|
5773
6990
|
{
|
|
5774
6991
|
"name": "DialResizableContainer",
|
|
@@ -8281,6 +9498,12 @@
|
|
|
8281
9498
|
"required": false,
|
|
8282
9499
|
"description": "Optional tooltip displayed when a file or folder name contains forbidden characters"
|
|
8283
9500
|
},
|
|
9501
|
+
{
|
|
9502
|
+
"name": "skipForbiddenSymbolsCheckForActions",
|
|
9503
|
+
"type": "boolean",
|
|
9504
|
+
"required": false,
|
|
9505
|
+
"description": "When provided, skips the forbidden-symbols check when building row action menus, so all actions are shown even for items whose names contain forbidden characters."
|
|
9506
|
+
},
|
|
8284
9507
|
{
|
|
8285
9508
|
"name": "onCreateFolder",
|
|
8286
9509
|
"type": "(\n file: DialUploadFileItem,\n folderPath: string,\n fileId: string,\n ) => void | Promise<void>",
|
|
@@ -8725,7 +9948,8 @@
|
|
|
8725
9948
|
"examples": [
|
|
8726
9949
|
"<DialSchemaRenderer\n schema={mySchema}\n onChange={(v) => console.log(v)}\n onDefaultValues={(defaults) => console.log(defaults)}\n/>"
|
|
8727
9950
|
],
|
|
8728
|
-
"sourceFile": "components/SchemaRenderer/SchemaRenderer.tsx"
|
|
9951
|
+
"sourceFile": "components/SchemaRenderer/SchemaRenderer.tsx",
|
|
9952
|
+
"supersededBy": "SchemaRenderer"
|
|
8729
9953
|
},
|
|
8730
9954
|
{
|
|
8731
9955
|
"name": "DialJsonEditor",
|
|
@@ -8830,6 +10054,13 @@
|
|
|
8830
10054
|
"type": "ReactNode",
|
|
8831
10055
|
"required": false,
|
|
8832
10056
|
"description": "Content to display when the editor is empty"
|
|
10057
|
+
},
|
|
10058
|
+
{
|
|
10059
|
+
"name": "showDragbar",
|
|
10060
|
+
"type": "boolean",
|
|
10061
|
+
"required": false,
|
|
10062
|
+
"defaultValue": "true",
|
|
10063
|
+
"description": "Whether to show the bottom drag bar that resizes the editor height"
|
|
8833
10064
|
}
|
|
8834
10065
|
],
|
|
8835
10066
|
"examples": [
|
|
@@ -9083,6 +10314,10 @@
|
|
|
9083
10314
|
"name": "Static",
|
|
9084
10315
|
"value": "'static'"
|
|
9085
10316
|
},
|
|
10317
|
+
{
|
|
10318
|
+
"name": "Starter",
|
|
10319
|
+
"value": "'starter'"
|
|
10320
|
+
},
|
|
9086
10321
|
{
|
|
9087
10322
|
"name": "Success",
|
|
9088
10323
|
"value": "'success'"
|
|
@@ -10121,7 +11356,7 @@
|
|
|
10121
11356
|
"value": "'flat-sections'"
|
|
10122
11357
|
}
|
|
10123
11358
|
],
|
|
10124
|
-
"sourceFile": "
|
|
11359
|
+
"sourceFile": "types/json-schema.ts"
|
|
10125
11360
|
},
|
|
10126
11361
|
{
|
|
10127
11362
|
"name": "SchemaDisplayMode",
|
|
@@ -10136,7 +11371,7 @@
|
|
|
10136
11371
|
"value": "'radio'"
|
|
10137
11372
|
}
|
|
10138
11373
|
],
|
|
10139
|
-
"sourceFile": "
|
|
11374
|
+
"sourceFile": "types/json-schema.ts"
|
|
10140
11375
|
},
|
|
10141
11376
|
{
|
|
10142
11377
|
"name": "SchemaOrientation",
|
|
@@ -10151,7 +11386,7 @@
|
|
|
10151
11386
|
"value": "'column'"
|
|
10152
11387
|
}
|
|
10153
11388
|
],
|
|
10154
|
-
"sourceFile": "
|
|
11389
|
+
"sourceFile": "types/json-schema.ts"
|
|
10155
11390
|
},
|
|
10156
11391
|
{
|
|
10157
11392
|
"name": "JsonSchemaType",
|
|
@@ -10186,7 +11421,7 @@
|
|
|
10186
11421
|
"value": "'null'"
|
|
10187
11422
|
}
|
|
10188
11423
|
],
|
|
10189
|
-
"sourceFile": "
|
|
11424
|
+
"sourceFile": "types/json-schema.ts"
|
|
10190
11425
|
},
|
|
10191
11426
|
{
|
|
10192
11427
|
"name": "JsonSchema",
|
|
@@ -10197,7 +11432,7 @@
|
|
|
10197
11432
|
"value": "Record<string, JsonSchemaDef>"
|
|
10198
11433
|
}
|
|
10199
11434
|
],
|
|
10200
|
-
"sourceFile": "
|
|
11435
|
+
"sourceFile": "models/json-schema.ts"
|
|
10201
11436
|
},
|
|
10202
11437
|
{
|
|
10203
11438
|
"name": "JsonSchemaDef",
|
|
@@ -10296,7 +11531,7 @@
|
|
|
10296
11531
|
"value": "string[]"
|
|
10297
11532
|
}
|
|
10298
11533
|
],
|
|
10299
|
-
"sourceFile": "
|
|
11534
|
+
"sourceFile": "models/json-schema.ts"
|
|
10300
11535
|
},
|
|
10301
11536
|
{
|
|
10302
11537
|
"name": "ValidationError",
|
|
@@ -10311,7 +11546,132 @@
|
|
|
10311
11546
|
"value": "string"
|
|
10312
11547
|
}
|
|
10313
11548
|
],
|
|
10314
|
-
"sourceFile": "
|
|
11549
|
+
"sourceFile": "models/json-schema.ts"
|
|
11550
|
+
},
|
|
11551
|
+
{
|
|
11552
|
+
"name": "SchemaRendererTexts",
|
|
11553
|
+
"kind": "interface",
|
|
11554
|
+
"members": [
|
|
11555
|
+
{
|
|
11556
|
+
"name": "noItemSchema",
|
|
11557
|
+
"value": "string"
|
|
11558
|
+
},
|
|
11559
|
+
{
|
|
11560
|
+
"name": "noItemsYet",
|
|
11561
|
+
"value": "string"
|
|
11562
|
+
},
|
|
11563
|
+
{
|
|
11564
|
+
"name": "addItem",
|
|
11565
|
+
"value": "string"
|
|
11566
|
+
},
|
|
11567
|
+
{
|
|
11568
|
+
"name": "selectTypeToAdd",
|
|
11569
|
+
"value": "string"
|
|
11570
|
+
},
|
|
11571
|
+
{
|
|
11572
|
+
"name": "noConfigurableProperties",
|
|
11573
|
+
"value": "string"
|
|
11574
|
+
},
|
|
11575
|
+
{
|
|
11576
|
+
"name": "noFieldsYet",
|
|
11577
|
+
"value": "string"
|
|
11578
|
+
},
|
|
11579
|
+
{
|
|
11580
|
+
"name": "keyColumnHeader",
|
|
11581
|
+
"value": "string"
|
|
11582
|
+
},
|
|
11583
|
+
{
|
|
11584
|
+
"name": "valueColumnHeader",
|
|
11585
|
+
"value": "string"
|
|
11586
|
+
},
|
|
11587
|
+
{
|
|
11588
|
+
"name": "addField",
|
|
11589
|
+
"value": "string"
|
|
11590
|
+
},
|
|
11591
|
+
{
|
|
11592
|
+
"name": "keyInputPlaceholder",
|
|
11593
|
+
"value": "string"
|
|
11594
|
+
},
|
|
11595
|
+
{
|
|
11596
|
+
"name": "stringInputPlaceholder",
|
|
11597
|
+
"value": "string"
|
|
11598
|
+
},
|
|
11599
|
+
{
|
|
11600
|
+
"name": "integerInputPlaceholder",
|
|
11601
|
+
"value": "string"
|
|
11602
|
+
},
|
|
11603
|
+
{
|
|
11604
|
+
"name": "numberInputPlaceholder",
|
|
11605
|
+
"value": "string"
|
|
11606
|
+
},
|
|
11607
|
+
{
|
|
11608
|
+
"name": "enumSelectPlaceholder",
|
|
11609
|
+
"value": "string"
|
|
11610
|
+
},
|
|
11611
|
+
{
|
|
11612
|
+
"name": "selectTypePlaceholder",
|
|
11613
|
+
"value": "string"
|
|
11614
|
+
},
|
|
11615
|
+
{
|
|
11616
|
+
"name": "removeItemAriaLabel",
|
|
11617
|
+
"value": "string"
|
|
11618
|
+
},
|
|
11619
|
+
{
|
|
11620
|
+
"name": "removeFieldAriaLabel",
|
|
11621
|
+
"value": "string"
|
|
11622
|
+
},
|
|
11623
|
+
{
|
|
11624
|
+
"name": "typeColumnHeader",
|
|
11625
|
+
"value": "string"
|
|
11626
|
+
},
|
|
11627
|
+
{
|
|
11628
|
+
"name": "entryTypeString",
|
|
11629
|
+
"value": "string"
|
|
11630
|
+
},
|
|
11631
|
+
{
|
|
11632
|
+
"name": "entryTypeNumber",
|
|
11633
|
+
"value": "string"
|
|
11634
|
+
},
|
|
11635
|
+
{
|
|
11636
|
+
"name": "entryTypeBoolean",
|
|
11637
|
+
"value": "string"
|
|
11638
|
+
},
|
|
11639
|
+
{
|
|
11640
|
+
"name": "entryTypeNull",
|
|
11641
|
+
"value": "string"
|
|
11642
|
+
},
|
|
11643
|
+
{
|
|
11644
|
+
"name": "entryTypeObject",
|
|
11645
|
+
"value": "string"
|
|
11646
|
+
},
|
|
11647
|
+
{
|
|
11648
|
+
"name": "entryTypeArray",
|
|
11649
|
+
"value": "string"
|
|
11650
|
+
},
|
|
11651
|
+
{
|
|
11652
|
+
"name": "entryTypeChangeWarning",
|
|
11653
|
+
"value": "string"
|
|
11654
|
+
},
|
|
11655
|
+
{
|
|
11656
|
+
"name": "booleanTrueOption",
|
|
11657
|
+
"value": "string"
|
|
11658
|
+
},
|
|
11659
|
+
{
|
|
11660
|
+
"name": "booleanFalseOption",
|
|
11661
|
+
"value": "string"
|
|
11662
|
+
},
|
|
11663
|
+
{
|
|
11664
|
+
"name": "invalidJsonError",
|
|
11665
|
+
"value": "string"
|
|
11666
|
+
}
|
|
11667
|
+
],
|
|
11668
|
+
"sourceFile": "models/json-schema.ts"
|
|
11669
|
+
},
|
|
11670
|
+
{
|
|
11671
|
+
"name": "SchemaRenderField",
|
|
11672
|
+
"kind": "type",
|
|
11673
|
+
"sourceFile": "components/New/SchemaRenderer/types.ts",
|
|
11674
|
+
"typeBody": "(\n path: string[],\n schema: JsonSchemaDef,\n defaultElement: ReactElement,\n) => ReactNode"
|
|
10315
11675
|
},
|
|
10316
11676
|
{
|
|
10317
11677
|
"name": "NotificationVariant",
|
|
@@ -10380,13 +11740,54 @@
|
|
|
10380
11740
|
"value": "'weekday'"
|
|
10381
11741
|
}
|
|
10382
11742
|
],
|
|
10383
|
-
"sourceFile": "types/calendar.ts"
|
|
10384
|
-
},
|
|
10385
|
-
{
|
|
10386
|
-
"name": "CalendarValue",
|
|
10387
|
-
"kind": "type",
|
|
10388
|
-
"sourceFile": "components/New/Calendar/Calendar.tsx",
|
|
10389
|
-
"typeBody": "Date | string | null"
|
|
11743
|
+
"sourceFile": "types/calendar.ts"
|
|
11744
|
+
},
|
|
11745
|
+
{
|
|
11746
|
+
"name": "CalendarValue",
|
|
11747
|
+
"kind": "type",
|
|
11748
|
+
"sourceFile": "components/New/Calendar/Calendar.tsx",
|
|
11749
|
+
"typeBody": "Date | string | null"
|
|
11750
|
+
},
|
|
11751
|
+
{
|
|
11752
|
+
"name": "BreadcrumbsSize",
|
|
11753
|
+
"kind": "enum",
|
|
11754
|
+
"members": [
|
|
11755
|
+
{
|
|
11756
|
+
"name": "Small",
|
|
11757
|
+
"value": "'small'",
|
|
11758
|
+
"comment": "14px `dial-small-text`, with a `dial-small-semi-text` current page."
|
|
11759
|
+
},
|
|
11760
|
+
{
|
|
11761
|
+
"name": "Heading",
|
|
11762
|
+
"value": "'heading'",
|
|
11763
|
+
"comment": "18px `dial-h2-text`, for a trail that doubles as the page heading. The\ntoken is semibold, so every segment is — including the current page."
|
|
11764
|
+
}
|
|
11765
|
+
],
|
|
11766
|
+
"sourceFile": "types/breadcrumbs.ts"
|
|
11767
|
+
},
|
|
11768
|
+
{
|
|
11769
|
+
"name": "BreadcrumbsItem",
|
|
11770
|
+
"kind": "interface",
|
|
11771
|
+
"members": [
|
|
11772
|
+
{
|
|
11773
|
+
"name": "label",
|
|
11774
|
+
"value": "string"
|
|
11775
|
+
},
|
|
11776
|
+
{
|
|
11777
|
+
"name": "href?",
|
|
11778
|
+
"value": "string"
|
|
11779
|
+
},
|
|
11780
|
+
{
|
|
11781
|
+
"name": "onClick?",
|
|
11782
|
+
"value": "(event: MouseEvent<HTMLElement>) => void"
|
|
11783
|
+
},
|
|
11784
|
+
{
|
|
11785
|
+
"name": "icon?",
|
|
11786
|
+
"value": "ReactNode"
|
|
11787
|
+
}
|
|
11788
|
+
],
|
|
11789
|
+
"sourceFile": "components/New/Breadcrumbs/Breadcrumbs.tsx",
|
|
11790
|
+
"description": "One step of the trail rendered by ."
|
|
10390
11791
|
},
|
|
10391
11792
|
{
|
|
10392
11793
|
"name": "TextareaResize",
|
|
@@ -10411,6 +11812,24 @@
|
|
|
10411
11812
|
],
|
|
10412
11813
|
"sourceFile": "components/New/Textarea/Textarea.tsx"
|
|
10413
11814
|
},
|
|
11815
|
+
{
|
|
11816
|
+
"name": "AccordionCaretPosition",
|
|
11817
|
+
"kind": "enum",
|
|
11818
|
+
"members": [
|
|
11819
|
+
{
|
|
11820
|
+
"name": "Start",
|
|
11821
|
+
"value": "'start'",
|
|
11822
|
+
"comment": "Before the title, at the header's leading edge."
|
|
11823
|
+
},
|
|
11824
|
+
{
|
|
11825
|
+
"name": "End",
|
|
11826
|
+
"value": "'end'",
|
|
11827
|
+
"comment": "After the title, at the header's trailing edge."
|
|
11828
|
+
}
|
|
11829
|
+
],
|
|
11830
|
+
"sourceFile": "types/accordion.ts",
|
|
11831
|
+
"description": "Where an `Accordion` header draws its caret."
|
|
11832
|
+
},
|
|
10414
11833
|
{
|
|
10415
11834
|
"name": "RadioGroupItem",
|
|
10416
11835
|
"kind": "interface",
|
|
@@ -10485,6 +11904,10 @@
|
|
|
10485
11904
|
"name": "count?",
|
|
10486
11905
|
"value": "number"
|
|
10487
11906
|
},
|
|
11907
|
+
{
|
|
11908
|
+
"name": "icon?",
|
|
11909
|
+
"value": "ReactNode"
|
|
11910
|
+
},
|
|
10488
11911
|
{
|
|
10489
11912
|
"name": "disabled?",
|
|
10490
11913
|
"value": "boolean"
|
|
@@ -10493,6 +11916,166 @@
|
|
|
10493
11916
|
"sourceFile": "components/New/Tabs/Tabs.tsx",
|
|
10494
11917
|
"description": "A single tab entry rendered by ."
|
|
10495
11918
|
},
|
|
11919
|
+
{
|
|
11920
|
+
"name": "FilterChipItem",
|
|
11921
|
+
"kind": "interface",
|
|
11922
|
+
"members": [
|
|
11923
|
+
{
|
|
11924
|
+
"name": "value",
|
|
11925
|
+
"value": "T"
|
|
11926
|
+
},
|
|
11927
|
+
{
|
|
11928
|
+
"name": "label",
|
|
11929
|
+
"value": "string"
|
|
11930
|
+
},
|
|
11931
|
+
{
|
|
11932
|
+
"name": "icon?",
|
|
11933
|
+
"value": "ReactNode"
|
|
11934
|
+
}
|
|
11935
|
+
],
|
|
11936
|
+
"sourceFile": "components/New/FilterChips/FilterChips.tsx"
|
|
11937
|
+
},
|
|
11938
|
+
{
|
|
11939
|
+
"name": "BadgeColor",
|
|
11940
|
+
"kind": "enum",
|
|
11941
|
+
"members": [
|
|
11942
|
+
{
|
|
11943
|
+
"name": "Blue",
|
|
11944
|
+
"value": "'blue'"
|
|
11945
|
+
},
|
|
11946
|
+
{
|
|
11947
|
+
"name": "Green",
|
|
11948
|
+
"value": "'green'"
|
|
11949
|
+
},
|
|
11950
|
+
{
|
|
11951
|
+
"name": "Violet",
|
|
11952
|
+
"value": "'violet'"
|
|
11953
|
+
},
|
|
11954
|
+
{
|
|
11955
|
+
"name": "Indigo",
|
|
11956
|
+
"value": "'indigo'"
|
|
11957
|
+
},
|
|
11958
|
+
{
|
|
11959
|
+
"name": "Brown",
|
|
11960
|
+
"value": "'brown'"
|
|
11961
|
+
},
|
|
11962
|
+
{
|
|
11963
|
+
"name": "Red",
|
|
11964
|
+
"value": "'red'"
|
|
11965
|
+
}
|
|
11966
|
+
],
|
|
11967
|
+
"sourceFile": "types/badge.ts",
|
|
11968
|
+
"description": "The visual colour of a `BadgeVariant.Filled` badge."
|
|
11969
|
+
},
|
|
11970
|
+
{
|
|
11971
|
+
"name": "BadgeVariant",
|
|
11972
|
+
"kind": "enum",
|
|
11973
|
+
"members": [
|
|
11974
|
+
{
|
|
11975
|
+
"name": "Outlined",
|
|
11976
|
+
"value": "'outlined'",
|
|
11977
|
+
"comment": "A neutral label with a border on the sunken layer, for topics and plain categories."
|
|
11978
|
+
},
|
|
11979
|
+
{
|
|
11980
|
+
"name": "Filled",
|
|
11981
|
+
"value": "'filled'",
|
|
11982
|
+
"comment": "A pill filled with one of the visual colours, for a label that is told apart by colour."
|
|
11983
|
+
}
|
|
11984
|
+
],
|
|
11985
|
+
"sourceFile": "types/badge.ts",
|
|
11986
|
+
"description": "How a `Badge` is drawn."
|
|
11987
|
+
},
|
|
11988
|
+
{
|
|
11989
|
+
"name": "AvatarShape",
|
|
11990
|
+
"kind": "enum",
|
|
11991
|
+
"members": [
|
|
11992
|
+
{
|
|
11993
|
+
"name": "Circle",
|
|
11994
|
+
"value": "'circle'",
|
|
11995
|
+
"comment": "A circle — the avatar of a person."
|
|
11996
|
+
},
|
|
11997
|
+
{
|
|
11998
|
+
"name": "Square",
|
|
11999
|
+
"value": "'square'",
|
|
12000
|
+
"comment": "A rounded square — the avatar of an application, model or other entity."
|
|
12001
|
+
}
|
|
12002
|
+
],
|
|
12003
|
+
"sourceFile": "types/avatar.ts",
|
|
12004
|
+
"description": "The outline an `Avatar` is clipped to."
|
|
12005
|
+
},
|
|
12006
|
+
{
|
|
12007
|
+
"name": "EntityIdentityItem",
|
|
12008
|
+
"kind": "interface",
|
|
12009
|
+
"members": [
|
|
12010
|
+
{
|
|
12011
|
+
"name": "type",
|
|
12012
|
+
"value": "EntityType"
|
|
12013
|
+
},
|
|
12014
|
+
{
|
|
12015
|
+
"name": "name",
|
|
12016
|
+
"value": "string"
|
|
12017
|
+
},
|
|
12018
|
+
{
|
|
12019
|
+
"name": "version?",
|
|
12020
|
+
"value": "string"
|
|
12021
|
+
},
|
|
12022
|
+
{
|
|
12023
|
+
"name": "iconUrl?",
|
|
12024
|
+
"value": "string"
|
|
12025
|
+
},
|
|
12026
|
+
{
|
|
12027
|
+
"name": "isFeatured?",
|
|
12028
|
+
"value": "boolean"
|
|
12029
|
+
}
|
|
12030
|
+
],
|
|
12031
|
+
"sourceFile": "components/New/EntityIdentity/EntityIdentity.tsx",
|
|
12032
|
+
"description": "Identity fields of the entity rendered by `EntityIdentity`."
|
|
12033
|
+
},
|
|
12034
|
+
{
|
|
12035
|
+
"name": "EntityIdentityLabels",
|
|
12036
|
+
"kind": "interface",
|
|
12037
|
+
"members": [
|
|
12038
|
+
{
|
|
12039
|
+
"name": "type?",
|
|
12040
|
+
"value": "string"
|
|
12041
|
+
},
|
|
12042
|
+
{
|
|
12043
|
+
"name": "featured?",
|
|
12044
|
+
"value": "string"
|
|
12045
|
+
}
|
|
12046
|
+
],
|
|
12047
|
+
"sourceFile": "components/New/EntityIdentity/EntityIdentity.tsx",
|
|
12048
|
+
"description": "User-visible strings of `EntityIdentity`."
|
|
12049
|
+
},
|
|
12050
|
+
{
|
|
12051
|
+
"name": "EntityType",
|
|
12052
|
+
"kind": "enum",
|
|
12053
|
+
"members": [
|
|
12054
|
+
{
|
|
12055
|
+
"name": "Model",
|
|
12056
|
+
"value": "'model'"
|
|
12057
|
+
},
|
|
12058
|
+
{
|
|
12059
|
+
"name": "Agent",
|
|
12060
|
+
"value": "'agent'"
|
|
12061
|
+
},
|
|
12062
|
+
{
|
|
12063
|
+
"name": "Toolset",
|
|
12064
|
+
"value": "'toolset'"
|
|
12065
|
+
},
|
|
12066
|
+
{
|
|
12067
|
+
"name": "Skill",
|
|
12068
|
+
"value": "'skill'"
|
|
12069
|
+
},
|
|
12070
|
+
{
|
|
12071
|
+
"name": "Prompt",
|
|
12072
|
+
"value": "'prompt'",
|
|
12073
|
+
"comment": "Reusable text prompt. Carries a body instead of a runtime."
|
|
12074
|
+
}
|
|
12075
|
+
],
|
|
12076
|
+
"sourceFile": "types/entity-type.ts",
|
|
12077
|
+
"description": "The category of a DIAL catalog entity. It picks the colour of the type label and the featured chip."
|
|
12078
|
+
},
|
|
10496
12079
|
{
|
|
10497
12080
|
"name": "TagAppearance",
|
|
10498
12081
|
"kind": "enum",
|
|
@@ -10508,6 +12091,25 @@
|
|
|
10508
12091
|
],
|
|
10509
12092
|
"sourceFile": "types/tag.ts"
|
|
10510
12093
|
},
|
|
12094
|
+
{
|
|
12095
|
+
"name": "AutocompleteTagInputSuggestion",
|
|
12096
|
+
"kind": "interface",
|
|
12097
|
+
"members": [
|
|
12098
|
+
{
|
|
12099
|
+
"name": "value",
|
|
12100
|
+
"value": "string"
|
|
12101
|
+
},
|
|
12102
|
+
{
|
|
12103
|
+
"name": "label",
|
|
12104
|
+
"value": "string"
|
|
12105
|
+
},
|
|
12106
|
+
{
|
|
12107
|
+
"name": "description?",
|
|
12108
|
+
"value": "string"
|
|
12109
|
+
}
|
|
12110
|
+
],
|
|
12111
|
+
"sourceFile": "components/New/AutocompleteTagInput/utils.ts"
|
|
12112
|
+
},
|
|
10511
12113
|
{
|
|
10512
12114
|
"name": "TooltipContainerOptions",
|
|
10513
12115
|
"kind": "interface",
|
|
@@ -10535,6 +12137,21 @@
|
|
|
10535
12137
|
],
|
|
10536
12138
|
"sourceFile": "components/New/Tooltip/TooltipContext.tsx"
|
|
10537
12139
|
},
|
|
12140
|
+
{
|
|
12141
|
+
"name": "InteractiveTooltipTrigger",
|
|
12142
|
+
"kind": "enum",
|
|
12143
|
+
"members": [
|
|
12144
|
+
{
|
|
12145
|
+
"name": "Hover",
|
|
12146
|
+
"value": "'hover'"
|
|
12147
|
+
},
|
|
12148
|
+
{
|
|
12149
|
+
"name": "Click",
|
|
12150
|
+
"value": "'click'"
|
|
12151
|
+
}
|
|
12152
|
+
],
|
|
12153
|
+
"sourceFile": "types/tooltip.ts"
|
|
12154
|
+
},
|
|
10538
12155
|
{
|
|
10539
12156
|
"name": "TooltipPlacement",
|
|
10540
12157
|
"kind": "enum",
|
|
@@ -10557,6 +12174,140 @@
|
|
|
10557
12174
|
}
|
|
10558
12175
|
],
|
|
10559
12176
|
"sourceFile": "types/tooltip.ts"
|
|
12177
|
+
},
|
|
12178
|
+
{
|
|
12179
|
+
"name": "TransferQueueItem",
|
|
12180
|
+
"kind": "interface",
|
|
12181
|
+
"members": [
|
|
12182
|
+
{
|
|
12183
|
+
"name": "id",
|
|
12184
|
+
"value": "string"
|
|
12185
|
+
},
|
|
12186
|
+
{
|
|
12187
|
+
"name": "name",
|
|
12188
|
+
"value": "string"
|
|
12189
|
+
},
|
|
12190
|
+
{
|
|
12191
|
+
"name": "status",
|
|
12192
|
+
"value": "TransferQueueItemStatus"
|
|
12193
|
+
},
|
|
12194
|
+
{
|
|
12195
|
+
"name": "percent?",
|
|
12196
|
+
"value": "number"
|
|
12197
|
+
},
|
|
12198
|
+
{
|
|
12199
|
+
"name": "message?",
|
|
12200
|
+
"value": "string"
|
|
12201
|
+
}
|
|
12202
|
+
],
|
|
12203
|
+
"sourceFile": "components/New/TransferQueue/TransferQueue.tsx",
|
|
12204
|
+
"description": "One file (or other named unit of work) tracked by a `TransferQueue`."
|
|
12205
|
+
},
|
|
12206
|
+
{
|
|
12207
|
+
"name": "TransferQueueLabels",
|
|
12208
|
+
"kind": "interface",
|
|
12209
|
+
"members": [
|
|
12210
|
+
{
|
|
12211
|
+
"name": "cancelItemAriaLabel",
|
|
12212
|
+
"value": "(name: string) => string"
|
|
12213
|
+
},
|
|
12214
|
+
{
|
|
12215
|
+
"name": "itemProgressAriaLabel",
|
|
12216
|
+
"value": "(name: string) => string"
|
|
12217
|
+
},
|
|
12218
|
+
{
|
|
12219
|
+
"name": "successLabel",
|
|
12220
|
+
"value": "string"
|
|
12221
|
+
},
|
|
12222
|
+
{
|
|
12223
|
+
"name": "canceledLabel",
|
|
12224
|
+
"value": "string"
|
|
12225
|
+
},
|
|
12226
|
+
{
|
|
12227
|
+
"name": "failedMessage",
|
|
12228
|
+
"value": "string"
|
|
12229
|
+
},
|
|
12230
|
+
{
|
|
12231
|
+
"name": "warningMessage",
|
|
12232
|
+
"value": "string"
|
|
12233
|
+
},
|
|
12234
|
+
{
|
|
12235
|
+
"name": "queueProgressAriaLabel",
|
|
12236
|
+
"value": "string"
|
|
12237
|
+
},
|
|
12238
|
+
{
|
|
12239
|
+
"name": "queueProgressValueText",
|
|
12240
|
+
"value": "(completed: number, total: number) => string"
|
|
12241
|
+
},
|
|
12242
|
+
{
|
|
12243
|
+
"name": "collapseAriaLabel",
|
|
12244
|
+
"value": "string"
|
|
12245
|
+
},
|
|
12246
|
+
{
|
|
12247
|
+
"name": "expandAriaLabel",
|
|
12248
|
+
"value": "string"
|
|
12249
|
+
},
|
|
12250
|
+
{
|
|
12251
|
+
"name": "closeAriaLabel",
|
|
12252
|
+
"value": "string"
|
|
12253
|
+
},
|
|
12254
|
+
{
|
|
12255
|
+
"name": "closeConfirmHeader",
|
|
12256
|
+
"value": "string"
|
|
12257
|
+
},
|
|
12258
|
+
{
|
|
12259
|
+
"name": "closeConfirmDescriptionInProgress",
|
|
12260
|
+
"value": "string"
|
|
12261
|
+
},
|
|
12262
|
+
{
|
|
12263
|
+
"name": "closeConfirmDescriptionFailed",
|
|
12264
|
+
"value": "string"
|
|
12265
|
+
},
|
|
12266
|
+
{
|
|
12267
|
+
"name": "closeConfirmDescriptionMixed",
|
|
12268
|
+
"value": "string"
|
|
12269
|
+
},
|
|
12270
|
+
{
|
|
12271
|
+
"name": "closeConfirmLabel",
|
|
12272
|
+
"value": "string"
|
|
12273
|
+
},
|
|
12274
|
+
{
|
|
12275
|
+
"name": "closeCancelLabel",
|
|
12276
|
+
"value": "string"
|
|
12277
|
+
}
|
|
12278
|
+
],
|
|
12279
|
+
"sourceFile": "components/New/TransferQueue/TransferQueue.tsx",
|
|
12280
|
+
"description": "Every user-visible string of `TransferQueue`."
|
|
12281
|
+
},
|
|
12282
|
+
{
|
|
12283
|
+
"name": "TransferQueueItemStatus",
|
|
12284
|
+
"kind": "enum",
|
|
12285
|
+
"members": [
|
|
12286
|
+
{
|
|
12287
|
+
"name": "InProgress",
|
|
12288
|
+
"value": "'inProgress'",
|
|
12289
|
+
"comment": "Queued or running; the row shows a spinner and, when cancelable, a cancel control."
|
|
12290
|
+
},
|
|
12291
|
+
{
|
|
12292
|
+
"name": "Success",
|
|
12293
|
+
"value": "'success'"
|
|
12294
|
+
},
|
|
12295
|
+
{
|
|
12296
|
+
"name": "Warning",
|
|
12297
|
+
"value": "'warning'",
|
|
12298
|
+
"comment": "Delivered, but not everything the user asked for made it through."
|
|
12299
|
+
},
|
|
12300
|
+
{
|
|
12301
|
+
"name": "Failed",
|
|
12302
|
+
"value": "'failed'"
|
|
12303
|
+
},
|
|
12304
|
+
{
|
|
12305
|
+
"name": "Canceled",
|
|
12306
|
+
"value": "'canceled'"
|
|
12307
|
+
}
|
|
12308
|
+
],
|
|
12309
|
+
"sourceFile": "types/transfer-queue.ts",
|
|
12310
|
+
"description": "Lifecycle status of one item in a `TransferQueue`."
|
|
10560
12311
|
}
|
|
10561
12312
|
],
|
|
10562
12313
|
"hooks": [
|
|
@@ -10621,12 +12372,30 @@
|
|
|
10621
12372
|
"description": "Class names of the enclosing `ThemeScope`s, outermost first, or `''` when the\ncaller sits outside any scope. Components rendering into a `FloatingPortal`\nmerge this onto their floating root so the tokens follow them out of the\nsubtree.",
|
|
10622
12373
|
"signature": "() => string"
|
|
10623
12374
|
},
|
|
12375
|
+
{
|
|
12376
|
+
"name": "extractInitials",
|
|
12377
|
+
"sourceFile": "utils/avatar.ts",
|
|
12378
|
+
"description": "Returns 1–2 uppercase initials derived from a display name, or `'?'` when it has no letters.",
|
|
12379
|
+
"signature": "(name: string) => string"
|
|
12380
|
+
},
|
|
10624
12381
|
{
|
|
10625
12382
|
"name": "matchesAccept",
|
|
10626
12383
|
"sourceFile": "utils/file-accept.ts",
|
|
10627
12384
|
"description": "Tests a file against the value of a native `accept` attribute.\n\nThe file picker filters by `accept` on its own, but a drop does not: dropping\na `.png` onto an input that accepts `.md` hands the file over regardless. Any\ndrop target therefore has to re-check what it received.\n\nSupports all three `accept` token forms — an extension (`.md`), a full MIME\ntype (`text/markdown`) and a MIME wildcard (`image/*`). An empty or missing\n`accept` accepts everything, matching the attribute's own semantics.",
|
|
10628
12385
|
"signature": "(file: File, accept?: string) => boolean"
|
|
10629
12386
|
},
|
|
12387
|
+
{
|
|
12388
|
+
"name": "DEFAULT_TRANSFER_QUEUE_LABELS",
|
|
12389
|
+
"sourceFile": "components/New/TransferQueue/constants.ts",
|
|
12390
|
+
"description": "English defaults for every `TransferQueue` string; a host passes translations through `labels`.",
|
|
12391
|
+
"signature": "DEFAULT_TRANSFER_QUEUE_LABELS: TransferQueueLabels"
|
|
12392
|
+
},
|
|
12393
|
+
{
|
|
12394
|
+
"name": "TRANSFER_QUEUE_AUTO_CLOSE_DELAY_MS",
|
|
12395
|
+
"sourceFile": "components/New/TransferQueue/constants.ts",
|
|
12396
|
+
"description": "Delay before a queue whose items have all succeeded closes itself.",
|
|
12397
|
+
"signature": "TRANSFER_QUEUE_AUTO_CLOSE_DELAY_MS = 8000"
|
|
12398
|
+
},
|
|
10630
12399
|
{
|
|
10631
12400
|
"name": "GRID_SELECTION_COLUMN_ID",
|
|
10632
12401
|
"sourceFile": "components/New/Grid/Grid.tsx",
|
|
@@ -10761,6 +12530,11 @@
|
|
|
10761
12530
|
"name": "NOT_ALLOWED_SPACES_REGEXP",
|
|
10762
12531
|
"sourceFile": "constants/validation.ts",
|
|
10763
12532
|
"signature": "NOT_ALLOWED_SPACES_REGEXP = new RegExp(NOT_ALLOWED_SPACES)"
|
|
12533
|
+
},
|
|
12534
|
+
{
|
|
12535
|
+
"name": "DIAL_KIT_CLASS",
|
|
12536
|
+
"sourceFile": "constants/public-class-names.ts",
|
|
12537
|
+
"signature": "DIAL_KIT_CLASS = {\n /* ── Feedback and status ───────────────────────────────────────────────── */\n /** The `role=\"status\"` root of a `Spinner`. */\n spinner: 'dial-kit-spinner',\n /**\n * The outermost element of a `ProgressBar`: the box wrapping its label,\n * track and readout — or the track itself, which is the root when the bar\n * has neither.\n */\n progressBar: 'dial-kit-progress-bar',\n /** The root of a `Skeleton`, wrapping its avatar and text rows. */\n skeleton: 'dial-kit-skeleton',\n /**\n * The `Notification` surface. Present on every wrapper too — the toast and\n * section-message variants of error, info, success, warning, loading and\n * general all render this component.\n */\n notification: 'dial-kit-notification',\n /** The empty-state root of `NoDataContent`. */\n noDataContent: 'dial-kit-no-data-content',\n /** The `role=\"status\"` panel of a `TransferQueue`: header, rows and aggregate bar. */\n transferQueue: 'dial-kit-transfer-queue',\n\n /* ── Text ──────────────────────────────────────────────────────────────── */\n /** The text element of a `Highlight`, which renders the matched query. */\n highlight: 'dial-kit-highlight',\n /** The caption line under a field, rendered by `CaptionText`. */\n captionText: 'dial-kit-caption-text',\n /**\n * A caption in its error variant — what `ErrorText` renders. Additive to\n * `captionText`, since one component draws both.\n */\n errorText: 'dial-kit-error-text',\n /** The `Label` root, which wraps the `label` element and its info button. */\n label: 'dial-kit-label',\n\n /* ── Containers ────────────────────────────────────────────────────────── */\n /** The `article` element of a `CardShell`. */\n cardShell: 'dial-kit-card-shell',\n /** The `aside` element of a `CollapsibleSidebar`. */\n collapsibleSidebar: 'dial-kit-collapsible-sidebar',\n /** The content box inside a `ResizableContainer`'s resize frame. */\n resizableContainer: 'dial-kit-resizable-container',\n /**\n * The `role=\"dialog\"` panel of a `Popup`. Its backdrop is reached through\n * `overlayClassName`.\n */\n popup: 'dial-kit-popup',\n /** The `role=\"dialog\"` panel of a `BottomSheet`. */\n bottomSheet: 'dial-kit-bottom-sheet',\n /** The `role=\"dialog\"` panel of a `SideDrawer`, open or closed. */\n sideDrawer: 'dial-kit-side-drawer',\n /** The `Popup` panel of a `ConfirmationPopup`, additive to `popup`. */\n confirmationPopup: 'dial-kit-confirmation-popup',\n /** The root of an `Accordion`. */\n accordion: 'dial-kit-accordion',\n /** The breadcrumb root of a `FolderPath`. */\n folderPath: 'dial-kit-folder-path',\n /** The `nav` element of a `Breadcrumbs` trail. */\n breadcrumbs: 'dial-kit-breadcrumbs',\n /**\n * One segment of a `Breadcrumbs` trail: the link, button or plain span that\n * draws the label — not the `li`, which also holds the separator after it.\n */\n breadcrumbsItem: 'dial-kit-breadcrumbs-item',\n\n /* ── Menus and overlays ────────────────────────────────────────────────── */\n /**\n * The trigger wrapper of a `Dropdown`. Its floating panel is reached through\n * `listClassName`.\n */\n dropdown: 'dial-kit-dropdown',\n /**\n * The `role=\"none\"` item list inside a dropdown overlay — the box that holds\n * the rows and owns their vertical padding. Present in both generations, and\n * on a submenu's own list. It is *not* the floating panel.\n */\n dropdownList: 'dial-kit-dropdown-list',\n /**\n * One row of a floating overlay: a dropdown item, a `Select` option, a\n * submenu trigger, or a submenu child. It sits on the element that draws the\n * row box — so on the wrapper, not the inner button, for a row that has a\n * `rightControl` beside it.\n */\n menuItem: 'dial-kit-menuitem',\n /**\n * The trailing check of a chosen `MenuItemMark.Check` row. Decorative, like\n * the glyph itself — the row's `aria-checked` / `aria-selected` carries the\n * state.\n */\n menuItemCheck: 'dial-kit-menuitem-check',\n /** The primary icon of a `DialDropdownIcon` trigger. */\n dropdownIcon: 'dial-kit-dropdown-icon',\n /**\n * The caret badge of a `DialDropdownIcon` trigger — the round plate the\n * chevron sits on. Absent when `showCaret` is `false`.\n */\n dropdownIconCaret: 'dial-kit-dropdown-icon-caret',\n /** The bubble of a `Tooltip`, rendered by `TooltipContent` into a portal. */\n tooltip: 'dial-kit-tooltip',\n /** The panel of an `InteractiveTooltip` — the one whose content takes focus. */\n interactiveTooltip: 'dial-kit-interactive-tooltip',\n /** The text element of an `EllipsisTooltip`, which is also its trigger. */\n ellipsisTooltip: 'dial-kit-ellipsis-tooltip',\n\n /* ── Fields ────────────────────────────────────────────────────────────── */\n /** The `Search` field, additive to the `dial-kit-input` its `Input` carries. */\n search: 'dial-kit-search',\n /** The `PasswordInput` field, additive to `dial-kit-input`. */\n passwordInput: 'dial-kit-password-input',\n /** The `NumberInput` field, additive to `dial-kit-input`. */\n numberInput: 'dial-kit-number-input',\n /** The `TagInput` field, additive to `dial-kit-input`. */\n tagInput: 'dial-kit-tag-input',\n /** The `AutocompleteTagInput` field, additive to `dial-kit-input`. */\n autocompleteTagInput: 'dial-kit-autocomplete-tag-input',\n /** The root of a `Select`, wrapping its label, field and caption. */\n select: 'dial-kit-select',\n /** The trigger button of an `InlineSelect`. */\n inlineSelect: 'dial-kit-inline-select',\n /** The root of a `Calendar`, wrapping its label and date field. */\n calendar: 'dial-kit-calendar',\n /** The root of a `SchemaRenderer`, wrapping its top-level sections or fields. */\n schemaRenderer: 'dial-kit-schema-renderer',\n /**\n * The card of one collapsible `SchemaRenderer` section, at any depth: a\n * top-level property, a nested object or array, an array item, or a\n * key-value entry holding an object.\n */\n schemaRendererSection: 'dial-kit-schema-renderer-section',\n /** The drop area of a `FileDropzone`. */\n fileDropzone: 'dial-kit-file-dropzone',\n /**\n * The root of a `FileIcon`, wrapping the file or folder glyph (or\n * its spinner while loading) and the shared badge.\n */\n fileIcon: 'dial-kit-file-icon',\n /** The row of a `FileName`: its type icon, the name and any details. */\n fileName: 'dial-kit-file-name',\n /** The `FileName` row of a `FolderName`, additive to `fileName`. */\n folderName: 'dial-kit-folder-name',\n /**\n * The `role=\"img\"` badge of a `SharedEntityIndicator` — standalone, or the\n * shared badge a `FileIcon` draws over its glyph.\n */\n sharedEntityIndicator: 'dial-kit-shared-entity-indicator',\n /** The root of a `Badge`: the label box, with its icon when it has one. */\n badge: 'dial-kit-badge',\n /** The root of an `Avatar`: the image, or the initials box that replaces it. */\n avatar: 'dial-kit-avatar',\n /** The root row of an `EntityIdentity`: its icon, type label, name and version. */\n entityIdentity: 'dial-kit-entity-identity',\n\n /* ── Controls ──────────────────────────────────────────────────────────── */\n /** The row of a `Switch`: the control and its label. */\n switch: 'dial-kit-switch',\n /** The row of a `Checkbox`: the box and its label. */\n checkbox: 'dial-kit-checkbox',\n /** The decorative box a `CheckboxBox` draws, in a checkbox or a menu row. */\n checkboxBox: 'dial-kit-checkbox-box',\n /** The row of a `Radio`: the circle and its label. */\n radio: 'dial-kit-radio',\n /** The root of a `RadioGroup`, wrapping its label and its radios. */\n radioGroup: 'dial-kit-radio-group',\n /**\n * The root of a `RadioGroupPopupField`, wrapping its label and the collapsed\n * field that opens the group.\n */\n radioGroupPopupField: 'dial-kit-radio-group-popup-field',\n /** The `role=\"radiogroup\"` track of a `SegmentedControl`. */\n segmentedControl: 'dial-kit-segmented-control',\n /** One segment of a `SegmentedControl`. */\n segmentedControlItem: 'dial-kit-segmented-control-item',\n /**\n * The outermost element of a `Tabs`: the box wrapping its heading and tab\n * list — or the `role=\"tablist\"` itself, which is the root when the tabs\n * carry no `sectionLabel`.\n */\n tabs: 'dial-kit-tabs',\n /**\n * The `role=\"tablist\"` holding the tabs, in either orientation. Additive to\n * `tabs` when there is no heading above it, since one element is then both.\n */\n tabList: 'dial-kit-tab-list',\n /**\n * One tab inside `Tabs`, in either orientation. The selected tab of a\n * horizontal row keeps its own `dial-kit-tab-selected-underline`.\n */\n tab: 'dial-kit-tab',\n /**\n * The selected tab, additive to `tab`. A horizontal row draws its selection\n * with `dial-kit-tab-selected-underline`, which carries the gradient rule;\n * this one carries no declarations and marks the selected tab in either\n * orientation.\n */\n tabSelected: 'dial-kit-tab-selected',\n /** The `sectionLabel` heading above a `Tabs`. Absent when there is none. */\n tabsSectionLabel: 'dial-kit-tabs-section-label',\n /**\n * The `role=\"group\"` row of a `FilterChips`. Its chips are `Tag` pills, so\n * they carry `dial-kit-tag` and have no entry of their own.\n */\n filterChips: 'dial-kit-filter-chips',\n /** A `Tag` pill, wherever it is rendered — including a `TagInput`'s rows. */\n tag: 'dial-kit-tag',\n /**\n * A `ToggleIconButton`, additive to the `dial-kit-base-icon-button` it\n * already carries.\n */\n toggleIconButton: 'dial-kit-toggle-icon-button',\n /** A `CloseButton`, additive to `dial-kit-base-icon-button`. */\n closeButton: 'dial-kit-close-button',\n /** An `InfoButton`, additive to `dial-kit-base-icon-button`. */\n infoButton: 'dial-kit-info-button',\n /**\n * The wrapper of a `ButtonDropdown` — its trigger carries\n * `dial-kit-base-button`.\n */\n buttonDropdown: 'dial-kit-button-dropdown',\n} as const"
|
|
10764
12538
|
}
|
|
10765
12539
|
]
|
|
10766
12540
|
}
|