@epam/ai-dial-ui-kit 0.13.0-dev.9 → 0.14.0-dev.1
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 +45 -0
- package/dist/CHANGELOG.md +48 -1
- package/dist/{JsonEditor-CRSkEnWP.cjs → JsonEditor-pyqbLZZf.cjs} +1 -1
- package/dist/{JsonEditor-Djt1V27V.js → JsonEditor-v9m_npfK.js} +1 -1
- package/dist/MarkdownEditor-5UpxUtXf.js +75 -0
- package/dist/{MarkdownEditor-BbGX2uA9.cjs → MarkdownEditor-9aPIyyuu.cjs} +1 -1
- package/dist/MarkdownEditor-BjqdSHPU.cjs +1 -0
- package/dist/{MarkdownEditor-DtKScLM2.js → MarkdownEditor-CWZVSR--.js} +1 -1
- package/dist/components-manifest.json +3420 -391
- package/dist/dial-ui-kit.cjs.js +1 -1
- package/dist/dial-ui-kit.es.js +201 -148
- package/dist/{index-JVDPW40K.js → index-DKDaSZqV.js} +24490 -21241
- package/dist/index-xlqMH2Q1.cjs +71 -0
- package/dist/index.css +6 -2
- package/dist/mcp-server.cjs +29 -9
- package/dist/migration-guides/0.13.0/caption-semi-text-lead-rename.md +82 -0
- package/dist/migration-guides/0.13.0/field-label-props-unification.md +94 -0
- package/dist/migration-guides/0.13.0/focus-border-token-rename.md +106 -0
- package/dist/migration-guides/0.13.0/progress-bar-2-0-rewrite.md +103 -0
- package/dist/migration-guides/0.13.0/spinner-dial-prefix-removal.md +69 -0
- package/dist/migration-guides/0.13.0/typography-heading-scale-shift.md +93 -0
- package/dist/migration-guides/README.md +6 -0
- package/dist/src/components/Accordion/Accordion.d.ts +1 -0
- package/dist/src/components/Analytics/Bar/Bar.d.ts +12 -7
- package/dist/src/components/Analytics/BarGroup/BarGroup.d.ts +23 -16
- package/dist/src/components/Analytics/Card/Card.d.ts +14 -3
- package/dist/src/components/Analytics/ErrorTag/ErrorTag.d.ts +1 -0
- package/dist/src/components/Analytics/Histogram/Histogram.d.ts +9 -6
- package/dist/src/components/Analytics/Histogram/utils.d.ts +10 -0
- package/dist/src/components/AutocompleteInput/AutocompleteInputValue.d.ts +1 -0
- package/dist/src/components/Breadcrumb/Breadcrumb.d.ts +1 -0
- package/dist/src/components/Breadcrumb/BreadcrumbItem.d.ts +3 -0
- package/dist/src/components/Button/Button.d.ts +1 -0
- package/dist/src/components/Button/ButtonWrappers.d.ts +1 -15
- package/dist/src/components/ButtonDropdown/ButtonDropdown.d.ts +1 -0
- package/dist/src/components/CaptionText/CaptionText.d.ts +1 -0
- package/dist/src/components/Checkbox/Checkbox.d.ts +1 -0
- package/dist/src/components/CloseButton/CloseButton.d.ts +1 -0
- package/dist/src/components/CollapsibleSidebar/CollapsibleSidebar.d.ts +1 -0
- package/dist/src/components/ConfirmationPopup/ConfirmationPopup.d.ts +1 -0
- package/dist/src/components/DraggableItem/DraggableItem.d.ts +1 -0
- package/dist/src/components/DropdownIcon/DropdownIcon.d.ts +1 -0
- package/dist/src/components/EllipsisTooltip/EllipsisTooltip.d.ts +1 -0
- package/dist/src/components/FabButton/FabButton.d.ts +8 -3
- package/dist/src/components/FileIcon/FileIcon.d.ts +1 -0
- package/dist/src/components/FileManager/FileManager.d.ts +3 -0
- package/dist/src/components/FileManager/FileManagerProvider.d.ts +1 -0
- package/dist/src/components/FileManager/components/DestinationFolderPopup/DestinationFolderPopup.d.ts +3 -0
- package/dist/src/components/FileManager/components/FoldersTree/FoldersTree.d.ts +3 -0
- package/dist/src/components/FileManager/hooks/use-file-manager-context.d.ts +2 -0
- package/dist/src/components/FileManager/hooks/use-file-manager-tabs.d.ts +3 -0
- package/dist/src/components/FileName/FileName.d.ts +1 -0
- package/dist/src/components/FolderName/FolderName.d.ts +1 -0
- package/dist/src/components/FormItem/FormItem.d.ts +1 -0
- package/dist/src/components/FormPopup/FormPopup.d.ts +1 -0
- package/dist/src/components/Grid/Grid.d.ts +1 -0
- package/dist/src/components/Grid/comparators/base-column-comparator.d.ts +1 -0
- package/dist/src/components/Grid/renderers/DateCellRenderer.d.ts +1 -0
- package/dist/src/components/Icon/Icon.d.ts +1 -0
- package/dist/src/components/IconButton/IconButton.d.ts +5 -0
- package/dist/src/components/IconButton/IconButtonWrappers.d.ts +1 -0
- package/dist/src/components/Input/Input.d.ts +1 -0
- package/dist/src/components/InputPopup/InputPopup.d.ts +1 -0
- package/dist/src/components/JsonEditor/JsonEditor.d.ts +1 -0
- package/dist/src/components/Label/Label.d.ts +1 -0
- package/dist/src/components/LabelledText/LabelledText.d.ts +1 -0
- package/dist/src/components/LoadFileArea/LoadFileArea.d.ts +1 -0
- package/dist/src/components/LoadFileArea/LoadFileAreaField.d.ts +1 -0
- package/dist/src/components/Loader/Loader.d.ts +1 -0
- package/dist/src/components/MarkdownEditor/MarkdownEditor.d.ts +1 -0
- package/dist/src/components/New/Accordion/Accordion.d.ts +71 -0
- package/dist/src/components/New/Button/Button.d.ts +66 -0
- package/dist/src/components/New/Button/ButtonWrappers.d.ts +94 -0
- package/dist/src/components/New/Button/__tests__/utils.spec.d.ts +1 -0
- package/dist/src/components/New/Button/constants.d.ts +2 -0
- package/dist/src/components/New/Button/utils.d.ts +2 -0
- package/dist/src/components/New/ButtonDropdown/ButtonDropdown.d.ts +24 -0
- package/dist/src/components/New/ButtonDropdown/constants.d.ts +1 -0
- package/dist/src/components/New/Calendar/Calendar.d.ts +55 -0
- package/dist/src/components/New/Calendar/constants.d.ts +17 -0
- package/dist/src/components/New/Calendar/utils.d.ts +25 -0
- package/dist/src/components/New/Calendar/utils.spec.d.ts +1 -0
- package/dist/src/components/New/CaptionText/CaptionText.d.ts +21 -0
- package/dist/src/components/New/CardShell/CardShell.d.ts +14 -0
- package/dist/src/components/New/CloseButton/CloseButton.d.ts +33 -0
- package/dist/src/components/New/ConfirmationPopup/ConfirmationPopup.d.ts +55 -0
- package/dist/src/components/New/ConfirmationPopup/constants.d.ts +14 -0
- package/dist/src/components/New/Dropdown/Dropdown.d.ts +87 -0
- package/dist/src/components/New/Dropdown/DropdownSubMenuItem.d.ts +8 -0
- package/dist/src/components/New/Dropdown/constants.d.ts +9 -0
- package/dist/src/components/New/FileDropzone/FileDropzone.d.ts +81 -0
- package/dist/src/components/New/FolderPath/FolderPath.d.ts +32 -0
- package/dist/src/components/New/Highlight/Highlight.d.ts +19 -0
- package/dist/src/components/New/IconButton/IconButton.d.ts +48 -0
- package/dist/src/components/New/IconButton/IconButtonWrappers.d.ts +71 -0
- package/dist/src/components/New/InfoButton/InfoButton.d.ts +26 -0
- package/dist/src/components/New/InfoButton/InfoButton.stories.d.ts +6 -0
- package/dist/src/components/New/InlineSelect/InlineSelect.d.ts +51 -0
- package/dist/src/components/New/Input/Button/InputButton.d.ts +25 -0
- package/dist/src/components/New/Input/Button/constants.d.ts +1 -0
- package/dist/src/components/New/Input/Input.d.ts +67 -0
- package/dist/src/components/New/Input/utils.d.ts +2 -0
- package/dist/src/components/New/Label/Label.d.ts +33 -0
- package/dist/src/components/New/MarkdownEditor/MarkdownEditor.d.ts +33 -0
- package/dist/src/components/New/MarkdownEditor/constants.d.ts +20 -0
- package/dist/src/components/New/Notification/Notification.d.ts +7 -0
- package/dist/src/components/New/Notification/constants.d.ts +12 -1
- package/dist/src/components/New/NumberInput/NumberInput.d.ts +36 -0
- package/dist/src/components/New/PasswordInput/PasswordInput.d.ts +33 -0
- package/dist/src/components/New/Popup/Popup.d.ts +72 -0
- package/dist/src/components/New/Popup/constants.d.ts +10 -0
- package/dist/src/components/New/Search/Search.d.ts +42 -0
- package/dist/src/components/New/Select/MultiSelectTags.d.ts +17 -0
- package/dist/src/components/New/Select/Select.d.ts +110 -0
- package/dist/src/components/New/Select/SelectSubMenuItem.d.ts +8 -0
- package/dist/src/components/New/Select/constants.d.ts +32 -0
- package/dist/src/components/New/Switch/Switch.d.ts +38 -0
- package/dist/src/components/New/Tabs/Tabs.d.ts +63 -0
- package/dist/src/components/New/Tag/Tag.d.ts +45 -0
- package/dist/src/components/New/TagInput/TagInput.d.ts +72 -0
- package/dist/src/components/New/TagInput/utils.d.ts +21 -0
- package/dist/src/components/New/TagInput/utils.spec.d.ts +1 -0
- package/dist/src/components/New/Textarea/Textarea.d.ts +39 -0
- package/dist/src/components/New/constants/overlay.d.ts +24 -0
- package/dist/src/components/NoDataContent/NoDataContent.d.ts +1 -0
- package/dist/src/components/Notification/Notification.d.ts +1 -0
- package/dist/src/components/NumberInput/NumberInput.d.ts +1 -0
- package/dist/src/components/Pagination/Pagination.d.ts +3 -0
- package/dist/src/components/PasswordInput/PasswordInput.d.ts +1 -0
- package/dist/src/components/Popup/Popup.d.ts +2 -1
- package/dist/src/components/ProgressBar/ProgressBar.d.ts +51 -10
- package/dist/src/components/RadioButton/RadioButton.d.ts +1 -0
- package/dist/src/components/RadioGroup/RadioGroup.d.ts +1 -0
- package/dist/src/components/RadioGroupPopupField/RadioGroupPopupField.d.ts +1 -0
- package/dist/src/components/RemoveButton/RemoveButton.d.ts +1 -0
- package/dist/src/components/ResizableContainer/ConditionalResizableContainer.d.ts +1 -0
- package/dist/src/components/ResizableContainer/ResizableContainer.d.ts +1 -0
- package/dist/src/components/SchemaRenderer/SchemaRenderer.d.ts +1 -0
- package/dist/src/components/SchemaRenderer/components/SchemaKeyValueEditor.d.ts +9 -1
- package/dist/src/components/SchemaRenderer/types.d.ts +6 -1
- package/dist/src/components/SchemaRenderer/utils.d.ts +1 -0
- package/dist/src/components/Search/Search.d.ts +1 -0
- package/dist/src/components/SegmentedControl/SegmentedControl.d.ts +1 -0
- package/dist/src/components/Select/Select.d.ts +1 -0
- package/dist/src/components/SelectField/SelectField.d.ts +1 -0
- package/dist/src/components/SharedEntityIndicator/SharedEntityIndicator.d.ts +1 -0
- package/dist/src/components/Skeleton/Skeleton.d.ts +19 -18
- package/dist/src/components/Skeleton/utils.d.ts +2 -2
- package/dist/src/components/Slider/Slider.d.ts +1 -0
- package/dist/src/components/Spinner/Spinner.d.ts +5 -2
- package/dist/src/components/Steps/Steps.d.ts +1 -0
- package/dist/src/components/Switch/Switch.d.ts +1 -0
- package/dist/src/components/Tabs/Tabs.d.ts +1 -0
- package/dist/src/components/Tag/Tag.d.ts +1 -0
- package/dist/src/components/TagInput/TagInput.d.ts +1 -0
- package/dist/src/components/Textarea/Textarea.d.ts +1 -0
- package/dist/src/components/Tooltip/Tooltip.d.ts +1 -0
- package/dist/src/components/Tooltip/TooltipContainer.d.ts +1 -0
- package/dist/src/components/Tooltip/TooltipContent.d.ts +1 -0
- package/dist/src/components/Tooltip/TooltipTrigger.d.ts +1 -0
- package/dist/src/index.d.ts +89 -13
- package/dist/src/mcp/types.d.ts +12 -0
- package/dist/src/models/dropdown.d.ts +27 -0
- package/dist/src/types/button.d.ts +1 -0
- package/dist/src/types/calendar.d.ts +6 -0
- package/dist/src/types/skeleton.d.ts +3 -3
- package/dist/src/utils/__tests__/accessible-name.spec.d.ts +1 -0
- package/dist/src/utils/__tests__/file-accept.spec.d.ts +1 -0
- package/dist/src/utils/accessible-name.d.ts +19 -0
- package/dist/src/utils/file-accept.d.ts +16 -0
- package/dist/src/utils/sub-menu-floating.d.ts +15 -2
- package/package.json +4 -2
- package/dist/index-CmA_N28F.cjs +0 -71
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.
|
|
3
|
-
"generatedAt": "2026-
|
|
2
|
+
"version": "0.14.0-dev.1",
|
|
3
|
+
"generatedAt": "2026-08-19T12:39:41.400Z",
|
|
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",
|
|
@@ -20,45 +20,2863 @@
|
|
|
20
20
|
},
|
|
21
21
|
"setupNotes": "## Next.js Integration\n1. Install the package and peer dependencies that are not currently in your project\n``` bash\nnpm install @epam/ai-dial-ui-kit\nnpm install react react-dom @tabler/icons-react classnames\nnpm install @floating-ui/react monaco-editor @monaco-editor/react\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."
|
|
22
22
|
},
|
|
23
|
-
"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 | Weight | Size / Line-height
|
|
24
|
-
"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-
|
|
23
|
+
"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\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\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",
|
|
24
|
+
"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\n### controlsBgColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\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)` | `#124ACE` |\n| `control-neutral` | `var(--bg-control-neutral)` | `#FCFCFC` |\n| `control-neutral-hover` | `var(--bg-control-neutral-hover)` | `#E0E6F0` |\n| `control-neutral-active` | `var(--bg-control-neutral-active)` | `#D1DBEA` |\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` | `var(--bg-control-disable)` | `#DCE0E8` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `hover-alpha` | `var(--stroke-hover-alpha)` | `#2764D933` |\n| `focus-blue` | `var(--stroke-focus-blue)` | `#6785FB` |\n| `accent-alpha` | `var(--stroke-accent-alpha)` | `#2764D933` |\n| `error-alpha` | `var(--stroke-error-alpha)` | `#AE2F2F73` |\n| `control-disable-alpha` | `var(--text-control-disable-alpha)` | `#848E9C` |\n\n### visualBgColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\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### visualTextColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\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\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `warning-icon` | `var(--text-warning-icon)` | `#EEC840` |\n\n### controlsTextColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `control-permanent` | `var(--text-control-permanent)` | `#FCFCFC` |\n| `control-disable-alpha` | `var(--text-control-disable-alpha)` | `#848E9C` |\n| `control-disable-beta` | `var(--text-control-disable-beta)` | `#DCE0E8` |\n| `control-blue-hover` | `var(--text-control-blue-hover)` | `#5976E9` |\n| `control-blue-active` | `var(--text-control-blue-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` |",
|
|
25
25
|
"components": [
|
|
26
|
+
{
|
|
27
|
+
"name": "Spinner",
|
|
28
|
+
"category": "Components_2_0",
|
|
29
|
+
"generation": "2.0",
|
|
30
|
+
"description": "Design system 2.0",
|
|
31
|
+
"props": [
|
|
32
|
+
{
|
|
33
|
+
"name": "size",
|
|
34
|
+
"type": "number",
|
|
35
|
+
"required": false,
|
|
36
|
+
"defaultValue": "40"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "className",
|
|
40
|
+
"type": "string",
|
|
41
|
+
"required": false
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "fullWidth",
|
|
45
|
+
"type": "boolean",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": "false"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "ariaLabel",
|
|
51
|
+
"type": "string",
|
|
52
|
+
"required": false,
|
|
53
|
+
"defaultValue": "'Loading'"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"examples": [],
|
|
57
|
+
"sourceFile": "components/Spinner/Spinner.tsx"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "ProgressBar",
|
|
61
|
+
"category": "Components_2_0",
|
|
62
|
+
"generation": "2.0",
|
|
63
|
+
"description": "A horizontal bar indicating progress toward a goal.\naliases: Progress|LoadingBar|Meter\nDesign system 2.0\n\nNames itself from `labelProps.label` through `aria-labelledby`; without one it\nfalls back to `aria-label`, and finally to `Progress` so the bar is never\nanonymous. Prefer a real label — several bars all announcing \"Progress\" tell a\nscreen reader user nothing about which is which.\n\nScreen readers derive the announced percentage from the value and `max`. When\nthe raw numbers are more useful than a percentage, pass `aria-valuetext`\n(e.g. `\"3 of 10 files\"`); it goes straight through to the element.\n\n`valueLabel` renders a readout at the end of the label row. Formatting stays\nwith the caller — the bar has no way to know how many decimals or which unit\na given quantity deserves. It does not name the bar, so pair it with a\nmatching `aria-valuetext` to have the same reading announced.",
|
|
64
|
+
"props": [
|
|
65
|
+
{
|
|
66
|
+
"name": "value",
|
|
67
|
+
"type": "number",
|
|
68
|
+
"required": true,
|
|
69
|
+
"description": "Current progress. Clamped into `0…max`."
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "max",
|
|
73
|
+
"type": "number",
|
|
74
|
+
"required": false,
|
|
75
|
+
"defaultValue": "100",
|
|
76
|
+
"description": "Value that counts as complete."
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "size",
|
|
80
|
+
"type": "ElementSize",
|
|
81
|
+
"required": false,
|
|
82
|
+
"defaultValue": "ElementSize.Standard",
|
|
83
|
+
"description": "Bar height: standard is 8px, small is 4px."
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "labelProps",
|
|
87
|
+
"type": "LabelProps",
|
|
88
|
+
"required": false,
|
|
89
|
+
"description": "Props of the rendered above the bar, which also names it."
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "valueLabel",
|
|
93
|
+
"type": "ReactNode",
|
|
94
|
+
"required": false,
|
|
95
|
+
"description": "Readout rendered at the end of the label row."
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"examples": [
|
|
99
|
+
"<ProgressBar value={40} labelProps={{ label: 'Uploading' }} />\n<ProgressBar value={3} max={10} aria-valuetext=\"3 of 10 files\" />\n<ProgressBar value={80} size={ElementSize.Small} />\n\n<ProgressBar\n value={3.313182}\n max={500}\n labelProps={{ label: 'Cost per month', caption: 'Billed monthly' }}\n valueLabel=\"3.31 / 500\"\n aria-valuetext=\"3.31 of 500\"\n/>"
|
|
100
|
+
],
|
|
101
|
+
"sourceFile": "components/ProgressBar/ProgressBar.tsx"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"name": "Skeleton",
|
|
105
|
+
"category": "Components_2_0",
|
|
106
|
+
"generation": "2.0",
|
|
107
|
+
"description": "Skeleton\naliases: PlaceholderUI|ShimmerLoader\nDesign system 2.0\n\nA placeholder component to show while content is loading.\nProvides various skeleton shapes and configurations.",
|
|
108
|
+
"props": [
|
|
109
|
+
{
|
|
110
|
+
"name": "active",
|
|
111
|
+
"type": "boolean",
|
|
112
|
+
"required": false,
|
|
113
|
+
"defaultValue": "true",
|
|
114
|
+
"description": "Whether to show the loading animation"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "paragraph",
|
|
118
|
+
"type": "boolean | { rows?: number; width?: string | string[] }",
|
|
119
|
+
"required": false,
|
|
120
|
+
"defaultValue": "true",
|
|
121
|
+
"description": "Show paragraph placeholder or configure its appearance"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"name": "avatar",
|
|
125
|
+
"type": "| boolean\n | {\n size?: number | SkeletonAvatarSize;\n shape?: SkeletonAvatarShape;\n }",
|
|
126
|
+
"required": false,
|
|
127
|
+
"defaultValue": "false",
|
|
128
|
+
"description": "Show avatar placeholder or configure its appearance"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "showTitle",
|
|
132
|
+
"type": "boolean | { width?: string }",
|
|
133
|
+
"required": false,
|
|
134
|
+
"defaultValue": "true",
|
|
135
|
+
"description": "Show title placeholder or configure its appearance"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"name": "loading",
|
|
139
|
+
"type": "boolean",
|
|
140
|
+
"required": false,
|
|
141
|
+
"defaultValue": "true",
|
|
142
|
+
"description": "Display the skeleton when true"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "children",
|
|
146
|
+
"type": "ReactNode",
|
|
147
|
+
"required": false,
|
|
148
|
+
"description": "Content to be displayed when loading is false"
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"name": "variant",
|
|
152
|
+
"type": "SkeletonVariant",
|
|
153
|
+
"required": false,
|
|
154
|
+
"defaultValue": "SkeletonVariant.Default",
|
|
155
|
+
"description": "Skeleton variant"
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"name": "width",
|
|
159
|
+
"type": "string | number",
|
|
160
|
+
"required": false,
|
|
161
|
+
"description": "Width of the skeleton"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"name": "height",
|
|
165
|
+
"type": "string | number",
|
|
166
|
+
"required": false,
|
|
167
|
+
"description": "Height of the skeleton"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "overlay",
|
|
171
|
+
"type": "ReactNode",
|
|
172
|
+
"required": false,
|
|
173
|
+
"description": "Content to overlay on top of the skeleton (e.g., a spinner)"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "color",
|
|
177
|
+
"type": "string",
|
|
178
|
+
"required": false,
|
|
179
|
+
"description": "Custom background color for the skeleton elements (overrides the default token)"
|
|
180
|
+
}
|
|
181
|
+
],
|
|
182
|
+
"examples": [
|
|
183
|
+
"// Simple skeleton\n<Skeleton />\n\n// Text skeleton with custom size\n<Skeleton variant={SkeletonVariant.Text} width=\"200px\" height=\"20px\" />\n\n// Circular avatar skeleton\n<Skeleton variant={SkeletonVariant.Circular} width={40} height={40} />\n\n// Complex skeleton with avatar, showTitle and paragraph\n<Skeleton\n avatar\n showTitle\n paragraph={{ rows: 3 }}\n active\n/>\n\n// Conditional loading\n<Skeleton loading={isLoading}>\n <div>Your content here</div>\n</Skeleton>\n\n// Custom paragraph widths\n<Skeleton\n paragraph={{ rows: 3, width: ['100%', '80%', '60%'] }}\n/>\n\n// Avatar with size and shape\n<Skeleton\n avatar={{\n size: SkeletonAvatarSize.Large,\n shape: SkeletonAvatarShape.Square\n }}\n/>"
|
|
184
|
+
],
|
|
185
|
+
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"name": "Notification",
|
|
189
|
+
"category": "Components_2_0",
|
|
190
|
+
"generation": "2.0",
|
|
191
|
+
"description": "A contextual feedback component for displaying important messages.\naliases: Notification\nDesign system 2.0\n\nRenders a colored container with an icon, message text, and an optional\nclose button.\n\nThe container is a live region whose politeness follows the variant: `error`\nand `warning` use `role=\"alert\"` (assertive, interrupts the screen reader),\nevery other variant uses `role=\"status\"` (polite, queues). Pass an explicit\n`role` to override — including for a notification that is static page content\nrather than an update.",
|
|
192
|
+
"props": [
|
|
193
|
+
{
|
|
194
|
+
"name": "variant",
|
|
195
|
+
"type": "NotificationVariant",
|
|
196
|
+
"required": false,
|
|
197
|
+
"defaultValue": "NotificationVariant.Info",
|
|
198
|
+
"description": "Defines the visual style and icon of the alert"
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "type",
|
|
202
|
+
"type": "NotificationType",
|
|
203
|
+
"required": false,
|
|
204
|
+
"defaultValue": "NotificationType.Toast",
|
|
205
|
+
"description": "Defines the type of notification, either a toast or a section message"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"name": "title",
|
|
209
|
+
"type": "ReactNode",
|
|
210
|
+
"required": false,
|
|
211
|
+
"description": "Optional heading displayed above the message in semibold"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "message",
|
|
215
|
+
"type": "ReactNode",
|
|
216
|
+
"required": true,
|
|
217
|
+
"description": "Message text to display inside the alert"
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"name": "closable",
|
|
221
|
+
"type": "boolean",
|
|
222
|
+
"required": false,
|
|
223
|
+
"defaultValue": "false",
|
|
224
|
+
"description": "Whether the alert has a close button"
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "iconSize",
|
|
228
|
+
"type": "number",
|
|
229
|
+
"required": false,
|
|
230
|
+
"defaultValue": "24",
|
|
231
|
+
"description": "Size of the icon displayed in the alert"
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"name": "iconStroke",
|
|
235
|
+
"type": "number",
|
|
236
|
+
"required": false,
|
|
237
|
+
"defaultValue": "2",
|
|
238
|
+
"description": "Stroke width of the icon displayed in the alert"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"name": "textClassName",
|
|
242
|
+
"type": "string",
|
|
243
|
+
"required": false,
|
|
244
|
+
"description": "Additional CSS classes applied to the message text"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "onClose",
|
|
248
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
249
|
+
"required": false,
|
|
250
|
+
"description": "Callback fired when the close button is clicked"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"examples": [
|
|
254
|
+
"<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/>"
|
|
255
|
+
],
|
|
256
|
+
"sourceFile": "components/New/Notification/Notification.tsx"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "Highlight",
|
|
260
|
+
"category": "Components_2_0",
|
|
261
|
+
"generation": "2.0",
|
|
262
|
+
"description": "Renders text with the first occurrence of `query` wrapped in a highlight mark, with ellipsis truncation and a tooltip when overflowing.\nDesign system 2.0",
|
|
263
|
+
"props": [
|
|
264
|
+
{
|
|
265
|
+
"name": "text",
|
|
266
|
+
"type": "string",
|
|
267
|
+
"required": true
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "query",
|
|
271
|
+
"type": "string",
|
|
272
|
+
"required": true
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "markClassName",
|
|
276
|
+
"type": "string",
|
|
277
|
+
"required": false
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "className",
|
|
281
|
+
"type": "string",
|
|
282
|
+
"required": false
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"name": "maxLines",
|
|
286
|
+
"type": "number",
|
|
287
|
+
"required": false,
|
|
288
|
+
"defaultValue": "2"
|
|
289
|
+
}
|
|
290
|
+
],
|
|
291
|
+
"examples": [],
|
|
292
|
+
"sourceFile": "components/New/Highlight/Highlight.tsx"
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
"name": "CardShell",
|
|
296
|
+
"category": "Components_2_0",
|
|
297
|
+
"generation": "2.0",
|
|
298
|
+
"description": "A shared elevated card shell used as the base wrapper for browse-grid cards.\nDesign system 2.0\n\nRenders an `<article>` with rounded corners, padding, a resting shadow, and\na hover lift with a stronger shadow. Respects `prefers-reduced-motion` by\ndisabling the transform/shadow transition and hover lift.",
|
|
299
|
+
"props": [],
|
|
300
|
+
"examples": [],
|
|
301
|
+
"sourceFile": "components/New/CardShell/CardShell.tsx"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "ErrorMessageNotification",
|
|
305
|
+
"category": "Components_2_0",
|
|
306
|
+
"generation": "2.0",
|
|
307
|
+
"description": "",
|
|
308
|
+
"props": [],
|
|
309
|
+
"examples": [],
|
|
310
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"name": "ErrorToastNotification",
|
|
314
|
+
"category": "Components_2_0",
|
|
315
|
+
"generation": "2.0",
|
|
316
|
+
"description": "",
|
|
317
|
+
"props": [],
|
|
318
|
+
"examples": [],
|
|
319
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
"name": "InfoMessageNotification",
|
|
323
|
+
"category": "Components_2_0",
|
|
324
|
+
"generation": "2.0",
|
|
325
|
+
"description": "",
|
|
326
|
+
"props": [],
|
|
327
|
+
"examples": [],
|
|
328
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "InfoToastNotification",
|
|
332
|
+
"category": "Components_2_0",
|
|
333
|
+
"generation": "2.0",
|
|
334
|
+
"description": "",
|
|
335
|
+
"props": [],
|
|
336
|
+
"examples": [],
|
|
337
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "LoadingMessageNotification",
|
|
341
|
+
"category": "Components_2_0",
|
|
342
|
+
"generation": "2.0",
|
|
343
|
+
"description": "",
|
|
344
|
+
"props": [],
|
|
345
|
+
"examples": [],
|
|
346
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "LoadingToastNotification",
|
|
350
|
+
"category": "Components_2_0",
|
|
351
|
+
"generation": "2.0",
|
|
352
|
+
"description": "",
|
|
353
|
+
"props": [],
|
|
354
|
+
"examples": [],
|
|
355
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
"name": "SuccessMessageNotification",
|
|
359
|
+
"category": "Components_2_0",
|
|
360
|
+
"generation": "2.0",
|
|
361
|
+
"description": "",
|
|
362
|
+
"props": [],
|
|
363
|
+
"examples": [],
|
|
364
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
365
|
+
},
|
|
366
|
+
{
|
|
367
|
+
"name": "SuccessToastNotification",
|
|
368
|
+
"category": "Components_2_0",
|
|
369
|
+
"generation": "2.0",
|
|
370
|
+
"description": "",
|
|
371
|
+
"props": [],
|
|
372
|
+
"examples": [],
|
|
373
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "WarningMessageNotification",
|
|
377
|
+
"category": "Components_2_0",
|
|
378
|
+
"generation": "2.0",
|
|
379
|
+
"description": "",
|
|
380
|
+
"props": [],
|
|
381
|
+
"examples": [],
|
|
382
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "WarningToastNotification",
|
|
386
|
+
"category": "Components_2_0",
|
|
387
|
+
"generation": "2.0",
|
|
388
|
+
"description": "",
|
|
389
|
+
"props": [],
|
|
390
|
+
"examples": [],
|
|
391
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "Calendar",
|
|
395
|
+
"category": "Components_2_0",
|
|
396
|
+
"generation": "2.0",
|
|
397
|
+
"description": "A date/time picker supporting four selection modes.\naliases: DatePicker|DateTimePicker\nDesign system 2.0\n\nRenders a text-field trigger that opens a rounded month-grid popover for\nthe `date`/`datetime` modes, a masked `\"HH:mm\"` text field for `time`, and\na popover list of weekday names for `weekday`. Month/weekday names and\ndate formatting are localized via the `locale` prop.",
|
|
398
|
+
"props": [
|
|
399
|
+
{
|
|
400
|
+
"name": "mode",
|
|
401
|
+
"type": "CalendarMode",
|
|
402
|
+
"required": false,
|
|
403
|
+
"defaultValue": "CalendarMode.Date",
|
|
404
|
+
"description": "Selection mode: date, datetime, time or weekday"
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "value",
|
|
408
|
+
"type": "CalendarValue",
|
|
409
|
+
"required": false,
|
|
410
|
+
"description": "Controlled value: a `Date` for date/datetime, an `\"HH:mm\"` string for time, an ISO weekday number (`\"1\"`=Monday…`\"7\"`=Sunday) for weekday"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "onChange",
|
|
414
|
+
"type": "(value: CalendarValue) => void",
|
|
415
|
+
"required": false,
|
|
416
|
+
"description": "Callback fired with the next value when the selection changes"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "labelProps",
|
|
420
|
+
"type": "LabelProps",
|
|
421
|
+
"required": false,
|
|
422
|
+
"description": "Props of the rendered above the control, including `label`, `required` and `caption`"
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "placeholder",
|
|
426
|
+
"type": "string",
|
|
427
|
+
"required": false,
|
|
428
|
+
"description": "Placeholder shown when there is no value; defaults to a mode-appropriate string (\"Select date\", \"Select date and time\", \"--:--\" or \"Select day\")"
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "disabled",
|
|
432
|
+
"type": "boolean",
|
|
433
|
+
"required": false,
|
|
434
|
+
"defaultValue": "false",
|
|
435
|
+
"description": "Disables the control"
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "invalid",
|
|
439
|
+
"type": "boolean",
|
|
440
|
+
"required": false,
|
|
441
|
+
"defaultValue": "false",
|
|
442
|
+
"description": "Applies error styling"
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"name": "id",
|
|
446
|
+
"type": "string",
|
|
447
|
+
"required": false,
|
|
448
|
+
"description": "id applied to the control, linked to the label"
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
"name": "className",
|
|
452
|
+
"type": "string",
|
|
453
|
+
"required": false,
|
|
454
|
+
"description": "Additional CSS classes applied to the outer container"
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"name": "minDate",
|
|
458
|
+
"type": "Date",
|
|
459
|
+
"required": false,
|
|
460
|
+
"description": "Earliest selectable date (date/datetime modes)"
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"name": "maxDate",
|
|
464
|
+
"type": "Date",
|
|
465
|
+
"required": false,
|
|
466
|
+
"description": "Latest selectable date (date/datetime modes)"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "locale",
|
|
470
|
+
"type": "string",
|
|
471
|
+
"required": false,
|
|
472
|
+
"defaultValue": "DEFAULT_CALENDAR_LOCALE",
|
|
473
|
+
"description": "BCP 47 locale tag used to localize month/weekday names and date formatting"
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "fieldClassName",
|
|
477
|
+
"type": "string",
|
|
478
|
+
"required": false,
|
|
479
|
+
"description": "Additional classes merged onto the trigger field, overriding conflicting defaults"
|
|
480
|
+
}
|
|
481
|
+
],
|
|
482
|
+
"examples": [
|
|
483
|
+
"<Calendar mode={CalendarMode.Date} value={date} onChange={setDate} />\n<Calendar mode={CalendarMode.DateTime} value={date} onChange={setDate} />\n<Calendar mode={CalendarMode.Time} value={time} onChange={setTime} />\n<Calendar mode={CalendarMode.Weekday} value={weekday} onChange={setWeekday} />\n<Calendar mode={CalendarMode.Date} value={date} onChange={setDate} locale=\"de-DE\" />\n<Calendar labelProps={{ label: 'Start date', required: true }} value={date} onChange={setDate} />"
|
|
484
|
+
],
|
|
485
|
+
"sourceFile": "components/New/Calendar/Calendar.tsx"
|
|
486
|
+
},
|
|
487
|
+
{
|
|
488
|
+
"name": "FolderPath",
|
|
489
|
+
"category": "Components_2_0",
|
|
490
|
+
"generation": "2.0",
|
|
491
|
+
"description": "A read-only, non-clickable folder/location path built on top of `DialBreadcrumb`.\naliases: FolderBreadcrumb|LocationPath\nDesign system 2.0\n\nEvery segment is disabled (no navigation); the first segment gets a leading\nfolder icon and the last segment is styled as the current/leaf item.",
|
|
492
|
+
"props": [
|
|
493
|
+
{
|
|
494
|
+
"name": "segments",
|
|
495
|
+
"type": "string[]",
|
|
496
|
+
"required": true,
|
|
497
|
+
"description": "Path segments to display, outermost first"
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"name": "labelClassName",
|
|
501
|
+
"type": "string",
|
|
502
|
+
"required": false,
|
|
503
|
+
"defaultValue": "'dial-small-text'",
|
|
504
|
+
"description": "Additional CSS classes applied to non-leaf segments"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "leafClassName",
|
|
508
|
+
"type": "string",
|
|
509
|
+
"required": false,
|
|
510
|
+
"defaultValue": "'dial-small-semi-text'",
|
|
511
|
+
"description": "Additional CSS classes applied to the last (leaf) segment"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"name": "className",
|
|
515
|
+
"type": "string",
|
|
516
|
+
"required": false,
|
|
517
|
+
"description": "Additional CSS classes applied to the breadcrumb's `<nav>` element.\n`DialBreadcrumb` scrolls horizontally on overflow, so this must not shrink\nthe nav to content width (e.g. never `w-auto`)."
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "ariaLabel",
|
|
521
|
+
"type": "string",
|
|
522
|
+
"required": false,
|
|
523
|
+
"defaultValue": "'Folder path'",
|
|
524
|
+
"description": "Accessible name for the underlying `<nav>`.\n`DialBreadcrumb` would otherwise name it \"Breadcrumb\", which misdescribes a\npath with no navigable items; override it when a page shows more than one."
|
|
525
|
+
}
|
|
526
|
+
],
|
|
527
|
+
"examples": [
|
|
528
|
+
"<FolderPath segments={['Shared', 'Team Space', 'Reports']} />"
|
|
529
|
+
],
|
|
530
|
+
"sourceFile": "components/New/FolderPath/FolderPath.tsx"
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "DangerButton",
|
|
534
|
+
"category": "Components_2_0",
|
|
535
|
+
"generation": "2.0",
|
|
536
|
+
"description": "A Danger Button component with predefined danger variant",
|
|
537
|
+
"props": [],
|
|
538
|
+
"examples": [
|
|
539
|
+
"<DangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
540
|
+
],
|
|
541
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"name": "GhostButton",
|
|
545
|
+
"category": "Components_2_0",
|
|
546
|
+
"generation": "2.0",
|
|
547
|
+
"description": "A Ghost Button component with predefined ghost appearance",
|
|
548
|
+
"props": [],
|
|
549
|
+
"examples": [
|
|
550
|
+
"<GhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
551
|
+
],
|
|
552
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "LinkButton",
|
|
556
|
+
"category": "Components_2_0",
|
|
557
|
+
"generation": "2.0",
|
|
558
|
+
"description": "A Link Button component with predefined link appearance",
|
|
559
|
+
"props": [],
|
|
560
|
+
"examples": [
|
|
561
|
+
"<LinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>",
|
|
562
|
+
"<LinkButton label=\"Read the docs\" href=\"/docs\" />\n<LinkButton label=\"Open dashboard\" href=\"https://example.com\" target=\"_blank\" />"
|
|
563
|
+
],
|
|
564
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"name": "NeutralButton",
|
|
568
|
+
"category": "Components_2_0",
|
|
569
|
+
"generation": "2.0",
|
|
570
|
+
"description": "A Neutral Button component with predefined neutral variant",
|
|
571
|
+
"props": [],
|
|
572
|
+
"examples": [
|
|
573
|
+
"<NeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
574
|
+
],
|
|
575
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "OutlinedButton",
|
|
579
|
+
"category": "Components_2_0",
|
|
580
|
+
"generation": "2.0",
|
|
581
|
+
"description": "An Outlined Button component with predefined outlined appearance",
|
|
582
|
+
"props": [],
|
|
583
|
+
"examples": [
|
|
584
|
+
"<OutlinedButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
585
|
+
],
|
|
586
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "PrimaryButton",
|
|
590
|
+
"category": "Components_2_0",
|
|
591
|
+
"generation": "2.0",
|
|
592
|
+
"description": "A Primary Button component with predefined primary variant\nDesign system 2.0",
|
|
593
|
+
"props": [],
|
|
594
|
+
"examples": [
|
|
595
|
+
"<PrimaryButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
596
|
+
],
|
|
597
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "DangerIconButton",
|
|
601
|
+
"category": "Components_2_0",
|
|
602
|
+
"generation": "2.0",
|
|
603
|
+
"description": "A Danger Icon Button component with predefined danger variant",
|
|
604
|
+
"props": [],
|
|
605
|
+
"examples": [
|
|
606
|
+
"<DangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
607
|
+
],
|
|
608
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
"name": "GhostIconButton",
|
|
612
|
+
"category": "Components_2_0",
|
|
613
|
+
"generation": "2.0",
|
|
614
|
+
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
615
|
+
"props": [],
|
|
616
|
+
"examples": [
|
|
617
|
+
"<GhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
618
|
+
],
|
|
619
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "NeutralIconButton",
|
|
623
|
+
"category": "Components_2_0",
|
|
624
|
+
"generation": "2.0",
|
|
625
|
+
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
626
|
+
"props": [],
|
|
627
|
+
"examples": [
|
|
628
|
+
"<NeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
629
|
+
],
|
|
630
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
631
|
+
},
|
|
632
|
+
{
|
|
633
|
+
"name": "PrimaryIconButton",
|
|
634
|
+
"category": "Components_2_0",
|
|
635
|
+
"generation": "2.0",
|
|
636
|
+
"description": "A Primary Icon Button component with predefined primary variant\nDesign system 2.0",
|
|
637
|
+
"props": [],
|
|
638
|
+
"examples": [
|
|
639
|
+
"<PrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
640
|
+
],
|
|
641
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"name": "StaticIconButton",
|
|
645
|
+
"category": "Components_2_0",
|
|
646
|
+
"generation": "2.0",
|
|
647
|
+
"description": "A Outlined Icon Button component with predefined outlined appearance",
|
|
648
|
+
"props": [],
|
|
649
|
+
"examples": [
|
|
650
|
+
"<StaticIconButton\n icon={<Icon />}\n onClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
651
|
+
],
|
|
652
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "Button",
|
|
656
|
+
"category": "Components_2_0",
|
|
657
|
+
"generation": "2.0",
|
|
658
|
+
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction\nDesign system 2.0",
|
|
659
|
+
"props": [
|
|
660
|
+
{
|
|
661
|
+
"name": "variant",
|
|
662
|
+
"type": "ButtonVariant",
|
|
663
|
+
"required": false,
|
|
664
|
+
"description": "Defines the visual style of the button"
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "size",
|
|
668
|
+
"type": "ElementSize",
|
|
669
|
+
"required": false,
|
|
670
|
+
"defaultValue": "ElementSize.Standard",
|
|
671
|
+
"description": "Defines the size of the button"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "appearance",
|
|
675
|
+
"type": "ButtonAppearance",
|
|
676
|
+
"required": false,
|
|
677
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
678
|
+
"description": "Defines the type of the button"
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "textClassName",
|
|
682
|
+
"type": "string",
|
|
683
|
+
"required": false,
|
|
684
|
+
"description": "Additional CSS classes to apply specifically to the button text"
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "label",
|
|
688
|
+
"type": "ReactNode",
|
|
689
|
+
"required": false,
|
|
690
|
+
"description": "The content of the button. Can be any React node."
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"name": "iconBefore",
|
|
694
|
+
"type": "ReactNode",
|
|
695
|
+
"required": false,
|
|
696
|
+
"description": "Icon or element to display before the button text"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "iconAfter",
|
|
700
|
+
"type": "ReactNode",
|
|
701
|
+
"required": false,
|
|
702
|
+
"description": "Icon or element to display after the button text"
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "tooltipProps",
|
|
706
|
+
"type": "TooltipProps",
|
|
707
|
+
"required": false
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"name": "href",
|
|
711
|
+
"type": "string",
|
|
712
|
+
"required": false,
|
|
713
|
+
"description": "Destination to navigate to. Renders an `<a>` instead of a\n`<button>`, so the control keeps the link role, middle-click, and\n\"open in new tab\". Pair it with `ButtonAppearance.Link` (or `LinkButton`)\nunless a button-shaped link is intended."
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "target",
|
|
717
|
+
"type": "HTMLAttributeAnchorTarget",
|
|
718
|
+
"required": false,
|
|
719
|
+
"description": "Anchor target, only meaningful alongside `href`"
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"name": "rel",
|
|
723
|
+
"type": "string",
|
|
724
|
+
"required": false,
|
|
725
|
+
"description": "Anchor `rel`. Defaults to `noopener noreferrer` when\n`target=\"_blank\"`."
|
|
726
|
+
}
|
|
727
|
+
],
|
|
728
|
+
"examples": [
|
|
729
|
+
"<Button\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
730
|
+
"<Button\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
731
|
+
],
|
|
732
|
+
"sourceFile": "components/New/Button/Button.tsx"
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "IconButton",
|
|
736
|
+
"category": "Components_2_0",
|
|
737
|
+
"generation": "2.0",
|
|
738
|
+
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton\nDesign system 2.0",
|
|
739
|
+
"props": [
|
|
740
|
+
{
|
|
741
|
+
"name": "variant",
|
|
742
|
+
"type": "ButtonVariant",
|
|
743
|
+
"required": false,
|
|
744
|
+
"description": "Defines the visual style of the button"
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
"name": "size",
|
|
748
|
+
"type": "ElementSize",
|
|
749
|
+
"required": false,
|
|
750
|
+
"defaultValue": "ElementSize.Standard",
|
|
751
|
+
"description": "Defines the size of the button"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"name": "appearance",
|
|
755
|
+
"type": "ButtonAppearance",
|
|
756
|
+
"required": false,
|
|
757
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
758
|
+
"description": "Defines the type of the button"
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
"name": "icon",
|
|
762
|
+
"type": "ReactNode",
|
|
763
|
+
"required": true,
|
|
764
|
+
"description": "Icon display"
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "tooltipProps",
|
|
768
|
+
"type": "TooltipProps",
|
|
769
|
+
"required": false
|
|
770
|
+
}
|
|
771
|
+
],
|
|
772
|
+
"examples": [
|
|
773
|
+
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
774
|
+
"<IconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
775
|
+
],
|
|
776
|
+
"sourceFile": "components/New/IconButton/IconButton.tsx"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "FabButton",
|
|
780
|
+
"category": "Components_2_0",
|
|
781
|
+
"generation": "2.0",
|
|
782
|
+
"description": "A Floating Action Button (FAB) component — circular icon button for primary actions.\naliases: FloatingActionButton|FabButton|CircularButton\nDesign system 2.0",
|
|
783
|
+
"props": [
|
|
784
|
+
{
|
|
785
|
+
"name": "icon",
|
|
786
|
+
"type": "ReactNode",
|
|
787
|
+
"required": false,
|
|
788
|
+
"description": "Icon to display inside the button"
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "tooltipProps",
|
|
792
|
+
"type": "TooltipProps",
|
|
793
|
+
"required": false,
|
|
794
|
+
"description": "Optional tooltip configuration"
|
|
795
|
+
}
|
|
796
|
+
],
|
|
797
|
+
"examples": [
|
|
798
|
+
"<FabButton\n icon={<IconArrowNarrowDown size={24} stroke={1.5} />}\n onClick={handleClick}\n aria-label=\"Scroll to bottom\"\n/>"
|
|
799
|
+
],
|
|
800
|
+
"sourceFile": "components/FabButton/FabButton.tsx"
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"name": "ButtonDropdown",
|
|
804
|
+
"category": "Components_2_0",
|
|
805
|
+
"generation": "2.0",
|
|
806
|
+
"description": "A Button dropdown component based on the Dropdown component\naliases: SplitButton|MenuButton\nDesign system 2.0",
|
|
807
|
+
"props": [
|
|
808
|
+
{
|
|
809
|
+
"name": "items",
|
|
810
|
+
"type": "DropdownItem[]",
|
|
811
|
+
"required": true,
|
|
812
|
+
"description": "DropdownItems with actions"
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"examples": [
|
|
816
|
+
"<ButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
817
|
+
],
|
|
818
|
+
"sourceFile": "components/New/ButtonDropdown/ButtonDropdown.tsx"
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"name": "MarkdownEditor",
|
|
822
|
+
"category": "Components_2_0",
|
|
823
|
+
"generation": "2.0",
|
|
824
|
+
"description": "The 2.0 Markdown editor: a formatting toolbar (bold/italic/strikethrough,\nDesign system 2.0\ntext style, lists, quote/link/code, table) plus an edit/live/preview mode\nswitcher and fullscreen, built on top of `@uiw/react-md-editor`.\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyMarkdownEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
825
|
+
"props": [
|
|
826
|
+
{
|
|
827
|
+
"name": "value",
|
|
828
|
+
"type": "string",
|
|
829
|
+
"required": false,
|
|
830
|
+
"description": "The current markdown content"
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"name": "onChange",
|
|
834
|
+
"type": "(value: string) => void",
|
|
835
|
+
"required": false,
|
|
836
|
+
"description": "Callback fired when the editor content changes"
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "height",
|
|
840
|
+
"type": "number",
|
|
841
|
+
"required": false,
|
|
842
|
+
"defaultValue": "300",
|
|
843
|
+
"description": "Height of the editor in pixels"
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"name": "theme",
|
|
847
|
+
"type": "EditorThemes",
|
|
848
|
+
"required": false,
|
|
849
|
+
"defaultValue": "EditorThemes.light",
|
|
850
|
+
"description": "Theme for the editor ('light' or 'dark')"
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "className",
|
|
854
|
+
"type": "string",
|
|
855
|
+
"required": false,
|
|
856
|
+
"description": "Additional CSS classes for the container"
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
"name": "placeholder",
|
|
860
|
+
"type": "string",
|
|
861
|
+
"required": false,
|
|
862
|
+
"description": "Placeholder text shown when the editor is empty"
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"name": "defaultPreview",
|
|
866
|
+
"type": "PreviewType",
|
|
867
|
+
"required": false,
|
|
868
|
+
"defaultValue": "'edit'",
|
|
869
|
+
"description": "Initial edit/live/preview mode"
|
|
870
|
+
}
|
|
871
|
+
],
|
|
872
|
+
"examples": [
|
|
873
|
+
"<MarkdownEditor value={value} onChange={setValue} height={400} />"
|
|
874
|
+
],
|
|
875
|
+
"sourceFile": "components/New/MarkdownEditor/MarkdownEditor.tsx",
|
|
876
|
+
"lazy": {
|
|
877
|
+
"loaderExportName": "LazyMarkdownEditor",
|
|
878
|
+
"packageImport": "@epam/ai-dial-ui-kit",
|
|
879
|
+
"ssr": false,
|
|
880
|
+
"nextDynamicExample": "import dynamic from 'next/dynamic';\nimport { LazyMarkdownEditor } from '@epam/ai-dial-ui-kit';\n\nconst MarkdownEditor = dynamic(\n async () => (await LazyMarkdownEditor()).MarkdownEditor,\n { ssr: false },\n);"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"name": "InlineSelect",
|
|
885
|
+
"category": "Components_2_0",
|
|
886
|
+
"generation": "2.0",
|
|
887
|
+
"description": "An inline select control combining `InlineSelectTrigger` with `Dropdown`.\nDesign system 2.0",
|
|
888
|
+
"props": [
|
|
889
|
+
{
|
|
890
|
+
"name": "items",
|
|
891
|
+
"type": "DropdownItem[]",
|
|
892
|
+
"required": true
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"name": "selectedKey",
|
|
896
|
+
"type": "string",
|
|
897
|
+
"required": false
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"name": "defaultSelectedKey",
|
|
901
|
+
"type": "string",
|
|
902
|
+
"required": false
|
|
903
|
+
},
|
|
904
|
+
{
|
|
905
|
+
"name": "onSelect",
|
|
906
|
+
"type": "(item: DropdownItem) => void",
|
|
907
|
+
"required": false
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"name": "size",
|
|
911
|
+
"type": "ElementSize",
|
|
912
|
+
"required": false
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"name": "disabled",
|
|
916
|
+
"type": "boolean",
|
|
917
|
+
"required": false
|
|
918
|
+
},
|
|
919
|
+
{
|
|
920
|
+
"name": "placement",
|
|
921
|
+
"type": "Placement",
|
|
922
|
+
"required": false,
|
|
923
|
+
"defaultValue": "'bottom-end'"
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "matchReferenceWidth",
|
|
927
|
+
"type": "boolean",
|
|
928
|
+
"required": false,
|
|
929
|
+
"defaultValue": "false"
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "listClassName",
|
|
933
|
+
"type": "string",
|
|
934
|
+
"required": false
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "ariaLabel",
|
|
938
|
+
"type": "string",
|
|
939
|
+
"required": false
|
|
940
|
+
}
|
|
941
|
+
],
|
|
942
|
+
"examples": [
|
|
943
|
+
"<InlineSelect\n items={[{ key: 'a', label: 'Option A' }, { key: 'b', label: 'Option B' }]}\n onSelect={(item) => console.log(item.key)}\n/>"
|
|
944
|
+
],
|
|
945
|
+
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx"
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"name": "InlineSelectTrigger",
|
|
949
|
+
"category": "Components_2_0",
|
|
950
|
+
"generation": "2.0",
|
|
951
|
+
"description": "",
|
|
952
|
+
"props": [
|
|
953
|
+
{
|
|
954
|
+
"name": "label",
|
|
955
|
+
"type": "string",
|
|
956
|
+
"required": true
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "size",
|
|
960
|
+
"type": "ElementSize",
|
|
961
|
+
"required": false
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"name": "isOpen",
|
|
965
|
+
"type": "boolean",
|
|
966
|
+
"required": false,
|
|
967
|
+
"defaultValue": "false"
|
|
968
|
+
}
|
|
969
|
+
],
|
|
970
|
+
"examples": [],
|
|
971
|
+
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "Select",
|
|
975
|
+
"category": "Components_2_0",
|
|
976
|
+
"generation": "2.0",
|
|
977
|
+
"description": "A versatile select supporting single and multiple selections.\naliases: OptionPicker|ChoiceSelector\nDesign system 2.0\n\nThe field is an , so it carries the 2.0 field styling, sizes,\nlabel, caption and error states, and it exposes the control as a `combobox`\nwhose popup is the option list.\n\nSingle mode:\n- The field shows the selected option's leading icon + label.\n- In the list, the selected option is indicated by a LEFT border, a tinted background\n and a trailing check icon.\n\nMultiple mode uses checkboxes (including Select All with indeterminate state) and\nrenders the selection as removable tags inside the field.\n\nThe field itself is never typeable: `searchable` puts a search field in the overlay\nheader that filters the options.",
|
|
978
|
+
"props": [
|
|
979
|
+
{
|
|
980
|
+
"name": "options",
|
|
981
|
+
"type": "SelectOption[]",
|
|
982
|
+
"required": true,
|
|
983
|
+
"description": "Array of options to select from."
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"name": "multiple",
|
|
987
|
+
"type": "boolean",
|
|
988
|
+
"required": false,
|
|
989
|
+
"defaultValue": "false",
|
|
990
|
+
"description": "Whether multiple selections are allowed."
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "id",
|
|
994
|
+
"type": "string",
|
|
995
|
+
"required": false,
|
|
996
|
+
"description": "The id of the field, linked to the label."
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "size",
|
|
1000
|
+
"type": "ElementSize",
|
|
1001
|
+
"required": false,
|
|
1002
|
+
"defaultValue": "ElementSize.Standard",
|
|
1003
|
+
"description": "Field height: standard is 40px, small is 24px."
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "value",
|
|
1007
|
+
"type": "string | string[]",
|
|
1008
|
+
"required": false,
|
|
1009
|
+
"description": "Controlled selected value(s)."
|
|
1010
|
+
},
|
|
1011
|
+
{
|
|
1012
|
+
"name": "customSelectedValue",
|
|
1013
|
+
"type": "string",
|
|
1014
|
+
"required": false,
|
|
1015
|
+
"description": "Custom string to render as the selected value in single mode."
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"name": "prefix",
|
|
1019
|
+
"type": "string",
|
|
1020
|
+
"required": false,
|
|
1021
|
+
"description": "Prefix for selected value(s)."
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"name": "defaultValue",
|
|
1025
|
+
"type": "string | string[]",
|
|
1026
|
+
"required": false,
|
|
1027
|
+
"description": "Uncontrolled initial selected value(s)."
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"name": "placeholder",
|
|
1031
|
+
"type": "string",
|
|
1032
|
+
"required": false,
|
|
1033
|
+
"defaultValue": "'Select...'",
|
|
1034
|
+
"description": "Placeholder text when no selection is made."
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "labelProps",
|
|
1038
|
+
"type": "LabelProps",
|
|
1039
|
+
"required": false,
|
|
1040
|
+
"description": "Props of the rendered above the field."
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "error",
|
|
1044
|
+
"type": "string",
|
|
1045
|
+
"required": false,
|
|
1046
|
+
"description": "Error message rendered below the field (does not by itself apply error styling, pass `invalid` too)."
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"name": "caption",
|
|
1050
|
+
"type": "string",
|
|
1051
|
+
"required": false,
|
|
1052
|
+
"description": "Helper text rendered below the field when there is no `error`."
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "ariaLabel",
|
|
1056
|
+
"type": "string",
|
|
1057
|
+
"required": false,
|
|
1058
|
+
"description": "Accessible name for the field; use it when there is no visible label."
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "searchable",
|
|
1062
|
+
"type": "boolean",
|
|
1063
|
+
"required": false,
|
|
1064
|
+
"defaultValue": "false",
|
|
1065
|
+
"description": "Show a search field in the overlay header."
|
|
1066
|
+
},
|
|
1067
|
+
{
|
|
1068
|
+
"name": "searchSize",
|
|
1069
|
+
"type": "ElementSize",
|
|
1070
|
+
"required": false,
|
|
1071
|
+
"defaultValue": "ElementSize.Standard",
|
|
1072
|
+
"description": "Size of the overlay search input when `searchable` is enabled."
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "searchPlaceholder",
|
|
1076
|
+
"type": "string",
|
|
1077
|
+
"required": false,
|
|
1078
|
+
"description": "Placeholder for the overlay search input."
|
|
1079
|
+
},
|
|
1080
|
+
{
|
|
1081
|
+
"name": "selectAll",
|
|
1082
|
+
"type": "boolean",
|
|
1083
|
+
"required": false,
|
|
1084
|
+
"defaultValue": "false",
|
|
1085
|
+
"description": "Show a \"Select All\" checkbox in multiple mode."
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"name": "selectAllLabel",
|
|
1089
|
+
"type": "string",
|
|
1090
|
+
"required": false,
|
|
1091
|
+
"defaultValue": "'Select all'",
|
|
1092
|
+
"description": "Label for the \"Select All\" checkbox."
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "emptyStateTitle",
|
|
1096
|
+
"type": "string",
|
|
1097
|
+
"required": false,
|
|
1098
|
+
"defaultValue": "'No options available'",
|
|
1099
|
+
"description": "Title text when there are no options."
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"name": "emptyStateDescription",
|
|
1103
|
+
"type": "string",
|
|
1104
|
+
"required": false,
|
|
1105
|
+
"description": "Description text when there are no options."
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"name": "emptyStateIcon",
|
|
1109
|
+
"type": "ReactNode",
|
|
1110
|
+
"required": false,
|
|
1111
|
+
"description": "Icon to display when there are no options."
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "disabled",
|
|
1115
|
+
"type": "boolean",
|
|
1116
|
+
"required": false,
|
|
1117
|
+
"defaultValue": "false",
|
|
1118
|
+
"description": "Disable the control."
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"name": "className",
|
|
1122
|
+
"type": "string",
|
|
1123
|
+
"required": false,
|
|
1124
|
+
"description": "Additional CSS classes for the outer container."
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "fieldClassName",
|
|
1128
|
+
"type": "string",
|
|
1129
|
+
"required": false,
|
|
1130
|
+
"description": "Additional CSS classes for the field itself."
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"name": "listClassName",
|
|
1134
|
+
"type": "string",
|
|
1135
|
+
"required": false,
|
|
1136
|
+
"description": "Additional CSS classes for the list dropdown."
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "closable",
|
|
1140
|
+
"type": "boolean",
|
|
1141
|
+
"required": false,
|
|
1142
|
+
"defaultValue": "false",
|
|
1143
|
+
"description": "Show a close button in the dropdown header."
|
|
1144
|
+
},
|
|
1145
|
+
{
|
|
1146
|
+
"name": "invalid",
|
|
1147
|
+
"type": "boolean",
|
|
1148
|
+
"required": false,
|
|
1149
|
+
"description": "Whether the select is in an invalid state, affecting styling."
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
"name": "header",
|
|
1153
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1154
|
+
"required": false,
|
|
1155
|
+
"description": "Custom node/function rendered above the options."
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"name": "footer",
|
|
1159
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1160
|
+
"required": false,
|
|
1161
|
+
"description": "Custom node/function rendered below the options."
|
|
1162
|
+
},
|
|
1163
|
+
{
|
|
1164
|
+
"name": "open",
|
|
1165
|
+
"type": "boolean",
|
|
1166
|
+
"required": false,
|
|
1167
|
+
"description": "Controlled open state of the dropdown. When provided, makes the dropdown controlled."
|
|
1168
|
+
},
|
|
1169
|
+
{
|
|
1170
|
+
"name": "onOpenChange",
|
|
1171
|
+
"type": "(open: boolean) => void",
|
|
1172
|
+
"required": false,
|
|
1173
|
+
"description": "Called when the dropdown open state changes."
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"name": "onSearchQueryChange",
|
|
1177
|
+
"type": "(query: string) => void",
|
|
1178
|
+
"required": false,
|
|
1179
|
+
"description": "Called when the overlay search query changes, including the reset to `''` on close. Use it to fetch options for the query."
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"name": "dismissRef",
|
|
1183
|
+
"type": "Ref<unknown>",
|
|
1184
|
+
"required": false,
|
|
1185
|
+
"description": "Ref object to expose a `dismiss` method to programmatically close the select."
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"name": "onClose",
|
|
1189
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1190
|
+
"required": false,
|
|
1191
|
+
"description": "Called when the dropdown close button is clicked."
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "onChange",
|
|
1195
|
+
"type": "(next: string | string[]) => void",
|
|
1196
|
+
"required": false,
|
|
1197
|
+
"description": "Called when the selection changes."
|
|
1198
|
+
},
|
|
1199
|
+
{
|
|
1200
|
+
"name": "onFooterClick",
|
|
1201
|
+
"type": "(e: MouseEvent<HTMLDivElement>) => void",
|
|
1202
|
+
"required": false,
|
|
1203
|
+
"description": "Called when the footer element is clicked. When provided, automatically closes the dropdown."
|
|
1204
|
+
},
|
|
1205
|
+
{
|
|
1206
|
+
"name": "customMultiSelectTagsRenderer",
|
|
1207
|
+
"type": "(\n options: SelectOption[],\n selectedValues: string[],\n handleRemoveTag: (\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void,\n ) => ReactNode",
|
|
1208
|
+
"required": false,
|
|
1209
|
+
"description": "Renders the selected tags of a multi-select in place of the default ones."
|
|
1210
|
+
}
|
|
1211
|
+
],
|
|
1212
|
+
"examples": [
|
|
1213
|
+
"<Select options={[{ value: 'option-1', label: 'Option 1' }]} />\n<Select searchable options={[{ value: 'a', label: 'Alpha' }, { value: 'b', label: 'Beta' }]} />\n<Select multiple selectAll options={[{ value: '1', label: 'One' }, { value: '2', label: 'Two' }]} />\n<Select labelProps={{ label: 'Operator' }} caption=\"Pick a comparison\" options={options} />"
|
|
1214
|
+
],
|
|
1215
|
+
"sourceFile": "components/New/Select/Select.tsx"
|
|
1216
|
+
},
|
|
1217
|
+
{
|
|
1218
|
+
"name": "MultiSelectTags",
|
|
1219
|
+
"category": "Components_2_0",
|
|
1220
|
+
"generation": "2.0",
|
|
1221
|
+
"description": "The selected values of a multi-select, rendered as removable tags inside the\nDesign system 2.0\nfield.",
|
|
1222
|
+
"props": [
|
|
1223
|
+
{
|
|
1224
|
+
"name": "options",
|
|
1225
|
+
"type": "SelectOption[]",
|
|
1226
|
+
"required": true,
|
|
1227
|
+
"description": "All available options, used to resolve labels and icons"
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "selectedValues",
|
|
1231
|
+
"type": "string[]",
|
|
1232
|
+
"required": true,
|
|
1233
|
+
"description": "Values currently selected"
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "handleRemoveTag",
|
|
1237
|
+
"type": "(\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void",
|
|
1238
|
+
"required": false,
|
|
1239
|
+
"description": "Called with the value whose tag was removed; when omitted the tags are not removable"
|
|
1240
|
+
}
|
|
1241
|
+
],
|
|
1242
|
+
"examples": [],
|
|
1243
|
+
"sourceFile": "components/New/Select/MultiSelectTags.tsx"
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"name": "InfoButton",
|
|
1247
|
+
"category": "Components_2_0",
|
|
1248
|
+
"generation": "2.0",
|
|
1249
|
+
"description": "An Info button component with a customizable icon and accessible label.\nDesign system 2.0",
|
|
1250
|
+
"props": [
|
|
1251
|
+
{
|
|
1252
|
+
"name": "caption",
|
|
1253
|
+
"type": "string",
|
|
1254
|
+
"required": false,
|
|
1255
|
+
"description": "Text shown in the tooltip, and the fallback accessible name"
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "onClick",
|
|
1259
|
+
"type": "() => void",
|
|
1260
|
+
"required": false,
|
|
1261
|
+
"description": "Click handler for the info button"
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"name": "'aria-label'",
|
|
1265
|
+
"type": "string",
|
|
1266
|
+
"required": false
|
|
1267
|
+
}
|
|
1268
|
+
],
|
|
1269
|
+
"examples": [
|
|
1270
|
+
"<InfoButton\n caption=\"Info\"\n/>"
|
|
1271
|
+
],
|
|
1272
|
+
"sourceFile": "components/New/InfoButton/InfoButton.tsx"
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"name": "Label",
|
|
1276
|
+
"category": "Components_2_0",
|
|
1277
|
+
"generation": "2.0",
|
|
1278
|
+
"description": "A label component\naliases: FormLabel|RequiredIndicator\nDesign system 2.0",
|
|
1279
|
+
"props": [
|
|
1280
|
+
{
|
|
1281
|
+
"name": "label",
|
|
1282
|
+
"type": "ReactNode",
|
|
1283
|
+
"required": false,
|
|
1284
|
+
"description": "The label text to display for the label"
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"name": "required",
|
|
1288
|
+
"type": "boolean",
|
|
1289
|
+
"required": false,
|
|
1290
|
+
"description": "Whether the field is required. Renders a visual `*`\nplus visually hidden text so the requirement is announced too."
|
|
1291
|
+
},
|
|
1292
|
+
{
|
|
1293
|
+
"name": "caption",
|
|
1294
|
+
"type": "string",
|
|
1295
|
+
"required": false,
|
|
1296
|
+
"description": "Explanatory text, exposed through an info button next to the label"
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "size",
|
|
1300
|
+
"type": "ElementSize",
|
|
1301
|
+
"required": false,
|
|
1302
|
+
"defaultValue": "ElementSize.Small",
|
|
1303
|
+
"description": "The size of the label, which can be 'small', 'medium', or 'large'."
|
|
1304
|
+
}
|
|
1305
|
+
],
|
|
1306
|
+
"examples": [
|
|
1307
|
+
"// Basic label\n<Label htmlFor=\"email-input\" label=\"Email Address\" />"
|
|
1308
|
+
],
|
|
1309
|
+
"sourceFile": "components/New/Label/Label.tsx"
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"name": "Textarea",
|
|
1313
|
+
"category": "Components_2_0",
|
|
1314
|
+
"generation": "2.0",
|
|
1315
|
+
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox\nDesign system 2.0",
|
|
1316
|
+
"props": [
|
|
1317
|
+
{
|
|
1318
|
+
"name": "labelProps",
|
|
1319
|
+
"type": "LabelProps",
|
|
1320
|
+
"required": false,
|
|
1321
|
+
"description": "Props for the field label, including `label` (label text) and `required` (whether to show required indicator)"
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"name": "invalid",
|
|
1325
|
+
"type": "boolean",
|
|
1326
|
+
"required": false,
|
|
1327
|
+
"description": "Whether the textarea has validation errors (applies error styling)"
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "containerClassName",
|
|
1331
|
+
"type": "string",
|
|
1332
|
+
"required": false,
|
|
1333
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
1334
|
+
},
|
|
1335
|
+
{
|
|
1336
|
+
"name": "resize",
|
|
1337
|
+
"type": "boolean",
|
|
1338
|
+
"required": false,
|
|
1339
|
+
"defaultValue": "false",
|
|
1340
|
+
"description": "Whether the textarea has possibility to resize"
|
|
1341
|
+
},
|
|
1342
|
+
{
|
|
1343
|
+
"name": "error",
|
|
1344
|
+
"type": "string",
|
|
1345
|
+
"required": false,
|
|
1346
|
+
"description": "Error message to display below the textarea (also adds error styling)"
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
"name": "caption",
|
|
1350
|
+
"type": "string",
|
|
1351
|
+
"required": false,
|
|
1352
|
+
"description": "Optional caption text to display below the textarea"
|
|
1353
|
+
},
|
|
1354
|
+
{
|
|
1355
|
+
"name": "onChange",
|
|
1356
|
+
"type": "(value: string) => void",
|
|
1357
|
+
"required": false,
|
|
1358
|
+
"description": "Callback function called when the textarea value changes"
|
|
1359
|
+
}
|
|
1360
|
+
],
|
|
1361
|
+
"examples": [
|
|
1362
|
+
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
1363
|
+
],
|
|
1364
|
+
"sourceFile": "components/New/Textarea/Textarea.tsx"
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
"name": "Input",
|
|
1368
|
+
"category": "Components_2_0",
|
|
1369
|
+
"generation": "2.0",
|
|
1370
|
+
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput\nDesign system 2.0",
|
|
1371
|
+
"props": [
|
|
1372
|
+
{
|
|
1373
|
+
"name": "labelProps",
|
|
1374
|
+
"type": "LabelProps",
|
|
1375
|
+
"required": false
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"name": "inputButtonProps",
|
|
1379
|
+
"type": "InputButtonProps",
|
|
1380
|
+
"required": false
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "size",
|
|
1384
|
+
"type": "ElementSize",
|
|
1385
|
+
"required": false,
|
|
1386
|
+
"defaultValue": "ElementSize.Standard",
|
|
1387
|
+
"description": "The size of the input, which can be 'small', 'standard', or 'large'."
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
"name": "invalid",
|
|
1391
|
+
"type": "boolean",
|
|
1392
|
+
"required": false,
|
|
1393
|
+
"description": "Whether the input has validation errors (applies error styling)"
|
|
1394
|
+
},
|
|
1395
|
+
{
|
|
1396
|
+
"name": "error",
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"required": false,
|
|
1399
|
+
"description": "Error message to display below the input (also adds error styling)"
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
"name": "caption",
|
|
1403
|
+
"type": "string",
|
|
1404
|
+
"required": false,
|
|
1405
|
+
"description": "Helper text to display below the input"
|
|
1406
|
+
},
|
|
1407
|
+
{
|
|
1408
|
+
"name": "tooltipText",
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"required": false
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"name": "iconBefore",
|
|
1414
|
+
"type": "ReactNode",
|
|
1415
|
+
"required": false,
|
|
1416
|
+
"description": "Icon or element to display before the input"
|
|
1417
|
+
},
|
|
1418
|
+
{
|
|
1419
|
+
"name": "iconAfter",
|
|
1420
|
+
"type": "ReactNode",
|
|
1421
|
+
"required": false,
|
|
1422
|
+
"description": "Icon or element to display after the input"
|
|
1423
|
+
},
|
|
1424
|
+
{
|
|
1425
|
+
"name": "children",
|
|
1426
|
+
"type": "ReactNode",
|
|
1427
|
+
"required": false,
|
|
1428
|
+
"description": "Content rendered inside the field before the input, for values a plain `<input>` cannot hold (e.g. multi-select tags)"
|
|
1429
|
+
},
|
|
1430
|
+
{
|
|
1431
|
+
"name": "prefix",
|
|
1432
|
+
"type": "string",
|
|
1433
|
+
"required": false
|
|
1434
|
+
},
|
|
1435
|
+
{
|
|
1436
|
+
"name": "postfix",
|
|
1437
|
+
"type": "string",
|
|
1438
|
+
"required": false
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
"name": "inputRef",
|
|
1442
|
+
"type": "Ref<HTMLInputElement>",
|
|
1443
|
+
"required": false,
|
|
1444
|
+
"description": "Ref to access the underlying input element"
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"name": "wrapperRef",
|
|
1448
|
+
"type": "Ref<HTMLDivElement>",
|
|
1449
|
+
"required": false
|
|
1450
|
+
},
|
|
1451
|
+
{
|
|
1452
|
+
"name": "onChange",
|
|
1453
|
+
"type": "(value?: string) => void",
|
|
1454
|
+
"required": false,
|
|
1455
|
+
"description": "Callback function called when the input value changes"
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "containerClassName",
|
|
1459
|
+
"type": "string",
|
|
1460
|
+
"required": false,
|
|
1461
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
1462
|
+
},
|
|
1463
|
+
{
|
|
1464
|
+
"name": "wrapperClassName",
|
|
1465
|
+
"type": "string",
|
|
1466
|
+
"required": false,
|
|
1467
|
+
"description": "Additional CSS classes to apply to the input wrapper div"
|
|
1468
|
+
}
|
|
1469
|
+
],
|
|
1470
|
+
"examples": [
|
|
1471
|
+
"<Input\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
1472
|
+
],
|
|
1473
|
+
"sourceFile": "components/New/Input/Input.tsx"
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"name": "PasswordInput",
|
|
1477
|
+
"category": "Components_2_0",
|
|
1478
|
+
"generation": "2.0",
|
|
1479
|
+
"description": "A password field with a reveal toggle, built on .\naliases: SecureInput|ToggleablePassword\nDesign system 2.0\n\nThe toggle is a real `<button>`, so it is reachable by keyboard and announces\nboth its purpose and its state. `type` and `iconAfter` are owned by this\ncomponent; every other prop is passed through.",
|
|
1480
|
+
"props": [
|
|
1481
|
+
{
|
|
1482
|
+
"name": "showPasswordLabel",
|
|
1483
|
+
"type": "string",
|
|
1484
|
+
"required": false,
|
|
1485
|
+
"defaultValue": "'Show password'",
|
|
1486
|
+
"description": "Accessible name of the toggle while the value is masked"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "hidePasswordLabel",
|
|
1490
|
+
"type": "string",
|
|
1491
|
+
"required": false,
|
|
1492
|
+
"defaultValue": "'Hide password'",
|
|
1493
|
+
"description": "Accessible name of the toggle while the value is visible"
|
|
1494
|
+
}
|
|
1495
|
+
],
|
|
1496
|
+
"examples": [
|
|
1497
|
+
"<PasswordInput\n id=\"password\"\n labelProps={{ label: 'Password', required: true }}\n value={password}\n onChange={setPassword}\n/>"
|
|
1498
|
+
],
|
|
1499
|
+
"sourceFile": "components/New/PasswordInput/PasswordInput.tsx"
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"name": "NumberInput",
|
|
1503
|
+
"category": "Components_2_0",
|
|
1504
|
+
"generation": "2.0",
|
|
1505
|
+
"description": "A number field, built on .\naliases: NumericField|NumberField\nDesign system 2.0\n\n`type` is owned by this component; every other prop is passed\nthrough, so it shares the 2.0 field styling, sizes, label, caption and error\nstates.",
|
|
1506
|
+
"props": [
|
|
1507
|
+
{
|
|
1508
|
+
"name": "integer",
|
|
1509
|
+
"type": "boolean",
|
|
1510
|
+
"required": false,
|
|
1511
|
+
"description": "When true, restricts input to integer values only — blocks decimal points, minus, plus, and scientific notation (e/E)"
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"name": "onChange",
|
|
1515
|
+
"type": "(value?: number | string) => void",
|
|
1516
|
+
"required": false,
|
|
1517
|
+
"description": "Callback function called when the input value changes.\n Returns either a number (for most values) or a string (for decimal values < 1 with leading zeros)"
|
|
1518
|
+
}
|
|
1519
|
+
],
|
|
1520
|
+
"examples": [
|
|
1521
|
+
"<NumberInput\n id=\"age\"\n placeholder=\"Enter your age\"\n value={25}\n onChange={(value) => setAge(value)}\n/>"
|
|
1522
|
+
],
|
|
1523
|
+
"sourceFile": "components/New/NumberInput/NumberInput.tsx"
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "Popup",
|
|
1527
|
+
"category": "Components_2_0",
|
|
1528
|
+
"generation": "2.0",
|
|
1529
|
+
"description": "An accessible modal dialog using Floating UI.\naliases: Modal|Dialog\nDesign system 2.0\n\nRenders in a portal with a scrim overlay, focus management, a header with the\ntitle and close control, a scrollable body and an optional footer. Sections\nare separated by spacing rather than rules; add your own through\n`headerClassName` or the footer node if a surface needs them.\n\nA string `header` names the dialog automatically. A `header` node cannot —\npass `ariaLabel` in that case, or the dialog opens unnamed.",
|
|
1530
|
+
"props": [
|
|
1531
|
+
{
|
|
1532
|
+
"name": "open",
|
|
1533
|
+
"type": "boolean",
|
|
1534
|
+
"required": false,
|
|
1535
|
+
"defaultValue": "false",
|
|
1536
|
+
"description": "Controls visibility of the popup"
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
"name": "header",
|
|
1540
|
+
"type": "ReactNode",
|
|
1541
|
+
"required": false,
|
|
1542
|
+
"description": "Optional title rendered in the header"
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"name": "ariaLabel",
|
|
1546
|
+
"type": "string",
|
|
1547
|
+
"required": false,
|
|
1548
|
+
"description": "Accessible name for the dialog; needed when `header` is not a string"
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"name": "portalId",
|
|
1552
|
+
"type": "string",
|
|
1553
|
+
"required": false,
|
|
1554
|
+
"description": "Optional portal container id"
|
|
1555
|
+
},
|
|
1556
|
+
{
|
|
1557
|
+
"name": "className",
|
|
1558
|
+
"type": "string",
|
|
1559
|
+
"required": false,
|
|
1560
|
+
"description": "Additional CSS classes applied to the popup container"
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "overlayClassName",
|
|
1564
|
+
"type": "string",
|
|
1565
|
+
"required": false,
|
|
1566
|
+
"description": "Additional CSS classes applied to the overlay"
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"name": "titleClassName",
|
|
1570
|
+
"type": "string",
|
|
1571
|
+
"required": false,
|
|
1572
|
+
"description": "Additional CSS classes applied to the title element"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "headerClassName",
|
|
1576
|
+
"type": "string",
|
|
1577
|
+
"required": false,
|
|
1578
|
+
"description": "Additional CSS classes applied to the popup header container"
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"name": "bodyClassName",
|
|
1582
|
+
"type": "string",
|
|
1583
|
+
"required": false,
|
|
1584
|
+
"description": "Additional CSS classes applied to the scrollable body wrapper around `children`"
|
|
1585
|
+
},
|
|
1586
|
+
{
|
|
1587
|
+
"name": "children",
|
|
1588
|
+
"type": "ReactNode",
|
|
1589
|
+
"required": false,
|
|
1590
|
+
"description": "Body content"
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"name": "footer",
|
|
1594
|
+
"type": "ReactNode",
|
|
1595
|
+
"required": false,
|
|
1596
|
+
"description": "Footer area for actions"
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "onClose",
|
|
1600
|
+
"type": "(e?: MouseEvent<HTMLButtonElement> | null) => void",
|
|
1601
|
+
"required": false,
|
|
1602
|
+
"description": "Callback fired when the popup requests to close"
|
|
1603
|
+
},
|
|
1604
|
+
{
|
|
1605
|
+
"name": "size",
|
|
1606
|
+
"type": "PopupSize",
|
|
1607
|
+
"required": false,
|
|
1608
|
+
"defaultValue": "PopupSize.Md",
|
|
1609
|
+
"description": "Sets the max-width of the popup"
|
|
1610
|
+
},
|
|
1611
|
+
{
|
|
1612
|
+
"name": "hideClose",
|
|
1613
|
+
"type": "boolean",
|
|
1614
|
+
"required": false,
|
|
1615
|
+
"defaultValue": "false",
|
|
1616
|
+
"description": "Whether the close button is hidden in the header"
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"name": "closeAriaLabel",
|
|
1620
|
+
"type": "string",
|
|
1621
|
+
"required": false,
|
|
1622
|
+
"defaultValue": "'Close dialog'",
|
|
1623
|
+
"description": "Accessible name of the close button"
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"name": "closeOnOutsideClick",
|
|
1627
|
+
"type": "boolean",
|
|
1628
|
+
"required": false,
|
|
1629
|
+
"defaultValue": "true",
|
|
1630
|
+
"description": "Whether the popup closes when clicking outside"
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "preventKeyboardOnOpen",
|
|
1634
|
+
"type": "boolean",
|
|
1635
|
+
"required": false,
|
|
1636
|
+
"defaultValue": "false",
|
|
1637
|
+
"description": "When true, initial focus goes to a non-input guard to avoid opening the virtual keyboard on mobile. Redundant since the default focuses the dialog container, which never raises the keyboard; kept for compatibility"
|
|
1638
|
+
}
|
|
1639
|
+
],
|
|
1640
|
+
"examples": [
|
|
1641
|
+
"<Popup\n open\n header=\"Title\"\n size={PopupSize.Md}\n footer={\n <div className=\"flex justify-end gap-2 px-6 py-4\">\n <NeutralButton label=\"Cancel\" />\n <PrimaryButton label=\"Confirm\" />\n </div>\n }\n onClose={() => setOpen(false)}\n>\n <div className=\"px-6 py-4\">Dialog content goes here…</div>\n</Popup>"
|
|
1642
|
+
],
|
|
1643
|
+
"sourceFile": "components/New/Popup/Popup.tsx"
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"name": "CloseButton",
|
|
1647
|
+
"category": "Components_2_0",
|
|
1648
|
+
"generation": "2.0",
|
|
1649
|
+
"description": "A close button: a ghost carrying an X icon.\naliases: DismissButton|ExitButton\nDesign system 2.0\n\nSized through like every other 2.0 control. It defaults to\nthe small 24px box that headers and toasts want; pass `ElementSize.Standard`\nwhere the control stands alone, since only that variant carries the 44×44\npointer target. Name it after the thing it closes (\"Close dialog\", \"Close\nnotification\") — the default `\"Close\"` only keeps the control from being unnamed.",
|
|
1650
|
+
"props": [
|
|
1651
|
+
{
|
|
1652
|
+
"name": "ariaLabel",
|
|
1653
|
+
"type": "string",
|
|
1654
|
+
"required": false,
|
|
1655
|
+
"defaultValue": "'Close'",
|
|
1656
|
+
"description": "Accessible name of the button"
|
|
1657
|
+
},
|
|
1658
|
+
{
|
|
1659
|
+
"name": "className",
|
|
1660
|
+
"type": "string",
|
|
1661
|
+
"required": false,
|
|
1662
|
+
"description": "Additional CSS classes to apply to the button"
|
|
1663
|
+
},
|
|
1664
|
+
{
|
|
1665
|
+
"name": "size",
|
|
1666
|
+
"type": "ElementSize",
|
|
1667
|
+
"required": false,
|
|
1668
|
+
"defaultValue": "ElementSize.Small",
|
|
1669
|
+
"description": "Button size: small is 24px, standard is 40px"
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"name": "onClose",
|
|
1673
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1674
|
+
"required": true,
|
|
1675
|
+
"description": "Click event handler for the close button"
|
|
1676
|
+
},
|
|
1677
|
+
{
|
|
1678
|
+
"name": "disabled",
|
|
1679
|
+
"type": "boolean",
|
|
1680
|
+
"required": false,
|
|
1681
|
+
"description": "Whether the button is disabled"
|
|
1682
|
+
}
|
|
1683
|
+
],
|
|
1684
|
+
"examples": [
|
|
1685
|
+
"<CloseButton ariaLabel=\"Close notification\" onClose={handleClose} />\n<CloseButton ariaLabel=\"Close dialog\" size={ElementSize.Standard} onClose={handleClose} />"
|
|
1686
|
+
],
|
|
1687
|
+
"sourceFile": "components/New/CloseButton/CloseButton.tsx"
|
|
1688
|
+
},
|
|
1689
|
+
{
|
|
1690
|
+
"name": "ConfirmationPopup",
|
|
1691
|
+
"category": "Components_2_0",
|
|
1692
|
+
"generation": "2.0",
|
|
1693
|
+
"description": "A confirmation dialog built from and the 2.0 .\naliases: ConfirmDialog|WarningDialog\nDesign system 2.0\n\nProvides an accessible modal with a title, optional description or custom content,\nand a footer with Cancel / Confirm actions.",
|
|
1694
|
+
"props": [
|
|
1695
|
+
{
|
|
1696
|
+
"name": "description",
|
|
1697
|
+
"type": "ReactNode",
|
|
1698
|
+
"required": false,
|
|
1699
|
+
"description": "Secondary text (ignored when `children` set)"
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"name": "descriptionClassName",
|
|
1703
|
+
"type": "string",
|
|
1704
|
+
"required": false,
|
|
1705
|
+
"description": "Custom CSS class for the description"
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"name": "confirmLabel",
|
|
1709
|
+
"type": "string",
|
|
1710
|
+
"required": false,
|
|
1711
|
+
"defaultValue": "defaultConfirmLabel",
|
|
1712
|
+
"description": "Label for the confirm button"
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"name": "cancelLabel",
|
|
1716
|
+
"type": "string",
|
|
1717
|
+
"required": false,
|
|
1718
|
+
"defaultValue": "defaultCancelLabel",
|
|
1719
|
+
"description": "Label for the cancel button"
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"name": "isLoading",
|
|
1723
|
+
"type": "boolean",
|
|
1724
|
+
"required": false,
|
|
1725
|
+
"defaultValue": "false",
|
|
1726
|
+
"description": "Shows loader placeholder and hides actions"
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
"name": "disableConfirmButton",
|
|
1730
|
+
"type": "boolean",
|
|
1731
|
+
"required": false,
|
|
1732
|
+
"defaultValue": "false",
|
|
1733
|
+
"description": "Disables the confirm button"
|
|
1734
|
+
},
|
|
1735
|
+
{
|
|
1736
|
+
"name": "confirmClassName",
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"required": false,
|
|
1739
|
+
"description": "Extra classes merged into the confirm button"
|
|
1740
|
+
},
|
|
1741
|
+
{
|
|
1742
|
+
"name": "onConfirm",
|
|
1743
|
+
"type": "() => void",
|
|
1744
|
+
"required": true,
|
|
1745
|
+
"description": "Fired on confirm"
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
"name": "onCancel",
|
|
1749
|
+
"type": "() => void",
|
|
1750
|
+
"required": false,
|
|
1751
|
+
"description": "Fired on cancel (falls back to `onClose`)"
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
"name": "children",
|
|
1755
|
+
"type": "ReactNode",
|
|
1756
|
+
"required": false,
|
|
1757
|
+
"description": "Custom body content"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"name": "variant",
|
|
1761
|
+
"type": "ConfirmationPopupVariant",
|
|
1762
|
+
"required": false,
|
|
1763
|
+
"defaultValue": "ConfirmationPopupVariant.Info",
|
|
1764
|
+
"description": "Visual variant for the popup"
|
|
1765
|
+
}
|
|
1766
|
+
],
|
|
1767
|
+
"examples": [
|
|
1768
|
+
"<ConfirmationPopup\n open\n header=\"Delete item?\"\n description=\"This action cannot be undone.\"\n confirmLabel=\"Delete\"\n variant={ConfirmationPopupVariant.Danger}\n onClose={() => setOpen(false)}\n onConfirm={handleDelete}\n/>"
|
|
1769
|
+
],
|
|
1770
|
+
"sourceFile": "components/New/ConfirmationPopup/ConfirmationPopup.tsx"
|
|
1771
|
+
},
|
|
1772
|
+
{
|
|
1773
|
+
"name": "Dropdown",
|
|
1774
|
+
"category": "Components_2_0",
|
|
1775
|
+
"generation": "2.0",
|
|
1776
|
+
"description": "Renders the given trigger (`children`) and a floating contextual menu overlay.\naliases: ContextMenu|PopupMenu\nDesign system 2.0\n\nSupports click/hover/contextMenu triggers, controlled/uncontrolled open, and an optional\nclose button inside the overlay. Placement is taken directly from Floating UI; when\n`placement` is **undefined** (default), automatic placement is handled by `autoPlacement`.",
|
|
1777
|
+
"props": [
|
|
1778
|
+
{
|
|
1779
|
+
"name": "children",
|
|
1780
|
+
"type": "ReactNode",
|
|
1781
|
+
"required": true,
|
|
1782
|
+
"description": "Trigger element(s) to anchor and open the menu"
|
|
1783
|
+
},
|
|
1784
|
+
{
|
|
1785
|
+
"name": "items",
|
|
1786
|
+
"type": "DropdownItem[]",
|
|
1787
|
+
"required": false,
|
|
1788
|
+
"description": "Menu items to render"
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
"name": "onItemClick",
|
|
1792
|
+
"type": "(info: { key: string; domEvent: MouseEvent }) => void",
|
|
1793
|
+
"required": false,
|
|
1794
|
+
"description": "Global handler fired when any item is clicked"
|
|
1795
|
+
},
|
|
1796
|
+
{
|
|
1797
|
+
"name": "menuHeader",
|
|
1798
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1799
|
+
"required": false,
|
|
1800
|
+
"description": "Content rendered above the items list"
|
|
1801
|
+
},
|
|
1802
|
+
{
|
|
1803
|
+
"name": "menuFooter",
|
|
1804
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1805
|
+
"required": false,
|
|
1806
|
+
"description": "Content rendered below the items list"
|
|
1807
|
+
},
|
|
1808
|
+
{
|
|
1809
|
+
"name": "renderOverlay",
|
|
1810
|
+
"type": "() => ReactNode",
|
|
1811
|
+
"required": false,
|
|
1812
|
+
"description": "Render function for fully custom overlay content (ignored when `items` is provided)"
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "trigger",
|
|
1816
|
+
"type": "DropdownTrigger[]",
|
|
1817
|
+
"required": false,
|
|
1818
|
+
"defaultValue": "[DropdownTrigger.Click]",
|
|
1819
|
+
"description": "Interactions that open the menu"
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"name": "placement",
|
|
1823
|
+
"type": "Placement",
|
|
1824
|
+
"required": false,
|
|
1825
|
+
"description": "Floating UI placement string; when omitted, auto placement is used"
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"name": "allowedPlacements",
|
|
1829
|
+
"type": "Placement[]",
|
|
1830
|
+
"required": false,
|
|
1831
|
+
"description": "Restricts the allowed placements"
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"name": "disabled",
|
|
1835
|
+
"type": "boolean",
|
|
1836
|
+
"required": false,
|
|
1837
|
+
"defaultValue": "false",
|
|
1838
|
+
"description": "Disables interaction and prevents opening"
|
|
1839
|
+
},
|
|
1840
|
+
{
|
|
1841
|
+
"name": "open",
|
|
1842
|
+
"type": "boolean",
|
|
1843
|
+
"required": false,
|
|
1844
|
+
"description": "Controlled open state (when provided, `defaultOpen` is ignored)"
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"name": "defaultOpen",
|
|
1848
|
+
"type": "boolean",
|
|
1849
|
+
"required": false,
|
|
1850
|
+
"defaultValue": "false",
|
|
1851
|
+
"description": "Initial open state in uncontrolled mode"
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "onOpenChange",
|
|
1855
|
+
"type": "(open: boolean) => void",
|
|
1856
|
+
"required": false,
|
|
1857
|
+
"description": "Fired whenever the open state changes"
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"name": "closable",
|
|
1861
|
+
"type": "boolean",
|
|
1862
|
+
"required": false,
|
|
1863
|
+
"defaultValue": "false",
|
|
1864
|
+
"description": "Whether the overlay shows an internal close button"
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"name": "onClose",
|
|
1868
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1869
|
+
"required": false,
|
|
1870
|
+
"description": "Fired when the close button inside the overlay is clicked"
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"name": "className",
|
|
1874
|
+
"type": "string",
|
|
1875
|
+
"required": false,
|
|
1876
|
+
"description": "Additional CSS classes applied to the trigger wrapper"
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"name": "overlayContentClassName",
|
|
1880
|
+
"type": "string",
|
|
1881
|
+
"required": false,
|
|
1882
|
+
"description": "Additional CSS classes applied to the overlay content"
|
|
1883
|
+
},
|
|
1884
|
+
{
|
|
1885
|
+
"name": "separatorClassName",
|
|
1886
|
+
"type": "string",
|
|
1887
|
+
"required": false,
|
|
1888
|
+
"description": "Additional CSS classes applied to the separators between items"
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
"name": "listClassName",
|
|
1892
|
+
"type": "string",
|
|
1893
|
+
"required": false,
|
|
1894
|
+
"description": "Additional CSS classes applied to the floating overlay"
|
|
1895
|
+
},
|
|
1896
|
+
{
|
|
1897
|
+
"name": "outsidePressIgnoreRef",
|
|
1898
|
+
"type": "RefObject<HTMLElement | null>",
|
|
1899
|
+
"required": false,
|
|
1900
|
+
"description": "Ref to an element that should not trigger outside press behavior"
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"name": "outsideClosable",
|
|
1904
|
+
"type": "boolean",
|
|
1905
|
+
"required": false,
|
|
1906
|
+
"defaultValue": "true",
|
|
1907
|
+
"description": "Whether clicks outside the overlay should close it"
|
|
1908
|
+
},
|
|
1909
|
+
{
|
|
1910
|
+
"name": "anchorToMouse",
|
|
1911
|
+
"type": "boolean",
|
|
1912
|
+
"required": false,
|
|
1913
|
+
"defaultValue": "false",
|
|
1914
|
+
"description": "Whether to anchor the dropdown to the mouse position"
|
|
1915
|
+
},
|
|
1916
|
+
{
|
|
1917
|
+
"name": "matchReferenceWidth",
|
|
1918
|
+
"type": "boolean",
|
|
1919
|
+
"required": false,
|
|
1920
|
+
"defaultValue": "true",
|
|
1921
|
+
"description": "Whether to match the reference element's width"
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
"name": "maxDropdownHeight",
|
|
1925
|
+
"type": "number | null",
|
|
1926
|
+
"required": false,
|
|
1927
|
+
"description": "Maximum height of the dropdown menu; when omitted, no limit is applied"
|
|
1928
|
+
}
|
|
1929
|
+
],
|
|
1930
|
+
"examples": [
|
|
1931
|
+
"// Simple items menu\n<Dropdown items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Open</button>\n</Dropdown>\n\n// Hover trigger\n<Dropdown trigger={[DropdownTrigger.Hover]} placement=\"bottom-end\" items={items}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Hover me</button>\n</Dropdown>\n\n// Custom overlay content\n<Dropdown closable renderOverlay={() => <div className=\"p-3\">Custom content</div>}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Custom</button>\n</Dropdown>"
|
|
1932
|
+
],
|
|
1933
|
+
"sourceFile": "components/New/Dropdown/Dropdown.tsx"
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "CaptionText",
|
|
1937
|
+
"category": "Components_2_0",
|
|
1938
|
+
"generation": "2.0",
|
|
1939
|
+
"description": "A component for displaying caption text with consistent styling\naliases: HelperText|ValidationText\nDesign system 2.0",
|
|
1940
|
+
"props": [
|
|
1941
|
+
{
|
|
1942
|
+
"name": "text",
|
|
1943
|
+
"type": "string",
|
|
1944
|
+
"required": false,
|
|
1945
|
+
"description": "The text to display. If undefined or empty, nothing is rendered"
|
|
1946
|
+
},
|
|
1947
|
+
{
|
|
1948
|
+
"name": "variant",
|
|
1949
|
+
"type": "CaptionType",
|
|
1950
|
+
"required": false,
|
|
1951
|
+
"defaultValue": "CaptionType.Description",
|
|
1952
|
+
"description": "The variant of the caption text, e.g., error or description."
|
|
1953
|
+
}
|
|
1954
|
+
],
|
|
1955
|
+
"examples": [
|
|
1956
|
+
"<CaptionText text=\"This field is required\" variant={CaptionType.Error} />"
|
|
1957
|
+
],
|
|
1958
|
+
"sourceFile": "components/New/CaptionText/CaptionText.tsx"
|
|
1959
|
+
},
|
|
1960
|
+
{
|
|
1961
|
+
"name": "ErrorText",
|
|
1962
|
+
"category": "Components_2_0",
|
|
1963
|
+
"generation": "2.0",
|
|
1964
|
+
"description": "",
|
|
1965
|
+
"props": [],
|
|
1966
|
+
"examples": [],
|
|
1967
|
+
"sourceFile": "components/New/CaptionText/CaptionText.tsx"
|
|
1968
|
+
},
|
|
1969
|
+
{
|
|
1970
|
+
"name": "Accordion",
|
|
1971
|
+
"category": "Components_2_0",
|
|
1972
|
+
"generation": "2.0",
|
|
1973
|
+
"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.",
|
|
1974
|
+
"props": [
|
|
1975
|
+
{
|
|
1976
|
+
"name": "title",
|
|
1977
|
+
"type": "ReactNode",
|
|
1978
|
+
"required": true,
|
|
1979
|
+
"description": "Title rendered in the header."
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"name": "description",
|
|
1983
|
+
"type": "ReactNode",
|
|
1984
|
+
"required": false,
|
|
1985
|
+
"description": "Optional secondary text rendered under the title."
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"name": "children",
|
|
1989
|
+
"type": "ReactNode",
|
|
1990
|
+
"required": false,
|
|
1991
|
+
"description": "Content revealed when expanded."
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"name": "expanded",
|
|
1995
|
+
"type": "boolean",
|
|
1996
|
+
"required": false,
|
|
1997
|
+
"description": "Controlled expanded state."
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"name": "defaultExpanded",
|
|
2001
|
+
"type": "boolean",
|
|
2002
|
+
"required": false,
|
|
2003
|
+
"defaultValue": "false",
|
|
2004
|
+
"description": "Initial expanded state when uncontrolled."
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "disabled",
|
|
2008
|
+
"type": "boolean",
|
|
2009
|
+
"required": false,
|
|
2010
|
+
"description": "Disables toggling."
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"name": "nonCollapsible",
|
|
2014
|
+
"type": "boolean",
|
|
2015
|
+
"required": false,
|
|
2016
|
+
"description": "Renders the panel permanently expanded, with a static header."
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"name": "ariaLabel",
|
|
2020
|
+
"type": "string",
|
|
2021
|
+
"required": false,
|
|
2022
|
+
"description": "Accessible name for the header; needed when `title` carries no text."
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
"name": "onToggle",
|
|
2026
|
+
"type": "(expanded: boolean) => void",
|
|
2027
|
+
"required": false,
|
|
2028
|
+
"description": "Fired when the header is clicked. Receives the next expanded state."
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "className",
|
|
2032
|
+
"type": "string",
|
|
2033
|
+
"required": false,
|
|
2034
|
+
"description": "Additional CSS classes for the outer container."
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"name": "headerClassName",
|
|
2038
|
+
"type": "string",
|
|
2039
|
+
"required": false,
|
|
2040
|
+
"description": "Additional CSS classes for the header."
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "contentClassName",
|
|
2044
|
+
"type": "string",
|
|
2045
|
+
"required": false,
|
|
2046
|
+
"description": "Additional CSS classes for the content region."
|
|
2047
|
+
}
|
|
2048
|
+
],
|
|
2049
|
+
"examples": [
|
|
2050
|
+
"<Accordion title=\"Advanced settings\" description=\"Optional configuration\">\n <p>Panel content</p>\n</Accordion>\n\n<Accordion title=\"Always open\" nonCollapsible>\n <p>Panel content</p>\n</Accordion>"
|
|
2051
|
+
],
|
|
2052
|
+
"sourceFile": "components/New/Accordion/Accordion.tsx"
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "Switch",
|
|
2056
|
+
"category": "Components_2_0",
|
|
2057
|
+
"generation": "2.0",
|
|
2058
|
+
"description": "A switch (toggle) control from the 2.0 design system.\naliases: ToggleSwitch|BinaryToggle|Switcher\nDesign system 2.0",
|
|
2059
|
+
"props": [
|
|
2060
|
+
{
|
|
2061
|
+
"name": "labelProps",
|
|
2062
|
+
"type": "LabelProps",
|
|
2063
|
+
"required": false,
|
|
2064
|
+
"description": "Props of the rendered next to the control"
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
"name": "isOn",
|
|
2068
|
+
"type": "boolean",
|
|
2069
|
+
"required": false,
|
|
2070
|
+
"defaultValue": "false",
|
|
2071
|
+
"description": "The current value of the switch"
|
|
2072
|
+
},
|
|
2073
|
+
{
|
|
2074
|
+
"name": "disabled",
|
|
2075
|
+
"type": "boolean",
|
|
2076
|
+
"required": false,
|
|
2077
|
+
"description": "Whether the switch is disabled"
|
|
2078
|
+
},
|
|
2079
|
+
{
|
|
2080
|
+
"name": "onChange",
|
|
2081
|
+
"type": "(value: boolean) => void",
|
|
2082
|
+
"required": false,
|
|
2083
|
+
"description": "Callback fired with the new value when toggled"
|
|
2084
|
+
},
|
|
2085
|
+
{
|
|
2086
|
+
"name": "caption",
|
|
2087
|
+
"type": "string",
|
|
2088
|
+
"required": false,
|
|
2089
|
+
"description": "Caption text rendered below the label, and described by the switch"
|
|
2090
|
+
}
|
|
2091
|
+
],
|
|
2092
|
+
"examples": [
|
|
2093
|
+
"<Switch\n id=\"notifications\"\n labelProps={{ label: 'Active' }}\n isOn={isActive}\n onChange={setIsActive}\n/>"
|
|
2094
|
+
],
|
|
2095
|
+
"sourceFile": "components/New/Switch/Switch.tsx"
|
|
2096
|
+
},
|
|
2097
|
+
{
|
|
2098
|
+
"name": "Tabs",
|
|
2099
|
+
"category": "Components_2_0",
|
|
2100
|
+
"generation": "2.0",
|
|
2101
|
+
"description": "A horizontal row of tabs, underlining the active one and showing optional count badges.\naliases: TabRow|TabNavigation|TabBar\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\nThe component renders the tabs only; the panels stay with the consumer.",
|
|
2102
|
+
"props": [
|
|
2103
|
+
{
|
|
2104
|
+
"name": "tabs",
|
|
2105
|
+
"type": "TabItem[]",
|
|
2106
|
+
"required": true,
|
|
2107
|
+
"description": "Ordered list of tabs to render."
|
|
2108
|
+
},
|
|
2109
|
+
{
|
|
2110
|
+
"name": "activeTabId",
|
|
2111
|
+
"type": "string",
|
|
2112
|
+
"required": true,
|
|
2113
|
+
"description": "ID of the currently selected tab."
|
|
2114
|
+
},
|
|
2115
|
+
{
|
|
2116
|
+
"name": "onTabChange",
|
|
2117
|
+
"type": "(tabId: string) => void",
|
|
2118
|
+
"required": true,
|
|
2119
|
+
"description": "Fired with the tab's `id` when the user selects a tab."
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
"name": "ariaLabel",
|
|
2123
|
+
"type": "string",
|
|
2124
|
+
"required": false,
|
|
2125
|
+
"description": "Accessible name for the tab list."
|
|
2126
|
+
},
|
|
2127
|
+
{
|
|
2128
|
+
"name": "className",
|
|
2129
|
+
"type": "string",
|
|
2130
|
+
"required": false,
|
|
2131
|
+
"description": "Additional CSS classes for the tab list container."
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"name": "tabClassName",
|
|
2135
|
+
"type": "string",
|
|
2136
|
+
"required": false,
|
|
2137
|
+
"description": "Additional CSS classes applied to every tab."
|
|
2138
|
+
}
|
|
2139
|
+
],
|
|
2140
|
+
"examples": [
|
|
2141
|
+
"<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/>"
|
|
2142
|
+
],
|
|
2143
|
+
"sourceFile": "components/New/Tabs/Tabs.tsx"
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
"name": "FileDropzone",
|
|
2147
|
+
"category": "Components_2_0",
|
|
2148
|
+
"generation": "2.0",
|
|
2149
|
+
"description": "A dashed drop area that takes files by drag-and-drop or through the file picker.\naliases: LoadFileArea|FileUpload|DragDropUpload|UploadArea\nDesign system 2.0\n\nThe area is a label over a visually hidden file input, so the picker opens on\nclick and the control stays operable by keyboard and announced as a file input\nwithout any extra wiring. The border highlights while a drag hovers it.\n\n`accept` is enforced on drops as well as in the picker — the browser only\nfilters the latter — so `onChange` never receives a file the caller excluded.\nRejected files go to `onReject`; all copy stays with the caller, which keeps\nvalidation messages in the consumer's own wording and language.",
|
|
2150
|
+
"props": [
|
|
2151
|
+
{
|
|
2152
|
+
"name": "labelProps",
|
|
2153
|
+
"type": "LabelProps",
|
|
2154
|
+
"required": false,
|
|
2155
|
+
"description": "Props of the naming the field, rendered above the area."
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
"name": "label",
|
|
2159
|
+
"type": "ReactNode",
|
|
2160
|
+
"required": true,
|
|
2161
|
+
"description": "Primary line of copy."
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
"name": "description",
|
|
2165
|
+
"type": "ReactNode",
|
|
2166
|
+
"required": false,
|
|
2167
|
+
"description": "Secondary line of copy."
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"name": "onChange",
|
|
2171
|
+
"type": "(files: File[]) => void",
|
|
2172
|
+
"required": true,
|
|
2173
|
+
"description": "Fired with the accepted files."
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"name": "onReject",
|
|
2177
|
+
"type": "(files: File[]) => void",
|
|
2178
|
+
"required": false,
|
|
2179
|
+
"description": "Fired with dropped files that `accept` excluded."
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"name": "accept",
|
|
2183
|
+
"type": "string",
|
|
2184
|
+
"required": false,
|
|
2185
|
+
"description": "Comma-separated `accept` tokens."
|
|
2186
|
+
},
|
|
2187
|
+
{
|
|
2188
|
+
"name": "multiple",
|
|
2189
|
+
"type": "boolean",
|
|
2190
|
+
"required": false,
|
|
2191
|
+
"defaultValue": "false",
|
|
2192
|
+
"description": "Whether more than one file can be selected."
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "disabled",
|
|
2196
|
+
"type": "boolean",
|
|
2197
|
+
"required": false,
|
|
2198
|
+
"defaultValue": "false",
|
|
2199
|
+
"description": "Disables picking and dropping."
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"name": "errorText",
|
|
2203
|
+
"type": "string",
|
|
2204
|
+
"required": false,
|
|
2205
|
+
"description": "Error message rendered below the area."
|
|
2206
|
+
},
|
|
2207
|
+
{
|
|
2208
|
+
"name": "icon",
|
|
2209
|
+
"type": "ReactNode",
|
|
2210
|
+
"required": false,
|
|
2211
|
+
"description": "Icon rendered above the copy."
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"name": "id",
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"required": false,
|
|
2217
|
+
"description": "`id` of the underlying file input."
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "ariaLabel",
|
|
2221
|
+
"type": "string",
|
|
2222
|
+
"required": false,
|
|
2223
|
+
"description": "Accessible name; needed when `label` carries no text."
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
"name": "className",
|
|
2227
|
+
"type": "string",
|
|
2228
|
+
"required": false,
|
|
2229
|
+
"description": "Additional CSS classes for the drop area."
|
|
2230
|
+
}
|
|
2231
|
+
],
|
|
2232
|
+
"examples": [
|
|
2233
|
+
"<FileDropzone\n label=\"Drag and drop it or click here to upload\"\n description=\"File formats .md, .zip and .skill\"\n accept=\".md,.zip,.skill\"\n onChange={(files) => upload(files)}\n onReject={() => setError('Unsupported file format')}\n/>"
|
|
2234
|
+
],
|
|
2235
|
+
"sourceFile": "components/New/FileDropzone/FileDropzone.tsx"
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"name": "Tag",
|
|
2239
|
+
"category": "Components_2_0",
|
|
2240
|
+
"generation": "2.0",
|
|
2241
|
+
"description": "A compact label element used for selections, filters, or categories.\naliases: Chip|Pill\nDesign system 2.0\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.",
|
|
2242
|
+
"props": [
|
|
2243
|
+
{
|
|
2244
|
+
"name": "label",
|
|
2245
|
+
"type": "string",
|
|
2246
|
+
"required": true,
|
|
2247
|
+
"description": "Text content displayed inside the tag."
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"name": "icon",
|
|
2251
|
+
"type": "ReactNode",
|
|
2252
|
+
"required": false,
|
|
2253
|
+
"description": "Icon rendered before the label."
|
|
2254
|
+
},
|
|
2255
|
+
{
|
|
2256
|
+
"name": "size",
|
|
2257
|
+
"type": "ElementSize",
|
|
2258
|
+
"required": false,
|
|
2259
|
+
"defaultValue": "ElementSize.Standard",
|
|
2260
|
+
"description": "Tag height: standard is 24px, small is 20px."
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
"name": "selected",
|
|
2264
|
+
"type": "boolean",
|
|
2265
|
+
"required": false,
|
|
2266
|
+
"defaultValue": "false",
|
|
2267
|
+
"description": "Applies the accent-tinted selected styling."
|
|
2268
|
+
},
|
|
2269
|
+
{
|
|
2270
|
+
"name": "disabled",
|
|
2271
|
+
"type": "boolean",
|
|
2272
|
+
"required": false,
|
|
2273
|
+
"defaultValue": "false",
|
|
2274
|
+
"description": "Dims the tag and suppresses the remove control and click handling."
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
"name": "closable",
|
|
2278
|
+
"type": "boolean",
|
|
2279
|
+
"required": false,
|
|
2280
|
+
"defaultValue": "false",
|
|
2281
|
+
"description": "Renders the remove button. Needs `onRemove` to appear."
|
|
2282
|
+
},
|
|
2283
|
+
{
|
|
2284
|
+
"name": "removeLabel",
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"required": false,
|
|
2287
|
+
"description": "Accessible name of the remove button; defaults to `Remove <label>`."
|
|
2288
|
+
},
|
|
2289
|
+
{
|
|
2290
|
+
"name": "onRemove",
|
|
2291
|
+
"type": "(event: MouseEvent<HTMLButtonElement>) => void",
|
|
2292
|
+
"required": false,
|
|
2293
|
+
"description": "Called when the remove button is clicked. The click does not bubble to `onClick`."
|
|
2294
|
+
}
|
|
2295
|
+
],
|
|
2296
|
+
"examples": [
|
|
2297
|
+
"<Tag label=\"TypeScript\" />\n<Tag label=\"TypeScript\" closable onRemove={() => remove('TypeScript')} />\n<Tag label=\"Drafts\" selected onClick={() => toggle('Drafts')} />"
|
|
2298
|
+
],
|
|
2299
|
+
"sourceFile": "components/New/Tag/Tag.tsx"
|
|
2300
|
+
},
|
|
2301
|
+
{
|
|
2302
|
+
"name": "TagInput",
|
|
2303
|
+
"category": "Components_2_0",
|
|
2304
|
+
"generation": "2.0",
|
|
2305
|
+
"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.",
|
|
2306
|
+
"props": [
|
|
2307
|
+
{
|
|
2308
|
+
"name": "id",
|
|
2309
|
+
"type": "string",
|
|
2310
|
+
"required": false,
|
|
2311
|
+
"description": "The id of the text input, linked to the label."
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"name": "value",
|
|
2315
|
+
"type": "string[]",
|
|
2316
|
+
"required": false,
|
|
2317
|
+
"description": "Controlled tag list."
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
"name": "defaultValue",
|
|
2321
|
+
"type": "string[]",
|
|
2322
|
+
"required": false,
|
|
2323
|
+
"description": "Initial tag list when uncontrolled."
|
|
2324
|
+
},
|
|
2325
|
+
{
|
|
2326
|
+
"name": "size",
|
|
2327
|
+
"type": "ElementSize",
|
|
2328
|
+
"required": false,
|
|
2329
|
+
"defaultValue": "ElementSize.Standard",
|
|
2330
|
+
"description": "Field height: standard is 40px, small is 24px."
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"name": "labelProps",
|
|
2334
|
+
"type": "LabelProps",
|
|
2335
|
+
"required": false,
|
|
2336
|
+
"description": "Props of the rendered above the field."
|
|
2337
|
+
},
|
|
2338
|
+
{
|
|
2339
|
+
"name": "placeholder",
|
|
2340
|
+
"type": "string",
|
|
2341
|
+
"required": false,
|
|
2342
|
+
"description": "Placeholder shown while there are no tags."
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
"name": "caption",
|
|
2346
|
+
"type": "string",
|
|
2347
|
+
"required": false,
|
|
2348
|
+
"description": "Helper text rendered below the field when there is no `error`."
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"name": "error",
|
|
2352
|
+
"type": "string",
|
|
2353
|
+
"required": false,
|
|
2354
|
+
"description": "Error message rendered below the field (pass `invalid` too for error styling)."
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"name": "invalid",
|
|
2358
|
+
"type": "boolean",
|
|
2359
|
+
"required": false,
|
|
2360
|
+
"description": "Applies the field's error styling."
|
|
2361
|
+
},
|
|
2362
|
+
{
|
|
2363
|
+
"name": "disabled",
|
|
2364
|
+
"type": "boolean",
|
|
2365
|
+
"required": false,
|
|
2366
|
+
"defaultValue": "false",
|
|
2367
|
+
"description": "Disables typing and tag removal."
|
|
2368
|
+
},
|
|
2369
|
+
{
|
|
2370
|
+
"name": "readOnly",
|
|
2371
|
+
"type": "boolean",
|
|
2372
|
+
"required": false,
|
|
2373
|
+
"defaultValue": "false",
|
|
2374
|
+
"description": "Shows the tags without allowing new ones or removal."
|
|
2375
|
+
},
|
|
2376
|
+
{
|
|
2377
|
+
"name": "collapseTagOverflow",
|
|
2378
|
+
"type": "boolean",
|
|
2379
|
+
"required": false,
|
|
2380
|
+
"defaultValue": "false",
|
|
2381
|
+
"description": "Keep the tags on one line, replacing the ones that do not fit with a `+N` chip."
|
|
2382
|
+
},
|
|
2383
|
+
{
|
|
2384
|
+
"name": "ariaLabel",
|
|
2385
|
+
"type": "string",
|
|
2386
|
+
"required": false,
|
|
2387
|
+
"description": "Accessible name for the text input; use it when there is no visible label."
|
|
2388
|
+
},
|
|
2389
|
+
{
|
|
2390
|
+
"name": "tagListLabel",
|
|
2391
|
+
"type": "string",
|
|
2392
|
+
"required": false,
|
|
2393
|
+
"defaultValue": "'Tags'",
|
|
2394
|
+
"description": "Accessible name of the tag list."
|
|
2395
|
+
},
|
|
2396
|
+
{
|
|
2397
|
+
"name": "className",
|
|
2398
|
+
"type": "string",
|
|
2399
|
+
"required": false,
|
|
2400
|
+
"description": "Additional CSS classes for the outer container."
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
"name": "fieldClassName",
|
|
2404
|
+
"type": "string",
|
|
2405
|
+
"required": false,
|
|
2406
|
+
"description": "Additional CSS classes for the field itself."
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"name": "tagClassName",
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"required": false,
|
|
2412
|
+
"description": "Additional CSS classes applied to every tag."
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
"name": "onChange",
|
|
2416
|
+
"type": "(tags: string[]) => void",
|
|
2417
|
+
"required": false,
|
|
2418
|
+
"description": "Called with the new list whenever a tag is added or removed."
|
|
2419
|
+
}
|
|
2420
|
+
],
|
|
2421
|
+
"examples": [
|
|
2422
|
+
"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/>"
|
|
2423
|
+
],
|
|
2424
|
+
"sourceFile": "components/New/TagInput/TagInput.tsx"
|
|
2425
|
+
},
|
|
2426
|
+
{
|
|
2427
|
+
"name": "Search",
|
|
2428
|
+
"category": "Components_2_0",
|
|
2429
|
+
"generation": "2.0",
|
|
2430
|
+
"description": "A search field with a leading magnifier and a clear button, built on .\naliases: SearchField|QueryInput|SearchBox\nDesign system 2.0\n\nFully controlled: it renders exactly the `value` it is given and reports every\nedit through `onChange`, which receives `undefined` for an empty field. The\nclear button appears only while there is something to clear, and returns focus\nto the input once pressed so keyboard users are not dropped to the page body.\n\n`type` and both icon slots are owned by this component; every other\n prop is passed through.",
|
|
2431
|
+
"props": [
|
|
2432
|
+
{
|
|
2433
|
+
"name": "withoutBorder",
|
|
2434
|
+
"type": "boolean",
|
|
2435
|
+
"required": false,
|
|
2436
|
+
"defaultValue": "false",
|
|
2437
|
+
"description": "Renders the field without its border and background"
|
|
2438
|
+
},
|
|
2439
|
+
{
|
|
2440
|
+
"name": "clearLabel",
|
|
2441
|
+
"type": "string",
|
|
2442
|
+
"required": false,
|
|
2443
|
+
"defaultValue": "'Clear search'",
|
|
2444
|
+
"description": "Accessible name of the clear button"
|
|
2445
|
+
}
|
|
2446
|
+
],
|
|
2447
|
+
"examples": [
|
|
2448
|
+
"<Search\n id=\"search\"\n value={query}\n placeholder=\"Search\"\n onChange={setQuery}\n/>"
|
|
2449
|
+
],
|
|
2450
|
+
"sourceFile": "components/New/Search/Search.tsx"
|
|
2451
|
+
},
|
|
26
2452
|
{
|
|
27
2453
|
"name": "DialCaptionText",
|
|
28
2454
|
"category": "Elements",
|
|
29
|
-
"
|
|
2455
|
+
"generation": "1.0",
|
|
2456
|
+
"description": "A component for displaying error messages with consistent styling\naliases: HelperText|ValidationText\nDesign system 1.0",
|
|
2457
|
+
"props": [
|
|
2458
|
+
{
|
|
2459
|
+
"name": "text",
|
|
2460
|
+
"type": "string",
|
|
2461
|
+
"required": false,
|
|
2462
|
+
"description": "The text to display. If undefined or empty, nothing is rendered"
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"name": "variant",
|
|
2466
|
+
"type": "CaptionType",
|
|
2467
|
+
"required": false,
|
|
2468
|
+
"defaultValue": "CaptionType.Description",
|
|
2469
|
+
"description": "The variant of the caption text, e.g., error or description."
|
|
2470
|
+
}
|
|
2471
|
+
],
|
|
2472
|
+
"examples": [
|
|
2473
|
+
"<DialCaptionText text=\"This field is required\" variant={CaptionType.Error} />"
|
|
2474
|
+
],
|
|
2475
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx",
|
|
2476
|
+
"supersededBy": "CaptionText"
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"name": "DialErrorText",
|
|
2480
|
+
"category": "Elements",
|
|
2481
|
+
"generation": "1.0",
|
|
2482
|
+
"description": "",
|
|
2483
|
+
"props": [],
|
|
2484
|
+
"examples": [],
|
|
2485
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx",
|
|
2486
|
+
"supersededBy": "ErrorText"
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"name": "DialAnalyticsCard",
|
|
2490
|
+
"category": "Analytics",
|
|
2491
|
+
"generation": "1.0",
|
|
2492
|
+
"description": "A simple analytics summary card that displays a single metric as a title,\na prominent value, and an optional description.\naliases: MetricCard|StatCard|KpiCard\nDesign system 1.0\n\nTwo visual variants are available via the enum:\n- `Default` — `bg-layer-3`, large `dial-display2-text` value, supports a description.\n- `Compact` — denser `bg-layer-2` card with a `dial-body-semi-text` value and no\n description (the `description` prop is ignored in this variant).\n\n**Compare mode** — pass `compareValues` to split the value area 50/50 between two\nmetrics, each with its own sub-title. Long sub-titles truncate to a single line and\nshow the full text in a tooltip. Pair with `delta` to show a change badge next\nto the card title, and `deltaUnit` for a suffix such as `\"s\"`.",
|
|
2493
|
+
"props": [
|
|
2494
|
+
{
|
|
2495
|
+
"name": "title",
|
|
2496
|
+
"type": "ReactNode",
|
|
2497
|
+
"required": true,
|
|
2498
|
+
"description": "Short label describing the metric, rendered above the value."
|
|
2499
|
+
},
|
|
2500
|
+
{
|
|
2501
|
+
"name": "value",
|
|
2502
|
+
"type": "ReactNode",
|
|
2503
|
+
"required": false,
|
|
2504
|
+
"description": "The primary metric value. Ignored when `compareValues` is set."
|
|
2505
|
+
},
|
|
2506
|
+
{
|
|
2507
|
+
"name": "description",
|
|
2508
|
+
"type": "ReactNode",
|
|
2509
|
+
"required": false,
|
|
2510
|
+
"description": "Optional supporting text. Ignored when `variant` is `Compact`."
|
|
2511
|
+
},
|
|
2512
|
+
{
|
|
2513
|
+
"name": "variant",
|
|
2514
|
+
"type": "AnalyticsCardVariant",
|
|
2515
|
+
"required": false,
|
|
2516
|
+
"defaultValue": "AnalyticsCardVariant.Default",
|
|
2517
|
+
"description": "Visual style of the card."
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"name": "error",
|
|
2521
|
+
"type": "boolean",
|
|
2522
|
+
"required": false,
|
|
2523
|
+
"description": "Renders an error tag in place of the value."
|
|
2524
|
+
},
|
|
2525
|
+
{
|
|
2526
|
+
"name": "isLoading",
|
|
2527
|
+
"type": "boolean",
|
|
2528
|
+
"required": false,
|
|
2529
|
+
"description": "Renders a loader in place of the value."
|
|
2530
|
+
},
|
|
2531
|
+
{
|
|
2532
|
+
"name": "className",
|
|
2533
|
+
"type": "string",
|
|
2534
|
+
"required": false,
|
|
2535
|
+
"description": "Additional CSS classes for the card container."
|
|
2536
|
+
},
|
|
2537
|
+
{
|
|
2538
|
+
"name": "delta",
|
|
2539
|
+
"type": "number",
|
|
2540
|
+
"required": false,
|
|
2541
|
+
"description": "Numeric change shown as a badge next to the title. ≥0 = success, <0 = error."
|
|
2542
|
+
},
|
|
2543
|
+
{
|
|
2544
|
+
"name": "deltaPositive",
|
|
2545
|
+
"type": "boolean",
|
|
2546
|
+
"required": false,
|
|
2547
|
+
"description": "Overrides sign-based badge colour. Use for lower-is-better metrics."
|
|
2548
|
+
},
|
|
2549
|
+
{
|
|
2550
|
+
"name": "deltaUnit",
|
|
2551
|
+
"type": "string",
|
|
2552
|
+
"required": false,
|
|
2553
|
+
"description": "Suffix appended to the formatted delta (e.g. `\"s\"` → `+9s`)."
|
|
2554
|
+
},
|
|
2555
|
+
{
|
|
2556
|
+
"name": "compareValues",
|
|
2557
|
+
"type": "[AnalyticsCardCompareItem, AnalyticsCardCompareItem]",
|
|
2558
|
+
"required": false,
|
|
2559
|
+
"description": "Enables compare mode with two side-by-side metrics."
|
|
2560
|
+
}
|
|
2561
|
+
],
|
|
2562
|
+
"examples": [
|
|
2563
|
+
"<DialAnalyticsCard\n title=\"Total requests\"\n value=\"12,480\"\n description=\"+12% vs last week\"\n/>",
|
|
2564
|
+
"<DialAnalyticsCard\n title=\"Response time\"\n delta={9}\n deltaUnit=\"s\"\n deltaPositive={false}\n compareValues={[\n { title: 'This week', value: '248ms' },\n { title: 'Last week', value: '220ms' },\n ]}\n/>"
|
|
2565
|
+
],
|
|
2566
|
+
"sourceFile": "components/Analytics/Card/Card.tsx"
|
|
2567
|
+
},
|
|
2568
|
+
{
|
|
2569
|
+
"name": "DialAnalyticsBar",
|
|
2570
|
+
"category": "Analytics",
|
|
2571
|
+
"generation": "1.0",
|
|
2572
|
+
"description": "A compact analytics meter: a horizontal bar whose fill width and color reflect a\nvalue relative to `maxValue`, with an optional title on the left and value on the right.\naliases: MetricBar|Meter|ScoreBar\nDesign system 1.0\n\nThe fill color is resolved from `colorMap` based on the normalized ratio\n(`value / maxValue`), so the bar shifts hue as the value grows. An empty bar\n(value `0`) shows only the `bg-layer-1` track. A missing value (`null`) shows\nan em dash and no progress bar.",
|
|
2573
|
+
"props": [
|
|
2574
|
+
{
|
|
2575
|
+
"name": "value",
|
|
2576
|
+
"type": "number | null",
|
|
2577
|
+
"required": false,
|
|
2578
|
+
"description": "Current value used to size and color the bar. Pass `null` for no data (em dash, no bar). Omit when `error` is set."
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
"name": "maxValue",
|
|
2582
|
+
"type": "number",
|
|
2583
|
+
"required": false,
|
|
2584
|
+
"defaultValue": "1",
|
|
2585
|
+
"description": "Upper bound of the scale."
|
|
2586
|
+
},
|
|
2587
|
+
{
|
|
2588
|
+
"name": "error",
|
|
2589
|
+
"type": "boolean",
|
|
2590
|
+
"required": false,
|
|
2591
|
+
"description": "Renders the error state (error-colored bar + error tag)."
|
|
2592
|
+
},
|
|
2593
|
+
{
|
|
2594
|
+
"name": "isLoading",
|
|
2595
|
+
"type": "boolean",
|
|
2596
|
+
"required": false,
|
|
2597
|
+
"description": "Renders the loading state (loader + empty track)."
|
|
2598
|
+
},
|
|
2599
|
+
{
|
|
2600
|
+
"name": "title",
|
|
2601
|
+
"type": "ReactNode",
|
|
2602
|
+
"required": false,
|
|
2603
|
+
"description": "Optional label rendered above the bar, on the left."
|
|
2604
|
+
},
|
|
2605
|
+
{
|
|
2606
|
+
"name": "valueLabel",
|
|
2607
|
+
"type": "ReactNode",
|
|
2608
|
+
"required": false,
|
|
2609
|
+
"description": "Text rendered above the bar, on the right. Defaults to `value` or `—` when null."
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"name": "colorMap",
|
|
2613
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2614
|
+
"required": false,
|
|
2615
|
+
"defaultValue": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
2616
|
+
"description": "Color bands keyed by ratio."
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
"name": "className",
|
|
2620
|
+
"type": "string",
|
|
2621
|
+
"required": false,
|
|
2622
|
+
"description": "Additional CSS classes for the outer container."
|
|
2623
|
+
},
|
|
2624
|
+
{
|
|
2625
|
+
"name": "titleClassName",
|
|
2626
|
+
"type": "string",
|
|
2627
|
+
"required": false,
|
|
2628
|
+
"description": "Additional CSS classes for the title label."
|
|
2629
|
+
},
|
|
2630
|
+
{
|
|
2631
|
+
"name": "valueClassName",
|
|
2632
|
+
"type": "string",
|
|
2633
|
+
"required": false,
|
|
2634
|
+
"description": "Additional CSS classes for the value label."
|
|
2635
|
+
},
|
|
2636
|
+
{
|
|
2637
|
+
"name": "inline",
|
|
2638
|
+
"type": "boolean",
|
|
2639
|
+
"required": false,
|
|
2640
|
+
"description": "Renders the title and bar on a single row (50% / 50%)."
|
|
2641
|
+
},
|
|
2642
|
+
{
|
|
2643
|
+
"name": "ariaLabel",
|
|
2644
|
+
"type": "string",
|
|
2645
|
+
"required": false,
|
|
2646
|
+
"description": "Accessible label for the bar."
|
|
2647
|
+
}
|
|
2648
|
+
],
|
|
2649
|
+
"examples": [
|
|
2650
|
+
"<DialAnalyticsBar title=\"Relevance\" value={0.82} valueLabel=\"82%\" />",
|
|
2651
|
+
"<DialAnalyticsBar\n title=\"Score\"\n value={640}\n maxValue={1000}\n colorMap={customColorMap}\n/>"
|
|
2652
|
+
],
|
|
2653
|
+
"sourceFile": "components/Analytics/Bar/Bar.tsx"
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
"name": "DialAnalyticsErrorTag",
|
|
2657
|
+
"category": "Analytics",
|
|
2658
|
+
"generation": "1.0",
|
|
2659
|
+
"description": "A non-interactive error tag used across analytics components to indicate that a\nDesign system 1.0\nmetric value could not be provided. Renders a styled with the\nerror palette (`bg-error`, `text-error`, `border-error`).",
|
|
2660
|
+
"props": [
|
|
2661
|
+
{
|
|
2662
|
+
"name": "label",
|
|
2663
|
+
"type": "string",
|
|
2664
|
+
"required": false,
|
|
2665
|
+
"defaultValue": "'Error'",
|
|
2666
|
+
"description": "Text shown inside the tag."
|
|
2667
|
+
},
|
|
2668
|
+
{
|
|
2669
|
+
"name": "className",
|
|
2670
|
+
"type": "string",
|
|
2671
|
+
"required": false,
|
|
2672
|
+
"description": "Additional CSS classes applied to the tag."
|
|
2673
|
+
}
|
|
2674
|
+
],
|
|
2675
|
+
"examples": [
|
|
2676
|
+
"<DialAnalyticsErrorTag />"
|
|
2677
|
+
],
|
|
2678
|
+
"sourceFile": "components/Analytics/ErrorTag/ErrorTag.tsx"
|
|
2679
|
+
},
|
|
2680
|
+
{
|
|
2681
|
+
"name": "DialAnalyticsBarGroup",
|
|
2682
|
+
"category": "Analytics",
|
|
2683
|
+
"generation": "1.0",
|
|
2684
|
+
"description": "A collapsible group of analytics bars built from a key/value map. Wraps\n: the `title` is shown in the header, the number of entries\nis shown as the header description, and each entry renders a \nwith the key as its title and the value as its value.\naliases: MetricBarGroup|BarList|NumericResults\nDesign system 1.0",
|
|
2685
|
+
"props": [
|
|
2686
|
+
{
|
|
2687
|
+
"name": "title",
|
|
2688
|
+
"type": "ReactNode",
|
|
2689
|
+
"required": true,
|
|
2690
|
+
"description": "Title passed to the accordion header."
|
|
2691
|
+
},
|
|
2692
|
+
{
|
|
2693
|
+
"name": "titleTooltip",
|
|
2694
|
+
"type": "ReactNode",
|
|
2695
|
+
"required": false,
|
|
2696
|
+
"description": "Tooltip shown when hovering the accordion header title."
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
"name": "description",
|
|
2700
|
+
"type": "ReactNode",
|
|
2701
|
+
"required": false,
|
|
2702
|
+
"description": "Description passed to the accordion header. Defaults to the number of entries."
|
|
2703
|
+
},
|
|
2704
|
+
{
|
|
2705
|
+
"name": "data",
|
|
2706
|
+
"type": "Record<string, number | null>",
|
|
2707
|
+
"required": true,
|
|
2708
|
+
"description": "Map of metric name to numeric value (or `null` when missing). Each entry renders one bar."
|
|
2709
|
+
},
|
|
2710
|
+
{
|
|
2711
|
+
"name": "compareData",
|
|
2712
|
+
"type": "Record<string, number | null>",
|
|
2713
|
+
"required": false,
|
|
2714
|
+
"description": "Enables compare mode: union of keys, delta badge (`compareData − data`) when both sides are numeric and the rounded delta is non-zero, em dash (no bar) when a side is missing."
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "compareLabels",
|
|
2718
|
+
"type": "[ReactNode, ReactNode]",
|
|
2719
|
+
"required": false,
|
|
2720
|
+
"description": "Labels for the two bars in compare mode: first for `data`, second for `compareData`."
|
|
2721
|
+
},
|
|
2722
|
+
{
|
|
2723
|
+
"name": "maxValue",
|
|
2724
|
+
"type": "number",
|
|
2725
|
+
"required": false,
|
|
2726
|
+
"description": "Upper bound passed to every bar."
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "colorMap",
|
|
2730
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2731
|
+
"required": false,
|
|
2732
|
+
"description": "Color map passed to every bar."
|
|
2733
|
+
},
|
|
2734
|
+
{
|
|
2735
|
+
"name": "defaultExpanded",
|
|
2736
|
+
"type": "boolean",
|
|
2737
|
+
"required": false,
|
|
2738
|
+
"defaultValue": "true",
|
|
2739
|
+
"description": "Whether the accordion is expanded initially."
|
|
2740
|
+
},
|
|
2741
|
+
{
|
|
2742
|
+
"name": "nonCollapsible",
|
|
2743
|
+
"type": "boolean",
|
|
2744
|
+
"required": false,
|
|
2745
|
+
"description": "Renders the group permanently expanded without a toggle or chevron."
|
|
2746
|
+
},
|
|
2747
|
+
{
|
|
2748
|
+
"name": "isLoading",
|
|
2749
|
+
"type": "boolean",
|
|
2750
|
+
"required": false,
|
|
2751
|
+
"description": "Renders a loader in place of the bars while the data is being fetched."
|
|
2752
|
+
},
|
|
2753
|
+
{
|
|
2754
|
+
"name": "onBarClick",
|
|
2755
|
+
"type": "(key: string, value: number | null) => void",
|
|
2756
|
+
"required": false,
|
|
2757
|
+
"description": "Invoked with the entry key and value when a bar (or, in compare mode, the whole entry) is clicked."
|
|
2758
|
+
},
|
|
2759
|
+
{
|
|
2760
|
+
"name": "inline",
|
|
2761
|
+
"type": "boolean",
|
|
2762
|
+
"required": false,
|
|
2763
|
+
"description": "Renders every bar on a single row (50% title, 50% bar + value)."
|
|
2764
|
+
},
|
|
2765
|
+
{
|
|
2766
|
+
"name": "barTitleClassName",
|
|
2767
|
+
"type": "string",
|
|
2768
|
+
"required": false,
|
|
2769
|
+
"description": "Additional CSS classes for each bar's title label."
|
|
2770
|
+
},
|
|
2771
|
+
{
|
|
2772
|
+
"name": "barValueClassName",
|
|
2773
|
+
"type": "string",
|
|
2774
|
+
"required": false,
|
|
2775
|
+
"description": "Additional CSS classes for each bar's value label."
|
|
2776
|
+
},
|
|
2777
|
+
{
|
|
2778
|
+
"name": "barClassName",
|
|
2779
|
+
"type": "string",
|
|
2780
|
+
"required": false,
|
|
2781
|
+
"description": "Additional CSS classes for each bar's outer container."
|
|
2782
|
+
},
|
|
2783
|
+
{
|
|
2784
|
+
"name": "barDescriptions",
|
|
2785
|
+
"type": "Record<string, ReactNode>",
|
|
2786
|
+
"required": false,
|
|
2787
|
+
"description": "Map of bar key to tooltip content. Hovering each bar shows its description."
|
|
2788
|
+
},
|
|
2789
|
+
{
|
|
2790
|
+
"name": "className",
|
|
2791
|
+
"type": "string",
|
|
2792
|
+
"required": false,
|
|
2793
|
+
"description": "Additional CSS classes for the accordion container."
|
|
2794
|
+
}
|
|
2795
|
+
],
|
|
2796
|
+
"examples": [
|
|
2797
|
+
"<DialAnalyticsBarGroup\n title=\"Relevance\"\n data={{ accuracy: 0.82, recall: 0.64, precision: 0.91 }}\n/>"
|
|
2798
|
+
],
|
|
2799
|
+
"sourceFile": "components/Analytics/BarGroup/BarGroup.tsx"
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
"name": "DialAnalyticsHistogram",
|
|
2803
|
+
"category": "Analytics",
|
|
2804
|
+
"generation": "1.0",
|
|
2805
|
+
"description": "A histogram that distributes `values` across the bands of a color map and draws a\ncolumn per band. Each column's height is relative to the Y-axis max (an even\nceiling of the dataset size — the \"out of N\" in the tooltip). Empty columns\nare outlined, populated columns are filled with their band color. A left\nY-axis (count) and horizontal grid lines provide scale; interval labels run\nalong the bottom. Hovering a column reveals a tooltip with its share of the\ntotal.\naliases: Distribution|ColumnChart|FrequencyChart\nDesign system 1.0",
|
|
30
2806
|
"props": [
|
|
31
2807
|
{
|
|
32
|
-
"name": "
|
|
2808
|
+
"name": "title",
|
|
2809
|
+
"type": "ReactNode",
|
|
2810
|
+
"required": true,
|
|
2811
|
+
"description": "Title rendered above the histogram."
|
|
2812
|
+
},
|
|
2813
|
+
{
|
|
2814
|
+
"name": "values",
|
|
2815
|
+
"type": "number[]",
|
|
2816
|
+
"required": true,
|
|
2817
|
+
"description": "Values to distribute across the columns."
|
|
2818
|
+
},
|
|
2819
|
+
{
|
|
2820
|
+
"name": "colorMap",
|
|
2821
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2822
|
+
"required": false,
|
|
2823
|
+
"defaultValue": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
2824
|
+
"description": "Color bands defining the columns."
|
|
2825
|
+
},
|
|
2826
|
+
{
|
|
2827
|
+
"name": "valueTitle",
|
|
33
2828
|
"type": "string",
|
|
34
2829
|
"required": false,
|
|
35
|
-
"
|
|
2830
|
+
"defaultValue": "'values'",
|
|
2831
|
+
"description": "Noun used in the hover tooltip."
|
|
36
2832
|
},
|
|
37
2833
|
{
|
|
38
|
-
"name": "
|
|
39
|
-
"type": "
|
|
2834
|
+
"name": "showCount",
|
|
2835
|
+
"type": "boolean",
|
|
40
2836
|
"required": false,
|
|
41
|
-
"
|
|
42
|
-
|
|
2837
|
+
"description": "When `true`, renders each column's count inside its bar."
|
|
2838
|
+
},
|
|
2839
|
+
{
|
|
2840
|
+
"name": "isLoading",
|
|
2841
|
+
"type": "boolean",
|
|
2842
|
+
"required": false,
|
|
2843
|
+
"description": "Renders a loader in place of the histogram while the data is being fetched."
|
|
2844
|
+
},
|
|
2845
|
+
{
|
|
2846
|
+
"name": "className",
|
|
2847
|
+
"type": "string",
|
|
2848
|
+
"required": false,
|
|
2849
|
+
"description": "Additional CSS classes for the outer container."
|
|
2850
|
+
},
|
|
2851
|
+
{
|
|
2852
|
+
"name": "compareValues",
|
|
2853
|
+
"type": "number[]",
|
|
2854
|
+
"required": false,
|
|
2855
|
+
"description": "Second set of values; enables compare mode (primary striped, compare solid)."
|
|
2856
|
+
},
|
|
2857
|
+
{
|
|
2858
|
+
"name": "valueSetLabel",
|
|
2859
|
+
"type": "string",
|
|
2860
|
+
"required": false,
|
|
2861
|
+
"description": "Label for the primary values set (compare mode tooltip)."
|
|
2862
|
+
},
|
|
2863
|
+
{
|
|
2864
|
+
"name": "compareValueSetLabel",
|
|
2865
|
+
"type": "string",
|
|
2866
|
+
"required": false,
|
|
2867
|
+
"description": "Label for the compare values set (compare mode tooltip)."
|
|
43
2868
|
}
|
|
44
2869
|
],
|
|
45
2870
|
"examples": [
|
|
46
|
-
"<
|
|
2871
|
+
"<DialAnalyticsHistogram\n title=\"Score distribution\"\n values={[0.1, 0.15, 0.4, 0.42, 0.43, 0.9, 1]}\n valueTitle=\"responses\"\n/>"
|
|
47
2872
|
],
|
|
48
|
-
"sourceFile": "components/
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": "DialErrorText",
|
|
52
|
-
"category": "Elements",
|
|
53
|
-
"description": "",
|
|
54
|
-
"props": [],
|
|
55
|
-
"examples": [],
|
|
56
|
-
"sourceFile": "components/CaptionText/CaptionText.tsx"
|
|
2873
|
+
"sourceFile": "components/Analytics/Histogram/Histogram.tsx"
|
|
57
2874
|
},
|
|
58
2875
|
{
|
|
59
2876
|
"name": "DialLabel",
|
|
60
2877
|
"category": "Elements",
|
|
61
|
-
"
|
|
2878
|
+
"generation": "1.0",
|
|
2879
|
+
"description": "A label component\naliases: FormLabel|RequiredIndicator\nDesign system 1.0",
|
|
62
2880
|
"props": [
|
|
63
2881
|
{
|
|
64
2882
|
"name": "label",
|
|
@@ -82,12 +2900,14 @@
|
|
|
82
2900
|
"examples": [
|
|
83
2901
|
"// Basic label\n<DialLabel htmlFor=\"email-input\" label=\"Email Address\" />"
|
|
84
2902
|
],
|
|
85
|
-
"sourceFile": "components/Label/Label.tsx"
|
|
2903
|
+
"sourceFile": "components/Label/Label.tsx",
|
|
2904
|
+
"supersededBy": "Label"
|
|
86
2905
|
},
|
|
87
2906
|
{
|
|
88
2907
|
"name": "DialAccordion",
|
|
89
2908
|
"category": "Layout",
|
|
90
|
-
"
|
|
2909
|
+
"generation": "1.0",
|
|
2910
|
+
"description": "A collapsible panel that toggles its content when the header is clicked.\naliases: Collapse|Disclosure|ExpandablePanel\nDesign system 1.0\n\nWorks as a controlled component when `expanded` is provided, otherwise it manages\nits own state from `defaultExpanded`. The header shows a chevron that rotates when\nexpanded, a title, and an optional description.",
|
|
91
2911
|
"props": [
|
|
92
2912
|
{
|
|
93
2913
|
"name": "title",
|
|
@@ -160,12 +2980,14 @@
|
|
|
160
2980
|
"examples": [
|
|
161
2981
|
"<DialAccordion title=\"Advanced settings\" description=\"Optional configuration\">\n <p>Panel content</p>\n</DialAccordion>"
|
|
162
2982
|
],
|
|
163
|
-
"sourceFile": "components/Accordion/Accordion.tsx"
|
|
2983
|
+
"sourceFile": "components/Accordion/Accordion.tsx",
|
|
2984
|
+
"supersededBy": "Accordion"
|
|
164
2985
|
},
|
|
165
2986
|
{
|
|
166
2987
|
"name": "DialIcon",
|
|
167
2988
|
"category": "Data Display",
|
|
168
|
-
"
|
|
2989
|
+
"generation": "1.0",
|
|
2990
|
+
"description": "A wrapper component for rendering icons with consistent styling\naliases: IconRenderer|SVGWrapper\nDesign system 1.0",
|
|
169
2991
|
"props": [
|
|
170
2992
|
{
|
|
171
2993
|
"name": "icon",
|
|
@@ -188,7 +3010,8 @@
|
|
|
188
3010
|
{
|
|
189
3011
|
"name": "DialNotification",
|
|
190
3012
|
"category": "Elements",
|
|
191
|
-
"
|
|
3013
|
+
"generation": "1.0",
|
|
3014
|
+
"description": "A contextual feedback component for displaying important messages.\naliases: Notification|StatusBanner\nDesign system 1.0\n\nRenders a colored container with an icon, message text, and an optional\nclose button.",
|
|
192
3015
|
"props": [
|
|
193
3016
|
{
|
|
194
3017
|
"name": "variant",
|
|
@@ -247,12 +3070,14 @@
|
|
|
247
3070
|
"examples": [
|
|
248
3071
|
"<DialNotification\n variant={NotificationVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<DialNotification\n variant={NotificationVariant.Success}\n title=\"Saved\"\n message=\"Changes saved successfully.\"\n/>\n\n<DialNotification\n variant={NotificationVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<DialNotification\n variant={NotificationVariant.Loading}\n title=\"Processing\"\n message=\"Please wait...\"\n/>"
|
|
249
3072
|
],
|
|
250
|
-
"sourceFile": "components/Notification/Notification.tsx"
|
|
3073
|
+
"sourceFile": "components/Notification/Notification.tsx",
|
|
3074
|
+
"supersededBy": "Notification"
|
|
251
3075
|
},
|
|
252
3076
|
{
|
|
253
3077
|
"name": "DialLoader",
|
|
254
3078
|
"category": "Feedback",
|
|
255
|
-
"
|
|
3079
|
+
"generation": "1.0",
|
|
3080
|
+
"description": "A simple loading spinner component.\naliases: LoadingSpinner|ProgressSpinner\nDesign system 1.0\n\nRenders a spinning SVG with optional full-width container.",
|
|
256
3081
|
"props": [
|
|
257
3082
|
{
|
|
258
3083
|
"name": "size",
|
|
@@ -293,79 +3118,11 @@
|
|
|
293
3118
|
],
|
|
294
3119
|
"sourceFile": "components/Loader/Loader.tsx"
|
|
295
3120
|
},
|
|
296
|
-
{
|
|
297
|
-
"name": "DialSpinner",
|
|
298
|
-
"category": "Status",
|
|
299
|
-
"description": "",
|
|
300
|
-
"props": [
|
|
301
|
-
{
|
|
302
|
-
"name": "size",
|
|
303
|
-
"type": "number",
|
|
304
|
-
"required": false,
|
|
305
|
-
"defaultValue": "40"
|
|
306
|
-
},
|
|
307
|
-
{
|
|
308
|
-
"name": "className",
|
|
309
|
-
"type": "string",
|
|
310
|
-
"required": false
|
|
311
|
-
},
|
|
312
|
-
{
|
|
313
|
-
"name": "fullWidth",
|
|
314
|
-
"type": "boolean",
|
|
315
|
-
"required": false,
|
|
316
|
-
"defaultValue": "false"
|
|
317
|
-
},
|
|
318
|
-
{
|
|
319
|
-
"name": "ariaLabel",
|
|
320
|
-
"type": "string",
|
|
321
|
-
"required": false,
|
|
322
|
-
"defaultValue": "'Loading'"
|
|
323
|
-
}
|
|
324
|
-
],
|
|
325
|
-
"examples": [],
|
|
326
|
-
"sourceFile": "components/Spinner/Spinner.tsx"
|
|
327
|
-
},
|
|
328
|
-
{
|
|
329
|
-
"name": "DialProgressBar",
|
|
330
|
-
"category": "Status",
|
|
331
|
-
"description": "",
|
|
332
|
-
"props": [
|
|
333
|
-
{
|
|
334
|
-
"name": "value",
|
|
335
|
-
"type": "number",
|
|
336
|
-
"required": true
|
|
337
|
-
},
|
|
338
|
-
{
|
|
339
|
-
"name": "max",
|
|
340
|
-
"type": "number",
|
|
341
|
-
"required": false,
|
|
342
|
-
"defaultValue": "100"
|
|
343
|
-
},
|
|
344
|
-
{
|
|
345
|
-
"name": "size",
|
|
346
|
-
"type": "DialProgressBarSize",
|
|
347
|
-
"required": false,
|
|
348
|
-
"defaultValue": "DialProgressBarSize.Medium"
|
|
349
|
-
},
|
|
350
|
-
{
|
|
351
|
-
"name": "className",
|
|
352
|
-
"type": "string",
|
|
353
|
-
"required": false
|
|
354
|
-
},
|
|
355
|
-
{
|
|
356
|
-
"name": "ariaLabel",
|
|
357
|
-
"type": "string",
|
|
358
|
-
"required": false,
|
|
359
|
-
"defaultValue": "'Progress'"
|
|
360
|
-
}
|
|
361
|
-
],
|
|
362
|
-
"examples": [],
|
|
363
|
-
"sourceFile": "components/ProgressBar/ProgressBar.tsx"
|
|
364
|
-
},
|
|
365
3121
|
{
|
|
366
3122
|
"name": "DialPagination",
|
|
367
3123
|
"category": "Navigation",
|
|
368
|
-
"
|
|
3124
|
+
"generation": "1.0",
|
|
3125
|
+
"description": "Design system 1.0",
|
|
369
3126
|
"props": [
|
|
370
3127
|
{
|
|
371
3128
|
"name": "page",
|
|
@@ -394,7 +3151,8 @@
|
|
|
394
3151
|
{
|
|
395
3152
|
"name": "DialCheckbox",
|
|
396
3153
|
"category": "Form",
|
|
397
|
-
"
|
|
3154
|
+
"generation": "1.0",
|
|
3155
|
+
"description": "A Checkbox component with styling options\naliases: ToggleCheckbox|MultiSelectOption\nDesign system 1.0",
|
|
398
3156
|
"props": [
|
|
399
3157
|
{
|
|
400
3158
|
"name": "id",
|
|
@@ -447,7 +3205,8 @@
|
|
|
447
3205
|
{
|
|
448
3206
|
"name": "DialSteps",
|
|
449
3207
|
"category": "Navigation",
|
|
450
|
-
"
|
|
3208
|
+
"generation": "1.0",
|
|
3209
|
+
"description": "Props for the DialSteps component, which renders a multi-step navigation UI.\naliases: StepWizard|ProgressSteps\nDesign system 1.0",
|
|
451
3210
|
"props": [
|
|
452
3211
|
{
|
|
453
3212
|
"name": "steps",
|
|
@@ -476,7 +3235,8 @@
|
|
|
476
3235
|
{
|
|
477
3236
|
"name": "DialRadioButton",
|
|
478
3237
|
"category": "Free",
|
|
479
|
-
"
|
|
3238
|
+
"generation": "1.0",
|
|
3239
|
+
"description": "A stylized, accessible radio input with optional description.\naliases: ChoiceOption|RadioInput\nDesign system 1.0\n\nRenders a native `<input type=\"radio\" />` paired with a label. When `checked`\nand `description` are provided, a supporting text block appears under the control.",
|
|
480
3240
|
"props": [
|
|
481
3241
|
{
|
|
482
3242
|
"name": "name",
|
|
@@ -573,7 +3333,8 @@
|
|
|
573
3333
|
{
|
|
574
3334
|
"name": "DialRadioGroup",
|
|
575
3335
|
"category": "Form",
|
|
576
|
-
"
|
|
3336
|
+
"generation": "1.0",
|
|
3337
|
+
"description": "Groups multiple `DialRadio` options and renders custom content for the active option.\naliases: SelectionGroup|OptionGroup\nDesign system 1.0\n\nUses `DialField` as the field label and a container with `role=\"radiogroup\"`.\nContent provided in `radioButtons[].content` is shown under the currently active radio.",
|
|
577
3338
|
"props": [
|
|
578
3339
|
{
|
|
579
3340
|
"name": "fieldTitle",
|
|
@@ -692,7 +3453,8 @@
|
|
|
692
3453
|
{
|
|
693
3454
|
"name": "DialSlider",
|
|
694
3455
|
"category": "Form",
|
|
695
|
-
"
|
|
3456
|
+
"generation": "1.0",
|
|
3457
|
+
"description": "A range slider with a custom thumb showing the current value and optional labels.\naliases: RangeInput|TemperatureSlider\nDesign system 1.0",
|
|
696
3458
|
"props": [
|
|
697
3459
|
{
|
|
698
3460
|
"name": "value",
|
|
@@ -785,7 +3547,8 @@
|
|
|
785
3547
|
{
|
|
786
3548
|
"name": "DialNoDataContent",
|
|
787
3549
|
"category": "Feedback",
|
|
788
|
-
"
|
|
3550
|
+
"generation": "1.0",
|
|
3551
|
+
"description": "A component for displaying a message and icon when there is no data to show.\naliases: EmptyState|NoResults\nDesign system 1.0",
|
|
789
3552
|
"props": [
|
|
790
3553
|
{
|
|
791
3554
|
"name": "icon",
|
|
@@ -832,7 +3595,8 @@
|
|
|
832
3595
|
{
|
|
833
3596
|
"name": "DialCollapsibleSidebar",
|
|
834
3597
|
"category": "Navigation",
|
|
835
|
-
"
|
|
3598
|
+
"generation": "1.0",
|
|
3599
|
+
"description": "A collapsible horizontal bar component that allows toggling between an expanded and collapsed state.\naliases: ToggleSidebar|CollapsiblePanel\nDesign system 1.0\n\nIt supports customizable width, title, icons, additional buttons, and flexible styling options.",
|
|
836
3600
|
"props": [
|
|
837
3601
|
{
|
|
838
3602
|
"name": "children",
|
|
@@ -906,7 +3670,8 @@
|
|
|
906
3670
|
{
|
|
907
3671
|
"name": "DialLabelledText",
|
|
908
3672
|
"category": "Data Display",
|
|
909
|
-
"
|
|
3673
|
+
"generation": "1.0",
|
|
3674
|
+
"description": "A label component for form fields with optional tooltip, content, and custom elements.\naliases: LabelValue|DisplayText\nDesign system 1.0",
|
|
910
3675
|
"props": [
|
|
911
3676
|
{
|
|
912
3677
|
"name": "label",
|
|
@@ -953,7 +3718,8 @@
|
|
|
953
3718
|
{
|
|
954
3719
|
"name": "DialTag",
|
|
955
3720
|
"category": "Tag",
|
|
956
|
-
"
|
|
3721
|
+
"generation": "1.0",
|
|
3722
|
+
"description": "A compact label element used for selections, filters, or categories.\nDesign system 1.0",
|
|
957
3723
|
"props": [
|
|
958
3724
|
{
|
|
959
3725
|
"name": "label",
|
|
@@ -992,12 +3758,14 @@
|
|
|
992
3758
|
}
|
|
993
3759
|
],
|
|
994
3760
|
"examples": [],
|
|
995
|
-
"sourceFile": "components/Tag/Tag.tsx"
|
|
3761
|
+
"sourceFile": "components/Tag/Tag.tsx",
|
|
3762
|
+
"supersededBy": "Tag"
|
|
996
3763
|
},
|
|
997
3764
|
{
|
|
998
3765
|
"name": "DialEllipsisTooltip",
|
|
999
3766
|
"category": "Overlay",
|
|
1000
|
-
"
|
|
3767
|
+
"generation": "1.0",
|
|
3768
|
+
"description": "Single-line text with CSS ellipsis that shows a tooltip **only when actually truncated**.\naliases: TruncatedText|TruncationTooltip\nDesign system 1.0\n\nIf the text fits, tooltip content is empty and the popup stays hidden.\n\nImportant: width must be finite for truncation.\nConsumers can override via `className`.\n\na11y: when truncated, the full text is exposed via `aria-label` on the reference node.",
|
|
1001
3769
|
"props": [
|
|
1002
3770
|
{
|
|
1003
3771
|
"name": "text",
|
|
@@ -1044,7 +3812,8 @@
|
|
|
1044
3812
|
{
|
|
1045
3813
|
"name": "DialDraggableItem",
|
|
1046
3814
|
"category": "Components",
|
|
1047
|
-
"
|
|
3815
|
+
"generation": "1.0",
|
|
3816
|
+
"description": "A lightweight wrapper that makes its children sortable via drag-and-drop.\naliases: SortableItem|DragHandle\nDesign system 1.0\n\nRenders a row with a grab handle (left) and the provided content (right).\nIntegrates with `react-dnd` using a simple \"column\" drag type and delegates\nreordering logic to the provided `findItem` and `moveItem` callbacks.",
|
|
1048
3817
|
"props": [
|
|
1049
3818
|
{
|
|
1050
3819
|
"name": "id",
|
|
@@ -1092,7 +3861,8 @@
|
|
|
1092
3861
|
{
|
|
1093
3862
|
"name": "DialFileIcon",
|
|
1094
3863
|
"category": "FileManager/components",
|
|
1095
|
-
"
|
|
3864
|
+
"generation": "1.0",
|
|
3865
|
+
"description": "Renders a file-type icon based on a file extension.\naliases: ExtensionIcon|TypeIcon\nDesign system 1.0\n\nUses DialIcon to provide consistent icon wrapper styling.",
|
|
1096
3866
|
"props": [
|
|
1097
3867
|
{
|
|
1098
3868
|
"name": "extension",
|
|
@@ -1148,7 +3918,8 @@
|
|
|
1148
3918
|
{
|
|
1149
3919
|
"name": "DialFormItem",
|
|
1150
3920
|
"category": "Form",
|
|
1151
|
-
"
|
|
3921
|
+
"generation": "1.0",
|
|
3922
|
+
"description": "A layout wrapper for form controls with label, helper text and error message.\naliases: FieldWrapper|FormControl\nDesign system 1.0\n\nUses `DialLabel` for the label and `DialErrorText` for consistent error styling.\nWires accessibility with:\n- `role=\"group\"`\n- `aria-labelledby` (when label is present)\n- `aria-describedby` (description and/or error ids)",
|
|
1152
3923
|
"props": [
|
|
1153
3924
|
{
|
|
1154
3925
|
"name": "id",
|
|
@@ -1214,7 +3985,8 @@
|
|
|
1214
3985
|
{
|
|
1215
3986
|
"name": "DialSharedEntityIndicator",
|
|
1216
3987
|
"category": "FileManager/components",
|
|
1217
|
-
"
|
|
3988
|
+
"generation": "1.0",
|
|
3989
|
+
"description": "A compact icon-only indicator to denote a \"shared\" entity.\naliases: SharedIcon|AccessIndicator\nDesign system 1.0\n\nRenders a small arrow-up-right icon with token-based colors.",
|
|
1218
3990
|
"props": [
|
|
1219
3991
|
{
|
|
1220
3992
|
"name": "label",
|
|
@@ -1264,7 +4036,8 @@
|
|
|
1264
4036
|
{
|
|
1265
4037
|
"name": "DialFileName",
|
|
1266
4038
|
"category": "FileManager/components",
|
|
1267
|
-
"
|
|
4039
|
+
"generation": "1.0",
|
|
4040
|
+
"description": "Component to display a file name with a file icon and shared indicator.\naliases: FileDisplay|NameDisplay\nDesign system 1.0\n\nHandles long names with ellipsis and tooltip.\n\nIf `details` is provided (e.g., file size, date), the component switches to\na vertical layout and renders the extra information below the file name.",
|
|
1268
4041
|
"props": [
|
|
1269
4042
|
{
|
|
1270
4043
|
"name": "name",
|
|
@@ -1343,7 +4116,8 @@
|
|
|
1343
4116
|
{
|
|
1344
4117
|
"name": "DialFolderName",
|
|
1345
4118
|
"category": "FileManager/components",
|
|
1346
|
-
"
|
|
4119
|
+
"generation": "1.0",
|
|
4120
|
+
"description": "Component to display a folder name with a folder icon and shared indicator.\naliases: FolderDisplay|DirectoryName\nDesign system 1.0\n\nHandles long names with ellipsis and tooltip.",
|
|
1347
4121
|
"props": [
|
|
1348
4122
|
{
|
|
1349
4123
|
"name": "name",
|
|
@@ -1419,7 +4193,8 @@
|
|
|
1419
4193
|
{
|
|
1420
4194
|
"name": "DialResizableContainer",
|
|
1421
4195
|
"category": "Components",
|
|
1422
|
-
"
|
|
4196
|
+
"generation": "1.0",
|
|
4197
|
+
"description": "DialResizableContainer — A reusable resizable container\naliases: ResizePanel|SizableContainer\nDesign system 1.0\n\nsupporting both **controlled** and **uncontrolled** width modes.\n\nControlled Mode\n\nProvide `width` and optionally `onResizeStop`:\n```tsx\n<DialResizableContainer\n width={sidebarWidth}\n onResizeStop={(w) => setSidebarWidth(w)}\n minWidth={180}\n maxWidth={520}\n>\n <Sidebar />\n</DialResizableContainer>\n```\n\nUncontrolled Mode\n\nOmit `width` entirely — the component manages its own width:\n```tsx\n<DialResizableContainer\n defaultWidth={260}\n minWidth={180}\n maxWidth={520}\n>\n <Sidebar />\n</DialResizableContainer>\n```\n\nFeatures:\n- Resize from left or right\n- Fully supports controlled & uncontrolled sizing\n- Custom resize handler (icon or any ReactNode)\n- Callback when resize stops (optional)\n- Smooth hover/drag visibility transitions",
|
|
1423
4198
|
"props": [
|
|
1424
4199
|
{
|
|
1425
4200
|
"name": "children",
|
|
@@ -1489,7 +4264,8 @@
|
|
|
1489
4264
|
{
|
|
1490
4265
|
"name": "DialConditionalResizableContainer",
|
|
1491
4266
|
"category": "Components",
|
|
1492
|
-
"
|
|
4267
|
+
"generation": "1.0",
|
|
4268
|
+
"description": "DialConditionalResizableContainer — A conditional wrapper around `DialResizableContainer`.\naliases: OptionalResize|ConditionalPanel\nDesign system 1.0\n\nThis component renders its children inside a resizable container only when `enabled` is true.\nWhen `enabled` is false, children are rendered directly without any resizable behavior.\n\nAll other props are the same as `DialResizableContainer`. See the documentation for\n`DialResizableContainer` for full details on usage, controlled/uncontrolled modes, sides, and callbacks.",
|
|
1493
4269
|
"props": [
|
|
1494
4270
|
{
|
|
1495
4271
|
"name": "enabled",
|
|
@@ -1504,93 +4280,11 @@
|
|
|
1504
4280
|
],
|
|
1505
4281
|
"sourceFile": "components/ResizableContainer/ConditionalResizableContainer.tsx"
|
|
1506
4282
|
},
|
|
1507
|
-
{
|
|
1508
|
-
"name": "DialSkeleton",
|
|
1509
|
-
"category": "Feedback",
|
|
1510
|
-
"description": "DialSkeleton\naliases: PlaceholderUI|ShimmerLoader\n\nA placeholder component to show while content is loading.\nProvides various skeleton shapes and configurations.",
|
|
1511
|
-
"props": [
|
|
1512
|
-
{
|
|
1513
|
-
"name": "active",
|
|
1514
|
-
"type": "boolean",
|
|
1515
|
-
"required": false,
|
|
1516
|
-
"defaultValue": "true",
|
|
1517
|
-
"description": "Whether to show the loading animation"
|
|
1518
|
-
},
|
|
1519
|
-
{
|
|
1520
|
-
"name": "paragraph",
|
|
1521
|
-
"type": "boolean | { rows?: number; width?: string | string[] }",
|
|
1522
|
-
"required": false,
|
|
1523
|
-
"defaultValue": "true",
|
|
1524
|
-
"description": "Show paragraph placeholder or configure its appearance"
|
|
1525
|
-
},
|
|
1526
|
-
{
|
|
1527
|
-
"name": "avatar",
|
|
1528
|
-
"type": "| boolean\n | {\n size?: number | DialSkeletonAvatarSize;\n shape?: DialSkeletonAvatarShape;\n }",
|
|
1529
|
-
"required": false,
|
|
1530
|
-
"defaultValue": "false",
|
|
1531
|
-
"description": "Show avatar placeholder or configure its appearance"
|
|
1532
|
-
},
|
|
1533
|
-
{
|
|
1534
|
-
"name": "showTitle",
|
|
1535
|
-
"type": "boolean | { width?: string }",
|
|
1536
|
-
"required": false,
|
|
1537
|
-
"defaultValue": "true",
|
|
1538
|
-
"description": "Show title placeholder or configure its appearance"
|
|
1539
|
-
},
|
|
1540
|
-
{
|
|
1541
|
-
"name": "loading",
|
|
1542
|
-
"type": "boolean",
|
|
1543
|
-
"required": false,
|
|
1544
|
-
"defaultValue": "true",
|
|
1545
|
-
"description": "Display the skeleton when true"
|
|
1546
|
-
},
|
|
1547
|
-
{
|
|
1548
|
-
"name": "children",
|
|
1549
|
-
"type": "ReactNode",
|
|
1550
|
-
"required": false,
|
|
1551
|
-
"description": "Content to be displayed when loading is false"
|
|
1552
|
-
},
|
|
1553
|
-
{
|
|
1554
|
-
"name": "variant",
|
|
1555
|
-
"type": "DialSkeletonVariant",
|
|
1556
|
-
"required": false,
|
|
1557
|
-
"defaultValue": "DialSkeletonVariant.Default",
|
|
1558
|
-
"description": "Skeleton variant"
|
|
1559
|
-
},
|
|
1560
|
-
{
|
|
1561
|
-
"name": "width",
|
|
1562
|
-
"type": "string | number",
|
|
1563
|
-
"required": false,
|
|
1564
|
-
"description": "Width of the skeleton"
|
|
1565
|
-
},
|
|
1566
|
-
{
|
|
1567
|
-
"name": "height",
|
|
1568
|
-
"type": "string | number",
|
|
1569
|
-
"required": false,
|
|
1570
|
-
"description": "Height of the skeleton"
|
|
1571
|
-
},
|
|
1572
|
-
{
|
|
1573
|
-
"name": "overlay",
|
|
1574
|
-
"type": "ReactNode",
|
|
1575
|
-
"required": false,
|
|
1576
|
-
"description": "Content to overlay on top of the skeleton (e.g., a spinner)"
|
|
1577
|
-
},
|
|
1578
|
-
{
|
|
1579
|
-
"name": "color",
|
|
1580
|
-
"type": "string",
|
|
1581
|
-
"required": false,
|
|
1582
|
-
"description": "Custom background color for the skeleton elements (overrides the default token)"
|
|
1583
|
-
}
|
|
1584
|
-
],
|
|
1585
|
-
"examples": [
|
|
1586
|
-
"// Simple skeleton\n<DialSkeleton />\n\n// Text skeleton with custom size\n<DialSkeleton variant={DialSkeletonVariant.Text} width=\"200px\" height=\"20px\" />\n\n// Circular avatar skeleton\n<DialSkeleton variant={DialSkeletonVariant.Circular} width={40} height={40} />\n\n// Complex skeleton with avatar, showTitle and paragraph\n<DialSkeleton\n avatar\n showTitle\n paragraph={{ rows: 3 }}\n active\n/>\n\n// Conditional loading\n<DialSkeleton loading={isLoading}>\n <div>Your content here</div>\n</DialSkeleton>\n\n// Custom paragraph widths\n<DialSkeleton\n paragraph={{ rows: 3, width: ['100%', '80%', '60%'] }}\n/>\n\n// Avatar with size and shape\n<DialSkeleton\n avatar={{\n size: DialSkeletonAvatarSize.Large,\n shape: DialSkeletonAvatarShape.Square\n }}\n/>"
|
|
1587
|
-
],
|
|
1588
|
-
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
1589
|
-
},
|
|
1590
4283
|
{
|
|
1591
4284
|
"name": "DialGrid",
|
|
1592
4285
|
"category": "Grid",
|
|
1593
|
-
"
|
|
4286
|
+
"generation": "1.0",
|
|
4287
|
+
"description": "DialGrid — A feature-rich data grid wrapper built on ag-Grid with dark theme support.\naliases: DataTable|TableGrid\nDesign system 1.0\n\nProvides a pre-configured grid with:\n- Dark theme styling with CSS variable integration\n- Optional row selection with checkboxes\n- Context menu integration via DialDropdown\n- Text overflow handling with tooltips via DialEllipsisTooltip\n- Controlled or uncontrolled selection modes\n- Automatic column sizing and responsive behavior\n- Full accessibility support with ARIA attributes\n- Loading state with native AG-Grid overlay",
|
|
1594
4288
|
"props": [
|
|
1595
4289
|
{
|
|
1596
4290
|
"name": "columnDefs",
|
|
@@ -1741,10 +4435,60 @@
|
|
|
1741
4435
|
],
|
|
1742
4436
|
"sourceFile": "components/Grid/Grid.tsx"
|
|
1743
4437
|
},
|
|
4438
|
+
{
|
|
4439
|
+
"name": "DialDateCellRenderer",
|
|
4440
|
+
"category": "Grid",
|
|
4441
|
+
"generation": "1.0",
|
|
4442
|
+
"description": "Minimal date cell renderer (ag-Grid compatible).\nDesign system 1.0\n\nRenders the value in the **\"MMM dd, yyyy\"** format (e.g., \"Jul 20, 2025\"),\nwrapped in `DialEllipsisTooltip` (tooltip only appears if truncated).",
|
|
4443
|
+
"props": [
|
|
4444
|
+
{
|
|
4445
|
+
"name": "value",
|
|
4446
|
+
"type": "DateValue | null",
|
|
4447
|
+
"required": false
|
|
4448
|
+
},
|
|
4449
|
+
{
|
|
4450
|
+
"name": "locale",
|
|
4451
|
+
"type": "string",
|
|
4452
|
+
"required": false,
|
|
4453
|
+
"defaultValue": "DEFAULT_LOCALE",
|
|
4454
|
+
"description": "Locale fixed to U.S. English by default to enforce \"Jul 20, 2025\"."
|
|
4455
|
+
},
|
|
4456
|
+
{
|
|
4457
|
+
"name": "options",
|
|
4458
|
+
"type": "Intl.DateTimeFormatOptions",
|
|
4459
|
+
"required": false,
|
|
4460
|
+
"defaultValue": "DEFAULT_DATE_FORMAT_OPTIONS",
|
|
4461
|
+
"description": "Options for date formatting (e.g., timeZone)."
|
|
4462
|
+
},
|
|
4463
|
+
{
|
|
4464
|
+
"name": "emptyPlaceholder",
|
|
4465
|
+
"type": "string",
|
|
4466
|
+
"required": false,
|
|
4467
|
+
"description": "Placeholder when value is empty/invalid."
|
|
4468
|
+
},
|
|
4469
|
+
{
|
|
4470
|
+
"name": "className",
|
|
4471
|
+
"type": "string",
|
|
4472
|
+
"required": false,
|
|
4473
|
+
"description": "Additional classes merged into the wrapper."
|
|
4474
|
+
},
|
|
4475
|
+
{
|
|
4476
|
+
"name": "hideTooltip",
|
|
4477
|
+
"type": "boolean",
|
|
4478
|
+
"required": false,
|
|
4479
|
+
"defaultValue": "false"
|
|
4480
|
+
}
|
|
4481
|
+
],
|
|
4482
|
+
"examples": [
|
|
4483
|
+
"// ag-Grid colDef\n{ field: 'createdAt', cellRenderer: DateCellRenderer, cellRendererParams: { options: { timeZone: 'UTC' } } }\n\n// Direct usage\n<DateCellRenderer value=\"2025-07-20T00:00:00Z\" options={{ timeZone: 'UTC' }} />\n<DateCellRenderer value={1752969600000} options={{ timeZone: 'UTC' }} /> // milliseconds"
|
|
4484
|
+
],
|
|
4485
|
+
"sourceFile": "components/Grid/renderers/DateCellRenderer.tsx"
|
|
4486
|
+
},
|
|
1744
4487
|
{
|
|
1745
4488
|
"name": "DialTabs",
|
|
1746
4489
|
"category": "Navigation",
|
|
1747
|
-
"
|
|
4490
|
+
"generation": "1.0",
|
|
4491
|
+
"description": "A responsive and overflow-aware tabs component that automatically adapts its layout\naliases: TabNavigation|TabBar\nDesign system 1.0\n\nbetween a scrollable tab bar and a dropdown menu on smaller screens.\n\nWhen there are too many tabs to fit in a single line, it introduces a dropdown button\nfor accessing hidden tabs and ensures smooth horizontal scrolling. The component also\nautomatically keeps the active tab in view.\n\nSupports both horizontal and vertical orientations and dynamically adjusts layout\nbased on screen size and available space.\n\nOn larger screens, tabs are displayed according to the `orientation` prop\n(horizontal or vertical). On smaller screens (mobile or tablet), the tabs collapse\ninto a dropdown menu for better usability.",
|
|
1748
4492
|
"props": [
|
|
1749
4493
|
{
|
|
1750
4494
|
"name": "tabs",
|
|
@@ -1828,12 +4572,14 @@
|
|
|
1828
4572
|
"examples": [
|
|
1829
4573
|
"<DialTabs\n tabs={[\n { id: 'overview', name: 'Overview' },\n { id: 'details', name: 'Details' },\n { id: 'settings', name: 'Settings', invalid: true },\n ]}\n activeTab=\"overview\"\n onClick={(id) => setActiveTab(id)}\n orientation={TabOrientation.Horizontal}\n/>"
|
|
1830
4574
|
],
|
|
1831
|
-
"sourceFile": "components/Tabs/Tabs.tsx"
|
|
4575
|
+
"sourceFile": "components/Tabs/Tabs.tsx",
|
|
4576
|
+
"supersededBy": "Tabs"
|
|
1832
4577
|
},
|
|
1833
4578
|
{
|
|
1834
4579
|
"name": "DialBreadcrumb",
|
|
1835
4580
|
"category": "Navigation",
|
|
1836
|
-
"
|
|
4581
|
+
"generation": "1.0",
|
|
4582
|
+
"description": "Breadcrumb navigation component with horizontal scroll on overflow.\naliases: NavigationPath|BreadcrumbTrail\nDesign system 1.0\n\nUse either the `pathItems` prop or compose with `<DialBreadcrumbItem/>` as children.\nThe last item is treated as the current page.",
|
|
1837
4583
|
"props": [
|
|
1838
4584
|
{
|
|
1839
4585
|
"name": "pathItems",
|
|
@@ -1889,7 +4635,8 @@
|
|
|
1889
4635
|
{
|
|
1890
4636
|
"name": "DialBreadcrumbItem",
|
|
1891
4637
|
"category": "Navigation",
|
|
1892
|
-
"
|
|
4638
|
+
"generation": "1.0",
|
|
4639
|
+
"description": "Design system 1.0",
|
|
1893
4640
|
"props": [
|
|
1894
4641
|
{
|
|
1895
4642
|
"name": "label",
|
|
@@ -1949,7 +4696,8 @@
|
|
|
1949
4696
|
{
|
|
1950
4697
|
"name": "DialButton",
|
|
1951
4698
|
"category": "Elements/Buttons",
|
|
1952
|
-
"
|
|
4699
|
+
"generation": "1.0",
|
|
4700
|
+
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction\nDesign system 1.0",
|
|
1953
4701
|
"props": [
|
|
1954
4702
|
{
|
|
1955
4703
|
"name": "variant",
|
|
@@ -2011,12 +4759,14 @@
|
|
|
2011
4759
|
"<DialButton\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
2012
4760
|
"<DialButton\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
2013
4761
|
],
|
|
2014
|
-
"sourceFile": "components/Button/Button.tsx"
|
|
4762
|
+
"sourceFile": "components/Button/Button.tsx",
|
|
4763
|
+
"supersededBy": "Button"
|
|
2015
4764
|
},
|
|
2016
4765
|
{
|
|
2017
4766
|
"name": "DialIconButton",
|
|
2018
4767
|
"category": "Elements/Buttons",
|
|
2019
|
-
"
|
|
4768
|
+
"generation": "1.0",
|
|
4769
|
+
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton\nDesign system 1.0",
|
|
2020
4770
|
"props": [
|
|
2021
4771
|
{
|
|
2022
4772
|
"name": "variant",
|
|
@@ -2054,118 +4804,121 @@
|
|
|
2054
4804
|
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
2055
4805
|
"<DialIconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
2056
4806
|
],
|
|
2057
|
-
"sourceFile": "components/IconButton/IconButton.tsx"
|
|
4807
|
+
"sourceFile": "components/IconButton/IconButton.tsx",
|
|
4808
|
+
"supersededBy": "IconButton"
|
|
2058
4809
|
},
|
|
2059
4810
|
{
|
|
2060
4811
|
"name": "DialDangerButton",
|
|
2061
4812
|
"category": "Elements/Buttons",
|
|
4813
|
+
"generation": "1.0",
|
|
2062
4814
|
"description": "A Danger Button component with predefined danger variant",
|
|
2063
4815
|
"props": [],
|
|
2064
4816
|
"examples": [
|
|
2065
4817
|
"<DialDangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
2066
4818
|
],
|
|
2067
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4819
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4820
|
+
"supersededBy": "DangerButton"
|
|
2068
4821
|
},
|
|
2069
4822
|
{
|
|
2070
4823
|
"name": "DialNeutralButton",
|
|
2071
4824
|
"category": "Elements/Buttons",
|
|
4825
|
+
"generation": "1.0",
|
|
2072
4826
|
"description": "A Neutral Button component with predefined neutral variant",
|
|
2073
4827
|
"props": [],
|
|
2074
4828
|
"examples": [
|
|
2075
4829
|
"<DialNeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2076
4830
|
],
|
|
2077
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4831
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4832
|
+
"supersededBy": "NeutralButton"
|
|
2078
4833
|
},
|
|
2079
4834
|
{
|
|
2080
4835
|
"name": "DialPrimaryButton",
|
|
2081
4836
|
"category": "Elements/Buttons",
|
|
2082
|
-
"
|
|
4837
|
+
"generation": "1.0",
|
|
4838
|
+
"description": "A Primary Button component with predefined primary variant\nDesign system 1.0",
|
|
2083
4839
|
"props": [],
|
|
2084
4840
|
"examples": [
|
|
2085
4841
|
"<DialPrimaryButton\n label=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
2086
4842
|
],
|
|
2087
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4843
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4844
|
+
"supersededBy": "PrimaryButton"
|
|
2088
4845
|
},
|
|
2089
4846
|
{
|
|
2090
4847
|
"name": "DialGhostButton",
|
|
2091
4848
|
"category": "Elements/Buttons",
|
|
4849
|
+
"generation": "1.0",
|
|
2092
4850
|
"description": "A Ghost Button component with predefined ghost appearance",
|
|
2093
4851
|
"props": [],
|
|
2094
4852
|
"examples": [
|
|
2095
4853
|
"<DialGhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2096
4854
|
],
|
|
2097
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4855
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4856
|
+
"supersededBy": "GhostButton"
|
|
2098
4857
|
},
|
|
2099
4858
|
{
|
|
2100
4859
|
"name": "DialLinkButton",
|
|
2101
4860
|
"category": "Elements/Buttons",
|
|
4861
|
+
"generation": "1.0",
|
|
2102
4862
|
"description": "A Link Button component with predefined link appearance",
|
|
2103
4863
|
"props": [],
|
|
2104
4864
|
"examples": [
|
|
2105
4865
|
"<DialLinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2106
4866
|
],
|
|
2107
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
2108
|
-
|
|
2109
|
-
{
|
|
2110
|
-
"name": "DialRoundedButton",
|
|
2111
|
-
"category": "Elements/Buttons",
|
|
2112
|
-
"description": "A pill-shaped neutral button with an optional selected state.",
|
|
2113
|
-
"props": [
|
|
2114
|
-
{
|
|
2115
|
-
"name": "selected",
|
|
2116
|
-
"type": "boolean",
|
|
2117
|
-
"required": false,
|
|
2118
|
-
"description": "Applies accent-primary tint and border when true"
|
|
2119
|
-
}
|
|
2120
|
-
],
|
|
2121
|
-
"examples": [
|
|
2122
|
-
"<DialRoundedButton label=\"Tag\" selected={isActive} onClick={handleClick} />"
|
|
2123
|
-
],
|
|
2124
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4867
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4868
|
+
"supersededBy": "LinkButton"
|
|
2125
4869
|
},
|
|
2126
4870
|
{
|
|
2127
4871
|
"name": "DialDangerIconButton",
|
|
2128
4872
|
"category": "Elements/Buttons",
|
|
4873
|
+
"generation": "1.0",
|
|
2129
4874
|
"description": "A Danger Icon Button component with predefined danger variant",
|
|
2130
4875
|
"props": [],
|
|
2131
4876
|
"examples": [
|
|
2132
4877
|
"<DialDangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2133
4878
|
],
|
|
2134
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4879
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4880
|
+
"supersededBy": "DangerIconButton"
|
|
2135
4881
|
},
|
|
2136
4882
|
{
|
|
2137
4883
|
"name": "DialGhostIconButton",
|
|
2138
4884
|
"category": "Elements/Buttons",
|
|
4885
|
+
"generation": "1.0",
|
|
2139
4886
|
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
2140
4887
|
"props": [],
|
|
2141
4888
|
"examples": [
|
|
2142
4889
|
"<DialGhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2143
4890
|
],
|
|
2144
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4891
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4892
|
+
"supersededBy": "GhostIconButton"
|
|
2145
4893
|
},
|
|
2146
4894
|
{
|
|
2147
4895
|
"name": "DialNeutralIconButton",
|
|
2148
4896
|
"category": "Elements/Buttons",
|
|
4897
|
+
"generation": "1.0",
|
|
2149
4898
|
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
2150
4899
|
"props": [],
|
|
2151
4900
|
"examples": [
|
|
2152
4901
|
"<DialNeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2153
4902
|
],
|
|
2154
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4903
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4904
|
+
"supersededBy": "NeutralIconButton"
|
|
2155
4905
|
},
|
|
2156
4906
|
{
|
|
2157
4907
|
"name": "DialPrimaryIconButton",
|
|
2158
4908
|
"category": "Elements/Buttons",
|
|
2159
|
-
"
|
|
4909
|
+
"generation": "1.0",
|
|
4910
|
+
"description": "A Primary Icon Button component with predefined primary variant\nDesign system 1.0",
|
|
2160
4911
|
"props": [],
|
|
2161
4912
|
"examples": [
|
|
2162
4913
|
"<DialPrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2163
4914
|
],
|
|
2164
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4915
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4916
|
+
"supersededBy": "PrimaryIconButton"
|
|
2165
4917
|
},
|
|
2166
4918
|
{
|
|
2167
4919
|
"name": "DialSecondaryIconButton",
|
|
2168
4920
|
"category": "Elements/Buttons",
|
|
4921
|
+
"generation": "1.0",
|
|
2169
4922
|
"description": "A Secondary Icon Button component with predefined secondary variant",
|
|
2170
4923
|
"props": [],
|
|
2171
4924
|
"examples": [
|
|
@@ -2176,6 +4929,7 @@
|
|
|
2176
4929
|
{
|
|
2177
4930
|
"name": "DialSuccessIconButton",
|
|
2178
4931
|
"category": "Elements/Buttons",
|
|
4932
|
+
"generation": "1.0",
|
|
2179
4933
|
"description": "A Success Icon Button component with predefined success variant",
|
|
2180
4934
|
"props": [],
|
|
2181
4935
|
"examples": [
|
|
@@ -2186,6 +4940,7 @@
|
|
|
2186
4940
|
{
|
|
2187
4941
|
"name": "DialTertiaryIconButton",
|
|
2188
4942
|
"category": "Elements/Buttons",
|
|
4943
|
+
"generation": "1.0",
|
|
2189
4944
|
"description": "A Tertiary Icon Button component with predefined tertiary variant",
|
|
2190
4945
|
"props": [],
|
|
2191
4946
|
"examples": [
|
|
@@ -2196,7 +4951,8 @@
|
|
|
2196
4951
|
{
|
|
2197
4952
|
"name": "DialCloseButton",
|
|
2198
4953
|
"category": "Elements/Buttons",
|
|
2199
|
-
"
|
|
4954
|
+
"generation": "1.0",
|
|
4955
|
+
"description": "A Close button component with a customizable icon and accessible label.\naliases: DismissButton|ExitButton\nDesign system 1.0",
|
|
2200
4956
|
"props": [
|
|
2201
4957
|
{
|
|
2202
4958
|
"name": "ariaLabel",
|
|
@@ -2233,12 +4989,14 @@
|
|
|
2233
4989
|
"examples": [
|
|
2234
4990
|
"<DialCloseButton\n ariaLabel=\"Close dialog\"\n onClose={handleClose}\n className=\"custom-close\"\n size={32}\n/>"
|
|
2235
4991
|
],
|
|
2236
|
-
"sourceFile": "components/CloseButton/CloseButton.tsx"
|
|
4992
|
+
"sourceFile": "components/CloseButton/CloseButton.tsx",
|
|
4993
|
+
"supersededBy": "CloseButton"
|
|
2237
4994
|
},
|
|
2238
4995
|
{
|
|
2239
4996
|
"name": "DialRemoveButton",
|
|
2240
4997
|
"category": "Elements/Buttons",
|
|
2241
|
-
"
|
|
4998
|
+
"generation": "1.0",
|
|
4999
|
+
"description": "A specialized button component for removal or delete actions.\naliases: DeleteButton|TrashButton\nDesign system 1.0\n\nRenders a `DialDangerButton` with a predefined trash icon (`IconTrashX`) as the leading icon.\nAdditional props are passed directly to the underlying `DialDangerButton`.",
|
|
2242
5000
|
"props": [
|
|
2243
5001
|
{
|
|
2244
5002
|
"name": "iconClassName",
|
|
@@ -2252,33 +5010,11 @@
|
|
|
2252
5010
|
],
|
|
2253
5011
|
"sourceFile": "components/RemoveButton/RemoveButton.tsx"
|
|
2254
5012
|
},
|
|
2255
|
-
{
|
|
2256
|
-
"name": "DialFabButton",
|
|
2257
|
-
"category": "Elements/Buttons",
|
|
2258
|
-
"description": "A Floating Action Button (FAB) component — circular icon button for primary actions.\naliases: FloatingActionButton|FabButton|CircularButton",
|
|
2259
|
-
"props": [
|
|
2260
|
-
{
|
|
2261
|
-
"name": "icon",
|
|
2262
|
-
"type": "ReactNode",
|
|
2263
|
-
"required": false,
|
|
2264
|
-
"description": "Icon to display inside the button"
|
|
2265
|
-
},
|
|
2266
|
-
{
|
|
2267
|
-
"name": "tooltipProps",
|
|
2268
|
-
"type": "TooltipProps",
|
|
2269
|
-
"required": false,
|
|
2270
|
-
"description": "Optional tooltip configuration"
|
|
2271
|
-
}
|
|
2272
|
-
],
|
|
2273
|
-
"examples": [
|
|
2274
|
-
"<DialFabButton\n icon={<IconArrowNarrowDown size={24} stroke={1.5} />}\n onClick={handleClick}\n aria-label=\"Scroll to bottom\"\n/>"
|
|
2275
|
-
],
|
|
2276
|
-
"sourceFile": "components/FabButton/FabButton.tsx"
|
|
2277
|
-
},
|
|
2278
5013
|
{
|
|
2279
5014
|
"name": "DialTextarea",
|
|
2280
5015
|
"category": "Elements",
|
|
2281
|
-
"
|
|
5016
|
+
"generation": "1.0",
|
|
5017
|
+
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox\nDesign system 1.0",
|
|
2282
5018
|
"props": [
|
|
2283
5019
|
{
|
|
2284
5020
|
"name": "labelProps",
|
|
@@ -2327,12 +5063,14 @@
|
|
|
2327
5063
|
"examples": [
|
|
2328
5064
|
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
2329
5065
|
],
|
|
2330
|
-
"sourceFile": "components/Textarea/Textarea.tsx"
|
|
5066
|
+
"sourceFile": "components/Textarea/Textarea.tsx",
|
|
5067
|
+
"supersededBy": "Textarea"
|
|
2331
5068
|
},
|
|
2332
5069
|
{
|
|
2333
5070
|
"name": "DialTooltip",
|
|
2334
5071
|
"category": "Overlay",
|
|
2335
|
-
"
|
|
5072
|
+
"generation": "1.0",
|
|
5073
|
+
"description": "A Tooltip component that displays information on hover\naliases: HoverPopover|InfoPopover\nDesign system 1.0",
|
|
2336
5074
|
"props": [
|
|
2337
5075
|
{
|
|
2338
5076
|
"name": "hideTooltip",
|
|
@@ -2370,10 +5108,38 @@
|
|
|
2370
5108
|
],
|
|
2371
5109
|
"sourceFile": "components/Tooltip/Tooltip.tsx"
|
|
2372
5110
|
},
|
|
5111
|
+
{
|
|
5112
|
+
"name": "DialTooltipContainer",
|
|
5113
|
+
"category": "Overlay",
|
|
5114
|
+
"generation": "1.0",
|
|
5115
|
+
"description": "The container component that provides tooltip context and state management\nDesign system 1.0",
|
|
5116
|
+
"props": [],
|
|
5117
|
+
"examples": [],
|
|
5118
|
+
"sourceFile": "components/Tooltip/TooltipContainer.tsx"
|
|
5119
|
+
},
|
|
5120
|
+
{
|
|
5121
|
+
"name": "DialTooltipContent",
|
|
5122
|
+
"category": "Overlay",
|
|
5123
|
+
"generation": "1.0",
|
|
5124
|
+
"description": "The content area of a tooltip that displays the tooltip information\nDesign system 1.0",
|
|
5125
|
+
"props": [],
|
|
5126
|
+
"examples": [],
|
|
5127
|
+
"sourceFile": "components/Tooltip/TooltipContent.tsx"
|
|
5128
|
+
},
|
|
5129
|
+
{
|
|
5130
|
+
"name": "DialTooltipTrigger",
|
|
5131
|
+
"category": "Overlay",
|
|
5132
|
+
"generation": "1.0",
|
|
5133
|
+
"description": "The trigger element for a tooltip that can be clicked or hovered\nDesign system 1.0",
|
|
5134
|
+
"props": [],
|
|
5135
|
+
"examples": [],
|
|
5136
|
+
"sourceFile": "components/Tooltip/TooltipTrigger.tsx"
|
|
5137
|
+
},
|
|
2373
5138
|
{
|
|
2374
5139
|
"name": "DialSwitch",
|
|
2375
5140
|
"category": "Form",
|
|
2376
|
-
"
|
|
5141
|
+
"generation": "1.0",
|
|
5142
|
+
"description": "A Switch component with various styling options\naliases: ToggleSwitch|BinaryToggle\nDesign system 1.0",
|
|
2377
5143
|
"props": [
|
|
2378
5144
|
{
|
|
2379
5145
|
"name": "label",
|
|
@@ -2415,12 +5181,14 @@
|
|
|
2415
5181
|
"examples": [
|
|
2416
5182
|
"<DialSwitch\n switchId=\"switch\"\n label=\"Toggle\"\n isOn={true}\n disabled={false}\n onChange={(value) => console.log(value)}\n caption=\"Caption\"\n/>"
|
|
2417
5183
|
],
|
|
2418
|
-
"sourceFile": "components/Switch/Switch.tsx"
|
|
5184
|
+
"sourceFile": "components/Switch/Switch.tsx",
|
|
5185
|
+
"supersededBy": "Switch"
|
|
2419
5186
|
},
|
|
2420
5187
|
{
|
|
2421
5188
|
"name": "DialSegmentedControl",
|
|
2422
5189
|
"category": "Form",
|
|
2423
|
-
"
|
|
5190
|
+
"generation": "1.0",
|
|
5191
|
+
"description": "A single-select control for switching between a small set of mutually exclusive,\nequally-sized options (e.g. view switchers).\naliases: SegmentedButton|ViewSwitcher\nDesign system 1.0\n\nRenders a horizontal group of segments where every option is always visible and\nequally sized. Supports 2 or more segments, optional per-option icons, and\nkeyboard navigation (Arrow keys, Home, End).",
|
|
2424
5192
|
"props": [
|
|
2425
5193
|
{
|
|
2426
5194
|
"name": "options",
|
|
@@ -2467,7 +5235,8 @@
|
|
|
2467
5235
|
{
|
|
2468
5236
|
"name": "DialPopup",
|
|
2469
5237
|
"category": "Overlay",
|
|
2470
|
-
"
|
|
5238
|
+
"generation": "1.0",
|
|
5239
|
+
"description": "An accessible modal dialog component using Floating UI.\naliases: Modal|Dialog\nDesign system 1.0\n\nRenders in a portal with a scrim overlay, focus management, header with a title,\ncontent area, optional footer and a close control.",
|
|
2471
5240
|
"props": [
|
|
2472
5241
|
{
|
|
2473
5242
|
"name": "open",
|
|
@@ -2570,18 +5339,20 @@
|
|
|
2570
5339
|
"type": "boolean",
|
|
2571
5340
|
"required": false,
|
|
2572
5341
|
"defaultValue": "false",
|
|
2573
|
-
"description": "When true, initial focus goes to a non-input guard to avoid opening the virtual keyboard on mobile"
|
|
5342
|
+
"description": "When true, initial focus goes to a non-input guard to avoid opening the virtual keyboard on mobile. Redundant since the default focuses the dialog container, which never raises the keyboard; kept for compatibility"
|
|
2574
5343
|
}
|
|
2575
5344
|
],
|
|
2576
5345
|
"examples": [
|
|
2577
5346
|
"<DialPopup\n open\n title=\"Title\"\n size={PopupSize.Md}\n footer={\n <div className=\"flex justify-end gap-2\">\n <button className=\"btn-secondary px-3 py-1 rounded\">Cancel</button>\n <button className=\"btn-primary px-3 py-1 rounded\">Confirm</button>\n </div>\n }\n onClose={() => console.log('closed')}\n>\n <div className=\"p-6\">Dialog content goes here…</div>\n</DialPopup>"
|
|
2578
5347
|
],
|
|
2579
|
-
"sourceFile": "components/Popup/Popup.tsx"
|
|
5348
|
+
"sourceFile": "components/Popup/Popup.tsx",
|
|
5349
|
+
"supersededBy": "Popup"
|
|
2580
5350
|
},
|
|
2581
5351
|
{
|
|
2582
5352
|
"name": "DialConfirmationPopup",
|
|
2583
5353
|
"category": "Overlay",
|
|
2584
|
-
"
|
|
5354
|
+
"generation": "1.0",
|
|
5355
|
+
"description": "A confirmation dialog built with DialPopup and DialButton.\naliases: ConfirmDialog|WarningDialog\nDesign system 1.0\n\nProvides an accessible modal with a title, optional description or custom content,\nand a footer with Cancel / Confirm actions.",
|
|
2585
5356
|
"props": [
|
|
2586
5357
|
{
|
|
2587
5358
|
"name": "description",
|
|
@@ -2658,12 +5429,14 @@
|
|
|
2658
5429
|
"examples": [
|
|
2659
5430
|
"<ConfirmationModal\n open\n header=\"Delete item?\"\n description=\"This action cannot be undone.\"\n confirmLabel=\"Delete\"\n onClose={() => setOpen(false)}\n onConfirm={handleDelete}\n/>"
|
|
2660
5431
|
],
|
|
2661
|
-
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx"
|
|
5432
|
+
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx",
|
|
5433
|
+
"supersededBy": "ConfirmationPopup"
|
|
2662
5434
|
},
|
|
2663
5435
|
{
|
|
2664
5436
|
"name": "DialRadioGroupPopupField",
|
|
2665
5437
|
"category": "Form",
|
|
2666
|
-
"
|
|
5438
|
+
"generation": "1.0",
|
|
5439
|
+
"description": "A composite field that opens a popup with a radio group selector.\naliases: PopupRadio|ChoicePopup\nDesign system 1.0\n\nRenders a labeled readout using `DialInputPopup`; when opened, a `DialPopup`\ndisplays a `DialRadioGroup` allowing the user to pick from a list of options.\nThe footer provides Cancel/Apply actions, with Apply disabled when `isValid` is false.\n\nThe value shown in the collapsed field is derived from either `customInputValue`\nor the name of the currently selected radio option identified by `selectedValue`.",
|
|
2667
5440
|
"props": [],
|
|
2668
5441
|
"examples": [
|
|
2669
5442
|
"<DialRadioGroupPopupField\n fieldTitle=\"Status\"\n htmlFor=\"status\"\n header=\"Select status\"\n emptyValueText=\"None\"\n radioButtons={[\n { id: 'draft', name: 'Draft' },\n { id: 'review', name: 'In Review' },\n { id: 'published', name: 'Published' },\n ]}\n selectedValue=\"draft\"\n selectedRadioValue=\"draft\"\n onChangeRadioField={(id) => console.log('radio changed', id)}\n id=\"status-group\"\n isValid={true}\n onApply={() => console.log('applied')}\n/>"
|
|
@@ -2673,7 +5446,8 @@
|
|
|
2673
5446
|
{
|
|
2674
5447
|
"name": "DialFormPopup",
|
|
2675
5448
|
"category": "Overlay",
|
|
2676
|
-
"
|
|
5449
|
+
"generation": "1.0",
|
|
5450
|
+
"description": "A form-oriented popup dialog.\naliases: FormDialog|FormModal\nDesign system 1.0\n\nProvides an accessible popup with a title, custom body,\nand a footer with \"Cancel\" and \"Submit\" actions.",
|
|
2677
5451
|
"props": [
|
|
2678
5452
|
{
|
|
2679
5453
|
"name": "submitLabel",
|
|
@@ -2736,7 +5510,8 @@
|
|
|
2736
5510
|
{
|
|
2737
5511
|
"name": "DialInput",
|
|
2738
5512
|
"category": "Elements/Inputs",
|
|
2739
|
-
"
|
|
5513
|
+
"generation": "1.0",
|
|
5514
|
+
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput\nDesign system 1.0",
|
|
2740
5515
|
"props": [
|
|
2741
5516
|
{
|
|
2742
5517
|
"name": "labelProps",
|
|
@@ -2821,12 +5596,14 @@
|
|
|
2821
5596
|
"examples": [
|
|
2822
5597
|
"<DialInput\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
2823
5598
|
],
|
|
2824
|
-
"sourceFile": "components/Input/Input.tsx"
|
|
5599
|
+
"sourceFile": "components/Input/Input.tsx",
|
|
5600
|
+
"supersededBy": "Input"
|
|
2825
5601
|
},
|
|
2826
5602
|
{
|
|
2827
5603
|
"name": "DialNumberInput",
|
|
2828
5604
|
"category": "Elements/Inputs",
|
|
2829
|
-
"
|
|
5605
|
+
"generation": "1.0",
|
|
5606
|
+
"description": "A number input field component\naliases: NumericField|NumberField\nDesign system 1.0",
|
|
2830
5607
|
"props": [
|
|
2831
5608
|
{
|
|
2832
5609
|
"name": "integer",
|
|
@@ -2844,22 +5621,26 @@
|
|
|
2844
5621
|
"examples": [
|
|
2845
5622
|
"<DialNumberInput\n id=\"age\"\n placeholder=\"Enter your age\"\n value={25}\n onChange={(value) => setAge(value)}\n/>"
|
|
2846
5623
|
],
|
|
2847
|
-
"sourceFile": "components/NumberInput/NumberInput.tsx"
|
|
5624
|
+
"sourceFile": "components/NumberInput/NumberInput.tsx",
|
|
5625
|
+
"supersededBy": "NumberInput"
|
|
2848
5626
|
},
|
|
2849
5627
|
{
|
|
2850
5628
|
"name": "DialPasswordInput",
|
|
2851
5629
|
"category": "Elements/Inputs",
|
|
2852
|
-
"
|
|
5630
|
+
"generation": "1.0",
|
|
5631
|
+
"description": "A password input component with show/hide functionality and customizable props.\naliases: SecureInput|ToggleablePassword\nDesign system 1.0",
|
|
2853
5632
|
"props": [],
|
|
2854
5633
|
"examples": [
|
|
2855
5634
|
"<DialPasswordInput\n id=\"password\"\n label=\"Password\"\n value={password}\n onChange={e => setPassword(e.target.value)}\n disabled={false}\n/>"
|
|
2856
5635
|
],
|
|
2857
|
-
"sourceFile": "components/PasswordInput/PasswordInput.tsx"
|
|
5636
|
+
"sourceFile": "components/PasswordInput/PasswordInput.tsx",
|
|
5637
|
+
"supersededBy": "PasswordInput"
|
|
2858
5638
|
},
|
|
2859
5639
|
{
|
|
2860
5640
|
"name": "DialSearch",
|
|
2861
5641
|
"category": "Elements",
|
|
2862
|
-
"
|
|
5642
|
+
"generation": "1.0",
|
|
5643
|
+
"description": "A search input component with a customizable placeholder, icons, flexible props, and the ability\naliases: SearchField|QueryInput\nDesign system 1.0\n\nto clear the input value via a clear button. Supports multiple sizes for flexible layouts.",
|
|
2863
5644
|
"props": [
|
|
2864
5645
|
{
|
|
2865
5646
|
"name": "withoutBorder",
|
|
@@ -2883,12 +5664,14 @@
|
|
|
2883
5664
|
"examples": [
|
|
2884
5665
|
"<DialSearch\n id=\"search\"\n value={query}\n placeholder=\"Search\"\n size={ElementSize.Small}\n onChange={(value) => setQuery(value)}\n onBlur={() => handleBlur()}\n disabled={false}\n/>"
|
|
2885
5666
|
],
|
|
2886
|
-
"sourceFile": "components/Search/Search.tsx"
|
|
5667
|
+
"sourceFile": "components/Search/Search.tsx",
|
|
5668
|
+
"supersededBy": "Search"
|
|
2887
5669
|
},
|
|
2888
5670
|
{
|
|
2889
5671
|
"name": "DialInputPopup",
|
|
2890
5672
|
"category": "Overlay",
|
|
2891
|
-
"
|
|
5673
|
+
"generation": "1.0",
|
|
5674
|
+
"description": "An input field that opens a popup when clicked, displaying a selected value or a list of values.\naliases: PopupInput|ReadonlyInput\nDesign system 1.0\n\nIt supports read-only mode, error states, and disabled state, with customizable styling.\nThe modal content is rendered using a portal for seamless integration.",
|
|
2892
5675
|
"props": [
|
|
2893
5676
|
{
|
|
2894
5677
|
"name": "open",
|
|
@@ -2997,7 +5780,8 @@
|
|
|
2997
5780
|
{
|
|
2998
5781
|
"name": "DialAutocompleteInputValue",
|
|
2999
5782
|
"category": "Form",
|
|
3000
|
-
"
|
|
5783
|
+
"generation": "1.0",
|
|
5784
|
+
"description": "A component that displays a list of selected items in a customizable, styled list. Each item is\naliases: SelectedList|ItemDisplay\nDesign system 1.0\n\nrendered as a tag wrapped in a tooltip, allowing for truncation and additional context when\nhovered. The component is flexible and supports custom CSS classes for styling the list and\nindividual list items.",
|
|
3001
5785
|
"props": [
|
|
3002
5786
|
{
|
|
3003
5787
|
"name": "placeholder",
|
|
@@ -3039,7 +5823,8 @@
|
|
|
3039
5823
|
{
|
|
3040
5824
|
"name": "DialTagInput",
|
|
3041
5825
|
"category": "Form",
|
|
3042
|
-
"
|
|
5826
|
+
"generation": "1.0",
|
|
5827
|
+
"description": "A tag input field that allows users to add multiple tags using the Enter or comma key.\naliases: MultiTag|TagField\nDesign system 1.0\n\nSupports removing tags, displaying field labels, optional indicators, validation states,\nand dynamic layout adjustment when tags wrap to multiple lines.",
|
|
3043
5828
|
"props": [
|
|
3044
5829
|
{
|
|
3045
5830
|
"name": "elementId",
|
|
@@ -3120,12 +5905,14 @@
|
|
|
3120
5905
|
"examples": [
|
|
3121
5906
|
"<DialTagInput\n elementId=\"skills\"\n fieldTitle=\"Skills\"\n placeholder=\"Add a skill\"\n initialTags={['React', 'TypeScript']}\n optional\n onChange={(tags) => console.log('Updated tags:', tags)}\n/>"
|
|
3122
5907
|
],
|
|
3123
|
-
"sourceFile": "components/TagInput/TagInput.tsx"
|
|
5908
|
+
"sourceFile": "components/TagInput/TagInput.tsx",
|
|
5909
|
+
"supersededBy": "TagInput"
|
|
3124
5910
|
},
|
|
3125
5911
|
{
|
|
3126
5912
|
"name": "DialSelect",
|
|
3127
5913
|
"category": "Form",
|
|
3128
|
-
"
|
|
5914
|
+
"generation": "1.0",
|
|
5915
|
+
"description": "A versatile select supporting single and multiple selections.\naliases: OptionPicker|ChoiceSelector\nDesign system 1.0\n\nSingle mode mirrors the legacy visual:\n- Trigger shows the selected option's leading icon + label.\n- In the list, the selected option is indicated by a LEFT border and tinted background\n (no check icon).\n\nMultiple mode uses checkboxes (including Select All with indeterminate state).\n\nSearch:\n- `searchable`: shows a plain input in the overlay header that filters options.\n- `inlineSearch` (single mode only): the trigger renders a plain input; typing filters options;\n when closed, the input shows the selected label.",
|
|
3129
5916
|
"props": [
|
|
3130
5917
|
{
|
|
3131
5918
|
"name": "options",
|
|
@@ -3346,12 +6133,14 @@
|
|
|
3346
6133
|
"examples": [
|
|
3347
6134
|
"<DialSelect options={[{ value: 'option-1', label: 'Option 1' }]} />\n<DialSelect searchable options={[{ value: 'a', label: 'Alpha' }, { value: 'b', label: 'Beta' }]} />\n<DialSelect multiple selectAll options={[{ value: '1', label: 'One' }, { value: '2', label: 'Two' }]} />\n<DialSelect inlineSearch options={[{ value: 'r', label: 'Relax-Name' }, { value: 'rep2', label: 'rep2' }]} />"
|
|
3348
6135
|
],
|
|
3349
|
-
"sourceFile": "components/Select/Select.tsx"
|
|
6136
|
+
"sourceFile": "components/Select/Select.tsx",
|
|
6137
|
+
"supersededBy": "Select"
|
|
3350
6138
|
},
|
|
3351
6139
|
{
|
|
3352
6140
|
"name": "DialSelectField",
|
|
3353
6141
|
"category": "Form",
|
|
3354
|
-
"
|
|
6142
|
+
"generation": "1.0",
|
|
6143
|
+
"description": "A Select field wrapper that composes `DialFormItem` and `DialSelect`.\naliases: SelectInput|ComboField\nDesign system 1.0\n\nProvides unified label, description, error rendering and a readonly view that shows\nthe selected option labels (comma-separated in single mode, list in multiple).",
|
|
3355
6144
|
"props": [
|
|
3356
6145
|
{
|
|
3357
6146
|
"name": "selectClassName",
|
|
@@ -3374,7 +6163,8 @@
|
|
|
3374
6163
|
{
|
|
3375
6164
|
"name": "DialLoadFileArea",
|
|
3376
6165
|
"category": "Form",
|
|
3377
|
-
"
|
|
6166
|
+
"generation": "1.0",
|
|
6167
|
+
"description": "A drag-and-drop file upload area component that allows users to upload files\naliases: FileDropZone|DragDropUpload\nDesign system 1.0\n\neither by dragging them into the area or by selecting them through the file picker.\nDisplays helpful text, button prompts, and validation errors for file format or count limits.",
|
|
3378
6168
|
"props": [
|
|
3379
6169
|
{
|
|
3380
6170
|
"name": "files",
|
|
@@ -3415,7 +6205,8 @@
|
|
|
3415
6205
|
{
|
|
3416
6206
|
"name": "DialLoadFileAreaField",
|
|
3417
6207
|
"category": "Form",
|
|
3418
|
-
"
|
|
6208
|
+
"generation": "1.0",
|
|
6209
|
+
"description": "A composite file upload field that combines a label, file list management,\naliases: UploadField|FileListField\nDesign system 1.0\n\nand a drag-and-drop upload area. Allows users to add, remove, and validate files\nwith customizable restrictions on file types and count.\n\nThe component displays a header showing the field title and file count,\nalong with \"Add\" and \"Delete All\" buttons (when multiple uploads are enabled).\nIt integrates with `DialLoadFileArea` for drag-and-drop functionality and\nprovides file validation for both format and maximum file count.",
|
|
3419
6210
|
"props": [
|
|
3420
6211
|
{
|
|
3421
6212
|
"name": "fieldTitle",
|
|
@@ -3451,6 +6242,7 @@
|
|
|
3451
6242
|
{
|
|
3452
6243
|
"name": "DialDropdown",
|
|
3453
6244
|
"category": "Dropdown",
|
|
6245
|
+
"generation": "1.0",
|
|
3454
6246
|
"description": "",
|
|
3455
6247
|
"props": [
|
|
3456
6248
|
{
|
|
@@ -3582,12 +6374,14 @@
|
|
|
3582
6374
|
}
|
|
3583
6375
|
],
|
|
3584
6376
|
"examples": [],
|
|
3585
|
-
"sourceFile": "components/Dropdown/Dropdown.tsx"
|
|
6377
|
+
"sourceFile": "components/Dropdown/Dropdown.tsx",
|
|
6378
|
+
"supersededBy": "Dropdown"
|
|
3586
6379
|
},
|
|
3587
6380
|
{
|
|
3588
6381
|
"name": "DialButtonDropdown",
|
|
3589
6382
|
"category": "Dropdown",
|
|
3590
|
-
"
|
|
6383
|
+
"generation": "1.0",
|
|
6384
|
+
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton\nDesign system 1.0",
|
|
3591
6385
|
"props": [
|
|
3592
6386
|
{
|
|
3593
6387
|
"name": "items",
|
|
@@ -3599,12 +6393,14 @@
|
|
|
3599
6393
|
"examples": [
|
|
3600
6394
|
"<DialButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
3601
6395
|
],
|
|
3602
|
-
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx"
|
|
6396
|
+
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx",
|
|
6397
|
+
"supersededBy": "ButtonDropdown"
|
|
3603
6398
|
},
|
|
3604
6399
|
{
|
|
3605
6400
|
"name": "DialDropdownIcon",
|
|
3606
6401
|
"category": "Dropdown",
|
|
3607
|
-
"
|
|
6402
|
+
"generation": "1.0",
|
|
6403
|
+
"description": "A compact icon trigger with a dropdown menu.\naliases: ModelPicker|IconMenu|AvatarDropdown\nDesign system 1.0",
|
|
3608
6404
|
"props": [
|
|
3609
6405
|
{
|
|
3610
6406
|
"name": "icon",
|
|
@@ -3666,7 +6462,8 @@
|
|
|
3666
6462
|
{
|
|
3667
6463
|
"name": "DialFileManager",
|
|
3668
6464
|
"category": "FileManager",
|
|
3669
|
-
"
|
|
6465
|
+
"generation": "1.0",
|
|
6466
|
+
"description": "File Manager layout with a collapsible folders tree, breadcrumb/search header, and a data grid.\naliases: FileExplorer|FileBrowser\nDesign system 1.0",
|
|
3670
6467
|
"props": [
|
|
3671
6468
|
{
|
|
3672
6469
|
"name": "path",
|
|
@@ -4148,7 +6945,8 @@
|
|
|
4148
6945
|
{
|
|
4149
6946
|
"name": "DialDestinationFolderPopup",
|
|
4150
6947
|
"category": "FileManager/components",
|
|
4151
|
-
"
|
|
6948
|
+
"generation": "1.0",
|
|
6949
|
+
"description": "DestinationFolderPopup\naliases: FolderSelector|PathChooser\nDesign system 1.0",
|
|
4152
6950
|
"props": [],
|
|
4153
6951
|
"examples": [
|
|
4154
6952
|
"<DestinationFolderPopup\n open={isOpen}\n onClose={handleClose}\n onConfirm={handleConfirm}\n mode=\"copy\"\n title=\"Copy 3 files\"\n items={files}\n rootItem={rootFolder}\n path={currentPath}\n onPathChange={setCurrentPath}\n/>"
|
|
@@ -4158,7 +6956,8 @@
|
|
|
4158
6956
|
{
|
|
4159
6957
|
"name": "DialFoldersTree",
|
|
4160
6958
|
"category": "Data Display",
|
|
4161
|
-
"
|
|
6959
|
+
"generation": "1.0",
|
|
6960
|
+
"description": "DialFoldersTree — A hierarchical folder tree component with nested expand/collapse support, selection highlighting,\nDesign system 1.0\nand optional file display.",
|
|
4162
6961
|
"props": [
|
|
4163
6962
|
{
|
|
4164
6963
|
"name": "items",
|
|
@@ -4330,7 +7129,8 @@
|
|
|
4330
7129
|
{
|
|
4331
7130
|
"name": "DialSchemaRenderer",
|
|
4332
7131
|
"category": "Name",
|
|
4333
|
-
"
|
|
7132
|
+
"generation": "1.0",
|
|
7133
|
+
"description": "Renders a JSON Schema as a form UI with collapsible sections, validation, and default values.\naliases: SchemaRenderer|JsonSchemaForm\nDesign system 1.0",
|
|
4334
7134
|
"props": [],
|
|
4335
7135
|
"examples": [
|
|
4336
7136
|
"<DialSchemaRenderer\n schema={mySchema}\n onChange={(v) => console.log(v)}\n onDefaultValues={(defaults) => console.log(defaults)}\n/>"
|
|
@@ -4340,7 +7140,8 @@
|
|
|
4340
7140
|
{
|
|
4341
7141
|
"name": "DialJsonEditor",
|
|
4342
7142
|
"category": "Data Display",
|
|
4343
|
-
"
|
|
7143
|
+
"generation": "1.0",
|
|
7144
|
+
"description": "A JSON editor component built on top of Monaco Editor.\nDesign system 1.0\nProvides syntax highlighting, validation, and theme support for JSON editing.\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyDialJsonEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
4344
7145
|
"props": [
|
|
4345
7146
|
{
|
|
4346
7147
|
"name": "value",
|
|
@@ -4392,6 +7193,7 @@
|
|
|
4392
7193
|
{
|
|
4393
7194
|
"name": "DialMarkdownEditor",
|
|
4394
7195
|
"category": "Data Display",
|
|
7196
|
+
"generation": "1.0",
|
|
4395
7197
|
"description": "A Markdown editor component built on top of\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyDialMarkdownEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
4396
7198
|
"props": [
|
|
4397
7199
|
{
|
|
@@ -4449,10 +7251,26 @@
|
|
|
4449
7251
|
"packageImport": "@epam/ai-dial-ui-kit",
|
|
4450
7252
|
"ssr": false,
|
|
4451
7253
|
"nextDynamicExample": "import dynamic from 'next/dynamic';\nimport { LazyDialMarkdownEditor } from '@epam/ai-dial-ui-kit';\n\nconst DialMarkdownEditor = dynamic(\n async () => (await LazyDialMarkdownEditor()).DialMarkdownEditor,\n { ssr: false },\n);"
|
|
4452
|
-
}
|
|
7254
|
+
},
|
|
7255
|
+
"supersededBy": "MarkdownEditor"
|
|
4453
7256
|
}
|
|
4454
7257
|
],
|
|
4455
7258
|
"types": [
|
|
7259
|
+
{
|
|
7260
|
+
"name": "AnalyticsCardVariant",
|
|
7261
|
+
"kind": "enum",
|
|
7262
|
+
"members": [
|
|
7263
|
+
{
|
|
7264
|
+
"name": "Default",
|
|
7265
|
+
"value": "'default'"
|
|
7266
|
+
},
|
|
7267
|
+
{
|
|
7268
|
+
"name": "Compact",
|
|
7269
|
+
"value": "'compact'"
|
|
7270
|
+
}
|
|
7271
|
+
],
|
|
7272
|
+
"sourceFile": "types/analytics.ts"
|
|
7273
|
+
},
|
|
4456
7274
|
{
|
|
4457
7275
|
"name": "AnalyticsBarColorStop",
|
|
4458
7276
|
"kind": "interface",
|
|
@@ -4487,6 +7305,33 @@
|
|
|
4487
7305
|
],
|
|
4488
7306
|
"sourceFile": "models/analytics.ts"
|
|
4489
7307
|
},
|
|
7308
|
+
{
|
|
7309
|
+
"name": "DialTooltipContainerOptions",
|
|
7310
|
+
"kind": "interface",
|
|
7311
|
+
"members": [
|
|
7312
|
+
{
|
|
7313
|
+
"name": "initialOpen?",
|
|
7314
|
+
"value": "boolean"
|
|
7315
|
+
},
|
|
7316
|
+
{
|
|
7317
|
+
"name": "placement?",
|
|
7318
|
+
"value": "Placement"
|
|
7319
|
+
},
|
|
7320
|
+
{
|
|
7321
|
+
"name": "isTriggerClickable?",
|
|
7322
|
+
"value": "boolean"
|
|
7323
|
+
},
|
|
7324
|
+
{
|
|
7325
|
+
"name": "open?",
|
|
7326
|
+
"value": "boolean"
|
|
7327
|
+
},
|
|
7328
|
+
{
|
|
7329
|
+
"name": "onOpenChange?",
|
|
7330
|
+
"value": "(open: boolean) => void"
|
|
7331
|
+
}
|
|
7332
|
+
],
|
|
7333
|
+
"sourceFile": "components/Tooltip/TooltipContext.tsx"
|
|
7334
|
+
},
|
|
4490
7335
|
{
|
|
4491
7336
|
"name": "FileManagerGridRow",
|
|
4492
7337
|
"kind": "interface",
|
|
@@ -4613,6 +7458,21 @@
|
|
|
4613
7458
|
"sourceFile": "components/FileManager/FileManager.tsx",
|
|
4614
7459
|
"typeBody": "Omit<\n DialFileManagerBulkActionsToolbarProps,\n 'onClearSelection' | 'actions' | 'selectedCount'\n> & {\n actionLabels?: {\n [DialFileManagerActions.Duplicate]?: string;\n [DialFileManagerActions.Copy]?: string;\n [DialFileManagerActions.Download]?: string;\n [DialFileManagerActions.Delete]?: string;\n [DialFileManagerActions.Move]?: string;\n [DialFileManagerActions.Unshare]?: string;\n [DialFileManagerActions.RemoveAccess]?: string;\n };\n}"
|
|
4615
7460
|
},
|
|
7461
|
+
{
|
|
7462
|
+
"name": "EditorThemes",
|
|
7463
|
+
"kind": "enum",
|
|
7464
|
+
"members": [
|
|
7465
|
+
{
|
|
7466
|
+
"name": "dark",
|
|
7467
|
+
"value": "'dark'"
|
|
7468
|
+
},
|
|
7469
|
+
{
|
|
7470
|
+
"name": "light",
|
|
7471
|
+
"value": "'light'"
|
|
7472
|
+
}
|
|
7473
|
+
],
|
|
7474
|
+
"sourceFile": "types/editor.ts"
|
|
7475
|
+
},
|
|
4616
7476
|
{
|
|
4617
7477
|
"name": "ButtonVariant",
|
|
4618
7478
|
"kind": "enum",
|
|
@@ -4629,6 +7489,10 @@
|
|
|
4629
7489
|
"name": "Danger",
|
|
4630
7490
|
"value": "'danger'"
|
|
4631
7491
|
},
|
|
7492
|
+
{
|
|
7493
|
+
"name": "Static",
|
|
7494
|
+
"value": "'static'"
|
|
7495
|
+
},
|
|
4632
7496
|
{
|
|
4633
7497
|
"name": "Success",
|
|
4634
7498
|
"value": "'success'"
|
|
@@ -4788,6 +7652,21 @@
|
|
|
4788
7652
|
],
|
|
4789
7653
|
"sourceFile": "types/size.ts"
|
|
4790
7654
|
},
|
|
7655
|
+
{
|
|
7656
|
+
"name": "ScreenResolution",
|
|
7657
|
+
"kind": "enum",
|
|
7658
|
+
"members": [
|
|
7659
|
+
{
|
|
7660
|
+
"name": "Mobile",
|
|
7661
|
+
"value": "'mobile'"
|
|
7662
|
+
},
|
|
7663
|
+
{
|
|
7664
|
+
"name": "Tablet",
|
|
7665
|
+
"value": "'tablet'"
|
|
7666
|
+
}
|
|
7667
|
+
],
|
|
7668
|
+
"sourceFile": "types/tab.ts"
|
|
7669
|
+
},
|
|
4791
7670
|
{
|
|
4792
7671
|
"name": "TabOrientation",
|
|
4793
7672
|
"kind": "enum",
|
|
@@ -5066,7 +7945,7 @@
|
|
|
5066
7945
|
"sourceFile": "types/resizable-container.ts"
|
|
5067
7946
|
},
|
|
5068
7947
|
{
|
|
5069
|
-
"name": "
|
|
7948
|
+
"name": "SkeletonVariant",
|
|
5070
7949
|
"kind": "enum",
|
|
5071
7950
|
"members": [
|
|
5072
7951
|
{
|
|
@@ -5089,7 +7968,7 @@
|
|
|
5089
7968
|
"sourceFile": "types/skeleton.ts"
|
|
5090
7969
|
},
|
|
5091
7970
|
{
|
|
5092
|
-
"name": "
|
|
7971
|
+
"name": "SkeletonAvatarSize",
|
|
5093
7972
|
"kind": "enum",
|
|
5094
7973
|
"members": [
|
|
5095
7974
|
{
|
|
@@ -5108,7 +7987,7 @@
|
|
|
5108
7987
|
"sourceFile": "types/skeleton.ts"
|
|
5109
7988
|
},
|
|
5110
7989
|
{
|
|
5111
|
-
"name": "
|
|
7990
|
+
"name": "SkeletonAvatarShape",
|
|
5112
7991
|
"kind": "enum",
|
|
5113
7992
|
"members": [
|
|
5114
7993
|
{
|
|
@@ -5303,6 +8182,26 @@
|
|
|
5303
8182
|
{
|
|
5304
8183
|
"name": "children?",
|
|
5305
8184
|
"value": "DropdownItem[]"
|
|
8185
|
+
},
|
|
8186
|
+
{
|
|
8187
|
+
"name": "menuHeader?",
|
|
8188
|
+
"value": "ReactNode | (() => ReactNode)"
|
|
8189
|
+
},
|
|
8190
|
+
{
|
|
8191
|
+
"name": "menuFooter?",
|
|
8192
|
+
"value": "ReactNode | (() => ReactNode)"
|
|
8193
|
+
},
|
|
8194
|
+
{
|
|
8195
|
+
"name": "renderSubMenu?",
|
|
8196
|
+
"value": "() => ReactNode"
|
|
8197
|
+
},
|
|
8198
|
+
{
|
|
8199
|
+
"name": "renderItem?",
|
|
8200
|
+
"value": "(item: DropdownItem) => ReactNode"
|
|
8201
|
+
},
|
|
8202
|
+
{
|
|
8203
|
+
"name": "subMenuHoverOptions?",
|
|
8204
|
+
"value": "DropdownSubMenuHoverOptions"
|
|
5306
8205
|
}
|
|
5307
8206
|
],
|
|
5308
8207
|
"sourceFile": "models/dropdown.ts"
|
|
@@ -5554,6 +8453,90 @@
|
|
|
5554
8453
|
],
|
|
5555
8454
|
"sourceFile": "models/selection-mode.ts"
|
|
5556
8455
|
},
|
|
8456
|
+
{
|
|
8457
|
+
"name": "SchemaRendererVariant",
|
|
8458
|
+
"kind": "enum",
|
|
8459
|
+
"members": [
|
|
8460
|
+
{
|
|
8461
|
+
"name": "Sections",
|
|
8462
|
+
"value": "'sections'"
|
|
8463
|
+
},
|
|
8464
|
+
{
|
|
8465
|
+
"name": "Flat",
|
|
8466
|
+
"value": "'flat'"
|
|
8467
|
+
},
|
|
8468
|
+
{
|
|
8469
|
+
"name": "FlatSections",
|
|
8470
|
+
"value": "'flat-sections'"
|
|
8471
|
+
}
|
|
8472
|
+
],
|
|
8473
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
8474
|
+
},
|
|
8475
|
+
{
|
|
8476
|
+
"name": "SchemaDisplayMode",
|
|
8477
|
+
"kind": "enum",
|
|
8478
|
+
"members": [
|
|
8479
|
+
{
|
|
8480
|
+
"name": "Select",
|
|
8481
|
+
"value": "'select'"
|
|
8482
|
+
},
|
|
8483
|
+
{
|
|
8484
|
+
"name": "Radio",
|
|
8485
|
+
"value": "'radio'"
|
|
8486
|
+
}
|
|
8487
|
+
],
|
|
8488
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
8489
|
+
},
|
|
8490
|
+
{
|
|
8491
|
+
"name": "SchemaOrientation",
|
|
8492
|
+
"kind": "enum",
|
|
8493
|
+
"members": [
|
|
8494
|
+
{
|
|
8495
|
+
"name": "Row",
|
|
8496
|
+
"value": "'row'"
|
|
8497
|
+
},
|
|
8498
|
+
{
|
|
8499
|
+
"name": "Column",
|
|
8500
|
+
"value": "'column'"
|
|
8501
|
+
}
|
|
8502
|
+
],
|
|
8503
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
8504
|
+
},
|
|
8505
|
+
{
|
|
8506
|
+
"name": "JsonSchemaType",
|
|
8507
|
+
"kind": "enum",
|
|
8508
|
+
"members": [
|
|
8509
|
+
{
|
|
8510
|
+
"name": "String",
|
|
8511
|
+
"value": "'string'"
|
|
8512
|
+
},
|
|
8513
|
+
{
|
|
8514
|
+
"name": "Number",
|
|
8515
|
+
"value": "'number'"
|
|
8516
|
+
},
|
|
8517
|
+
{
|
|
8518
|
+
"name": "Integer",
|
|
8519
|
+
"value": "'integer'"
|
|
8520
|
+
},
|
|
8521
|
+
{
|
|
8522
|
+
"name": "Boolean",
|
|
8523
|
+
"value": "'boolean'"
|
|
8524
|
+
},
|
|
8525
|
+
{
|
|
8526
|
+
"name": "Object",
|
|
8527
|
+
"value": "'object'"
|
|
8528
|
+
},
|
|
8529
|
+
{
|
|
8530
|
+
"name": "Array",
|
|
8531
|
+
"value": "'array'"
|
|
8532
|
+
},
|
|
8533
|
+
{
|
|
8534
|
+
"name": "Null",
|
|
8535
|
+
"value": "'null'"
|
|
8536
|
+
}
|
|
8537
|
+
],
|
|
8538
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
8539
|
+
},
|
|
5557
8540
|
{
|
|
5558
8541
|
"name": "JsonSchema",
|
|
5559
8542
|
"kind": "interface",
|
|
@@ -5641,13 +8624,17 @@
|
|
|
5641
8624
|
"name": "anyOf?",
|
|
5642
8625
|
"value": "JsonSchemaDef[]"
|
|
5643
8626
|
},
|
|
8627
|
+
{
|
|
8628
|
+
"name": "allOf?",
|
|
8629
|
+
"value": "JsonSchemaDef[]"
|
|
8630
|
+
},
|
|
5644
8631
|
{
|
|
5645
8632
|
"name": "discriminator?",
|
|
5646
8633
|
"value": "{\n propertyName: string;\n mapping: Record<string, string>;\n }"
|
|
5647
8634
|
},
|
|
5648
8635
|
{
|
|
5649
8636
|
"name": "'dial:meta'?",
|
|
5650
|
-
"value": "
|
|
8637
|
+
"value": "DialMeta"
|
|
5651
8638
|
},
|
|
5652
8639
|
{
|
|
5653
8640
|
"name": "'dial:resource'?",
|
|
@@ -5674,122 +8661,164 @@
|
|
|
5674
8661
|
}
|
|
5675
8662
|
],
|
|
5676
8663
|
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
5677
|
-
}
|
|
5678
|
-
],
|
|
5679
|
-
"hooks": [
|
|
5680
|
-
{
|
|
5681
|
-
"name": "AnalyticsCardVariant",
|
|
5682
|
-
"sourceFile": "types/analytics.ts",
|
|
5683
|
-
"signature": "enum AnalyticsCardVariant { Default = 'default', Compact = 'compact' }"
|
|
5684
|
-
},
|
|
5685
|
-
{
|
|
5686
|
-
"name": "useDialFileManagerTabs",
|
|
5687
|
-
"sourceFile": "components/FileManager/hooks/use-file-manager-tabs.tsx",
|
|
5688
|
-
"signature": "(tabLabels?: Record<DialFileManagerTabs, string>, initialTab: DialFileManagerTabs = DialFileManagerTabs.MyFiles) => unknown"
|
|
5689
|
-
},
|
|
5690
|
-
{
|
|
5691
|
-
"name": "useEditableItem",
|
|
5692
|
-
"sourceFile": "hooks/use-editable-item.tsx",
|
|
5693
|
-
"description": "A React hook that manages the behavior of an inline-editable text input.\nIt provides validation handling, cancel/restore logic, auto-focus behavior,\nkeyboard shortcuts, and outside-click detection.",
|
|
5694
|
-
"signature": "function useEditableItem({\n value: initialValue,\n isEditing,\n isCreating,\n isLoading = false,\n restoreOnCancel = true,\n onValidate,\n onSave,\n onCancel,\n onCreateFolderSave,\n onCreateFolderCancel,\n}: UseEditableItemOptions): UseEditableItemResult"
|
|
5695
|
-
},
|
|
5696
|
-
{
|
|
5697
|
-
"name": "FileManagerProvider",
|
|
5698
|
-
"sourceFile": "components/FileManager/FileManagerProvider.tsx",
|
|
5699
|
-
"description": "Provider that encapsulates all File Manager business logic:\n- path & navigation\n- search (controlled + uncontrolled)\n- hidden files toggle\n- tree collapsed state\n- selection\n- clipboard (copy / cut / paste)\n- delete confirmation state\n- computed grid rows\n- new actions",
|
|
5700
|
-
"signature": "FileManagerProvider: FC<FileManagerProviderProps>"
|
|
5701
|
-
},
|
|
5702
|
-
{
|
|
5703
|
-
"name": "useFileManagerContext",
|
|
5704
|
-
"sourceFile": "components/FileManager/hooks/use-file-manager-context.ts",
|
|
5705
|
-
"description": "Hook to read the File Manager context.\nThrows if used outside of the provider.",
|
|
5706
|
-
"signature": "() => unknown"
|
|
5707
8664
|
},
|
|
5708
8665
|
{
|
|
5709
|
-
"name": "
|
|
5710
|
-
"
|
|
5711
|
-
"
|
|
8666
|
+
"name": "NotificationVariant",
|
|
8667
|
+
"kind": "enum",
|
|
8668
|
+
"members": [
|
|
8669
|
+
{
|
|
8670
|
+
"name": "Info",
|
|
8671
|
+
"value": "'info'"
|
|
8672
|
+
},
|
|
8673
|
+
{
|
|
8674
|
+
"name": "Success",
|
|
8675
|
+
"value": "'success'"
|
|
8676
|
+
},
|
|
8677
|
+
{
|
|
8678
|
+
"name": "Warning",
|
|
8679
|
+
"value": "'warning'"
|
|
8680
|
+
},
|
|
8681
|
+
{
|
|
8682
|
+
"name": "Error",
|
|
8683
|
+
"value": "'error'"
|
|
8684
|
+
},
|
|
8685
|
+
{
|
|
8686
|
+
"name": "Loading",
|
|
8687
|
+
"value": "'loading'"
|
|
8688
|
+
}
|
|
8689
|
+
],
|
|
8690
|
+
"sourceFile": "types/notification.ts"
|
|
5712
8691
|
},
|
|
5713
8692
|
{
|
|
5714
|
-
"name": "
|
|
5715
|
-
"
|
|
5716
|
-
"
|
|
8693
|
+
"name": "NotificationType",
|
|
8694
|
+
"kind": "enum",
|
|
8695
|
+
"members": [
|
|
8696
|
+
{
|
|
8697
|
+
"name": "Toast",
|
|
8698
|
+
"value": "'toast'"
|
|
8699
|
+
},
|
|
8700
|
+
{
|
|
8701
|
+
"name": "SectionMessage",
|
|
8702
|
+
"value": "'section-message'"
|
|
8703
|
+
}
|
|
8704
|
+
],
|
|
8705
|
+
"sourceFile": "types/notification.ts"
|
|
5717
8706
|
},
|
|
5718
8707
|
{
|
|
5719
|
-
"name": "
|
|
5720
|
-
"
|
|
5721
|
-
"
|
|
8708
|
+
"name": "CalendarMode",
|
|
8709
|
+
"kind": "enum",
|
|
8710
|
+
"members": [
|
|
8711
|
+
{
|
|
8712
|
+
"name": "Date",
|
|
8713
|
+
"value": "'date'"
|
|
8714
|
+
},
|
|
8715
|
+
{
|
|
8716
|
+
"name": "DateTime",
|
|
8717
|
+
"value": "'datetime'"
|
|
8718
|
+
},
|
|
8719
|
+
{
|
|
8720
|
+
"name": "Time",
|
|
8721
|
+
"value": "'time'"
|
|
8722
|
+
},
|
|
8723
|
+
{
|
|
8724
|
+
"name": "Weekday",
|
|
8725
|
+
"value": "'weekday'"
|
|
8726
|
+
}
|
|
8727
|
+
],
|
|
8728
|
+
"sourceFile": "types/calendar.ts"
|
|
5722
8729
|
},
|
|
5723
8730
|
{
|
|
5724
|
-
"name": "
|
|
5725
|
-
"
|
|
5726
|
-
"
|
|
8731
|
+
"name": "CalendarValue",
|
|
8732
|
+
"kind": "type",
|
|
8733
|
+
"sourceFile": "components/New/Calendar/Calendar.tsx",
|
|
8734
|
+
"typeBody": "Date | string | null"
|
|
5727
8735
|
},
|
|
5728
8736
|
{
|
|
5729
|
-
"name": "
|
|
5730
|
-
"
|
|
5731
|
-
"
|
|
5732
|
-
|
|
8737
|
+
"name": "TabItem",
|
|
8738
|
+
"kind": "interface",
|
|
8739
|
+
"members": [
|
|
8740
|
+
{
|
|
8741
|
+
"name": "id",
|
|
8742
|
+
"value": "string"
|
|
8743
|
+
},
|
|
8744
|
+
{
|
|
8745
|
+
"name": "label",
|
|
8746
|
+
"value": "string"
|
|
8747
|
+
},
|
|
8748
|
+
{
|
|
8749
|
+
"name": "count?",
|
|
8750
|
+
"value": "number"
|
|
8751
|
+
},
|
|
8752
|
+
{
|
|
8753
|
+
"name": "disabled?",
|
|
8754
|
+
"value": "boolean"
|
|
8755
|
+
}
|
|
8756
|
+
],
|
|
8757
|
+
"sourceFile": "components/New/Tabs/Tabs.tsx",
|
|
8758
|
+
"description": "A single tab entry rendered by ."
|
|
8759
|
+
}
|
|
8760
|
+
],
|
|
8761
|
+
"hooks": [
|
|
5733
8762
|
{
|
|
5734
|
-
"name": "
|
|
5735
|
-
"sourceFile": "
|
|
5736
|
-
"
|
|
8763
|
+
"name": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
8764
|
+
"sourceFile": "components/Analytics/Bar/utils.ts",
|
|
8765
|
+
"description": "Default color map for , expressed as ratios (value / maxValue).\nA value of `0` leaves the bar empty (track shows through); a value at the maximum\nuses the dedicated full-bar color.",
|
|
8766
|
+
"signature": "DEFAULT_ANALYTICS_BAR_COLOR_MAP: AnalyticsBarColorStop[]"
|
|
5737
8767
|
},
|
|
5738
8768
|
{
|
|
5739
|
-
"name": "
|
|
5740
|
-
"sourceFile": "components/
|
|
5741
|
-
"description": "A contextual feedback component for displaying important messages.\naliases: Notification\n\nRenders a colored container with an icon, message text, and an optional\nclose button.",
|
|
5742
|
-
"signature": "Notification: FC<NotificationProps>"
|
|
8769
|
+
"name": "DEFAULT_GRID_DATE_FORMAT_OPTIONS",
|
|
8770
|
+
"sourceFile": "components/Grid/renderers/constants.ts"
|
|
5743
8771
|
},
|
|
5744
8772
|
{
|
|
5745
|
-
"name": "
|
|
5746
|
-
"sourceFile": "components/
|
|
5747
|
-
"signature": "ErrorMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Error,\n)"
|
|
8773
|
+
"name": "DEFAULT_GRID_DATE_LOCALE",
|
|
8774
|
+
"sourceFile": "components/Grid/renderers/constants.ts"
|
|
5748
8775
|
},
|
|
5749
8776
|
{
|
|
5750
|
-
"name": "
|
|
5751
|
-
"sourceFile": "components/
|
|
5752
|
-
"signature": "ErrorToastNotification = NotificationVariantCreator(\n NotificationVariant.Error,\n NotificationType.Toast,\n)"
|
|
8777
|
+
"name": "convertGridDateToDate",
|
|
8778
|
+
"sourceFile": "components/Grid/renderers/utils.ts"
|
|
5753
8779
|
},
|
|
5754
8780
|
{
|
|
5755
|
-
"name": "
|
|
5756
|
-
"sourceFile": "components/
|
|
5757
|
-
"signature": "
|
|
8781
|
+
"name": "useDialFileManagerTabs",
|
|
8782
|
+
"sourceFile": "components/FileManager/hooks/use-file-manager-tabs.tsx",
|
|
8783
|
+
"signature": "(tabLabels?: Record<DialFileManagerTabs, string>, initialTab: DialFileManagerTabs = DialFileManagerTabs.MyFiles) => unknown"
|
|
5758
8784
|
},
|
|
5759
8785
|
{
|
|
5760
|
-
"name": "
|
|
5761
|
-
"sourceFile": "
|
|
5762
|
-
"signature": "
|
|
8786
|
+
"name": "EDITABLE_CONTAINER_ATTRIBUTE",
|
|
8787
|
+
"sourceFile": "hooks/use-editable-item.tsx",
|
|
8788
|
+
"signature": "EDITABLE_CONTAINER_ATTRIBUTE = 'data-editable-container'"
|
|
5763
8789
|
},
|
|
5764
8790
|
{
|
|
5765
|
-
"name": "
|
|
5766
|
-
"sourceFile": "
|
|
5767
|
-
"signature": "
|
|
8791
|
+
"name": "editableContainerProps",
|
|
8792
|
+
"sourceFile": "hooks/use-editable-item.tsx",
|
|
8793
|
+
"signature": "editableContainerProps = {\n [EDITABLE_CONTAINER_ATTRIBUTE]: '',\n} as const"
|
|
5768
8794
|
},
|
|
5769
8795
|
{
|
|
5770
|
-
"name": "
|
|
5771
|
-
"sourceFile": "
|
|
5772
|
-
"
|
|
8796
|
+
"name": "useEditableItem",
|
|
8797
|
+
"sourceFile": "hooks/use-editable-item.tsx",
|
|
8798
|
+
"description": "A React hook that manages the behavior of an inline-editable text input.\nIt provides validation handling, cancel/restore logic, auto-focus behavior,\nkeyboard shortcuts, and outside-click detection.",
|
|
8799
|
+
"signature": "function useEditableItem({\n value: initialValue,\n isEditing,\n isCreating,\n isLoading = false,\n restoreOnCancel = true,\n onValidate,\n onSave,\n onCancel,\n onCreateFolderSave,\n onCreateFolderCancel,\n}: UseEditableItemOptions): UseEditableItemResult"
|
|
5773
8800
|
},
|
|
5774
8801
|
{
|
|
5775
|
-
"name": "
|
|
5776
|
-
"sourceFile": "
|
|
5777
|
-
"signature": "SuccessMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Success,\n)"
|
|
8802
|
+
"name": "UseEditableItemOptions",
|
|
8803
|
+
"sourceFile": "hooks/use-editable-item.tsx"
|
|
5778
8804
|
},
|
|
5779
8805
|
{
|
|
5780
|
-
"name": "
|
|
5781
|
-
"sourceFile": "components/
|
|
5782
|
-
"
|
|
8806
|
+
"name": "FileManagerProvider",
|
|
8807
|
+
"sourceFile": "components/FileManager/FileManagerProvider.tsx",
|
|
8808
|
+
"description": "Provider that encapsulates all File Manager business logic:\n- path & navigation\n- search (controlled + uncontrolled)\n- hidden files toggle\n- tree collapsed state\n- selection\n- clipboard (copy / cut / paste)\n- delete confirmation state\n- computed grid rows\n- new actions",
|
|
8809
|
+
"signature": "FileManagerProvider: FC<FileManagerProviderProps>"
|
|
5783
8810
|
},
|
|
5784
8811
|
{
|
|
5785
|
-
"name": "
|
|
5786
|
-
"sourceFile": "components/
|
|
5787
|
-
"
|
|
8812
|
+
"name": "useFileManagerContext",
|
|
8813
|
+
"sourceFile": "components/FileManager/hooks/use-file-manager-context.ts",
|
|
8814
|
+
"description": "Hook to read the File Manager context.\nThrows if used outside of the provider.",
|
|
8815
|
+
"signature": "() => unknown"
|
|
5788
8816
|
},
|
|
5789
8817
|
{
|
|
5790
|
-
"name": "
|
|
5791
|
-
"sourceFile": "
|
|
5792
|
-
"
|
|
8818
|
+
"name": "matchesAccept",
|
|
8819
|
+
"sourceFile": "utils/file-accept.ts",
|
|
8820
|
+
"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.",
|
|
8821
|
+
"signature": "(file: File, accept?: string) => boolean"
|
|
5793
8822
|
}
|
|
5794
8823
|
],
|
|
5795
8824
|
"utils": [
|