@epam/ai-dial-ui-kit 0.16.0-dev.45 → 0.16.0-dev.46
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 +7 -10
- package/dist/CHANGELOG.md +4 -1
- package/dist/DateCellRenderer-Bx79kGGv.cjs +63 -0
- package/dist/MarkdownEditor-BtLY7OVq.cjs +1 -0
- package/dist/components-manifest.json +518 -3034
- package/dist/constants/public-class-names.js +0 -7
- package/dist/dial-ui-kit.cjs +3 -3
- package/dist/dial-ui-kit.js +373 -456
- package/dist/editors.cjs +1 -1
- package/dist/editors.js +4 -10
- package/dist/grid.cjs +1 -1
- package/dist/grid.js +23 -31
- package/dist/{merge-classes-B0SnCG4i.cjs → icon-D93YIwGJ.cjs} +1 -1
- package/dist/index.css +1 -1
- package/dist/migration-guides/0.16.0/legacy-file-manager-removal.md +5 -3
- package/dist/migration-guides/0.16.0/unused-legacy-components-removal.md +128 -0
- package/dist/migration-guides/README.md +1 -0
- package/dist/node_modules/react-dnd/dist/internals/registration.js +5 -13
- package/dist/src/components/New/MarkdownEditor/lazy.d.ts +8 -2
- package/dist/src/components/New/SegmentedControl/SegmentedControl.d.ts +2 -2
- package/dist/src/constants/public-class-names.d.ts +0 -7
- package/dist/src/index.d.ts +2 -53
- package/dist/src/subpaths/editors.d.ts +9 -15
- package/dist/src/subpaths/grid.d.ts +2 -8
- package/dist/src/types/editor.d.ts +0 -6
- package/dist/src/utils/grid-registration.d.ts +6 -8
- package/package.json +1 -12
- package/dist/DateCellRenderer-DrDOIpWg.cjs +0 -63
- package/dist/IconButton-CsePS6PY.cjs +0 -1
- package/dist/JsonEditor-DQhHSm93.cjs +0 -1
- package/dist/MarkdownEditor-CvIPIbPq.cjs +0 -1
- package/dist/MarkdownEditor-TR6X_gdl.cjs +0 -1
- package/dist/MarkdownEditorContainer-JIn_VNUX.cjs +0 -1
- package/dist/Switch-HEL_aq23.cjs +0 -1
- package/dist/assets/icons/file/c.svg.js +0 -5
- package/dist/assets/icons/file/cpp.svg.js +0 -5
- package/dist/assets/icons/file/cs.svg.js +0 -5
- package/dist/assets/icons/file/ini.svg.js +0 -5
- package/dist/assets/icons/file/json.svg.js +0 -5
- package/dist/assets/icons/file/md.svg.js +0 -5
- package/dist/assets/icons/file/py.svg.js +0 -5
- package/dist/assets/icons/open-popup.svg.js +0 -5
- package/dist/components/AutocompleteInput/AutocompleteInputValue.js +0 -21
- package/dist/components/ButtonDropdown/ButtonDropdown.js +0 -33
- package/dist/components/ButtonDropdown/constants.js +0 -8
- package/dist/components/Checkbox/Checkbox.js +0 -64
- package/dist/components/Checkbox/constants.js +0 -4
- package/dist/components/CollapsibleSidebar/CollapsibleSidebar.js +0 -84
- package/dist/components/ConfirmationPopup/ConfirmationPopup.js +0 -75
- package/dist/components/ConfirmationPopup/constants.js +0 -32
- package/dist/components/DraggableItem/DraggableItem.js +0 -61
- package/dist/components/DraggableItem/constants.js +0 -6
- package/dist/components/DropdownIcon/DropdownIcon.js +0 -103
- package/dist/components/FileIcon/FileIcon.js +0 -37
- package/dist/components/FileIcon/constants.js +0 -60
- package/dist/components/FileName/FileName.js +0 -68
- package/dist/components/FolderName/FolderName.js +0 -57
- package/dist/components/FormItem/FormItem.js +0 -90
- package/dist/components/FormItem/constants.js +0 -9
- package/dist/components/FormPopup/FormPopup.js +0 -59
- package/dist/components/FormPopup/constants.js +0 -6
- package/dist/components/Grid/Grid.js +0 -333
- package/dist/components/Grid/constants.js +0 -33
- package/dist/components/Grid/renderers/DateCellRenderer.js +0 -27
- package/dist/components/Grid/renderers/constants.js +0 -25
- package/dist/components/InputPopup/InputPopup.js +0 -174
- package/dist/components/JsonEditor/JsonEditor.js +0 -65
- package/dist/components/JsonEditor/lazy.js +0 -4
- package/dist/components/MarkdownEditor/MarkdownEditor.js +0 -39
- package/dist/components/MarkdownEditor/MarkdownEditorContainer.js +0 -82
- package/dist/components/MarkdownEditor/lazy.js +0 -4
- package/dist/components/Notification/Notification.js +0 -67
- package/dist/components/Notification/constants.js +0 -24
- package/dist/components/NumberInput/NumberInput.js +0 -41
- package/dist/components/Pagination/Pagination.js +0 -80
- package/dist/components/Pagination/utils.js +0 -10
- package/dist/components/PasswordInput/Icons/HideIcon.js +0 -16
- package/dist/components/PasswordInput/Icons/ShowIcon.js +0 -16
- package/dist/components/PasswordInput/PasswordInput.js +0 -21
- package/dist/components/Popup/Popup.js +0 -110
- package/dist/components/Popup/constants.js +0 -12
- package/dist/components/RadioButton/RadioButton.js +0 -103
- package/dist/components/RadioGroup/RadioGroup.js +0 -92
- package/dist/components/RadioGroup/constants.js +0 -10
- package/dist/components/RadioGroupPopupField/RadioGroupPopupField.js +0 -101
- package/dist/components/ResizableContainer/ConditionalResizableContainer.js +0 -6
- package/dist/components/ResizableContainer/ResizableContainer.js +0 -79
- package/dist/components/ResizableContainer/components/ResizeHandle.js +0 -20
- package/dist/components/ResizableContainer/components/ResizeIcon.js +0 -11
- package/dist/components/SchemaRenderer/SchemaRenderer.js +0 -151
- package/dist/components/SchemaRenderer/components/SchemaAdditionalPropertiesEditor.js +0 -56
- package/dist/components/SchemaRenderer/components/SchemaAnyOfEditor.js +0 -74
- package/dist/components/SchemaRenderer/components/SchemaArrayEditor.js +0 -118
- package/dist/components/SchemaRenderer/components/SchemaField.js +0 -78
- package/dist/components/SchemaRenderer/components/SchemaFieldContent.js +0 -114
- package/dist/components/SchemaRenderer/components/SchemaKeyValueEditor.js +0 -272
- package/dist/components/SchemaRenderer/components/SchemaObjectEditor.js +0 -36
- package/dist/components/SchemaRenderer/components/SchemaOneOfEditor.js +0 -192
- package/dist/components/SchemaRenderer/components/SchemaPrimitiveField.js +0 -161
- package/dist/components/SchemaRenderer/components/SchemaSection.js +0 -81
- package/dist/components/SchemaRenderer/context.js +0 -12
- package/dist/components/Search/Search.js +0 -63
- package/dist/components/Search/constants.js +0 -27
- package/dist/components/SegmentedControl/SegmentedControl.js +0 -87
- package/dist/components/SegmentedControl/constants.js +0 -8
- package/dist/components/Select/MultiSelectTags.js +0 -23
- package/dist/components/Select/Select.js +0 -435
- package/dist/components/Select/SelectSubMenuItem.js +0 -90
- package/dist/components/Select/constants.js +0 -15
- package/dist/components/SelectField/SelectField.js +0 -66
- package/dist/components/SharedEntityIndicator/SharedEntityIndicator.js +0 -34
- package/dist/components/Slider/Slider.js +0 -158
- package/dist/components/Switch/Switch.js +0 -70
- package/dist/components/TagInput/TagInput.js +0 -179
- package/dist/components/Textarea/Textarea.js +0 -43
- package/dist/constants/editor.js +0 -52
- package/dist/icon-CrGVkVpG.cjs +0 -1
- package/dist/icon-DhjrDQ8I.cjs +0 -1
- package/dist/lazy-kq-xfXXv.cjs +0 -1
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/DragSourceImpl.js +0 -25
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/connectors.js +0 -21
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useDrag.js +0 -20
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useDragSource.js +0 -19
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useDragSourceConnector.js +0 -22
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useDragSourceMonitor.js +0 -15
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useDragType.js +0 -13
- package/dist/node_modules/react-dnd/dist/hooks/useDrag/useRegisteredDragSource.js +0 -23
- package/dist/node_modules/react-dnd/dist/internals/DragSourceMonitorImpl.js +0 -88
- package/dist/node_modules/react-dnd/dist/internals/SourceConnector.js +0 -87
- package/dist/src/components/AutocompleteInput/AutocompleteInputValue.d.ts +0 -34
- package/dist/src/components/ButtonDropdown/ButtonDropdown.d.ts +0 -24
- package/dist/src/components/ButtonDropdown/constants.d.ts +0 -2
- package/dist/src/components/Checkbox/Checkbox.d.ts +0 -36
- package/dist/src/components/Checkbox/constants.d.ts +0 -1
- package/dist/src/components/CollapsibleSidebar/CollapsibleSidebar.d.ts +0 -46
- package/dist/src/components/ConfirmationPopup/ConfirmationPopup.d.ts +0 -55
- package/dist/src/components/ConfirmationPopup/constants.d.ts +0 -18
- package/dist/src/components/DraggableItem/DraggableItem.d.ts +0 -33
- package/dist/src/components/DraggableItem/constants.d.ts +0 -3
- package/dist/src/components/DropdownIcon/DropdownIcon.d.ts +0 -38
- package/dist/src/components/FileIcon/FileIcon.d.ts +0 -33
- package/dist/src/components/FileIcon/constants.d.ts +0 -9
- package/dist/src/components/FileName/FileName.d.ts +0 -49
- package/dist/src/components/FolderName/FolderName.d.ts +0 -37
- package/dist/src/components/FormItem/FormItem.d.ts +0 -66
- package/dist/src/components/FormItem/constants.d.ts +0 -3
- package/dist/src/components/FormPopup/FormPopup.d.ts +0 -46
- package/dist/src/components/FormPopup/constants.d.ts +0 -3
- package/dist/src/components/Grid/Grid.d.ts +0 -120
- package/dist/src/components/Grid/comparators/base-column-comparator.d.ts +0 -1
- package/dist/src/components/Grid/constants.d.ts +0 -28
- package/dist/src/components/Grid/renderers/DateCellRenderer.d.ts +0 -34
- package/dist/src/components/Grid/renderers/constants.d.ts +0 -7
- package/dist/src/components/Grid/renderers/utils.d.ts +0 -1
- package/dist/src/components/InputPopup/InputPopup.d.ts +0 -61
- package/dist/src/components/JsonEditor/JsonEditor.d.ts +0 -25
- package/dist/src/components/JsonEditor/lazy.d.ts +0 -14
- package/dist/src/components/MarkdownEditor/MarkdownEditor.d.ts +0 -38
- package/dist/src/components/MarkdownEditor/MarkdownEditorContainer.d.ts +0 -51
- package/dist/src/components/MarkdownEditor/lazy.d.ts +0 -7
- package/dist/src/components/Notification/Notification.d.ts +0 -58
- package/dist/src/components/Notification/constants.d.ts +0 -8
- package/dist/src/components/NumberInput/NumberInput.d.ts +0 -34
- package/dist/src/components/Pagination/Pagination.d.ts +0 -11
- package/dist/src/components/Pagination/utils.d.ts +0 -9
- package/dist/src/components/PasswordInput/Icons/HideIcon.d.ts +0 -16
- package/dist/src/components/PasswordInput/Icons/ShowIcon.d.ts +0 -16
- package/dist/src/components/PasswordInput/PasswordInput.d.ts +0 -26
- package/dist/src/components/Popup/Popup.d.ts +0 -64
- package/dist/src/components/Popup/constants.d.ts +0 -5
- package/dist/src/components/RadioButton/RadioButton.d.ts +0 -54
- package/dist/src/components/RadioGroup/RadioGroup.d.ts +0 -66
- package/dist/src/components/RadioGroup/constants.d.ts +0 -5
- package/dist/src/components/RadioGroupPopupField/RadioGroupPopupField.d.ts +0 -74
- package/dist/src/components/ResizableContainer/ConditionalResizableContainer.d.ts +0 -35
- package/dist/src/components/ResizableContainer/ResizableContainer.d.ts +0 -72
- package/dist/src/components/ResizableContainer/components/ResizeHandle.d.ts +0 -10
- package/dist/src/components/ResizableContainer/components/ResizeIcon.d.ts +0 -8
- package/dist/src/components/SchemaRenderer/SchemaRenderer.d.ts +0 -30
- package/dist/src/components/SchemaRenderer/components/SchemaAdditionalPropertiesEditor.d.ts +0 -20
- package/dist/src/components/SchemaRenderer/components/SchemaAnyOfEditor.d.ts +0 -31
- package/dist/src/components/SchemaRenderer/components/SchemaArrayEditor.d.ts +0 -31
- package/dist/src/components/SchemaRenderer/components/SchemaField.d.ts +0 -29
- package/dist/src/components/SchemaRenderer/components/SchemaFieldContent.d.ts +0 -25
- package/dist/src/components/SchemaRenderer/components/SchemaKeyValueEditor.d.ts +0 -33
- package/dist/src/components/SchemaRenderer/components/SchemaObjectEditor.d.ts +0 -31
- package/dist/src/components/SchemaRenderer/components/SchemaOneOfEditor.d.ts +0 -31
- package/dist/src/components/SchemaRenderer/components/SchemaPrimitiveField.d.ts +0 -31
- package/dist/src/components/SchemaRenderer/components/SchemaSection.d.ts +0 -33
- package/dist/src/components/SchemaRenderer/context.d.ts +0 -19
- package/dist/src/components/SchemaRenderer/types.d.ts +0 -62
- package/dist/src/components/SchemaRenderer/utils.d.ts +0 -1
- package/dist/src/components/Search/Search.d.ts +0 -35
- package/dist/src/components/Search/constants.d.ts +0 -8
- package/dist/src/components/SegmentedControl/SegmentedControl.d.ts +0 -40
- package/dist/src/components/SegmentedControl/constants.d.ts +0 -5
- package/dist/src/components/Select/MultiSelectTags.d.ts +0 -8
- package/dist/src/components/Select/Select.d.ts +0 -100
- package/dist/src/components/Select/SelectSubMenuItem.d.ts +0 -8
- package/dist/src/components/Select/constants.d.ts +0 -9
- package/dist/src/components/SelectField/SelectField.d.ts +0 -42
- package/dist/src/components/SharedEntityIndicator/SharedEntityIndicator.d.ts +0 -31
- package/dist/src/components/Slider/Slider.d.ts +0 -57
- package/dist/src/components/Switch/Switch.d.ts +0 -34
- package/dist/src/components/TagInput/TagInput.d.ts +0 -52
- package/dist/src/components/Textarea/Textarea.d.ts +0 -39
- package/dist/src/constants/editor.d.ts +0 -2
- package/dist/src/constants/storybook/form-item.d.ts +0 -3
- package/dist/src/models/segmented-control.d.ts +0 -7
- package/dist/src/types/form-item.d.ts +0 -31
- package/dist/src/types/select.d.ts +0 -8
- package/dist/types/form-item.js +0 -4
- package/dist/types/select.js +0 -5
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.16.0-dev.
|
|
3
|
-
"generatedAt": "2026-10-
|
|
2
|
+
"version": "0.16.0-dev.46",
|
|
3
|
+
"generatedAt": "2026-10-26T10:18:53.241Z",
|
|
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",
|
|
@@ -8,13 +8,11 @@
|
|
|
8
8
|
"cssImport": "import '@epam/ai-dial-ui-kit/styles.css'",
|
|
9
9
|
"peerDependencies": {
|
|
10
10
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
11
|
-
"@monaco-editor/react": "^4.7.0",
|
|
12
11
|
"@uiw/react-md-editor": "^4.1.0",
|
|
13
|
-
"monaco-editor": "^0.55.1",
|
|
14
12
|
"react": "^19.2.5",
|
|
15
13
|
"react-dom": "^19.2.5"
|
|
16
14
|
},
|
|
17
|
-
"setupNotes": "## Next.js Integration\n1. Install the package. React is the only peer you have to supply — everything\n the kit renders with, it installs itself.\n\n``` bash\nnpm install @epam/ai-dial-ui-kit\nnpm install react react-dom\n```\n\nAdd the editor
|
|
15
|
+
"setupNotes": "## Next.js Integration\n1. Install the package. React is the only peer you have to supply — everything\n the kit renders with, it installs itself.\n\n``` bash\nnpm install @epam/ai-dial-ui-kit\nnpm install react react-dom\n```\n\nAdd the editor package only if you use the Markdown editor\n(`LazyMarkdownEditor`). It is an optional peer, so `npm install` stays quiet\nwithout it, and the kit only reaches for it when the editor actually mounts:\n\n``` bash\nnpm install @uiw/react-md-editor\n```\n\n2. Import style in the root layout of the project:\n\n```tsx\n// app/layout.tsx\nimport \"@epam/ai-dial-ui-kit/styles.css\";\n```\n\n3. Usage example\n\n```tsx\n// app/page.tsx\n\"use client\";\nimport { DialPrimaryButton } from \"@epam/ai-dial-ui-kit\";\n\nexport default function Home() {\n return (\n <div className=\"w-full h-full flex flex-col gap-3 items-center justify-center\">\n <h1>Test library</h1>\n <DialPrimaryButton onClick={() => alert('Hello AI DIAL!')} />\n </div>\n );\n}\n```\nSee \"🎨 Theming & Customization\" section in README."
|
|
18
16
|
},
|
|
19
17
|
"styles": "# Typography CSS Utility Classes\n\n## Design-system-compliant classes (`dial-*-text`)\n\nUse these by default. They follow the design system type scale.\n\n| Class | Design name | Weight | Size / Line-height |\n| --------------------------------- | --------------------------- | -------- | ----------------------------------- |\n| `.dial-display1-text` | Display 1 | semibold | 32px / 48px |\n| `.dial-display2-text` | Display 2 | semibold | 28px / 40px |\n| `.dial-display3-text` | Display 3 | semibold | 22px / 32px |\n| `.dial-h1-text` | Heading 1 | semibold | 20px / 28px |\n| `.dial-h2-text` | Heading 2 | semibold | 18px / 26px |\n| `.dial-h3-text` | Heading 3 | semibold | 16px / 24px |\n| `.dial-body-text` | Body Text | normal | 16px / 24px |\n| `.dial-body-semi-text` | Body Text (Semi Bold) | semibold | 16px / 24px |\n| `.dial-body-paragraph-text` | Body Paragraph | normal | 16px / 26px |\n| `.dial-body-paragraph-semi-text` | Body Paragraph (Semi Bold) | semibold | 16px / 26px |\n| `.dial-small-text` | Small Text | normal | 14px / 20px |\n| `.dial-small-semi-text` | Small Text (Semi Bold) | semibold | 14px / 20px |\n| `.dial-small-paragraph-text` | Small Paragraph | normal | 14px / 24px |\n| `.dial-small-paragraph-semi-text` | Small Paragraph (Semi Bold) | semibold | 14px / 24px |\n| `.dial-tiny-text` | Tiny Text | normal | 12px / 16px |\n| `.dial-tiny-lead-text` | Tiny Text Lead | normal | 12px / 16px (+0.03em, uppercase) |\n| `.dial-tiny-semi-text` | Tiny Text (Semi Bold) | semibold | 12px / 16px |\n| `.dial-tiny-lead-semi-text` | Tiny Text Lead (Semi Bold) | semibold | 12px / 16px (+0.03em, uppercase) |\n| `.dial-caption-text` | Caption | normal | 10px / 12px |\n| `.dial-caption-lead-semi-text` | Caption Lead (Semi Bold) | semibold | 10px / 12px (+0.06em, uppercase) |\n| `.dial-code-text` | Code | normal | 14px / 20px (Fira Code / monospace) |\n| `.dial-italic-text` | Italic | normal | 18px / 22px (serif, italic) |\n| `.dial-small-italic-text` | Small Italic | normal | 14px / 20px (serif, italic) |\n| `.dial-tiny-italic-text` | Tiny Italic | normal | 12px / 16px (serif, italic) |\n| `.dial-caption-italic-text` | Caption Italic | normal | 10px / 12px (serif, italic) |\n\nThe three `*-lead-*` classes apply `text-transform: uppercase` themselves — pass them the sentence-case string, not a pre-uppercased one, so the accessible name stays readable.\n\n`.dial-code-text` resolves its family through `var(--theme-font-mono, var(--font-fira-code, 'Fira Code'))` before falling back to the system monospace stack. The kit ships no font file; the host provides the face.\n\nThe `*-italic-text` classes use a serif italic face and are intended for mathematical and formula symbols. Their line-heights follow the corresponding typography size; the default 18px variant uses a fixed 22px line-height to keep standalone symbols vertically aligned without changing their container's height.\n\n## Legacy classes (avoid in new code)\n\nClasses like `dial-h1`, `dial-h2`, `dial-body`, `dial-small*`, `dial-tiny*`, `dial-caption` are legacy. They can be used in legacy projects if user explicidly specify they need legacy typography.\n\n## Raw SCSS source\n",
|
|
20
18
|
"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 src/styles/theme.scss for full list */\n}\n```\n\n## Overlay stacking\n\nPortalled overlays stack on a ladder driven by one variable, `--z-overlay`\n(default `52`): `z-popup` (base — `Popup` backdrop), `z-floating` (+1 —\n`Dropdown`/`Select` overlays, submenus, `Calendar`), `z-interactive-tooltip`\n(+2 — `InteractiveTooltip`), `z-tooltip` (+3 — `Tooltip`). To lift every\noverlay above a host's own sticky header or modal, set the base once on `:root`\n(or in a `ThemeScope` class) — the steps move together, so their order is kept:\n\n```css\n:root {\n --z-overlay: 1000;\n}\n```\n\nDo not override `[role='menu']` or hardcode `z-[53]` in a host. To move one\noverlay only, pass a `z-*` utility through its class prop (`listClassName`,\n`overlayClassName`, `contentClassName`, `panelClassName`) — `mergeClasses`\nreplaces the layer's step with it.\n\n## Token Reference\n\n\n### backgroundsColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-base` | `var(--bg-layer-base)` | `#f5f7fa` |\n| `error` | `var(--bg-error)` | `#f3d6d8` |\n| `warning` | `var(--bg-warning)` | `#faf0cf` |\n| `info` | `var(--bg-info)` | `#e1eaf9` |\n| `success` | `var(--bg-success)` | `#dbf1eb` |\n| `gradient-1` | `var(--bg-gradient-1)` | `#1d4ed8` |\n| `gradient-2` | `var(--bg-gradient-2)` | `#885df2` |\n| `blue` | `var(--bg-visual-blue)` | `#d6edf9` |\n| `green-1` | `var(--bg-visual-green-1)` | `#cde8e5` |\n| `green-2` | `var(--bg-visual-green-2)` | `#d1f0dc` |\n| `brown` | `var(--bg-visual-brown)` | `#fde8d8` |\n| `red` | `var(--bg-visual-red)` | `#fce7f3` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `primary` | `var(--stroke-primary)` | `#57647a` |\n| `secondary` | `var(--stroke-secondary)` | `#d1dbea` |\n| `tertiary` | `var(--stroke-tertiary)` | `#e0e6f0` |\n| `error` | `var(--stroke-error)` | `#ae2f2f` |\n| `warning` | `var(--stroke-warning)` | `#eec840` |\n| `info` | `var(--stroke-info)` | `#1d4ed8` |\n| `accent` | `var(--stroke-accent)` | `#1d4ed8` |\n| `success` | `var(--stroke-success)` | `#007274` |\n| `default` | `var(--stroke-default)` | `#b2c2dd` |\n| `gradient-1` | `var(--stroke-gradient-1)` | `#5976e9` |\n| `gradient-2` | `var(--stroke-gradient-2)` | `#885df2` |\n| `focus` | `var(--stroke-focus)` | `#161b2d` |\n\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `primary` | `var(--text-primary)` | `#161b2d` |\n| `secondary` | `var(--text-secondary)` | `#57647a` |\n| `tertiary` | `var(--text-tertiary)` | `#848e9c` |\n| `accent` | `var(--text-accent)` | `#1d4ed8` |\n| `error` | `var(--text-error)` | `#ae2f2f` |\n| `warning` | `var(--text-warning)` | `#7f6300` |\n| `warning-icon` | `var(--text-warning-icon)` | `#eec840` |\n| `info` | `var(--text-info)` | `#1d4ed8` |\n| `success` | `var(--text-success)` | `#007274` |\n| `blue` | `var(--text-visual-blue)` | `#1189c8` |\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| `red` | `var(--text-visual-red)` | `#9d174d` |\n| `violet-1` | `var(--text-visual-violet-1)` | `#7c3aed` |\n| `violet-2` | `var(--text-visual-violet-2)` | `#3730b7` |\n\n### placeholderColor\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `primary` | `var(--text-primary)` | `#161b2d` |\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| `blackout` | `var(--bg-blackout)` | `#0c101d4d` |\n| `neutral` | `var(--bg-neutral)` | `#fcfcfc` |\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-error` | `var(--controls-bg-error)` | `#ae2f2f` |\n| `controls-disable` | `var(--controls-bg-disable)` | `#d1dbea` |\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| `hover` | `var(--stroke-hover)` | `#eef1f7` |\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-neutral` | `var(--controls-text-neutral)` | `#161b2d` |\n\n### shadowColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `xs` | `var(--shadow-xs-1)` | `#2764d933` |\n| `lg` | `var(--shadow-lg)` | `#2764d914` |",
|
|
@@ -6208,72 +6206,6 @@
|
|
|
6208
6206
|
],
|
|
6209
6207
|
"sourceFile": "components/Icon/Icon.tsx"
|
|
6210
6208
|
},
|
|
6211
|
-
{
|
|
6212
|
-
"name": "DialNotification",
|
|
6213
|
-
"category": "Elements",
|
|
6214
|
-
"generation": "1.0",
|
|
6215
|
-
"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.",
|
|
6216
|
-
"props": [
|
|
6217
|
-
{
|
|
6218
|
-
"name": "variant",
|
|
6219
|
-
"type": "NotificationVariant",
|
|
6220
|
-
"required": false,
|
|
6221
|
-
"defaultValue": "NotificationVariant.Info",
|
|
6222
|
-
"description": "Defines the visual style and icon of the alert"
|
|
6223
|
-
},
|
|
6224
|
-
{
|
|
6225
|
-
"name": "title",
|
|
6226
|
-
"type": "ReactNode",
|
|
6227
|
-
"required": false,
|
|
6228
|
-
"description": "Optional heading displayed above the message in semibold"
|
|
6229
|
-
},
|
|
6230
|
-
{
|
|
6231
|
-
"name": "message",
|
|
6232
|
-
"type": "ReactNode",
|
|
6233
|
-
"required": true,
|
|
6234
|
-
"description": "Message text to display inside the alert"
|
|
6235
|
-
},
|
|
6236
|
-
{
|
|
6237
|
-
"name": "closable",
|
|
6238
|
-
"type": "boolean",
|
|
6239
|
-
"required": false,
|
|
6240
|
-
"defaultValue": "false",
|
|
6241
|
-
"description": "Whether the alert has a close button"
|
|
6242
|
-
},
|
|
6243
|
-
{
|
|
6244
|
-
"name": "iconSize",
|
|
6245
|
-
"type": "number",
|
|
6246
|
-
"required": false,
|
|
6247
|
-
"defaultValue": "24",
|
|
6248
|
-
"description": "Size of the icon displayed in the alert"
|
|
6249
|
-
},
|
|
6250
|
-
{
|
|
6251
|
-
"name": "iconStroke",
|
|
6252
|
-
"type": "number",
|
|
6253
|
-
"required": false,
|
|
6254
|
-
"defaultValue": "2",
|
|
6255
|
-
"description": "Stroke width of the icon displayed in the alert"
|
|
6256
|
-
},
|
|
6257
|
-
{
|
|
6258
|
-
"name": "textClassName",
|
|
6259
|
-
"type": "string",
|
|
6260
|
-
"required": false,
|
|
6261
|
-
"defaultValue": "'flex-col'",
|
|
6262
|
-
"description": "Additional CSS classes applied to the message text"
|
|
6263
|
-
},
|
|
6264
|
-
{
|
|
6265
|
-
"name": "onClose",
|
|
6266
|
-
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
6267
|
-
"required": false,
|
|
6268
|
-
"description": "Callback fired when the close button is clicked"
|
|
6269
|
-
}
|
|
6270
|
-
],
|
|
6271
|
-
"examples": [
|
|
6272
|
-
"<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/>"
|
|
6273
|
-
],
|
|
6274
|
-
"sourceFile": "components/Notification/Notification.tsx",
|
|
6275
|
-
"supersededBy": "Notification"
|
|
6276
|
-
},
|
|
6277
6209
|
{
|
|
6278
6210
|
"name": "DialLoader",
|
|
6279
6211
|
"category": "Feedback",
|
|
@@ -6320,3066 +6252,917 @@
|
|
|
6320
6252
|
"sourceFile": "components/Loader/Loader.tsx"
|
|
6321
6253
|
},
|
|
6322
6254
|
{
|
|
6323
|
-
"name": "
|
|
6255
|
+
"name": "DialSteps",
|
|
6324
6256
|
"category": "Navigation",
|
|
6325
6257
|
"generation": "1.0",
|
|
6326
|
-
"description": "
|
|
6258
|
+
"description": "Props for the DialSteps component, which renders a multi-step navigation UI.\naliases: StepWizard|ProgressSteps\nDesign system 1.0",
|
|
6327
6259
|
"props": [
|
|
6328
6260
|
{
|
|
6329
|
-
"name": "
|
|
6330
|
-
"type": "
|
|
6331
|
-
"required": true
|
|
6332
|
-
|
|
6333
|
-
{
|
|
6334
|
-
"name": "totalPages",
|
|
6335
|
-
"type": "number",
|
|
6336
|
-
"required": true
|
|
6261
|
+
"name": "steps",
|
|
6262
|
+
"type": "Step[]",
|
|
6263
|
+
"required": true,
|
|
6264
|
+
"description": "Array of step objects to display"
|
|
6337
6265
|
},
|
|
6338
6266
|
{
|
|
6339
|
-
"name": "
|
|
6340
|
-
"type": "
|
|
6341
|
-
"required": true
|
|
6267
|
+
"name": "currentStep",
|
|
6268
|
+
"type": "string",
|
|
6269
|
+
"required": true,
|
|
6270
|
+
"description": "The id of the currently active step"
|
|
6342
6271
|
},
|
|
6343
6272
|
{
|
|
6344
|
-
"name": "
|
|
6345
|
-
"type": "string",
|
|
6346
|
-
"required":
|
|
6273
|
+
"name": "onChangeStep",
|
|
6274
|
+
"type": "(step: string) => void",
|
|
6275
|
+
"required": true,
|
|
6276
|
+
"description": "Callback to set the current step by id"
|
|
6347
6277
|
}
|
|
6348
6278
|
],
|
|
6349
|
-
"examples": [
|
|
6350
|
-
|
|
6279
|
+
"examples": [
|
|
6280
|
+
"<DialSteps\n steps={[{ id: 'step1', label: 'Step 1', status: StepStatus.VALID }, { id: 'step2', label: 'Step 2', status: StepStatus.ERROR }]}\n currentStep=\"step1\"\n onChangeStep={(step) => console.log(step)}\n/>"
|
|
6281
|
+
],
|
|
6282
|
+
"sourceFile": "components/Steps/Steps.tsx"
|
|
6351
6283
|
},
|
|
6352
6284
|
{
|
|
6353
|
-
"name": "
|
|
6354
|
-
"category": "
|
|
6285
|
+
"name": "DialNoDataContent",
|
|
6286
|
+
"category": "Feedback",
|
|
6355
6287
|
"generation": "1.0",
|
|
6356
|
-
"description": "A
|
|
6288
|
+
"description": "A component for displaying a message and icon when there is no data to show.\naliases: EmptyState|NoResults\nDesign system 1.0",
|
|
6357
6289
|
"props": [
|
|
6358
6290
|
{
|
|
6359
|
-
"name": "
|
|
6360
|
-
"type": "string",
|
|
6361
|
-
"required": true,
|
|
6362
|
-
"description": "Unique identifier for the checkbox element"
|
|
6363
|
-
},
|
|
6364
|
-
{
|
|
6365
|
-
"name": "label",
|
|
6291
|
+
"name": "icon",
|
|
6366
6292
|
"type": "ReactNode",
|
|
6367
6293
|
"required": false,
|
|
6368
|
-
"description": "
|
|
6294
|
+
"description": "Custom icon to display (defaults to clipboard icon)"
|
|
6369
6295
|
},
|
|
6370
6296
|
{
|
|
6371
|
-
"name": "
|
|
6372
|
-
"type": "
|
|
6297
|
+
"name": "title",
|
|
6298
|
+
"type": "string",
|
|
6373
6299
|
"required": true,
|
|
6374
|
-
"description": "The
|
|
6300
|
+
"description": "The message to display when no data is present"
|
|
6375
6301
|
},
|
|
6376
6302
|
{
|
|
6377
|
-
"name": "
|
|
6378
|
-
"type": "
|
|
6303
|
+
"name": "description",
|
|
6304
|
+
"type": "string",
|
|
6379
6305
|
"required": false,
|
|
6380
|
-
"description": "
|
|
6306
|
+
"description": "The description to display when no data is present"
|
|
6381
6307
|
},
|
|
6382
6308
|
{
|
|
6383
|
-
"name": "
|
|
6384
|
-
"type": "
|
|
6309
|
+
"name": "containerClassName",
|
|
6310
|
+
"type": "string",
|
|
6385
6311
|
"required": false,
|
|
6386
|
-
"description": "
|
|
6312
|
+
"description": "Additional CSS classes for the container"
|
|
6387
6313
|
},
|
|
6388
6314
|
{
|
|
6389
|
-
"name": "
|
|
6315
|
+
"name": "titleClassName",
|
|
6390
6316
|
"type": "string",
|
|
6391
6317
|
"required": false,
|
|
6392
|
-
"description": "
|
|
6318
|
+
"description": "Additional CSS classes for the title text"
|
|
6393
6319
|
},
|
|
6394
6320
|
{
|
|
6395
|
-
"name": "
|
|
6396
|
-
"type": "
|
|
6321
|
+
"name": "descriptionClassName",
|
|
6322
|
+
"type": "string",
|
|
6397
6323
|
"required": false,
|
|
6398
|
-
"description": "
|
|
6324
|
+
"description": "Additional CSS classes for the description text"
|
|
6399
6325
|
}
|
|
6400
6326
|
],
|
|
6401
6327
|
"examples": [
|
|
6402
|
-
"<
|
|
6328
|
+
"<NoDataContent\n emptyDataTitle=\"No results found\"\n icon={<CustomIcon />}\n/>"
|
|
6403
6329
|
],
|
|
6404
|
-
"sourceFile": "components/
|
|
6405
|
-
"supersededBy": "
|
|
6330
|
+
"sourceFile": "components/NoDataContent/NoDataContent.tsx",
|
|
6331
|
+
"supersededBy": "NoDataContent"
|
|
6406
6332
|
},
|
|
6407
6333
|
{
|
|
6408
|
-
"name": "
|
|
6409
|
-
"category": "
|
|
6334
|
+
"name": "DialLabelledText",
|
|
6335
|
+
"category": "Data Display",
|
|
6410
6336
|
"generation": "1.0",
|
|
6411
|
-
"description": "
|
|
6337
|
+
"description": "A label component for form fields with optional tooltip, content, and custom elements.\naliases: LabelValue|DisplayText\nDesign system 1.0",
|
|
6412
6338
|
"props": [
|
|
6413
6339
|
{
|
|
6414
|
-
"name": "
|
|
6415
|
-
"type": "
|
|
6340
|
+
"name": "label",
|
|
6341
|
+
"type": "ReactNode",
|
|
6416
6342
|
"required": true,
|
|
6417
|
-
"description": "
|
|
6343
|
+
"description": "The main label text for the field"
|
|
6418
6344
|
},
|
|
6419
6345
|
{
|
|
6420
|
-
"name": "
|
|
6346
|
+
"name": "text",
|
|
6347
|
+
"type": "ReactNode",
|
|
6348
|
+
"required": false,
|
|
6349
|
+
"description": "Optional tooltip and secondary text"
|
|
6350
|
+
},
|
|
6351
|
+
{
|
|
6352
|
+
"name": "tooltip",
|
|
6421
6353
|
"type": "string",
|
|
6422
|
-
"required":
|
|
6423
|
-
"description": "
|
|
6354
|
+
"required": false,
|
|
6355
|
+
"description": "Optional tooltip different from main text"
|
|
6424
6356
|
},
|
|
6425
6357
|
{
|
|
6426
|
-
"name": "
|
|
6427
|
-
"type": "
|
|
6428
|
-
"required":
|
|
6429
|
-
"description": "
|
|
6358
|
+
"name": "children",
|
|
6359
|
+
"type": "ReactNode",
|
|
6360
|
+
"required": false,
|
|
6361
|
+
"description": "Custom content to render instead of the default text/tooltip"
|
|
6362
|
+
},
|
|
6363
|
+
{
|
|
6364
|
+
"name": "postfix",
|
|
6365
|
+
"type": "ReactNode",
|
|
6366
|
+
"required": false,
|
|
6367
|
+
"description": "Element to display after the text (e.g., an asterisk)"
|
|
6368
|
+
},
|
|
6369
|
+
{
|
|
6370
|
+
"name": "className",
|
|
6371
|
+
"type": "string",
|
|
6372
|
+
"required": false,
|
|
6373
|
+
"description": "Additional CSS classes for the container element."
|
|
6430
6374
|
}
|
|
6431
6375
|
],
|
|
6432
6376
|
"examples": [
|
|
6433
|
-
"<
|
|
6377
|
+
"<DialLabelledText\n label=\"Username\"\n text=\"Enter your username\"\n postfix={<span>*</span>}\n/>"
|
|
6434
6378
|
],
|
|
6435
|
-
"sourceFile": "components/
|
|
6379
|
+
"sourceFile": "components/LabelledText/LabelledText.tsx"
|
|
6436
6380
|
},
|
|
6437
6381
|
{
|
|
6438
|
-
"name": "
|
|
6439
|
-
"category": "
|
|
6382
|
+
"name": "DialTag",
|
|
6383
|
+
"category": "Tag",
|
|
6440
6384
|
"generation": "1.0",
|
|
6441
|
-
"description": "A
|
|
6385
|
+
"description": "A compact label element used for selections, filters, or categories.\nDesign system 1.0",
|
|
6442
6386
|
"props": [
|
|
6443
6387
|
{
|
|
6444
|
-
"name": "
|
|
6388
|
+
"name": "label",
|
|
6445
6389
|
"type": "string",
|
|
6446
|
-
"required": true
|
|
6447
|
-
"description": "Radio group name"
|
|
6390
|
+
"required": true
|
|
6448
6391
|
},
|
|
6449
6392
|
{
|
|
6450
|
-
"name": "
|
|
6393
|
+
"name": "className",
|
|
6451
6394
|
"type": "string",
|
|
6452
|
-
"required":
|
|
6453
|
-
"description": "Radio value emitted on change"
|
|
6395
|
+
"required": false
|
|
6454
6396
|
},
|
|
6455
6397
|
{
|
|
6456
|
-
"name": "
|
|
6457
|
-
"type": "
|
|
6458
|
-
"required": false
|
|
6459
|
-
"description": "Visible label text"
|
|
6398
|
+
"name": "selected",
|
|
6399
|
+
"type": "boolean",
|
|
6400
|
+
"required": false
|
|
6460
6401
|
},
|
|
6461
6402
|
{
|
|
6462
|
-
"name": "
|
|
6403
|
+
"name": "icon",
|
|
6463
6404
|
"type": "ReactNode",
|
|
6464
|
-
"required": false
|
|
6465
|
-
"description": "Caption text describing label"
|
|
6405
|
+
"required": false
|
|
6466
6406
|
},
|
|
6467
6407
|
{
|
|
6468
|
-
"name": "
|
|
6469
|
-
"type": "
|
|
6470
|
-
"required": false
|
|
6471
|
-
"description": "Supporting text shown when checked"
|
|
6408
|
+
"name": "closable",
|
|
6409
|
+
"type": "boolean",
|
|
6410
|
+
"required": false
|
|
6472
6411
|
},
|
|
6473
6412
|
{
|
|
6474
|
-
"name": "
|
|
6475
|
-
"type": "
|
|
6476
|
-
"required": false
|
|
6477
|
-
"defaultValue": "false",
|
|
6478
|
-
"description": "Controlled checked state"
|
|
6413
|
+
"name": "onClick",
|
|
6414
|
+
"type": "(event: MouseEvent<HTMLDivElement>) => void",
|
|
6415
|
+
"required": false
|
|
6479
6416
|
},
|
|
6480
6417
|
{
|
|
6481
|
-
"name": "
|
|
6482
|
-
"type": "
|
|
6418
|
+
"name": "onRemove",
|
|
6419
|
+
"type": "(event: MouseEvent<HTMLButtonElement>) => void",
|
|
6420
|
+
"required": false
|
|
6421
|
+
}
|
|
6422
|
+
],
|
|
6423
|
+
"examples": [],
|
|
6424
|
+
"sourceFile": "components/Tag/Tag.tsx",
|
|
6425
|
+
"supersededBy": "Tag"
|
|
6426
|
+
},
|
|
6427
|
+
{
|
|
6428
|
+
"name": "DialEllipsisTooltip",
|
|
6429
|
+
"category": "Overlay",
|
|
6430
|
+
"generation": "1.0",
|
|
6431
|
+
"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.",
|
|
6432
|
+
"props": [
|
|
6433
|
+
{
|
|
6434
|
+
"name": "text",
|
|
6435
|
+
"type": "ReactNode",
|
|
6483
6436
|
"required": true,
|
|
6484
|
-
"description": "
|
|
6437
|
+
"description": "The text or node to display (truncated with ellipsis if too long)."
|
|
6485
6438
|
},
|
|
6486
6439
|
{
|
|
6487
6440
|
"name": "className",
|
|
6488
6441
|
"type": "string",
|
|
6489
6442
|
"required": false,
|
|
6490
|
-
"description": "
|
|
6443
|
+
"description": "Optional additional CSS classes for the text container (e.g. to set width)."
|
|
6491
6444
|
},
|
|
6492
6445
|
{
|
|
6493
|
-
"name": "
|
|
6446
|
+
"name": "contentClassName",
|
|
6494
6447
|
"type": "string",
|
|
6495
6448
|
"required": false,
|
|
6496
|
-
"description": "
|
|
6449
|
+
"description": "Optional additional CSS classes for the tooltip content."
|
|
6497
6450
|
},
|
|
6498
6451
|
{
|
|
6499
|
-
"name": "
|
|
6452
|
+
"name": "hideTooltip",
|
|
6500
6453
|
"type": "boolean",
|
|
6501
6454
|
"required": false,
|
|
6502
|
-
"description": "
|
|
6503
|
-
},
|
|
6504
|
-
{
|
|
6505
|
-
"name": "onChange",
|
|
6506
|
-
"type": "(value: string) => void",
|
|
6507
|
-
"required": false,
|
|
6508
|
-
"description": "Callback fired with `value` when the radio is changed"
|
|
6509
|
-
},
|
|
6510
|
-
{
|
|
6511
|
-
"name": "descriptionClassName",
|
|
6512
|
-
"type": "string",
|
|
6513
|
-
"required": false,
|
|
6514
|
-
"description": "Additional classes applied to the description block"
|
|
6455
|
+
"description": "If true, disables the tooltip even if text is truncated."
|
|
6515
6456
|
},
|
|
6516
6457
|
{
|
|
6517
|
-
"name": "
|
|
6458
|
+
"name": "id",
|
|
6518
6459
|
"type": "string",
|
|
6519
6460
|
"required": false,
|
|
6520
|
-
"description": "
|
|
6461
|
+
"description": "Optional attribute for unique identification"
|
|
6521
6462
|
},
|
|
6522
6463
|
{
|
|
6523
|
-
"name": "
|
|
6524
|
-
"type": "
|
|
6464
|
+
"name": "customTooltipContent",
|
|
6465
|
+
"type": "ReactNode",
|
|
6525
6466
|
"required": false,
|
|
6526
|
-
"
|
|
6527
|
-
"description": "When true, the caption is shown on the same line to the right of the label instead of underneath it"
|
|
6467
|
+
"description": "If provided, this content will be shown in the tooltip instead of the full text when truncated."
|
|
6528
6468
|
}
|
|
6529
6469
|
],
|
|
6530
6470
|
"examples": [
|
|
6531
|
-
"<
|
|
6471
|
+
"<DialEllipsisTooltip text=\"Very long message that will be truncated\" />\n<DialEllipsisTooltip text={<span className=\"font-medium\">Custom node</span>} className=\"max-w-[160px]\" />\n<DialEllipsisTooltip text=\"Tooltip disabled even if truncated\" hideTooltip />"
|
|
6532
6472
|
],
|
|
6533
|
-
"sourceFile": "components/
|
|
6473
|
+
"sourceFile": "components/EllipsisTooltip/EllipsisTooltip.tsx",
|
|
6474
|
+
"supersededBy": "EllipsisTooltip"
|
|
6534
6475
|
},
|
|
6535
6476
|
{
|
|
6536
|
-
"name": "
|
|
6537
|
-
"category": "
|
|
6477
|
+
"name": "DialTabs",
|
|
6478
|
+
"category": "Navigation",
|
|
6538
6479
|
"generation": "1.0",
|
|
6539
|
-
"description": "
|
|
6480
|
+
"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.",
|
|
6540
6481
|
"props": [
|
|
6541
6482
|
{
|
|
6542
|
-
"name": "
|
|
6543
|
-
"type": "
|
|
6544
|
-
"required": false,
|
|
6545
|
-
"description": "Optional label rendered by `DialField`"
|
|
6546
|
-
},
|
|
6547
|
-
{
|
|
6548
|
-
"name": "elementId",
|
|
6549
|
-
"type": "string",
|
|
6550
|
-
"required": true,
|
|
6551
|
-
"description": "Name for the underlying radio group; also used for input `name`"
|
|
6552
|
-
},
|
|
6553
|
-
{
|
|
6554
|
-
"name": "disabled",
|
|
6555
|
-
"type": "boolean",
|
|
6556
|
-
"required": false,
|
|
6557
|
-
"description": "Disables all child radios when set"
|
|
6558
|
-
},
|
|
6559
|
-
{
|
|
6560
|
-
"name": "radioButtons",
|
|
6561
|
-
"type": "RadioButtonWithContent[]",
|
|
6483
|
+
"name": "tabs",
|
|
6484
|
+
"type": "TabModel[]",
|
|
6562
6485
|
"required": true,
|
|
6563
|
-
"description": "Array of
|
|
6486
|
+
"description": "Array of tab models to render. Each tab must include an `id` and a display `name`."
|
|
6564
6487
|
},
|
|
6565
6488
|
{
|
|
6566
|
-
"name": "
|
|
6489
|
+
"name": "activeTab",
|
|
6567
6490
|
"type": "string",
|
|
6568
6491
|
"required": true,
|
|
6569
|
-
"description": "The
|
|
6570
|
-
},
|
|
6571
|
-
{
|
|
6572
|
-
"name": "orientation",
|
|
6573
|
-
"type": "RadioGroupOrientation",
|
|
6574
|
-
"required": true,
|
|
6575
|
-
"description": "Layout direction of radios: row or column"
|
|
6576
|
-
},
|
|
6577
|
-
{
|
|
6578
|
-
"name": "labelDescription",
|
|
6579
|
-
"type": "string",
|
|
6580
|
-
"required": false,
|
|
6581
|
-
"description": "Optional description rendered by `DialFormItem`"
|
|
6492
|
+
"description": "The identifier of the currently active tab."
|
|
6582
6493
|
},
|
|
6583
6494
|
{
|
|
6584
|
-
"name": "
|
|
6585
|
-
"type": "(
|
|
6495
|
+
"name": "onClick",
|
|
6496
|
+
"type": "(id: string) => void",
|
|
6586
6497
|
"required": true,
|
|
6587
|
-
"description": "Callback fired
|
|
6498
|
+
"description": "Callback fired when a tab is selected. Receives the tab's `id` as an argument."
|
|
6588
6499
|
},
|
|
6589
6500
|
{
|
|
6590
|
-
"name": "
|
|
6591
|
-
"type": "
|
|
6501
|
+
"name": "orientation",
|
|
6502
|
+
"type": "TabOrientation",
|
|
6592
6503
|
"required": false,
|
|
6593
|
-
"
|
|
6504
|
+
"defaultValue": "TabOrientation.Horizontal",
|
|
6505
|
+
"description": "Layout direction of the tabs. Uses the enum."
|
|
6594
6506
|
},
|
|
6595
6507
|
{
|
|
6596
|
-
"name": "
|
|
6597
|
-
"type": "
|
|
6508
|
+
"name": "view",
|
|
6509
|
+
"type": "TabView",
|
|
6598
6510
|
"required": false,
|
|
6599
|
-
"
|
|
6511
|
+
"defaultValue": "TabView.Default",
|
|
6512
|
+
"description": "Visual style of the tabs. Uses the enum.\n`Inline` renders a compact segmented control where the active tab is marked with a\nleading check icon. The inline view is not responsive and ignores overflow/dropdown logic."
|
|
6600
6513
|
},
|
|
6601
6514
|
{
|
|
6602
|
-
"name": "
|
|
6515
|
+
"name": "className",
|
|
6603
6516
|
"type": "string",
|
|
6604
|
-
"required": false
|
|
6605
|
-
"description": "Additional classes applied to each radio label"
|
|
6517
|
+
"required": false
|
|
6606
6518
|
},
|
|
6607
6519
|
{
|
|
6608
|
-
"name": "
|
|
6609
|
-
"type": "
|
|
6520
|
+
"name": "screenThreshold",
|
|
6521
|
+
"type": "ScreenResolution",
|
|
6610
6522
|
"required": false,
|
|
6611
|
-
"
|
|
6523
|
+
"defaultValue": "ScreenResolution.Tablet",
|
|
6524
|
+
"description": "Defines the screen size threshold\nbelow which tabs collapse into a dropdown. Uses the enum.\nWhen set to `Tablet`, both mobile and tablet screens will trigger dropdown mode."
|
|
6612
6525
|
},
|
|
6613
6526
|
{
|
|
6614
|
-
"name": "
|
|
6527
|
+
"name": "smallScreenContainerClassName",
|
|
6615
6528
|
"type": "string",
|
|
6616
6529
|
"required": false,
|
|
6617
|
-
"description": "
|
|
6530
|
+
"description": "Optional CSS class applied to the dropdown container\nin small-screen (collapsed) mode."
|
|
6618
6531
|
},
|
|
6619
6532
|
{
|
|
6620
|
-
"name": "
|
|
6533
|
+
"name": "smallScreenDropdownItemClassName",
|
|
6621
6534
|
"type": "string",
|
|
6622
6535
|
"required": false,
|
|
6623
|
-
"description": "
|
|
6536
|
+
"description": "Optional CSS class applied to individual dropdown\nitems in small-screen mode."
|
|
6624
6537
|
},
|
|
6625
6538
|
{
|
|
6626
|
-
"name": "
|
|
6539
|
+
"name": "desktopDropdownClassName",
|
|
6627
6540
|
"type": "string",
|
|
6628
6541
|
"required": false,
|
|
6629
|
-
"description": "
|
|
6542
|
+
"description": "Optional CSS class applied to dropdown button in non small-screen mode."
|
|
6630
6543
|
},
|
|
6631
6544
|
{
|
|
6632
|
-
"name": "
|
|
6545
|
+
"name": "desktopTabClassName",
|
|
6633
6546
|
"type": "string",
|
|
6634
6547
|
"required": false,
|
|
6635
|
-
"description": "
|
|
6548
|
+
"description": "Optional CSS class applied to tab in non small-screed mode."
|
|
6636
6549
|
},
|
|
6637
6550
|
{
|
|
6638
|
-
"name": "
|
|
6551
|
+
"name": "inlineContainerClassName",
|
|
6639
6552
|
"type": "string",
|
|
6640
|
-
"required": false
|
|
6641
|
-
"description": "Additional classes applied to each radio input's container"
|
|
6553
|
+
"required": false
|
|
6642
6554
|
},
|
|
6643
6555
|
{
|
|
6644
|
-
"name": "
|
|
6556
|
+
"name": "inlineTabClassName",
|
|
6645
6557
|
"type": "string",
|
|
6646
|
-
"required": false
|
|
6647
|
-
"description": "Additional classes applied to the selected radio input's container"
|
|
6558
|
+
"required": false
|
|
6648
6559
|
}
|
|
6649
6560
|
],
|
|
6650
6561
|
"examples": [
|
|
6651
|
-
"<
|
|
6562
|
+
"<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/>"
|
|
6652
6563
|
],
|
|
6653
|
-
"sourceFile": "components/
|
|
6654
|
-
"supersededBy": "
|
|
6564
|
+
"sourceFile": "components/Tabs/Tabs.tsx",
|
|
6565
|
+
"supersededBy": "Tabs"
|
|
6655
6566
|
},
|
|
6656
6567
|
{
|
|
6657
|
-
"name": "
|
|
6658
|
-
"category": "
|
|
6568
|
+
"name": "DialBreadcrumb",
|
|
6569
|
+
"category": "Navigation",
|
|
6659
6570
|
"generation": "1.0",
|
|
6660
|
-
"description": "
|
|
6571
|
+
"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.",
|
|
6661
6572
|
"props": [
|
|
6662
6573
|
{
|
|
6663
|
-
"name": "
|
|
6664
|
-
"type": "
|
|
6665
|
-
"required": true,
|
|
6666
|
-
"description": "Current slider value"
|
|
6667
|
-
},
|
|
6668
|
-
{
|
|
6669
|
-
"name": "min",
|
|
6670
|
-
"type": "number",
|
|
6671
|
-
"required": false,
|
|
6672
|
-
"defaultValue": "0",
|
|
6673
|
-
"description": "Minimum value"
|
|
6674
|
-
},
|
|
6675
|
-
{
|
|
6676
|
-
"name": "max",
|
|
6677
|
-
"type": "number",
|
|
6678
|
-
"required": false,
|
|
6679
|
-
"defaultValue": "1",
|
|
6680
|
-
"description": "Maximum value"
|
|
6681
|
-
},
|
|
6682
|
-
{
|
|
6683
|
-
"name": "step",
|
|
6684
|
-
"type": "number",
|
|
6685
|
-
"required": false,
|
|
6686
|
-
"defaultValue": "0.1",
|
|
6687
|
-
"description": "Step increment"
|
|
6688
|
-
},
|
|
6689
|
-
{
|
|
6690
|
-
"name": "disabled",
|
|
6691
|
-
"type": "boolean",
|
|
6692
|
-
"required": false,
|
|
6693
|
-
"defaultValue": "false",
|
|
6694
|
-
"description": "Disables interaction"
|
|
6695
|
-
},
|
|
6696
|
-
{
|
|
6697
|
-
"name": "labelProps",
|
|
6698
|
-
"type": "DialLabelProps",
|
|
6699
|
-
"required": false,
|
|
6700
|
-
"description": "Props forwarded to DialLabel rendered above the slider"
|
|
6701
|
-
},
|
|
6702
|
-
{
|
|
6703
|
-
"name": "labels",
|
|
6704
|
-
"type": "[string, string] | [string, string, string]",
|
|
6574
|
+
"name": "pathItems",
|
|
6575
|
+
"type": "DialBreadcrumbPathItem[]",
|
|
6705
6576
|
"required": false,
|
|
6706
|
-
"description": "
|
|
6577
|
+
"description": "Array of breadcrumb pathItems (see `DialBreadcrumbItem`)."
|
|
6707
6578
|
},
|
|
6708
6579
|
{
|
|
6709
|
-
"name": "
|
|
6710
|
-
"type": "
|
|
6580
|
+
"name": "separator",
|
|
6581
|
+
"type": "ReactNode",
|
|
6711
6582
|
"required": false,
|
|
6712
|
-
"
|
|
6583
|
+
"defaultValue": "defaultSeparator",
|
|
6584
|
+
"description": "Custom separator node (default: right chevron icon)."
|
|
6713
6585
|
},
|
|
6714
6586
|
{
|
|
6715
|
-
"name": "
|
|
6716
|
-
"type": "
|
|
6587
|
+
"name": "ariaLabel",
|
|
6588
|
+
"type": "string",
|
|
6717
6589
|
"required": false,
|
|
6718
|
-
"
|
|
6590
|
+
"defaultValue": "'Breadcrumb'",
|
|
6591
|
+
"description": "Aria label for the `<nav>` element (default: \"Breadcrumb\")."
|
|
6719
6592
|
},
|
|
6720
6593
|
{
|
|
6721
|
-
"name": "
|
|
6594
|
+
"name": "className",
|
|
6722
6595
|
"type": "string",
|
|
6723
6596
|
"required": false,
|
|
6724
|
-
"description": "Additional CSS classes for the
|
|
6597
|
+
"description": "Additional CSS classes for the `<nav>` container."
|
|
6725
6598
|
},
|
|
6726
6599
|
{
|
|
6727
|
-
"name": "
|
|
6728
|
-
"type": "
|
|
6600
|
+
"name": "children",
|
|
6601
|
+
"type": "ReactNode",
|
|
6729
6602
|
"required": false,
|
|
6730
|
-
"description": "
|
|
6603
|
+
"description": "Alternatively, compose with `<DialBreadcrumbItem/>` as children."
|
|
6731
6604
|
},
|
|
6732
6605
|
{
|
|
6733
|
-
"name": "
|
|
6606
|
+
"name": "labelClassName",
|
|
6734
6607
|
"type": "string",
|
|
6735
6608
|
"required": false,
|
|
6736
|
-
"description": "Additional CSS classes
|
|
6609
|
+
"description": "Additional CSS classes applied to each item when using `pathItems` prop."
|
|
6737
6610
|
},
|
|
6738
6611
|
{
|
|
6739
|
-
"name": "
|
|
6740
|
-
"type": "
|
|
6612
|
+
"name": "onBeforeNavigate",
|
|
6613
|
+
"type": "NavigationGuard",
|
|
6741
6614
|
"required": false,
|
|
6742
|
-
"description": "
|
|
6615
|
+
"description": "Navigation guard called before navigating to a breadcrumb item.\nGuard function called before navigating to a different breadcrumb item.\nReturn `true` to allow navigation, `false` to prevent it.\nCan return a Promise for async checks (e.g., showing a confirmation dialog)."
|
|
6743
6616
|
}
|
|
6744
6617
|
],
|
|
6745
6618
|
"examples": [
|
|
6746
|
-
"<
|
|
6619
|
+
"<DialBreadcrumb\n pathItems={[\n { label: 'Home', href: '/' },\n { label: 'Section', href: '/section' },\n { label: 'Current Page' },\n ]}\n/>\n\n<DialBreadcrumb>\n <DialBreadcrumbItem label=\"Home\" href=\"/\" />\n <DialBreadcrumbItem label=\"Section\" href=\"/section\" />\n <DialBreadcrumbItem label=\"Current Page\" />\n</DialBreadcrumb>",
|
|
6620
|
+
"<DialBreadcrumb\n pathItems={items}\n onBeforeNavigate={async () => {\n if (hasUnsavedChanges) {\n return await confirmLeave();\n }\n return true;\n }}\n />"
|
|
6747
6621
|
],
|
|
6748
|
-
"sourceFile": "components/
|
|
6749
|
-
"supersededBy": "Slider"
|
|
6622
|
+
"sourceFile": "components/Breadcrumb/Breadcrumb.tsx"
|
|
6750
6623
|
},
|
|
6751
6624
|
{
|
|
6752
|
-
"name": "
|
|
6753
|
-
"category": "
|
|
6625
|
+
"name": "DialBreadcrumbItem",
|
|
6626
|
+
"category": "Navigation",
|
|
6754
6627
|
"generation": "1.0",
|
|
6755
|
-
"description": "
|
|
6628
|
+
"description": "Design system 1.0",
|
|
6756
6629
|
"props": [
|
|
6757
6630
|
{
|
|
6758
|
-
"name": "
|
|
6631
|
+
"name": "label",
|
|
6759
6632
|
"type": "ReactNode",
|
|
6760
|
-
"required":
|
|
6761
|
-
"description": "Custom icon to display (defaults to clipboard icon)"
|
|
6633
|
+
"required": true
|
|
6762
6634
|
},
|
|
6763
6635
|
{
|
|
6764
|
-
"name": "
|
|
6636
|
+
"name": "href",
|
|
6765
6637
|
"type": "string",
|
|
6766
|
-
"required":
|
|
6767
|
-
"description": "The message to display when no data is present"
|
|
6638
|
+
"required": false
|
|
6768
6639
|
},
|
|
6769
6640
|
{
|
|
6770
|
-
"name": "
|
|
6771
|
-
"type": "
|
|
6772
|
-
"required": false
|
|
6773
|
-
"description": "The description to display when no data is present"
|
|
6641
|
+
"name": "onClick",
|
|
6642
|
+
"type": "MouseEventHandler<HTMLAnchorElement>",
|
|
6643
|
+
"required": false
|
|
6774
6644
|
},
|
|
6775
6645
|
{
|
|
6776
|
-
"name": "
|
|
6777
|
-
"type": "
|
|
6778
|
-
"required": false
|
|
6779
|
-
"description": "Additional CSS classes for the container"
|
|
6646
|
+
"name": "disabled",
|
|
6647
|
+
"type": "boolean",
|
|
6648
|
+
"required": false
|
|
6780
6649
|
},
|
|
6781
6650
|
{
|
|
6782
|
-
"name": "
|
|
6783
|
-
"type": "
|
|
6784
|
-
"required": false
|
|
6785
|
-
"description": "Additional CSS classes for the title text"
|
|
6651
|
+
"name": "iconBefore",
|
|
6652
|
+
"type": "ReactNode",
|
|
6653
|
+
"required": false
|
|
6786
6654
|
},
|
|
6787
6655
|
{
|
|
6788
|
-
"name": "
|
|
6656
|
+
"name": "labelClassName",
|
|
6789
6657
|
"type": "string",
|
|
6658
|
+
"required": false
|
|
6659
|
+
},
|
|
6660
|
+
{
|
|
6661
|
+
"name": "isLast",
|
|
6662
|
+
"type": "boolean",
|
|
6663
|
+
"required": false
|
|
6664
|
+
},
|
|
6665
|
+
{
|
|
6666
|
+
"name": "isFirst",
|
|
6667
|
+
"type": "boolean",
|
|
6668
|
+
"required": false
|
|
6669
|
+
},
|
|
6670
|
+
{
|
|
6671
|
+
"name": "separator",
|
|
6672
|
+
"type": "ReactNode",
|
|
6790
6673
|
"required": false,
|
|
6791
|
-
"
|
|
6674
|
+
"defaultValue": "defaultSeparator"
|
|
6675
|
+
},
|
|
6676
|
+
{
|
|
6677
|
+
"name": "onBeforeNavigate",
|
|
6678
|
+
"type": "NavigationGuard",
|
|
6679
|
+
"required": false
|
|
6792
6680
|
}
|
|
6793
6681
|
],
|
|
6794
|
-
"examples": [
|
|
6795
|
-
|
|
6796
|
-
],
|
|
6797
|
-
"sourceFile": "components/NoDataContent/NoDataContent.tsx",
|
|
6798
|
-
"supersededBy": "NoDataContent"
|
|
6682
|
+
"examples": [],
|
|
6683
|
+
"sourceFile": "components/Breadcrumb/BreadcrumbItem.tsx"
|
|
6799
6684
|
},
|
|
6800
6685
|
{
|
|
6801
|
-
"name": "
|
|
6802
|
-
"category": "
|
|
6686
|
+
"name": "DialButton",
|
|
6687
|
+
"category": "Elements/Buttons",
|
|
6803
6688
|
"generation": "1.0",
|
|
6804
|
-
"description": "A
|
|
6689
|
+
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction\nDesign system 1.0",
|
|
6805
6690
|
"props": [
|
|
6806
6691
|
{
|
|
6807
|
-
"name": "
|
|
6808
|
-
"type": "
|
|
6809
|
-
"required":
|
|
6810
|
-
"description": "
|
|
6692
|
+
"name": "variant",
|
|
6693
|
+
"type": "ButtonVariant",
|
|
6694
|
+
"required": false,
|
|
6695
|
+
"description": "Defines the visual style of the button"
|
|
6811
6696
|
},
|
|
6812
6697
|
{
|
|
6813
|
-
"name": "
|
|
6814
|
-
"type": "
|
|
6698
|
+
"name": "size",
|
|
6699
|
+
"type": "ElementSize",
|
|
6815
6700
|
"required": false,
|
|
6816
|
-
"defaultValue": "
|
|
6817
|
-
"description": "
|
|
6701
|
+
"defaultValue": "ElementSize.Standard",
|
|
6702
|
+
"description": "Defines the size of the button"
|
|
6818
6703
|
},
|
|
6819
6704
|
{
|
|
6820
|
-
"name": "
|
|
6821
|
-
"type": "
|
|
6822
|
-
"required":
|
|
6823
|
-
"
|
|
6705
|
+
"name": "appearance",
|
|
6706
|
+
"type": "ButtonAppearance",
|
|
6707
|
+
"required": false,
|
|
6708
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
6709
|
+
"description": "Defines the type of the button"
|
|
6824
6710
|
},
|
|
6825
6711
|
{
|
|
6826
|
-
"name": "
|
|
6712
|
+
"name": "textClassName",
|
|
6827
6713
|
"type": "string",
|
|
6828
6714
|
"required": false,
|
|
6829
|
-
"description": "Additional CSS classes
|
|
6715
|
+
"description": "Additional CSS classes to apply specifically to the button text"
|
|
6830
6716
|
},
|
|
6831
6717
|
{
|
|
6832
|
-
"name": "
|
|
6833
|
-
"type": "
|
|
6718
|
+
"name": "label",
|
|
6719
|
+
"type": "ReactNode",
|
|
6834
6720
|
"required": false,
|
|
6835
|
-
"description": "
|
|
6721
|
+
"description": "The content of the button. Can be any React node."
|
|
6836
6722
|
},
|
|
6837
6723
|
{
|
|
6838
|
-
"name": "
|
|
6839
|
-
"type": "number",
|
|
6840
|
-
"required": false,
|
|
6841
|
-
"defaultValue": "24",
|
|
6842
|
-
"description": "The size of the toggle icons. Defaults to 32"
|
|
6843
|
-
},
|
|
6844
|
-
{
|
|
6845
|
-
"name": "additionalButtons",
|
|
6724
|
+
"name": "iconBefore",
|
|
6846
6725
|
"type": "ReactNode",
|
|
6847
6726
|
"required": false,
|
|
6848
|
-
"description": "
|
|
6727
|
+
"description": "Icon or element to display before the button text"
|
|
6849
6728
|
},
|
|
6850
6729
|
{
|
|
6851
|
-
"name": "
|
|
6852
|
-
"type": "
|
|
6730
|
+
"name": "iconAfter",
|
|
6731
|
+
"type": "ReactNode",
|
|
6853
6732
|
"required": false,
|
|
6854
|
-
"
|
|
6855
|
-
"description": "The stroke width of the toggle icons. Defaults to 1.5"
|
|
6733
|
+
"description": "Icon or element to display after the button text"
|
|
6856
6734
|
},
|
|
6857
6735
|
{
|
|
6858
|
-
"name": "
|
|
6736
|
+
"name": "hideTitleOnMobile",
|
|
6859
6737
|
"type": "boolean",
|
|
6860
6738
|
"required": false,
|
|
6861
|
-
"description": "
|
|
6739
|
+
"description": "Whether to hide the title text on mobile devices"
|
|
6862
6740
|
},
|
|
6863
6741
|
{
|
|
6864
|
-
"name": "
|
|
6865
|
-
"type": "
|
|
6866
|
-
"required": false
|
|
6867
|
-
"description": "Fired when user clicks the toggle in controlled mode, with the next state"
|
|
6742
|
+
"name": "tooltipProps",
|
|
6743
|
+
"type": "TooltipProps",
|
|
6744
|
+
"required": false
|
|
6868
6745
|
}
|
|
6869
6746
|
],
|
|
6870
6747
|
"examples": [
|
|
6871
|
-
"<
|
|
6748
|
+
"<DialButton\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
6749
|
+
"<DialButton\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
6872
6750
|
],
|
|
6873
|
-
"sourceFile": "components/
|
|
6874
|
-
"supersededBy": "
|
|
6751
|
+
"sourceFile": "components/Button/Button.tsx",
|
|
6752
|
+
"supersededBy": "Button"
|
|
6875
6753
|
},
|
|
6876
6754
|
{
|
|
6877
|
-
"name": "
|
|
6878
|
-
"category": "
|
|
6755
|
+
"name": "DialIconButton",
|
|
6756
|
+
"category": "Elements/Buttons",
|
|
6879
6757
|
"generation": "1.0",
|
|
6880
|
-
"description": "A
|
|
6758
|
+
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton\nDesign system 1.0",
|
|
6881
6759
|
"props": [
|
|
6882
6760
|
{
|
|
6883
|
-
"name": "
|
|
6884
|
-
"type": "
|
|
6885
|
-
"required": true,
|
|
6886
|
-
"description": "The main label text for the field"
|
|
6887
|
-
},
|
|
6888
|
-
{
|
|
6889
|
-
"name": "text",
|
|
6890
|
-
"type": "ReactNode",
|
|
6761
|
+
"name": "variant",
|
|
6762
|
+
"type": "ButtonVariant",
|
|
6891
6763
|
"required": false,
|
|
6892
|
-
"description": "
|
|
6764
|
+
"description": "Defines the visual style of the button"
|
|
6893
6765
|
},
|
|
6894
6766
|
{
|
|
6895
|
-
"name": "
|
|
6896
|
-
"type": "
|
|
6767
|
+
"name": "size",
|
|
6768
|
+
"type": "ElementSize",
|
|
6897
6769
|
"required": false,
|
|
6898
|
-
"
|
|
6770
|
+
"defaultValue": "ElementSize.Standard",
|
|
6771
|
+
"description": "Defines the size of the button"
|
|
6899
6772
|
},
|
|
6900
6773
|
{
|
|
6901
|
-
"name": "
|
|
6902
|
-
"type": "
|
|
6774
|
+
"name": "appearance",
|
|
6775
|
+
"type": "ButtonAppearance",
|
|
6903
6776
|
"required": false,
|
|
6904
|
-
"
|
|
6777
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
6778
|
+
"description": "Defines the type of the button"
|
|
6905
6779
|
},
|
|
6906
6780
|
{
|
|
6907
|
-
"name": "
|
|
6781
|
+
"name": "icon",
|
|
6908
6782
|
"type": "ReactNode",
|
|
6909
|
-
"required":
|
|
6910
|
-
"description": "
|
|
6783
|
+
"required": true,
|
|
6784
|
+
"description": "Icon display"
|
|
6911
6785
|
},
|
|
6912
6786
|
{
|
|
6913
|
-
"name": "
|
|
6914
|
-
"type": "
|
|
6915
|
-
"required": false
|
|
6916
|
-
"description": "Additional CSS classes for the container element."
|
|
6787
|
+
"name": "tooltipProps",
|
|
6788
|
+
"type": "TooltipProps",
|
|
6789
|
+
"required": false
|
|
6917
6790
|
}
|
|
6918
6791
|
],
|
|
6919
6792
|
"examples": [
|
|
6920
|
-
"<
|
|
6793
|
+
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
6794
|
+
"<DialIconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
6921
6795
|
],
|
|
6922
|
-
"sourceFile": "components/
|
|
6796
|
+
"sourceFile": "components/IconButton/IconButton.tsx",
|
|
6797
|
+
"supersededBy": "IconButton"
|
|
6923
6798
|
},
|
|
6924
6799
|
{
|
|
6925
|
-
"name": "
|
|
6926
|
-
"category": "
|
|
6800
|
+
"name": "DialDangerButton",
|
|
6801
|
+
"category": "Elements/Buttons",
|
|
6927
6802
|
"generation": "1.0",
|
|
6928
|
-
"description": "A
|
|
6929
|
-
"props": [
|
|
6930
|
-
|
|
6931
|
-
|
|
6932
|
-
"type": "string",
|
|
6933
|
-
"required": true
|
|
6934
|
-
},
|
|
6935
|
-
{
|
|
6936
|
-
"name": "className",
|
|
6937
|
-
"type": "string",
|
|
6938
|
-
"required": false
|
|
6939
|
-
},
|
|
6940
|
-
{
|
|
6941
|
-
"name": "selected",
|
|
6942
|
-
"type": "boolean",
|
|
6943
|
-
"required": false
|
|
6944
|
-
},
|
|
6945
|
-
{
|
|
6946
|
-
"name": "icon",
|
|
6947
|
-
"type": "ReactNode",
|
|
6948
|
-
"required": false
|
|
6949
|
-
},
|
|
6950
|
-
{
|
|
6951
|
-
"name": "closable",
|
|
6952
|
-
"type": "boolean",
|
|
6953
|
-
"required": false
|
|
6954
|
-
},
|
|
6955
|
-
{
|
|
6956
|
-
"name": "onClick",
|
|
6957
|
-
"type": "(event: MouseEvent<HTMLDivElement>) => void",
|
|
6958
|
-
"required": false
|
|
6959
|
-
},
|
|
6960
|
-
{
|
|
6961
|
-
"name": "onRemove",
|
|
6962
|
-
"type": "(event: MouseEvent<HTMLButtonElement>) => void",
|
|
6963
|
-
"required": false
|
|
6964
|
-
}
|
|
6803
|
+
"description": "A Danger Button component with predefined danger variant",
|
|
6804
|
+
"props": [],
|
|
6805
|
+
"examples": [
|
|
6806
|
+
"<DialDangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
6965
6807
|
],
|
|
6966
|
-
"
|
|
6967
|
-
"
|
|
6968
|
-
"supersededBy": "Tag"
|
|
6808
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
6809
|
+
"supersededBy": "DangerButton"
|
|
6969
6810
|
},
|
|
6970
6811
|
{
|
|
6971
|
-
"name": "
|
|
6972
|
-
"category": "
|
|
6812
|
+
"name": "DialNeutralButton",
|
|
6813
|
+
"category": "Elements/Buttons",
|
|
6973
6814
|
"generation": "1.0",
|
|
6974
|
-
"description": "
|
|
6975
|
-
"props": [
|
|
6976
|
-
{
|
|
6977
|
-
"name": "text",
|
|
6978
|
-
"type": "ReactNode",
|
|
6979
|
-
"required": true,
|
|
6980
|
-
"description": "The text or node to display (truncated with ellipsis if too long)."
|
|
6981
|
-
},
|
|
6982
|
-
{
|
|
6983
|
-
"name": "className",
|
|
6984
|
-
"type": "string",
|
|
6985
|
-
"required": false,
|
|
6986
|
-
"description": "Optional additional CSS classes for the text container (e.g. to set width)."
|
|
6987
|
-
},
|
|
6988
|
-
{
|
|
6989
|
-
"name": "contentClassName",
|
|
6990
|
-
"type": "string",
|
|
6991
|
-
"required": false,
|
|
6992
|
-
"description": "Optional additional CSS classes for the tooltip content."
|
|
6993
|
-
},
|
|
6994
|
-
{
|
|
6995
|
-
"name": "hideTooltip",
|
|
6996
|
-
"type": "boolean",
|
|
6997
|
-
"required": false,
|
|
6998
|
-
"description": "If true, disables the tooltip even if text is truncated."
|
|
6999
|
-
},
|
|
7000
|
-
{
|
|
7001
|
-
"name": "id",
|
|
7002
|
-
"type": "string",
|
|
7003
|
-
"required": false,
|
|
7004
|
-
"description": "Optional attribute for unique identification"
|
|
7005
|
-
},
|
|
7006
|
-
{
|
|
7007
|
-
"name": "customTooltipContent",
|
|
7008
|
-
"type": "ReactNode",
|
|
7009
|
-
"required": false,
|
|
7010
|
-
"description": "If provided, this content will be shown in the tooltip instead of the full text when truncated."
|
|
7011
|
-
}
|
|
7012
|
-
],
|
|
6815
|
+
"description": "A Neutral Button component with predefined neutral variant",
|
|
6816
|
+
"props": [],
|
|
7013
6817
|
"examples": [
|
|
7014
|
-
"<
|
|
6818
|
+
"<DialNeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
7015
6819
|
],
|
|
7016
|
-
"sourceFile": "components/
|
|
7017
|
-
"supersededBy": "
|
|
6820
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
6821
|
+
"supersededBy": "NeutralButton"
|
|
7018
6822
|
},
|
|
7019
6823
|
{
|
|
7020
|
-
"name": "
|
|
7021
|
-
"category": "
|
|
6824
|
+
"name": "DialPrimaryButton",
|
|
6825
|
+
"category": "Elements/Buttons",
|
|
7022
6826
|
"generation": "1.0",
|
|
7023
|
-
"description": "A
|
|
7024
|
-
"props": [
|
|
7025
|
-
{
|
|
7026
|
-
"name": "id",
|
|
7027
|
-
"type": "string",
|
|
7028
|
-
"required": true,
|
|
7029
|
-
"description": "Unique identifier of the draggable item"
|
|
7030
|
-
},
|
|
7031
|
-
{
|
|
7032
|
-
"name": "children",
|
|
7033
|
-
"type": "ReactNode",
|
|
7034
|
-
"required": true,
|
|
7035
|
-
"description": "Content rendered within the draggable row"
|
|
7036
|
-
},
|
|
7037
|
-
{
|
|
7038
|
-
"name": "className",
|
|
7039
|
-
"type": "string",
|
|
7040
|
-
"required": false,
|
|
7041
|
-
"description": "Additional CSS classes applied to the root container"
|
|
7042
|
-
},
|
|
7043
|
-
{
|
|
7044
|
-
"name": "ariaLabel",
|
|
7045
|
-
"type": "string",
|
|
7046
|
-
"required": false,
|
|
7047
|
-
"defaultValue": "'Drag item'",
|
|
7048
|
-
"description": "Accessible label for the handle"
|
|
7049
|
-
},
|
|
7050
|
-
{
|
|
7051
|
-
"name": "onFind",
|
|
7052
|
-
"type": "(field: string) => number",
|
|
7053
|
-
"required": false,
|
|
7054
|
-
"description": "Function to resolve an item's current index by id"
|
|
7055
|
-
},
|
|
7056
|
-
{
|
|
7057
|
-
"name": "onMove",
|
|
7058
|
-
"type": "(field: string, atIndex: number) => void",
|
|
7059
|
-
"required": false,
|
|
7060
|
-
"description": "Function to move an item (by id) to a target index"
|
|
7061
|
-
}
|
|
7062
|
-
],
|
|
6827
|
+
"description": "A Primary Button component with predefined primary variant\nDesign system 1.0",
|
|
6828
|
+
"props": [],
|
|
7063
6829
|
"examples": [
|
|
7064
|
-
"<
|
|
6830
|
+
"<DialPrimaryButton\n label=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
7065
6831
|
],
|
|
7066
|
-
"sourceFile": "components/
|
|
6832
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
6833
|
+
"supersededBy": "PrimaryButton"
|
|
7067
6834
|
},
|
|
7068
6835
|
{
|
|
7069
|
-
"name": "
|
|
7070
|
-
"category": "
|
|
6836
|
+
"name": "DialGhostButton",
|
|
6837
|
+
"category": "Elements/Buttons",
|
|
7071
6838
|
"generation": "1.0",
|
|
7072
|
-
"description": "
|
|
7073
|
-
"props": [
|
|
7074
|
-
{
|
|
7075
|
-
"name": "extension",
|
|
7076
|
-
"type": "string",
|
|
7077
|
-
"required": false,
|
|
7078
|
-
"description": "File extension string (with or without leading dot)"
|
|
7079
|
-
},
|
|
7080
|
-
{
|
|
7081
|
-
"name": "size",
|
|
7082
|
-
"type": "number",
|
|
7083
|
-
"required": false,
|
|
7084
|
-
"defaultValue": "BASE_ICON_PROPS.size",
|
|
7085
|
-
"description": "Icon pixel size"
|
|
7086
|
-
},
|
|
7087
|
-
{
|
|
7088
|
-
"name": "stroke",
|
|
7089
|
-
"type": "number",
|
|
7090
|
-
"required": false,
|
|
7091
|
-
"defaultValue": "BASE_ICON_PROPS.stroke",
|
|
7092
|
-
"description": "Tabler icon stroke width"
|
|
7093
|
-
},
|
|
7094
|
-
{
|
|
7095
|
-
"name": "className",
|
|
7096
|
-
"type": "string",
|
|
7097
|
-
"required": false,
|
|
7098
|
-
"description": "Additional classes on the container"
|
|
7099
|
-
},
|
|
7100
|
-
{
|
|
7101
|
-
"name": "decorative",
|
|
7102
|
-
"type": "boolean",
|
|
7103
|
-
"required": false,
|
|
7104
|
-
"defaultValue": "false",
|
|
7105
|
-
"description": "Whether the icon should be hidden from assistive technologies"
|
|
7106
|
-
},
|
|
7107
|
-
{
|
|
7108
|
-
"name": "label",
|
|
7109
|
-
"type": "ReactNode",
|
|
7110
|
-
"required": false,
|
|
7111
|
-
"description": "Accessible label when not decorative; defaults to \"<EXT> file icon\""
|
|
7112
|
-
},
|
|
7113
|
-
{
|
|
7114
|
-
"name": "indicator",
|
|
7115
|
-
"type": "ReactNode",
|
|
7116
|
-
"required": false,
|
|
7117
|
-
"description": "Optional indicator element to display alongside the icon"
|
|
7118
|
-
}
|
|
7119
|
-
],
|
|
6839
|
+
"description": "A Ghost Button component with predefined ghost appearance",
|
|
6840
|
+
"props": [],
|
|
7120
6841
|
"examples": [
|
|
7121
|
-
"<
|
|
6842
|
+
"<DialGhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
7122
6843
|
],
|
|
7123
|
-
"sourceFile": "components/
|
|
7124
|
-
"supersededBy": "
|
|
6844
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
6845
|
+
"supersededBy": "GhostButton"
|
|
7125
6846
|
},
|
|
7126
6847
|
{
|
|
7127
|
-
"name": "
|
|
7128
|
-
"category": "
|
|
7129
|
-
"generation": "1.0",
|
|
7130
|
-
"description": "A
|
|
7131
|
-
"props": [
|
|
7132
|
-
{
|
|
7133
|
-
"name": "id",
|
|
7134
|
-
"type": "string",
|
|
7135
|
-
"required": false,
|
|
7136
|
-
"description": "Unique identifier for the form control element (used for accessibility)"
|
|
7137
|
-
},
|
|
7138
|
-
{
|
|
7139
|
-
"name": "labelVisuallyHidden",
|
|
7140
|
-
"type": "boolean",
|
|
7141
|
-
"required": false,
|
|
7142
|
-
"defaultValue": "false",
|
|
7143
|
-
"description": "Whether to visually hide the label (still accessible to screen readers, default: false)"
|
|
7144
|
-
},
|
|
7145
|
-
{
|
|
7146
|
-
"name": "className",
|
|
7147
|
-
"type": "string",
|
|
7148
|
-
"required": false,
|
|
7149
|
-
"description": "Additional CSS classes to apply to the container div"
|
|
7150
|
-
},
|
|
7151
|
-
{
|
|
7152
|
-
"name": "childrenClassName",
|
|
7153
|
-
"type": "string",
|
|
7154
|
-
"required": false,
|
|
7155
|
-
"description": "Additional CSS classes to apply to the children container div"
|
|
7156
|
-
},
|
|
7157
|
-
{
|
|
7158
|
-
"name": "labelClassName",
|
|
7159
|
-
"type": "string",
|
|
7160
|
-
"required": false,
|
|
7161
|
-
"description": "Additional CSS classes to apply to the label element"
|
|
7162
|
-
},
|
|
7163
|
-
{
|
|
7164
|
-
"name": "errorClassName",
|
|
7165
|
-
"type": "string",
|
|
7166
|
-
"required": false,
|
|
7167
|
-
"description": "Additional CSS classes to apply to the error message element"
|
|
7168
|
-
},
|
|
7169
|
-
{
|
|
7170
|
-
"name": "children",
|
|
7171
|
-
"type": "ReactNode",
|
|
7172
|
-
"required": true,
|
|
7173
|
-
"description": "The form control element(s) to render inside the DialFormItem"
|
|
7174
|
-
},
|
|
7175
|
-
{
|
|
7176
|
-
"name": "value",
|
|
7177
|
-
"type": "ReactNode",
|
|
7178
|
-
"required": false,
|
|
7179
|
-
"description": "The current value of the form control (for readonly mode)"
|
|
7180
|
-
},
|
|
7181
|
-
{
|
|
7182
|
-
"name": "defaultEmptyText",
|
|
7183
|
-
"type": "string",
|
|
7184
|
-
"required": false,
|
|
7185
|
-
"description": "Text to display when readonly and value is empty (default: \"None\")"
|
|
7186
|
-
}
|
|
7187
|
-
],
|
|
7188
|
-
"examples": [
|
|
7189
|
-
"<DialFormItem elementId=\"transport\" label=\"Transport\" className=\"w-[320px]\">\n <DialSelect\n elementId=\"transport\"\n value={transport}\n options={transportOptions}\n onChange={(val) => setTransport(val as ToolsetTransport)}\n />\n</DialFormItem>\n\n// With description and error\n<DialFormItem\n elementId=\"email\"\n label=\"Email Address\"\n description=\"We'll never share your email.\"\n error=\"Please enter a valid email address.\"\n>\n <DialInput\n elementId=\"email\"\n type=\"email\"\n value={email}\n onChange={(val) => setEmail(val as string)}\n placeholder=\"name@company.com\"\n />\n</DialFormItem>"
|
|
7190
|
-
],
|
|
7191
|
-
"sourceFile": "components/FormItem/FormItem.tsx"
|
|
7192
|
-
},
|
|
7193
|
-
{
|
|
7194
|
-
"name": "DialSharedEntityIndicator",
|
|
7195
|
-
"category": "FileManager/components",
|
|
7196
|
-
"generation": "1.0",
|
|
7197
|
-
"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.",
|
|
7198
|
-
"props": [
|
|
7199
|
-
{
|
|
7200
|
-
"name": "label",
|
|
7201
|
-
"type": "ReactNode",
|
|
7202
|
-
"required": false,
|
|
7203
|
-
"defaultValue": "'Shared entity'",
|
|
7204
|
-
"description": "Accessible label for assistive tech"
|
|
7205
|
-
},
|
|
7206
|
-
{
|
|
7207
|
-
"name": "size",
|
|
7208
|
-
"type": "number",
|
|
7209
|
-
"required": false,
|
|
7210
|
-
"defaultValue": "14",
|
|
7211
|
-
"description": "Pixel size for the icon"
|
|
7212
|
-
},
|
|
7213
|
-
{
|
|
7214
|
-
"name": "stroke",
|
|
7215
|
-
"type": "number",
|
|
7216
|
-
"required": false,
|
|
7217
|
-
"defaultValue": "1.5",
|
|
7218
|
-
"description": "Stroke width for the icon"
|
|
7219
|
-
},
|
|
7220
|
-
{
|
|
7221
|
-
"name": "className",
|
|
7222
|
-
"type": "string",
|
|
7223
|
-
"required": false,
|
|
7224
|
-
"description": "Additional Tailwind classes applied to the icon"
|
|
7225
|
-
},
|
|
7226
|
-
{
|
|
7227
|
-
"name": "containerClassName",
|
|
7228
|
-
"type": "string",
|
|
7229
|
-
"required": false,
|
|
7230
|
-
"description": "Additional Tailwind classes appended to the container"
|
|
7231
|
-
},
|
|
7232
|
-
{
|
|
7233
|
-
"name": "sharedIndicatorTooltip",
|
|
7234
|
-
"type": "ReactNode",
|
|
7235
|
-
"required": false,
|
|
7236
|
-
"description": "Custom tooltip content, defaults to \"Shared\""
|
|
7237
|
-
}
|
|
7238
|
-
],
|
|
7239
|
-
"examples": [
|
|
7240
|
-
"<DialSharedEntityIndicator />\n<DialSharedEntityIndicator size={12} label=\"Opens in new window\" />"
|
|
7241
|
-
],
|
|
7242
|
-
"sourceFile": "components/SharedEntityIndicator/SharedEntityIndicator.tsx",
|
|
7243
|
-
"supersededBy": "SharedEntityIndicator"
|
|
7244
|
-
},
|
|
7245
|
-
{
|
|
7246
|
-
"name": "DialFileName",
|
|
7247
|
-
"category": "FileManager/components",
|
|
7248
|
-
"generation": "1.0",
|
|
7249
|
-
"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.",
|
|
7250
|
-
"props": [
|
|
7251
|
-
{
|
|
7252
|
-
"name": "name",
|
|
7253
|
-
"type": "string",
|
|
7254
|
-
"required": true,
|
|
7255
|
-
"description": "Full file name with or without extension."
|
|
7256
|
-
},
|
|
7257
|
-
{
|
|
7258
|
-
"name": "fileExtension",
|
|
7259
|
-
"type": "string",
|
|
7260
|
-
"required": false
|
|
7261
|
-
},
|
|
7262
|
-
{
|
|
7263
|
-
"name": "className",
|
|
7264
|
-
"type": "string",
|
|
7265
|
-
"required": false,
|
|
7266
|
-
"description": "Additional CSS classes for the root container."
|
|
7267
|
-
},
|
|
7268
|
-
{
|
|
7269
|
-
"name": "shared",
|
|
7270
|
-
"type": "boolean",
|
|
7271
|
-
"required": false,
|
|
7272
|
-
"defaultValue": "false",
|
|
7273
|
-
"description": "Whether the file is shared."
|
|
7274
|
-
},
|
|
7275
|
-
{
|
|
7276
|
-
"name": "iconSize",
|
|
7277
|
-
"type": "number",
|
|
7278
|
-
"required": false,
|
|
7279
|
-
"defaultValue": "BASE_ICON_SIZE",
|
|
7280
|
-
"description": "Icon size in px. Default: BASE_ICON_SIZE."
|
|
7281
|
-
},
|
|
7282
|
-
{
|
|
7283
|
-
"name": "details",
|
|
7284
|
-
"type": "ReactNode",
|
|
7285
|
-
"required": false,
|
|
7286
|
-
"description": "Optional metadata block displayed under the file name (e.g., size, modified date)."
|
|
7287
|
-
},
|
|
7288
|
-
{
|
|
7289
|
-
"name": "sharedIndicatorClassName",
|
|
7290
|
-
"type": "string",
|
|
7291
|
-
"required": false,
|
|
7292
|
-
"description": "Additional CSS classes for the shared indicator."
|
|
7293
|
-
},
|
|
7294
|
-
{
|
|
7295
|
-
"name": "sharedIndicatorTooltip",
|
|
7296
|
-
"type": "ReactNode",
|
|
7297
|
-
"required": false,
|
|
7298
|
-
"description": "Custom tooltip content for the shared indicator; defaults to \"Shared\""
|
|
7299
|
-
},
|
|
7300
|
-
{
|
|
7301
|
-
"name": "hideTooltip",
|
|
7302
|
-
"type": "boolean",
|
|
7303
|
-
"required": false,
|
|
7304
|
-
"defaultValue": "false"
|
|
7305
|
-
},
|
|
7306
|
-
{
|
|
7307
|
-
"name": "isInvalidName",
|
|
7308
|
-
"type": "boolean",
|
|
7309
|
-
"required": false,
|
|
7310
|
-
"defaultValue": "false",
|
|
7311
|
-
"description": "If true, applies disabled styling to indicate the file name has invalid characters."
|
|
7312
|
-
},
|
|
7313
|
-
{
|
|
7314
|
-
"name": "tooltipContent",
|
|
7315
|
-
"type": "ReactNode",
|
|
7316
|
-
"required": false,
|
|
7317
|
-
"description": "Custom tooltip content to show when the name is truncated; defaults to showing the full name."
|
|
7318
|
-
}
|
|
7319
|
-
],
|
|
7320
|
-
"examples": [
|
|
7321
|
-
"// Without details\n<DialFileName name=\"Document.pdf\" />\n\n// With details (file size and updated date)\n<DialFileName\n name=\"Document.pdf\"\n details={<span className=\"text-secondary\">24 KB · Jul 20, 2025</span>}\n/>"
|
|
7322
|
-
],
|
|
7323
|
-
"sourceFile": "components/FileName/FileName.tsx",
|
|
7324
|
-
"supersededBy": "FileName"
|
|
7325
|
-
},
|
|
7326
|
-
{
|
|
7327
|
-
"name": "DialFolderName",
|
|
7328
|
-
"category": "FileManager/components",
|
|
7329
|
-
"generation": "1.0",
|
|
7330
|
-
"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.",
|
|
7331
|
-
"props": [
|
|
7332
|
-
{
|
|
7333
|
-
"name": "name",
|
|
7334
|
-
"type": "string",
|
|
7335
|
-
"required": true,
|
|
7336
|
-
"description": "Folder name"
|
|
7337
|
-
},
|
|
7338
|
-
{
|
|
7339
|
-
"name": "shared",
|
|
7340
|
-
"type": "boolean",
|
|
7341
|
-
"required": false,
|
|
7342
|
-
"defaultValue": "false",
|
|
7343
|
-
"description": "If true, shows shared indicator. Default: false."
|
|
7344
|
-
},
|
|
7345
|
-
{
|
|
7346
|
-
"name": "loading",
|
|
7347
|
-
"type": "boolean",
|
|
7348
|
-
"required": false,
|
|
7349
|
-
"defaultValue": "false",
|
|
7350
|
-
"description": "If true, shows loading state. Default: false."
|
|
7351
|
-
},
|
|
7352
|
-
{
|
|
7353
|
-
"name": "iconSize",
|
|
7354
|
-
"type": "number",
|
|
7355
|
-
"required": false,
|
|
7356
|
-
"defaultValue": "BASE_ICON_SIZE",
|
|
7357
|
-
"description": "Icon size in px. Default: BASE_ICON_SIZE."
|
|
7358
|
-
},
|
|
7359
|
-
{
|
|
7360
|
-
"name": "className",
|
|
7361
|
-
"type": "string",
|
|
7362
|
-
"required": false,
|
|
7363
|
-
"description": "Additional CSS classes for the root container"
|
|
7364
|
-
},
|
|
7365
|
-
{
|
|
7366
|
-
"name": "sharedIndicatorClassName",
|
|
7367
|
-
"type": "string",
|
|
7368
|
-
"required": false,
|
|
7369
|
-
"description": "Additional CSS classes for the shared indicator"
|
|
7370
|
-
},
|
|
7371
|
-
{
|
|
7372
|
-
"name": "sharedIndicatorTooltip",
|
|
7373
|
-
"type": "ReactNode",
|
|
7374
|
-
"required": false,
|
|
7375
|
-
"description": "Custom tooltip content for the shared indicator; defaults to \"Shared\""
|
|
7376
|
-
},
|
|
7377
|
-
{
|
|
7378
|
-
"name": "hideTooltip",
|
|
7379
|
-
"type": "boolean",
|
|
7380
|
-
"required": false,
|
|
7381
|
-
"defaultValue": "false",
|
|
7382
|
-
"description": "If true, disables the tooltip even if the name is truncated."
|
|
7383
|
-
},
|
|
7384
|
-
{
|
|
7385
|
-
"name": "isInvalidName",
|
|
7386
|
-
"type": "boolean",
|
|
7387
|
-
"required": false,
|
|
7388
|
-
"defaultValue": "false",
|
|
7389
|
-
"description": "If true, applies disabled styling to indicate the file name has invalid characters."
|
|
7390
|
-
},
|
|
7391
|
-
{
|
|
7392
|
-
"name": "tooltipContent",
|
|
7393
|
-
"type": "ReactNode",
|
|
7394
|
-
"required": false,
|
|
7395
|
-
"description": "Custom tooltip content to show when the name is truncated; defaults to showing the full name."
|
|
7396
|
-
}
|
|
7397
|
-
],
|
|
7398
|
-
"examples": [
|
|
7399
|
-
"<DialFolderName name=\"Organization\" />"
|
|
7400
|
-
],
|
|
7401
|
-
"sourceFile": "components/FolderName/FolderName.tsx",
|
|
7402
|
-
"supersededBy": "FolderName"
|
|
7403
|
-
},
|
|
7404
|
-
{
|
|
7405
|
-
"name": "DialResizableContainer",
|
|
7406
|
-
"category": "Components",
|
|
7407
|
-
"generation": "1.0",
|
|
7408
|
-
"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",
|
|
7409
|
-
"props": [
|
|
7410
|
-
{
|
|
7411
|
-
"name": "children",
|
|
7412
|
-
"type": "ReactNode",
|
|
7413
|
-
"required": true,
|
|
7414
|
-
"description": "Content placed inside the container."
|
|
7415
|
-
},
|
|
7416
|
-
{
|
|
7417
|
-
"name": "minWidth",
|
|
7418
|
-
"type": "number",
|
|
7419
|
-
"required": true,
|
|
7420
|
-
"description": "Minimum allowed width (px)."
|
|
7421
|
-
},
|
|
7422
|
-
{
|
|
7423
|
-
"name": "maxWidth",
|
|
7424
|
-
"type": "number",
|
|
7425
|
-
"required": true,
|
|
7426
|
-
"description": "Maximum allowed width (px)."
|
|
7427
|
-
},
|
|
7428
|
-
{
|
|
7429
|
-
"name": "width",
|
|
7430
|
-
"type": "number",
|
|
7431
|
-
"required": false,
|
|
7432
|
-
"description": "Controlled width. If omitted → uncontrolled mode."
|
|
7433
|
-
},
|
|
7434
|
-
{
|
|
7435
|
-
"name": "defaultWidth",
|
|
7436
|
-
"type": "number",
|
|
7437
|
-
"required": true,
|
|
7438
|
-
"description": "Initial width in uncontrolled mode."
|
|
7439
|
-
},
|
|
7440
|
-
{
|
|
7441
|
-
"name": "onResizeStop",
|
|
7442
|
-
"type": "(width: number) => void",
|
|
7443
|
-
"required": false,
|
|
7444
|
-
"description": "Optional callback fired when resize ends."
|
|
7445
|
-
},
|
|
7446
|
-
{
|
|
7447
|
-
"name": "onResize",
|
|
7448
|
-
"type": "(width: number) => void",
|
|
7449
|
-
"required": false,
|
|
7450
|
-
"description": "Optional callback fired continuously during resizing with current width."
|
|
7451
|
-
},
|
|
7452
|
-
{
|
|
7453
|
-
"name": "side",
|
|
7454
|
-
"type": "ResizableContainerSide",
|
|
7455
|
-
"required": false,
|
|
7456
|
-
"defaultValue": "ResizableContainerSide.Right",
|
|
7457
|
-
"description": "Resize handle side."
|
|
7458
|
-
},
|
|
7459
|
-
{
|
|
7460
|
-
"name": "resizeHandlerClassName",
|
|
7461
|
-
"type": "string",
|
|
7462
|
-
"required": false,
|
|
7463
|
-
"description": "Optional additional CSS classes."
|
|
7464
|
-
},
|
|
7465
|
-
{
|
|
7466
|
-
"name": "resizeHandler",
|
|
7467
|
-
"type": "ReactNode",
|
|
7468
|
-
"required": false,
|
|
7469
|
-
"description": "Optional custom handler element."
|
|
7470
|
-
}
|
|
7471
|
-
],
|
|
7472
|
-
"examples": [],
|
|
7473
|
-
"sourceFile": "components/ResizableContainer/ResizableContainer.tsx",
|
|
7474
|
-
"supersededBy": "ResizableContainer"
|
|
7475
|
-
},
|
|
7476
|
-
{
|
|
7477
|
-
"name": "DialConditionalResizableContainer",
|
|
7478
|
-
"category": "Components",
|
|
7479
|
-
"generation": "1.0",
|
|
7480
|
-
"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.",
|
|
7481
|
-
"props": [
|
|
7482
|
-
{
|
|
7483
|
-
"name": "enabled",
|
|
7484
|
-
"type": "boolean",
|
|
7485
|
-
"required": false,
|
|
7486
|
-
"defaultValue": "true",
|
|
7487
|
-
"description": "Whether resizing is enabled. When false, children are rendered directly."
|
|
7488
|
-
}
|
|
7489
|
-
],
|
|
7490
|
-
"examples": [
|
|
7491
|
-
"<DialConditionalResizableContainer\n enabled={!isCollapsed}\n defaultWidth={260}\n minWidth={180}\n maxWidth={520}\n onResize={(w) => console.log('Current width:', w)}\n onResizeStop={(w) => setSidebarWidth(w)}\n>\n <Sidebar />\n</DialConditionalResizableContainer>"
|
|
7492
|
-
],
|
|
7493
|
-
"sourceFile": "components/ResizableContainer/ConditionalResizableContainer.tsx",
|
|
7494
|
-
"supersededBy": "ConditionalResizableContainer"
|
|
7495
|
-
},
|
|
7496
|
-
{
|
|
7497
|
-
"name": "DialGrid",
|
|
7498
|
-
"category": "Grid",
|
|
7499
|
-
"generation": "1.0",
|
|
7500
|
-
"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",
|
|
7501
|
-
"props": [
|
|
7502
|
-
{
|
|
7503
|
-
"name": "columnDefs",
|
|
7504
|
-
"type": "ColDef<T>[]",
|
|
7505
|
-
"required": false,
|
|
7506
|
-
"description": "Array of column definitions (ag-Grid ColDef format)"
|
|
7507
|
-
},
|
|
7508
|
-
{
|
|
7509
|
-
"name": "rowData",
|
|
7510
|
-
"type": "T[]",
|
|
7511
|
-
"required": false,
|
|
7512
|
-
"description": "Array of data objects to display in the grid"
|
|
7513
|
-
},
|
|
7514
|
-
{
|
|
7515
|
-
"name": "additionalGridOptions",
|
|
7516
|
-
"type": "GridOptions<T>",
|
|
7517
|
-
"required": false,
|
|
7518
|
-
"description": "Additional ag-Grid GridOptions to merge with defaults"
|
|
7519
|
-
},
|
|
7520
|
-
{
|
|
7521
|
-
"name": "getContextMenuItems",
|
|
7522
|
-
"type": "(row: T) => DropdownItem[]",
|
|
7523
|
-
"required": false,
|
|
7524
|
-
"description": "Function returning context menu items for a given row"
|
|
7525
|
-
},
|
|
7526
|
-
{
|
|
7527
|
-
"name": "className",
|
|
7528
|
-
"type": "string",
|
|
7529
|
-
"required": false,
|
|
7530
|
-
"description": "Additional CSS classes to apply to the grid container"
|
|
7531
|
-
},
|
|
7532
|
-
{
|
|
7533
|
-
"name": "ariaLabel",
|
|
7534
|
-
"type": "string",
|
|
7535
|
-
"required": false,
|
|
7536
|
-
"defaultValue": "'Data grid'",
|
|
7537
|
-
"description": "Accessible label for the grid region"
|
|
7538
|
-
},
|
|
7539
|
-
{
|
|
7540
|
-
"name": "wrapCustomCellRenderers",
|
|
7541
|
-
"type": "boolean | ((col: ColDef<T>) => boolean)",
|
|
7542
|
-
"required": false,
|
|
7543
|
-
"defaultValue": "true",
|
|
7544
|
-
"description": "Whether to wrap custom cell renderers with context menu support"
|
|
7545
|
-
},
|
|
7546
|
-
{
|
|
7547
|
-
"name": "disabledRowIds",
|
|
7548
|
-
"type": "Set<string>",
|
|
7549
|
-
"required": false,
|
|
7550
|
-
"description": "Set of row IDs that should be disabled. Disabled rows are non-interactive and cannot be selected. IDs must match values from `getRowId`."
|
|
7551
|
-
},
|
|
7552
|
-
{
|
|
7553
|
-
"name": "selectedRowIds",
|
|
7554
|
-
"type": "Set<string>",
|
|
7555
|
-
"required": false,
|
|
7556
|
-
"description": "Controlled selection: set of row IDs that should be selected"
|
|
7557
|
-
},
|
|
7558
|
-
{
|
|
7559
|
-
"name": "onGridApiChange",
|
|
7560
|
-
"type": "(api: GridApi<T>) => void",
|
|
7561
|
-
"required": false,
|
|
7562
|
-
"description": "Callback invoked when the grid API becomes available"
|
|
7563
|
-
},
|
|
7564
|
-
{
|
|
7565
|
-
"name": "onSelectionChange",
|
|
7566
|
-
"type": "(selectedRowIds: Set<string>, selectedRows: T[]) => void",
|
|
7567
|
-
"required": false,
|
|
7568
|
-
"description": "Callback invoked when selection changes (selectedIds, selectedRows)"
|
|
7569
|
-
},
|
|
7570
|
-
{
|
|
7571
|
-
"name": "getRowId",
|
|
7572
|
-
"type": "(row: T) => string",
|
|
7573
|
-
"required": false,
|
|
7574
|
-
"defaultValue": "(row: T) =>\n String((row as Record<string, unknown>).id ?? JSON.stringify(row))",
|
|
7575
|
-
"description": "Function to extract unique ID from a row object (defaults to 'id' field)"
|
|
7576
|
-
},
|
|
7577
|
-
{
|
|
7578
|
-
"name": "alternateOddRowColors",
|
|
7579
|
-
"type": "boolean",
|
|
7580
|
-
"required": false,
|
|
7581
|
-
"defaultValue": "false",
|
|
7582
|
-
"description": "Whether to alternate background colors for odd/even rows"
|
|
7583
|
-
},
|
|
7584
|
-
{
|
|
7585
|
-
"name": "filterPlaceholder",
|
|
7586
|
-
"type": "string",
|
|
7587
|
-
"required": false,
|
|
7588
|
-
"defaultValue": "'Enter value'",
|
|
7589
|
-
"description": "Placeholder text for column filter inputs"
|
|
7590
|
-
},
|
|
7591
|
-
{
|
|
7592
|
-
"name": "emptyStateIcon",
|
|
7593
|
-
"type": "ReactNode",
|
|
7594
|
-
"required": false,
|
|
7595
|
-
"description": "Optional icon for empty state"
|
|
7596
|
-
},
|
|
7597
|
-
{
|
|
7598
|
-
"name": "emptyStateTitle",
|
|
7599
|
-
"type": "string",
|
|
7600
|
-
"required": false,
|
|
7601
|
-
"defaultValue": "'No results found'",
|
|
7602
|
-
"description": "Optional title text displayed when the grid has no rows to show."
|
|
7603
|
-
},
|
|
7604
|
-
{
|
|
7605
|
-
"name": "emptyStateDescription",
|
|
7606
|
-
"type": "string",
|
|
7607
|
-
"required": false,
|
|
7608
|
-
"defaultValue": "\"Sorry, we couldn't find any results for your search.\"",
|
|
7609
|
-
"description": "Optional description text displayed below the empty state title,\nproviding additional context or instructions (e.g., \"No data found\" or \"Try adjusting your filters\")."
|
|
7610
|
-
},
|
|
7611
|
-
{
|
|
7612
|
-
"name": "loading",
|
|
7613
|
-
"type": "boolean",
|
|
7614
|
-
"required": false,
|
|
7615
|
-
"defaultValue": "false",
|
|
7616
|
-
"description": "When true, shows AG-Grid's native loading overlay"
|
|
7617
|
-
},
|
|
7618
|
-
{
|
|
7619
|
-
"name": "wrapperBorder",
|
|
7620
|
-
"type": "boolean",
|
|
7621
|
-
"required": false,
|
|
7622
|
-
"defaultValue": "true",
|
|
7623
|
-
"description": "Whether to apply a border around the grid container"
|
|
7624
|
-
},
|
|
7625
|
-
{
|
|
7626
|
-
"name": "withoutHeaderBorders",
|
|
7627
|
-
"type": "boolean",
|
|
7628
|
-
"required": false,
|
|
7629
|
-
"defaultValue": "false",
|
|
7630
|
-
"description": "Whether to hide the header row borders"
|
|
7631
|
-
},
|
|
7632
|
-
{
|
|
7633
|
-
"name": "selectionMode",
|
|
7634
|
-
"type": "GridSelectionMode",
|
|
7635
|
-
"required": false,
|
|
7636
|
-
"description": "Could be GridSelectionMode.MULTIPLE or GridSelectionMode.SINGLE to enable selection column"
|
|
7637
|
-
},
|
|
7638
|
-
{
|
|
7639
|
-
"name": "allowDisabledContextMenu",
|
|
7640
|
-
"type": "boolean",
|
|
7641
|
-
"required": false,
|
|
7642
|
-
"defaultValue": "false",
|
|
7643
|
-
"description": "Enables context menu actions even if row itself is disabled for selection"
|
|
7644
|
-
}
|
|
7645
|
-
],
|
|
7646
|
-
"examples": [
|
|
7647
|
-
"// Basic usage with data\ninterface Product {\n id: string;\n name: string;\n price: number;\n}\n\nconst columns: ColDef<Product>[] = [\n { field: 'name', headerName: 'Product Name', flex: 1 },\n { field: 'price', headerName: 'Price', width: 120 },\n];\n\n<DialGrid<Product>\n columnDefs={columns}\n rowData={products}\n/>\n\n// With loading state\n<DialGrid<Product>\n columnDefs={columns}\n rowData={products}\n loading={true}\n/>\n\n// With context menu\nconst getContextMenu = (row: Product): DropdownItem[] => [\n { key: 'edit', label: 'Edit' },\n { key: 'delete', label: 'Delete', danger: true },\n];\n\n<DialGrid<Product>\n columnDefs={columns}\n rowData={products}\n getContextMenuItems={getContextMenu}\n/>\n\n// Controlled selection\nconst [selectedIds, setSelectedIds] = useState<Set<string>>(new Set());\n\n<DialGrid<Product>\n columnDefs={columns}\n rowData={products}\n selectedRowIds={selectedIds}\n onSelectionChange={(ids, rows) => {\n setSelectedIds(ids);\n console.log('Selected:', rows);\n }}\n/>"
|
|
7648
|
-
],
|
|
7649
|
-
"sourceFile": "components/Grid/Grid.tsx",
|
|
7650
|
-
"supersededBy": "Grid"
|
|
7651
|
-
},
|
|
7652
|
-
{
|
|
7653
|
-
"name": "DialDateCellRenderer",
|
|
7654
|
-
"category": "Grid",
|
|
7655
|
-
"generation": "1.0",
|
|
7656
|
-
"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).",
|
|
7657
|
-
"props": [
|
|
7658
|
-
{
|
|
7659
|
-
"name": "value",
|
|
7660
|
-
"type": "DateValue | null",
|
|
7661
|
-
"required": false
|
|
7662
|
-
},
|
|
7663
|
-
{
|
|
7664
|
-
"name": "locale",
|
|
7665
|
-
"type": "string",
|
|
7666
|
-
"required": false,
|
|
7667
|
-
"defaultValue": "DEFAULT_LOCALE",
|
|
7668
|
-
"description": "Locale fixed to U.S. English by default to enforce \"Jul 20, 2025\"."
|
|
7669
|
-
},
|
|
7670
|
-
{
|
|
7671
|
-
"name": "options",
|
|
7672
|
-
"type": "Intl.DateTimeFormatOptions",
|
|
7673
|
-
"required": false,
|
|
7674
|
-
"defaultValue": "DEFAULT_DATE_FORMAT_OPTIONS",
|
|
7675
|
-
"description": "Options for date formatting (e.g., timeZone)."
|
|
7676
|
-
},
|
|
7677
|
-
{
|
|
7678
|
-
"name": "emptyPlaceholder",
|
|
7679
|
-
"type": "string",
|
|
7680
|
-
"required": false,
|
|
7681
|
-
"description": "Placeholder when value is empty/invalid."
|
|
7682
|
-
},
|
|
7683
|
-
{
|
|
7684
|
-
"name": "className",
|
|
7685
|
-
"type": "string",
|
|
7686
|
-
"required": false,
|
|
7687
|
-
"description": "Additional classes merged into the wrapper."
|
|
7688
|
-
},
|
|
7689
|
-
{
|
|
7690
|
-
"name": "hideTooltip",
|
|
7691
|
-
"type": "boolean",
|
|
7692
|
-
"required": false,
|
|
7693
|
-
"defaultValue": "false"
|
|
7694
|
-
}
|
|
7695
|
-
],
|
|
7696
|
-
"examples": [
|
|
7697
|
-
"// 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"
|
|
7698
|
-
],
|
|
7699
|
-
"sourceFile": "components/Grid/renderers/DateCellRenderer.tsx",
|
|
7700
|
-
"supersededBy": "DateCellRenderer"
|
|
7701
|
-
},
|
|
7702
|
-
{
|
|
7703
|
-
"name": "DialTabs",
|
|
7704
|
-
"category": "Navigation",
|
|
7705
|
-
"generation": "1.0",
|
|
7706
|
-
"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.",
|
|
7707
|
-
"props": [
|
|
7708
|
-
{
|
|
7709
|
-
"name": "tabs",
|
|
7710
|
-
"type": "TabModel[]",
|
|
7711
|
-
"required": true,
|
|
7712
|
-
"description": "Array of tab models to render. Each tab must include an `id` and a display `name`."
|
|
7713
|
-
},
|
|
7714
|
-
{
|
|
7715
|
-
"name": "activeTab",
|
|
7716
|
-
"type": "string",
|
|
7717
|
-
"required": true,
|
|
7718
|
-
"description": "The identifier of the currently active tab."
|
|
7719
|
-
},
|
|
7720
|
-
{
|
|
7721
|
-
"name": "onClick",
|
|
7722
|
-
"type": "(id: string) => void",
|
|
7723
|
-
"required": true,
|
|
7724
|
-
"description": "Callback fired when a tab is selected. Receives the tab's `id` as an argument."
|
|
7725
|
-
},
|
|
7726
|
-
{
|
|
7727
|
-
"name": "orientation",
|
|
7728
|
-
"type": "TabOrientation",
|
|
7729
|
-
"required": false,
|
|
7730
|
-
"defaultValue": "TabOrientation.Horizontal",
|
|
7731
|
-
"description": "Layout direction of the tabs. Uses the enum."
|
|
7732
|
-
},
|
|
7733
|
-
{
|
|
7734
|
-
"name": "view",
|
|
7735
|
-
"type": "TabView",
|
|
7736
|
-
"required": false,
|
|
7737
|
-
"defaultValue": "TabView.Default",
|
|
7738
|
-
"description": "Visual style of the tabs. Uses the enum.\n`Inline` renders a compact segmented control where the active tab is marked with a\nleading check icon. The inline view is not responsive and ignores overflow/dropdown logic."
|
|
7739
|
-
},
|
|
7740
|
-
{
|
|
7741
|
-
"name": "className",
|
|
7742
|
-
"type": "string",
|
|
7743
|
-
"required": false
|
|
7744
|
-
},
|
|
7745
|
-
{
|
|
7746
|
-
"name": "screenThreshold",
|
|
7747
|
-
"type": "ScreenResolution",
|
|
7748
|
-
"required": false,
|
|
7749
|
-
"defaultValue": "ScreenResolution.Tablet",
|
|
7750
|
-
"description": "Defines the screen size threshold\nbelow which tabs collapse into a dropdown. Uses the enum.\nWhen set to `Tablet`, both mobile and tablet screens will trigger dropdown mode."
|
|
7751
|
-
},
|
|
7752
|
-
{
|
|
7753
|
-
"name": "smallScreenContainerClassName",
|
|
7754
|
-
"type": "string",
|
|
7755
|
-
"required": false,
|
|
7756
|
-
"description": "Optional CSS class applied to the dropdown container\nin small-screen (collapsed) mode."
|
|
7757
|
-
},
|
|
7758
|
-
{
|
|
7759
|
-
"name": "smallScreenDropdownItemClassName",
|
|
7760
|
-
"type": "string",
|
|
7761
|
-
"required": false,
|
|
7762
|
-
"description": "Optional CSS class applied to individual dropdown\nitems in small-screen mode."
|
|
7763
|
-
},
|
|
7764
|
-
{
|
|
7765
|
-
"name": "desktopDropdownClassName",
|
|
7766
|
-
"type": "string",
|
|
7767
|
-
"required": false,
|
|
7768
|
-
"description": "Optional CSS class applied to dropdown button in non small-screen mode."
|
|
7769
|
-
},
|
|
7770
|
-
{
|
|
7771
|
-
"name": "desktopTabClassName",
|
|
7772
|
-
"type": "string",
|
|
7773
|
-
"required": false,
|
|
7774
|
-
"description": "Optional CSS class applied to tab in non small-screed mode."
|
|
7775
|
-
},
|
|
7776
|
-
{
|
|
7777
|
-
"name": "inlineContainerClassName",
|
|
7778
|
-
"type": "string",
|
|
7779
|
-
"required": false
|
|
7780
|
-
},
|
|
7781
|
-
{
|
|
7782
|
-
"name": "inlineTabClassName",
|
|
7783
|
-
"type": "string",
|
|
7784
|
-
"required": false
|
|
7785
|
-
}
|
|
7786
|
-
],
|
|
7787
|
-
"examples": [
|
|
7788
|
-
"<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/>"
|
|
7789
|
-
],
|
|
7790
|
-
"sourceFile": "components/Tabs/Tabs.tsx",
|
|
7791
|
-
"supersededBy": "Tabs"
|
|
7792
|
-
},
|
|
7793
|
-
{
|
|
7794
|
-
"name": "DialBreadcrumb",
|
|
7795
|
-
"category": "Navigation",
|
|
7796
|
-
"generation": "1.0",
|
|
7797
|
-
"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.",
|
|
7798
|
-
"props": [
|
|
7799
|
-
{
|
|
7800
|
-
"name": "pathItems",
|
|
7801
|
-
"type": "DialBreadcrumbPathItem[]",
|
|
7802
|
-
"required": false,
|
|
7803
|
-
"description": "Array of breadcrumb pathItems (see `DialBreadcrumbItem`)."
|
|
7804
|
-
},
|
|
7805
|
-
{
|
|
7806
|
-
"name": "separator",
|
|
7807
|
-
"type": "ReactNode",
|
|
7808
|
-
"required": false,
|
|
7809
|
-
"defaultValue": "defaultSeparator",
|
|
7810
|
-
"description": "Custom separator node (default: right chevron icon)."
|
|
7811
|
-
},
|
|
7812
|
-
{
|
|
7813
|
-
"name": "ariaLabel",
|
|
7814
|
-
"type": "string",
|
|
7815
|
-
"required": false,
|
|
7816
|
-
"defaultValue": "'Breadcrumb'",
|
|
7817
|
-
"description": "Aria label for the `<nav>` element (default: \"Breadcrumb\")."
|
|
7818
|
-
},
|
|
7819
|
-
{
|
|
7820
|
-
"name": "className",
|
|
7821
|
-
"type": "string",
|
|
7822
|
-
"required": false,
|
|
7823
|
-
"description": "Additional CSS classes for the `<nav>` container."
|
|
7824
|
-
},
|
|
7825
|
-
{
|
|
7826
|
-
"name": "children",
|
|
7827
|
-
"type": "ReactNode",
|
|
7828
|
-
"required": false,
|
|
7829
|
-
"description": "Alternatively, compose with `<DialBreadcrumbItem/>` as children."
|
|
7830
|
-
},
|
|
7831
|
-
{
|
|
7832
|
-
"name": "labelClassName",
|
|
7833
|
-
"type": "string",
|
|
7834
|
-
"required": false,
|
|
7835
|
-
"description": "Additional CSS classes applied to each item when using `pathItems` prop."
|
|
7836
|
-
},
|
|
7837
|
-
{
|
|
7838
|
-
"name": "onBeforeNavigate",
|
|
7839
|
-
"type": "NavigationGuard",
|
|
7840
|
-
"required": false,
|
|
7841
|
-
"description": "Navigation guard called before navigating to a breadcrumb item.\nGuard function called before navigating to a different breadcrumb item.\nReturn `true` to allow navigation, `false` to prevent it.\nCan return a Promise for async checks (e.g., showing a confirmation dialog)."
|
|
7842
|
-
}
|
|
7843
|
-
],
|
|
7844
|
-
"examples": [
|
|
7845
|
-
"<DialBreadcrumb\n pathItems={[\n { label: 'Home', href: '/' },\n { label: 'Section', href: '/section' },\n { label: 'Current Page' },\n ]}\n/>\n\n<DialBreadcrumb>\n <DialBreadcrumbItem label=\"Home\" href=\"/\" />\n <DialBreadcrumbItem label=\"Section\" href=\"/section\" />\n <DialBreadcrumbItem label=\"Current Page\" />\n</DialBreadcrumb>",
|
|
7846
|
-
"<DialBreadcrumb\n pathItems={items}\n onBeforeNavigate={async () => {\n if (hasUnsavedChanges) {\n return await confirmLeave();\n }\n return true;\n }}\n />"
|
|
7847
|
-
],
|
|
7848
|
-
"sourceFile": "components/Breadcrumb/Breadcrumb.tsx"
|
|
7849
|
-
},
|
|
7850
|
-
{
|
|
7851
|
-
"name": "DialBreadcrumbItem",
|
|
7852
|
-
"category": "Navigation",
|
|
7853
|
-
"generation": "1.0",
|
|
7854
|
-
"description": "Design system 1.0",
|
|
7855
|
-
"props": [
|
|
7856
|
-
{
|
|
7857
|
-
"name": "label",
|
|
7858
|
-
"type": "ReactNode",
|
|
7859
|
-
"required": true
|
|
7860
|
-
},
|
|
7861
|
-
{
|
|
7862
|
-
"name": "href",
|
|
7863
|
-
"type": "string",
|
|
7864
|
-
"required": false
|
|
7865
|
-
},
|
|
7866
|
-
{
|
|
7867
|
-
"name": "onClick",
|
|
7868
|
-
"type": "MouseEventHandler<HTMLAnchorElement>",
|
|
7869
|
-
"required": false
|
|
7870
|
-
},
|
|
7871
|
-
{
|
|
7872
|
-
"name": "disabled",
|
|
7873
|
-
"type": "boolean",
|
|
7874
|
-
"required": false
|
|
7875
|
-
},
|
|
7876
|
-
{
|
|
7877
|
-
"name": "iconBefore",
|
|
7878
|
-
"type": "ReactNode",
|
|
7879
|
-
"required": false
|
|
7880
|
-
},
|
|
7881
|
-
{
|
|
7882
|
-
"name": "labelClassName",
|
|
7883
|
-
"type": "string",
|
|
7884
|
-
"required": false
|
|
7885
|
-
},
|
|
7886
|
-
{
|
|
7887
|
-
"name": "isLast",
|
|
7888
|
-
"type": "boolean",
|
|
7889
|
-
"required": false
|
|
7890
|
-
},
|
|
7891
|
-
{
|
|
7892
|
-
"name": "isFirst",
|
|
7893
|
-
"type": "boolean",
|
|
7894
|
-
"required": false
|
|
7895
|
-
},
|
|
7896
|
-
{
|
|
7897
|
-
"name": "separator",
|
|
7898
|
-
"type": "ReactNode",
|
|
7899
|
-
"required": false,
|
|
7900
|
-
"defaultValue": "defaultSeparator"
|
|
7901
|
-
},
|
|
7902
|
-
{
|
|
7903
|
-
"name": "onBeforeNavigate",
|
|
7904
|
-
"type": "NavigationGuard",
|
|
7905
|
-
"required": false
|
|
7906
|
-
}
|
|
7907
|
-
],
|
|
7908
|
-
"examples": [],
|
|
7909
|
-
"sourceFile": "components/Breadcrumb/BreadcrumbItem.tsx"
|
|
7910
|
-
},
|
|
7911
|
-
{
|
|
7912
|
-
"name": "DialButton",
|
|
7913
|
-
"category": "Elements/Buttons",
|
|
7914
|
-
"generation": "1.0",
|
|
7915
|
-
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction\nDesign system 1.0",
|
|
7916
|
-
"props": [
|
|
7917
|
-
{
|
|
7918
|
-
"name": "variant",
|
|
7919
|
-
"type": "ButtonVariant",
|
|
7920
|
-
"required": false,
|
|
7921
|
-
"description": "Defines the visual style of the button"
|
|
7922
|
-
},
|
|
7923
|
-
{
|
|
7924
|
-
"name": "size",
|
|
7925
|
-
"type": "ElementSize",
|
|
7926
|
-
"required": false,
|
|
7927
|
-
"defaultValue": "ElementSize.Standard",
|
|
7928
|
-
"description": "Defines the size of the button"
|
|
7929
|
-
},
|
|
7930
|
-
{
|
|
7931
|
-
"name": "appearance",
|
|
7932
|
-
"type": "ButtonAppearance",
|
|
7933
|
-
"required": false,
|
|
7934
|
-
"defaultValue": "ButtonAppearance.Solid",
|
|
7935
|
-
"description": "Defines the type of the button"
|
|
7936
|
-
},
|
|
7937
|
-
{
|
|
7938
|
-
"name": "textClassName",
|
|
7939
|
-
"type": "string",
|
|
7940
|
-
"required": false,
|
|
7941
|
-
"description": "Additional CSS classes to apply specifically to the button text"
|
|
7942
|
-
},
|
|
7943
|
-
{
|
|
7944
|
-
"name": "label",
|
|
7945
|
-
"type": "ReactNode",
|
|
7946
|
-
"required": false,
|
|
7947
|
-
"description": "The content of the button. Can be any React node."
|
|
7948
|
-
},
|
|
7949
|
-
{
|
|
7950
|
-
"name": "iconBefore",
|
|
7951
|
-
"type": "ReactNode",
|
|
7952
|
-
"required": false,
|
|
7953
|
-
"description": "Icon or element to display before the button text"
|
|
7954
|
-
},
|
|
7955
|
-
{
|
|
7956
|
-
"name": "iconAfter",
|
|
7957
|
-
"type": "ReactNode",
|
|
7958
|
-
"required": false,
|
|
7959
|
-
"description": "Icon or element to display after the button text"
|
|
7960
|
-
},
|
|
7961
|
-
{
|
|
7962
|
-
"name": "hideTitleOnMobile",
|
|
7963
|
-
"type": "boolean",
|
|
7964
|
-
"required": false,
|
|
7965
|
-
"description": "Whether to hide the title text on mobile devices"
|
|
7966
|
-
},
|
|
7967
|
-
{
|
|
7968
|
-
"name": "tooltipProps",
|
|
7969
|
-
"type": "TooltipProps",
|
|
7970
|
-
"required": false
|
|
7971
|
-
}
|
|
7972
|
-
],
|
|
7973
|
-
"examples": [
|
|
7974
|
-
"<DialButton\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
7975
|
-
"<DialButton\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
7976
|
-
],
|
|
7977
|
-
"sourceFile": "components/Button/Button.tsx",
|
|
7978
|
-
"supersededBy": "Button"
|
|
7979
|
-
},
|
|
7980
|
-
{
|
|
7981
|
-
"name": "DialIconButton",
|
|
7982
|
-
"category": "Elements/Buttons",
|
|
7983
|
-
"generation": "1.0",
|
|
7984
|
-
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton\nDesign system 1.0",
|
|
7985
|
-
"props": [
|
|
7986
|
-
{
|
|
7987
|
-
"name": "variant",
|
|
7988
|
-
"type": "ButtonVariant",
|
|
7989
|
-
"required": false,
|
|
7990
|
-
"description": "Defines the visual style of the button"
|
|
7991
|
-
},
|
|
7992
|
-
{
|
|
7993
|
-
"name": "size",
|
|
7994
|
-
"type": "ElementSize",
|
|
7995
|
-
"required": false,
|
|
7996
|
-
"defaultValue": "ElementSize.Standard",
|
|
7997
|
-
"description": "Defines the size of the button"
|
|
7998
|
-
},
|
|
7999
|
-
{
|
|
8000
|
-
"name": "appearance",
|
|
8001
|
-
"type": "ButtonAppearance",
|
|
8002
|
-
"required": false,
|
|
8003
|
-
"defaultValue": "ButtonAppearance.Solid",
|
|
8004
|
-
"description": "Defines the type of the button"
|
|
8005
|
-
},
|
|
8006
|
-
{
|
|
8007
|
-
"name": "icon",
|
|
8008
|
-
"type": "ReactNode",
|
|
8009
|
-
"required": true,
|
|
8010
|
-
"description": "Icon display"
|
|
8011
|
-
},
|
|
8012
|
-
{
|
|
8013
|
-
"name": "tooltipProps",
|
|
8014
|
-
"type": "TooltipProps",
|
|
8015
|
-
"required": false
|
|
8016
|
-
}
|
|
8017
|
-
],
|
|
8018
|
-
"examples": [
|
|
8019
|
-
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
8020
|
-
"<DialIconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
8021
|
-
],
|
|
8022
|
-
"sourceFile": "components/IconButton/IconButton.tsx",
|
|
8023
|
-
"supersededBy": "IconButton"
|
|
8024
|
-
},
|
|
8025
|
-
{
|
|
8026
|
-
"name": "DialDangerButton",
|
|
8027
|
-
"category": "Elements/Buttons",
|
|
8028
|
-
"generation": "1.0",
|
|
8029
|
-
"description": "A Danger Button component with predefined danger variant",
|
|
8030
|
-
"props": [],
|
|
8031
|
-
"examples": [
|
|
8032
|
-
"<DialDangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
8033
|
-
],
|
|
8034
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
8035
|
-
"supersededBy": "DangerButton"
|
|
8036
|
-
},
|
|
8037
|
-
{
|
|
8038
|
-
"name": "DialNeutralButton",
|
|
8039
|
-
"category": "Elements/Buttons",
|
|
8040
|
-
"generation": "1.0",
|
|
8041
|
-
"description": "A Neutral Button component with predefined neutral variant",
|
|
8042
|
-
"props": [],
|
|
8043
|
-
"examples": [
|
|
8044
|
-
"<DialNeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8045
|
-
],
|
|
8046
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
8047
|
-
"supersededBy": "NeutralButton"
|
|
8048
|
-
},
|
|
8049
|
-
{
|
|
8050
|
-
"name": "DialPrimaryButton",
|
|
8051
|
-
"category": "Elements/Buttons",
|
|
8052
|
-
"generation": "1.0",
|
|
8053
|
-
"description": "A Primary Button component with predefined primary variant\nDesign system 1.0",
|
|
8054
|
-
"props": [],
|
|
8055
|
-
"examples": [
|
|
8056
|
-
"<DialPrimaryButton\n label=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
8057
|
-
],
|
|
8058
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
8059
|
-
"supersededBy": "PrimaryButton"
|
|
8060
|
-
},
|
|
8061
|
-
{
|
|
8062
|
-
"name": "DialGhostButton",
|
|
8063
|
-
"category": "Elements/Buttons",
|
|
8064
|
-
"generation": "1.0",
|
|
8065
|
-
"description": "A Ghost Button component with predefined ghost appearance",
|
|
8066
|
-
"props": [],
|
|
8067
|
-
"examples": [
|
|
8068
|
-
"<DialGhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8069
|
-
],
|
|
8070
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
8071
|
-
"supersededBy": "GhostButton"
|
|
8072
|
-
},
|
|
8073
|
-
{
|
|
8074
|
-
"name": "DialLinkButton",
|
|
8075
|
-
"category": "Elements/Buttons",
|
|
8076
|
-
"generation": "1.0",
|
|
8077
|
-
"description": "A Link Button component with predefined link appearance",
|
|
8078
|
-
"props": [],
|
|
8079
|
-
"examples": [
|
|
8080
|
-
"<DialLinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8081
|
-
],
|
|
8082
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
8083
|
-
"supersededBy": "LinkButton"
|
|
8084
|
-
},
|
|
8085
|
-
{
|
|
8086
|
-
"name": "DialDangerIconButton",
|
|
8087
|
-
"category": "Elements/Buttons",
|
|
8088
|
-
"generation": "1.0",
|
|
8089
|
-
"description": "A Danger Icon Button component with predefined danger variant",
|
|
8090
|
-
"props": [],
|
|
8091
|
-
"examples": [
|
|
8092
|
-
"<DialDangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8093
|
-
],
|
|
8094
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
8095
|
-
"supersededBy": "DangerIconButton"
|
|
8096
|
-
},
|
|
8097
|
-
{
|
|
8098
|
-
"name": "DialGhostIconButton",
|
|
8099
|
-
"category": "Elements/Buttons",
|
|
8100
|
-
"generation": "1.0",
|
|
8101
|
-
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
8102
|
-
"props": [],
|
|
8103
|
-
"examples": [
|
|
8104
|
-
"<DialGhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8105
|
-
],
|
|
8106
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
8107
|
-
"supersededBy": "GhostIconButton"
|
|
8108
|
-
},
|
|
8109
|
-
{
|
|
8110
|
-
"name": "DialNeutralIconButton",
|
|
8111
|
-
"category": "Elements/Buttons",
|
|
8112
|
-
"generation": "1.0",
|
|
8113
|
-
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
8114
|
-
"props": [],
|
|
8115
|
-
"examples": [
|
|
8116
|
-
"<DialNeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8117
|
-
],
|
|
8118
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
8119
|
-
"supersededBy": "NeutralIconButton"
|
|
8120
|
-
},
|
|
8121
|
-
{
|
|
8122
|
-
"name": "DialPrimaryIconButton",
|
|
8123
|
-
"category": "Elements/Buttons",
|
|
8124
|
-
"generation": "1.0",
|
|
8125
|
-
"description": "A Primary Icon Button component with predefined primary variant\nDesign system 1.0",
|
|
8126
|
-
"props": [],
|
|
8127
|
-
"examples": [
|
|
8128
|
-
"<DialPrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8129
|
-
],
|
|
8130
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
8131
|
-
"supersededBy": "PrimaryIconButton"
|
|
8132
|
-
},
|
|
8133
|
-
{
|
|
8134
|
-
"name": "DialSecondaryIconButton",
|
|
8135
|
-
"category": "Elements/Buttons",
|
|
8136
|
-
"generation": "1.0",
|
|
8137
|
-
"description": "A Secondary Icon Button component with predefined secondary variant",
|
|
8138
|
-
"props": [],
|
|
8139
|
-
"examples": [
|
|
8140
|
-
"<DialSecondaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8141
|
-
],
|
|
8142
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
8143
|
-
},
|
|
8144
|
-
{
|
|
8145
|
-
"name": "DialSuccessIconButton",
|
|
8146
|
-
"category": "Elements/Buttons",
|
|
8147
|
-
"generation": "1.0",
|
|
8148
|
-
"description": "A Success Icon Button component with predefined success variant",
|
|
8149
|
-
"props": [],
|
|
8150
|
-
"examples": [
|
|
8151
|
-
"<DialSuccessIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8152
|
-
],
|
|
8153
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
8154
|
-
},
|
|
8155
|
-
{
|
|
8156
|
-
"name": "DialTertiaryIconButton",
|
|
8157
|
-
"category": "Elements/Buttons",
|
|
8158
|
-
"generation": "1.0",
|
|
8159
|
-
"description": "A Tertiary Icon Button component with predefined tertiary variant",
|
|
8160
|
-
"props": [],
|
|
8161
|
-
"examples": [
|
|
8162
|
-
"<DialTertiaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8163
|
-
],
|
|
8164
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
8165
|
-
},
|
|
8166
|
-
{
|
|
8167
|
-
"name": "DialCloseButton",
|
|
8168
|
-
"category": "Elements/Buttons",
|
|
8169
|
-
"generation": "1.0",
|
|
8170
|
-
"description": "A Close button component with a customizable icon and accessible label.\naliases: DismissButton|ExitButton\nDesign system 1.0",
|
|
8171
|
-
"props": [
|
|
8172
|
-
{
|
|
8173
|
-
"name": "ariaLabel",
|
|
8174
|
-
"type": "string",
|
|
8175
|
-
"required": false,
|
|
8176
|
-
"description": "Accessible label for screen readers"
|
|
8177
|
-
},
|
|
8178
|
-
{
|
|
8179
|
-
"name": "className",
|
|
8180
|
-
"type": "string",
|
|
8181
|
-
"required": false,
|
|
8182
|
-
"description": "Additional CSS classes to apply to the button"
|
|
8183
|
-
},
|
|
8184
|
-
{
|
|
8185
|
-
"name": "size",
|
|
8186
|
-
"type": "number",
|
|
8187
|
-
"required": false,
|
|
8188
|
-
"defaultValue": "24",
|
|
8189
|
-
"description": "Size of the close icon"
|
|
8190
|
-
},
|
|
8191
|
-
{
|
|
8192
|
-
"name": "onClose",
|
|
8193
|
-
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
8194
|
-
"required": true,
|
|
8195
|
-
"description": "Click event handler for the close button"
|
|
8196
|
-
},
|
|
8197
|
-
{
|
|
8198
|
-
"name": "disabled",
|
|
8199
|
-
"type": "boolean",
|
|
8200
|
-
"required": false,
|
|
8201
|
-
"description": "Whether the button is disabled"
|
|
8202
|
-
}
|
|
8203
|
-
],
|
|
8204
|
-
"examples": [
|
|
8205
|
-
"<DialCloseButton\n ariaLabel=\"Close dialog\"\n onClose={handleClose}\n className=\"custom-close\"\n size={32}\n/>"
|
|
8206
|
-
],
|
|
8207
|
-
"sourceFile": "components/CloseButton/CloseButton.tsx",
|
|
8208
|
-
"supersededBy": "CloseButton"
|
|
8209
|
-
},
|
|
8210
|
-
{
|
|
8211
|
-
"name": "DialRemoveButton",
|
|
8212
|
-
"category": "Elements/Buttons",
|
|
8213
|
-
"generation": "1.0",
|
|
8214
|
-
"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`.",
|
|
8215
|
-
"props": [
|
|
8216
|
-
{
|
|
8217
|
-
"name": "iconClassName",
|
|
8218
|
-
"type": "string",
|
|
8219
|
-
"required": false,
|
|
8220
|
-
"description": "Optional CSS class applied to the trash icon for additional styling"
|
|
8221
|
-
}
|
|
8222
|
-
],
|
|
8223
|
-
"examples": [
|
|
8224
|
-
"<DialRemoveButton\n label=\"Delete item\"\n onClick={handleDelete}\n iconClassName=\"text-error\"\n/>"
|
|
8225
|
-
],
|
|
8226
|
-
"sourceFile": "components/RemoveButton/RemoveButton.tsx"
|
|
8227
|
-
},
|
|
8228
|
-
{
|
|
8229
|
-
"name": "DialTextarea",
|
|
8230
|
-
"category": "Elements",
|
|
8231
|
-
"generation": "1.0",
|
|
8232
|
-
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox\nDesign system 1.0",
|
|
8233
|
-
"props": [
|
|
8234
|
-
{
|
|
8235
|
-
"name": "labelProps",
|
|
8236
|
-
"type": "DialLabelProps",
|
|
8237
|
-
"required": false,
|
|
8238
|
-
"description": "Props for the field label, including `label` (label text) and `required` (whether to show required indicator)"
|
|
8239
|
-
},
|
|
8240
|
-
{
|
|
8241
|
-
"name": "invalid",
|
|
8242
|
-
"type": "boolean",
|
|
8243
|
-
"required": false,
|
|
8244
|
-
"description": "Whether the textarea has validation errors (applies error styling)"
|
|
8245
|
-
},
|
|
8246
|
-
{
|
|
8247
|
-
"name": "containerClassName",
|
|
8248
|
-
"type": "string",
|
|
8249
|
-
"required": false,
|
|
8250
|
-
"description": "Additional CSS classes to apply to the container div"
|
|
8251
|
-
},
|
|
8252
|
-
{
|
|
8253
|
-
"name": "resize",
|
|
8254
|
-
"type": "boolean",
|
|
8255
|
-
"required": false,
|
|
8256
|
-
"defaultValue": "false",
|
|
8257
|
-
"description": "Whether the textarea has possibility to resize"
|
|
8258
|
-
},
|
|
8259
|
-
{
|
|
8260
|
-
"name": "error",
|
|
8261
|
-
"type": "string",
|
|
8262
|
-
"required": false,
|
|
8263
|
-
"description": "Error message to display below the textarea (also adds error styling)"
|
|
8264
|
-
},
|
|
8265
|
-
{
|
|
8266
|
-
"name": "caption",
|
|
8267
|
-
"type": "string",
|
|
8268
|
-
"required": false,
|
|
8269
|
-
"description": "Optional caption text to display below the textarea"
|
|
8270
|
-
},
|
|
8271
|
-
{
|
|
8272
|
-
"name": "onChange",
|
|
8273
|
-
"type": "(value: string) => void",
|
|
8274
|
-
"required": false,
|
|
8275
|
-
"description": "Callback function called when the textarea value changes"
|
|
8276
|
-
}
|
|
8277
|
-
],
|
|
8278
|
-
"examples": [
|
|
8279
|
-
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
8280
|
-
],
|
|
8281
|
-
"sourceFile": "components/Textarea/Textarea.tsx",
|
|
8282
|
-
"supersededBy": "Textarea"
|
|
8283
|
-
},
|
|
8284
|
-
{
|
|
8285
|
-
"name": "DialTooltip",
|
|
8286
|
-
"category": "Overlay",
|
|
8287
|
-
"generation": "1.0",
|
|
8288
|
-
"description": "A Tooltip component that displays information on hover\naliases: HoverPopover|InfoPopover\nDesign system 1.0",
|
|
8289
|
-
"props": [
|
|
8290
|
-
{
|
|
8291
|
-
"name": "hideTooltip",
|
|
8292
|
-
"type": "boolean",
|
|
8293
|
-
"required": false,
|
|
8294
|
-
"description": "Whether to hide the tooltip completely"
|
|
8295
|
-
},
|
|
8296
|
-
{
|
|
8297
|
-
"name": "tooltip",
|
|
8298
|
-
"type": "ReactNode",
|
|
8299
|
-
"required": false,
|
|
8300
|
-
"description": "The content to display in the tooltip"
|
|
8301
|
-
},
|
|
8302
|
-
{
|
|
8303
|
-
"name": "children",
|
|
8304
|
-
"type": "ReactNode",
|
|
8305
|
-
"required": true,
|
|
8306
|
-
"description": "The element that triggers the tooltip"
|
|
8307
|
-
},
|
|
8308
|
-
{
|
|
8309
|
-
"name": "triggerClassName",
|
|
8310
|
-
"type": "string",
|
|
8311
|
-
"required": false,
|
|
8312
|
-
"description": "Additional CSS classes for the trigger element"
|
|
8313
|
-
},
|
|
8314
|
-
{
|
|
8315
|
-
"name": "contentClassName",
|
|
8316
|
-
"type": "string",
|
|
8317
|
-
"required": false,
|
|
8318
|
-
"description": "Additional CSS classes for the tooltip content"
|
|
8319
|
-
}
|
|
8320
|
-
],
|
|
8321
|
-
"examples": [
|
|
8322
|
-
"<DialTooltip tooltip=\"This is helpful information\">\n <button>Hover me</button>\n</DialTooltip>"
|
|
8323
|
-
],
|
|
8324
|
-
"sourceFile": "components/Tooltip/Tooltip.tsx",
|
|
8325
|
-
"supersededBy": "Tooltip"
|
|
8326
|
-
},
|
|
8327
|
-
{
|
|
8328
|
-
"name": "DialTooltipContainer",
|
|
8329
|
-
"category": "Overlay",
|
|
8330
|
-
"generation": "1.0",
|
|
8331
|
-
"description": "The container component that provides tooltip context and state management\nDesign system 1.0",
|
|
8332
|
-
"props": [],
|
|
8333
|
-
"examples": [],
|
|
8334
|
-
"sourceFile": "components/Tooltip/TooltipContainer.tsx",
|
|
8335
|
-
"supersededBy": "TooltipContainer"
|
|
8336
|
-
},
|
|
8337
|
-
{
|
|
8338
|
-
"name": "DialTooltipContent",
|
|
8339
|
-
"category": "Overlay",
|
|
8340
|
-
"generation": "1.0",
|
|
8341
|
-
"description": "The content area of a tooltip that displays the tooltip information\nDesign system 1.0\n\nRenders nothing on a touch-only device, where no pointer can hover to reveal\nit. A narrow viewport is not itself disqualifying: an embed a few hundred\npixels wide still hovers on a desktop.",
|
|
8342
|
-
"props": [],
|
|
8343
|
-
"examples": [],
|
|
8344
|
-
"sourceFile": "components/Tooltip/TooltipContent.tsx",
|
|
8345
|
-
"supersededBy": "TooltipContent"
|
|
8346
|
-
},
|
|
8347
|
-
{
|
|
8348
|
-
"name": "DialTooltipTrigger",
|
|
8349
|
-
"category": "Overlay",
|
|
8350
|
-
"generation": "1.0",
|
|
8351
|
-
"description": "The trigger element for a tooltip that can be clicked or hovered\nDesign system 1.0",
|
|
8352
|
-
"props": [],
|
|
8353
|
-
"examples": [],
|
|
8354
|
-
"sourceFile": "components/Tooltip/TooltipTrigger.tsx",
|
|
8355
|
-
"supersededBy": "TooltipTrigger"
|
|
8356
|
-
},
|
|
8357
|
-
{
|
|
8358
|
-
"name": "DialSwitch",
|
|
8359
|
-
"category": "Form",
|
|
8360
|
-
"generation": "1.0",
|
|
8361
|
-
"description": "A Switch component with various styling options\naliases: ToggleSwitch|BinaryToggle\nDesign system 1.0",
|
|
8362
|
-
"props": [
|
|
8363
|
-
{
|
|
8364
|
-
"name": "label",
|
|
8365
|
-
"type": "ReactNode",
|
|
8366
|
-
"required": false
|
|
8367
|
-
},
|
|
8368
|
-
{
|
|
8369
|
-
"name": "switchId",
|
|
8370
|
-
"type": "string",
|
|
8371
|
-
"required": true,
|
|
8372
|
-
"description": "Unique identifier for the switch element"
|
|
8373
|
-
},
|
|
8374
|
-
{
|
|
8375
|
-
"name": "isOn",
|
|
8376
|
-
"type": "boolean",
|
|
8377
|
-
"required": false,
|
|
8378
|
-
"defaultValue": "false",
|
|
8379
|
-
"description": "The current value of the switch"
|
|
8380
|
-
},
|
|
8381
|
-
{
|
|
8382
|
-
"name": "disabled",
|
|
8383
|
-
"type": "boolean",
|
|
8384
|
-
"required": false,
|
|
8385
|
-
"description": "Whether the switch is disabled"
|
|
8386
|
-
},
|
|
8387
|
-
{
|
|
8388
|
-
"name": "onChange",
|
|
8389
|
-
"type": "(value: boolean) => void",
|
|
8390
|
-
"required": false,
|
|
8391
|
-
"description": "Callback function called when the switch value changes"
|
|
8392
|
-
},
|
|
8393
|
-
{
|
|
8394
|
-
"name": "caption",
|
|
8395
|
-
"type": "string",
|
|
8396
|
-
"required": false,
|
|
8397
|
-
"description": "Caption text"
|
|
8398
|
-
}
|
|
8399
|
-
],
|
|
8400
|
-
"examples": [
|
|
8401
|
-
"<DialSwitch\n switchId=\"switch\"\n label=\"Toggle\"\n isOn={true}\n disabled={false}\n onChange={(value) => console.log(value)}\n caption=\"Caption\"\n/>"
|
|
8402
|
-
],
|
|
8403
|
-
"sourceFile": "components/Switch/Switch.tsx",
|
|
8404
|
-
"supersededBy": "Switch"
|
|
8405
|
-
},
|
|
8406
|
-
{
|
|
8407
|
-
"name": "DialSegmentedControl",
|
|
8408
|
-
"category": "Form",
|
|
8409
|
-
"generation": "1.0",
|
|
8410
|
-
"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).",
|
|
8411
|
-
"props": [
|
|
8412
|
-
{
|
|
8413
|
-
"name": "options",
|
|
8414
|
-
"type": "SegmentedControlOption<T>[]",
|
|
8415
|
-
"required": true,
|
|
8416
|
-
"description": "Segments to render. Each option needs a unique `value` and may include a `label`, `icon`, and `disabled` flag."
|
|
8417
|
-
},
|
|
8418
|
-
{
|
|
8419
|
-
"name": "value",
|
|
8420
|
-
"type": "T",
|
|
8421
|
-
"required": true,
|
|
8422
|
-
"description": "The currently selected option `value`."
|
|
8423
|
-
},
|
|
8424
|
-
{
|
|
8425
|
-
"name": "onChange",
|
|
8426
|
-
"type": "(value: T) => void",
|
|
8427
|
-
"required": true,
|
|
8428
|
-
"description": "Callback fired with the selected option `value`."
|
|
8429
|
-
},
|
|
8430
|
-
{
|
|
8431
|
-
"name": "disabled",
|
|
8432
|
-
"type": "boolean",
|
|
8433
|
-
"required": false,
|
|
8434
|
-
"description": "Disables the entire control when set."
|
|
8435
|
-
},
|
|
8436
|
-
{
|
|
8437
|
-
"name": "className",
|
|
8438
|
-
"type": "string",
|
|
8439
|
-
"required": false,
|
|
8440
|
-
"description": "Additional classes applied to the container."
|
|
8441
|
-
},
|
|
8442
|
-
{
|
|
8443
|
-
"name": "ariaLabel",
|
|
8444
|
-
"type": "string",
|
|
8445
|
-
"required": false,
|
|
8446
|
-
"description": "Accessible label for the control (applied to the `tablist`)."
|
|
8447
|
-
}
|
|
8448
|
-
],
|
|
8449
|
-
"examples": [
|
|
8450
|
-
"<DialSegmentedControl\n ariaLabel=\"View\"\n value={view}\n onChange={setView}\n options={[\n { value: 'list', label: 'List' },\n { value: 'grid', label: 'Grid' },\n ]}\n/>"
|
|
8451
|
-
],
|
|
8452
|
-
"sourceFile": "components/SegmentedControl/SegmentedControl.tsx",
|
|
8453
|
-
"supersededBy": "SegmentedControl"
|
|
8454
|
-
},
|
|
8455
|
-
{
|
|
8456
|
-
"name": "DialPopup",
|
|
8457
|
-
"category": "Overlay",
|
|
8458
|
-
"generation": "1.0",
|
|
8459
|
-
"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.",
|
|
8460
|
-
"props": [
|
|
8461
|
-
{
|
|
8462
|
-
"name": "open",
|
|
8463
|
-
"type": "boolean",
|
|
8464
|
-
"required": false,
|
|
8465
|
-
"defaultValue": "false",
|
|
8466
|
-
"description": "Controls visibility of the popup"
|
|
8467
|
-
},
|
|
8468
|
-
{
|
|
8469
|
-
"name": "header",
|
|
8470
|
-
"type": "ReactNode",
|
|
8471
|
-
"required": false,
|
|
8472
|
-
"description": "Optional title rendered in the header"
|
|
8473
|
-
},
|
|
8474
|
-
{
|
|
8475
|
-
"name": "portalId",
|
|
8476
|
-
"type": "string",
|
|
8477
|
-
"required": false,
|
|
8478
|
-
"description": "Optional portal container id"
|
|
8479
|
-
},
|
|
8480
|
-
{
|
|
8481
|
-
"name": "className",
|
|
8482
|
-
"type": "string",
|
|
8483
|
-
"required": false,
|
|
8484
|
-
"description": "Additional CSS classes applied to the popup container"
|
|
8485
|
-
},
|
|
8486
|
-
{
|
|
8487
|
-
"name": "overlayClassName",
|
|
8488
|
-
"type": "string",
|
|
8489
|
-
"required": false,
|
|
8490
|
-
"description": "Additional CSS classes applied to the overlay"
|
|
8491
|
-
},
|
|
8492
|
-
{
|
|
8493
|
-
"name": "titleClassName",
|
|
8494
|
-
"type": "string",
|
|
8495
|
-
"required": false,
|
|
8496
|
-
"description": "Additional CSS classes applied to the title element"
|
|
8497
|
-
},
|
|
8498
|
-
{
|
|
8499
|
-
"name": "headerClassName",
|
|
8500
|
-
"type": "string",
|
|
8501
|
-
"required": false,
|
|
8502
|
-
"description": "Additional CSS classes applied to the popup header container"
|
|
8503
|
-
},
|
|
8504
|
-
{
|
|
8505
|
-
"name": "dividers",
|
|
8506
|
-
"type": "boolean",
|
|
8507
|
-
"required": false,
|
|
8508
|
-
"defaultValue": "true",
|
|
8509
|
-
"description": "Whether to render separators between sections"
|
|
8510
|
-
},
|
|
8511
|
-
{
|
|
8512
|
-
"name": "dividerFooter",
|
|
8513
|
-
"type": "boolean",
|
|
8514
|
-
"required": false,
|
|
8515
|
-
"defaultValue": "true",
|
|
8516
|
-
"description": "Whether to render a divider above the footer when `dividers` is true"
|
|
8517
|
-
},
|
|
8518
|
-
{
|
|
8519
|
-
"name": "children",
|
|
8520
|
-
"type": "ReactNode",
|
|
8521
|
-
"required": false,
|
|
8522
|
-
"description": "Body content"
|
|
8523
|
-
},
|
|
8524
|
-
{
|
|
8525
|
-
"name": "footer",
|
|
8526
|
-
"type": "ReactNode",
|
|
8527
|
-
"required": false,
|
|
8528
|
-
"description": "Footer area for actions"
|
|
8529
|
-
},
|
|
8530
|
-
{
|
|
8531
|
-
"name": "onClose",
|
|
8532
|
-
"type": "(e?: MouseEvent<HTMLButtonElement> | null) => void",
|
|
8533
|
-
"required": false,
|
|
8534
|
-
"description": "Callback fired when the popup requests to close"
|
|
8535
|
-
},
|
|
8536
|
-
{
|
|
8537
|
-
"name": "size",
|
|
8538
|
-
"type": "PopupSize",
|
|
8539
|
-
"required": false,
|
|
8540
|
-
"defaultValue": "PopupSize.Md",
|
|
8541
|
-
"description": "Sets the max-width of the popup"
|
|
8542
|
-
},
|
|
8543
|
-
{
|
|
8544
|
-
"name": "hideClose",
|
|
8545
|
-
"type": "boolean",
|
|
8546
|
-
"required": false,
|
|
8547
|
-
"defaultValue": "false",
|
|
8548
|
-
"description": "Whether the close button is hidden in the header (default: false)"
|
|
8549
|
-
},
|
|
8550
|
-
{
|
|
8551
|
-
"name": "closeOnOutsideClick",
|
|
8552
|
-
"type": "boolean",
|
|
8553
|
-
"required": false,
|
|
8554
|
-
"defaultValue": "true",
|
|
8555
|
-
"description": "Whether the popup closes when clicking outside (default: true)"
|
|
8556
|
-
},
|
|
8557
|
-
{
|
|
8558
|
-
"name": "preventKeyboardOnOpen",
|
|
8559
|
-
"type": "boolean",
|
|
8560
|
-
"required": false,
|
|
8561
|
-
"defaultValue": "false",
|
|
8562
|
-
"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"
|
|
8563
|
-
}
|
|
8564
|
-
],
|
|
8565
|
-
"examples": [
|
|
8566
|
-
"<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>"
|
|
8567
|
-
],
|
|
8568
|
-
"sourceFile": "components/Popup/Popup.tsx",
|
|
8569
|
-
"supersededBy": "Popup"
|
|
8570
|
-
},
|
|
8571
|
-
{
|
|
8572
|
-
"name": "DialConfirmationPopup",
|
|
8573
|
-
"category": "Overlay",
|
|
8574
|
-
"generation": "1.0",
|
|
8575
|
-
"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.",
|
|
8576
|
-
"props": [
|
|
8577
|
-
{
|
|
8578
|
-
"name": "description",
|
|
8579
|
-
"type": "ReactNode",
|
|
8580
|
-
"required": false,
|
|
8581
|
-
"description": "Secondary text (ignored when `children` set)"
|
|
8582
|
-
},
|
|
8583
|
-
{
|
|
8584
|
-
"name": "descriptionClassName",
|
|
8585
|
-
"type": "string",
|
|
8586
|
-
"required": false,
|
|
8587
|
-
"description": "Custom CSS class for the description"
|
|
8588
|
-
},
|
|
8589
|
-
{
|
|
8590
|
-
"name": "confirmLabel",
|
|
8591
|
-
"type": "string",
|
|
8592
|
-
"required": false,
|
|
8593
|
-
"defaultValue": "defaultConfirmLabel",
|
|
8594
|
-
"description": "Label for the confirm button"
|
|
8595
|
-
},
|
|
8596
|
-
{
|
|
8597
|
-
"name": "cancelLabel",
|
|
8598
|
-
"type": "string",
|
|
8599
|
-
"required": false,
|
|
8600
|
-
"defaultValue": "defaultCancelLabel",
|
|
8601
|
-
"description": "Label for the cancel button"
|
|
8602
|
-
},
|
|
8603
|
-
{
|
|
8604
|
-
"name": "isLoading",
|
|
8605
|
-
"type": "boolean",
|
|
8606
|
-
"required": false,
|
|
8607
|
-
"defaultValue": "false",
|
|
8608
|
-
"description": "Shows loader placeholder and hides actions"
|
|
8609
|
-
},
|
|
8610
|
-
{
|
|
8611
|
-
"name": "disableConfirmButton",
|
|
8612
|
-
"type": "boolean",
|
|
8613
|
-
"required": false,
|
|
8614
|
-
"defaultValue": "false",
|
|
8615
|
-
"description": "Disables the confirm button"
|
|
8616
|
-
},
|
|
8617
|
-
{
|
|
8618
|
-
"name": "confirmClassName",
|
|
8619
|
-
"type": "string",
|
|
8620
|
-
"required": false,
|
|
8621
|
-
"description": "Extra classes merged into the confirm button"
|
|
8622
|
-
},
|
|
8623
|
-
{
|
|
8624
|
-
"name": "onConfirm",
|
|
8625
|
-
"type": "() => void",
|
|
8626
|
-
"required": true,
|
|
8627
|
-
"description": "Fired on confirm"
|
|
8628
|
-
},
|
|
8629
|
-
{
|
|
8630
|
-
"name": "onCancel",
|
|
8631
|
-
"type": "() => void",
|
|
8632
|
-
"required": false,
|
|
8633
|
-
"description": "Fired on cancel (falls back to `onClose`)"
|
|
8634
|
-
},
|
|
8635
|
-
{
|
|
8636
|
-
"name": "children",
|
|
8637
|
-
"type": "ReactNode",
|
|
8638
|
-
"required": false,
|
|
8639
|
-
"description": "Custom body content"
|
|
8640
|
-
},
|
|
8641
|
-
{
|
|
8642
|
-
"name": "variant",
|
|
8643
|
-
"type": "ConfirmationPopupVariant",
|
|
8644
|
-
"required": false,
|
|
8645
|
-
"defaultValue": "ConfirmationPopupVariant.Info",
|
|
8646
|
-
"description": "Visual variant for the popup"
|
|
8647
|
-
}
|
|
8648
|
-
],
|
|
8649
|
-
"examples": [
|
|
8650
|
-
"<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/>"
|
|
8651
|
-
],
|
|
8652
|
-
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx",
|
|
8653
|
-
"supersededBy": "ConfirmationPopup"
|
|
8654
|
-
},
|
|
8655
|
-
{
|
|
8656
|
-
"name": "DialRadioGroupPopupField",
|
|
8657
|
-
"category": "Form",
|
|
8658
|
-
"generation": "1.0",
|
|
8659
|
-
"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`.",
|
|
8660
|
-
"props": [],
|
|
8661
|
-
"examples": [
|
|
8662
|
-
"<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/>"
|
|
8663
|
-
],
|
|
8664
|
-
"sourceFile": "components/RadioGroupPopupField/RadioGroupPopupField.tsx",
|
|
8665
|
-
"supersededBy": "RadioGroupPopupField"
|
|
8666
|
-
},
|
|
8667
|
-
{
|
|
8668
|
-
"name": "DialFormPopup",
|
|
8669
|
-
"category": "Overlay",
|
|
8670
|
-
"generation": "1.0",
|
|
8671
|
-
"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.",
|
|
8672
|
-
"props": [
|
|
8673
|
-
{
|
|
8674
|
-
"name": "submitLabel",
|
|
8675
|
-
"type": "string",
|
|
8676
|
-
"required": false,
|
|
8677
|
-
"defaultValue": "defaultSubmitLabel",
|
|
8678
|
-
"description": "Label for the primary action button"
|
|
8679
|
-
},
|
|
8680
|
-
{
|
|
8681
|
-
"name": "cancelLabel",
|
|
8682
|
-
"type": "string",
|
|
8683
|
-
"required": false,
|
|
8684
|
-
"defaultValue": "defaultCancelLabel",
|
|
8685
|
-
"description": "Label for the cancel button"
|
|
8686
|
-
},
|
|
8687
|
-
{
|
|
8688
|
-
"name": "isLoading",
|
|
8689
|
-
"type": "boolean",
|
|
8690
|
-
"required": false,
|
|
8691
|
-
"defaultValue": "false",
|
|
8692
|
-
"description": "Shows loader placeholder and hides actions"
|
|
8693
|
-
},
|
|
8694
|
-
{
|
|
8695
|
-
"name": "disableSubmitButton",
|
|
8696
|
-
"type": "boolean",
|
|
8697
|
-
"required": false,
|
|
8698
|
-
"defaultValue": "false",
|
|
8699
|
-
"description": "Disables the submit button"
|
|
8700
|
-
},
|
|
8701
|
-
{
|
|
8702
|
-
"name": "submitClassName",
|
|
8703
|
-
"type": "string",
|
|
8704
|
-
"required": false,
|
|
8705
|
-
"description": "Extra classes merged into the submit button"
|
|
8706
|
-
},
|
|
8707
|
-
{
|
|
8708
|
-
"name": "onSubmit",
|
|
8709
|
-
"type": "() => void",
|
|
8710
|
-
"required": true,
|
|
8711
|
-
"description": "Fired on submit"
|
|
8712
|
-
},
|
|
8713
|
-
{
|
|
8714
|
-
"name": "onCancel",
|
|
8715
|
-
"type": "() => void",
|
|
8716
|
-
"required": false,
|
|
8717
|
-
"description": "Fired on cancel (falls back to `onClose`)"
|
|
8718
|
-
},
|
|
8719
|
-
{
|
|
8720
|
-
"name": "children",
|
|
8721
|
-
"type": "ReactNode",
|
|
8722
|
-
"required": false,
|
|
8723
|
-
"description": "Custom body content"
|
|
8724
|
-
}
|
|
8725
|
-
],
|
|
8726
|
-
"examples": [
|
|
8727
|
-
"<DialFormPopup\n open\n header=\"Create Model\"\n onClose={() => setOpen(false)}\n onSubmit={handleSubmit}\n/>"
|
|
8728
|
-
],
|
|
8729
|
-
"sourceFile": "components/FormPopup/FormPopup.tsx"
|
|
8730
|
-
},
|
|
8731
|
-
{
|
|
8732
|
-
"name": "DialInput",
|
|
8733
|
-
"category": "Elements/Inputs",
|
|
8734
|
-
"generation": "1.0",
|
|
8735
|
-
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput\nDesign system 1.0",
|
|
8736
|
-
"props": [
|
|
8737
|
-
{
|
|
8738
|
-
"name": "labelProps",
|
|
8739
|
-
"type": "DialLabelProps",
|
|
8740
|
-
"required": false
|
|
8741
|
-
},
|
|
8742
|
-
{
|
|
8743
|
-
"name": "inputButtonProps",
|
|
8744
|
-
"type": "DialInputButtonProps",
|
|
8745
|
-
"required": false
|
|
8746
|
-
},
|
|
8747
|
-
{
|
|
8748
|
-
"name": "invalid",
|
|
8749
|
-
"type": "boolean",
|
|
8750
|
-
"required": false,
|
|
8751
|
-
"description": "Whether the input has validation errors (applies error styling)"
|
|
8752
|
-
},
|
|
8753
|
-
{
|
|
8754
|
-
"name": "error",
|
|
8755
|
-
"type": "string",
|
|
8756
|
-
"required": false,
|
|
8757
|
-
"description": "Error message to display below the input (also adds error styling)"
|
|
8758
|
-
},
|
|
8759
|
-
{
|
|
8760
|
-
"name": "caption",
|
|
8761
|
-
"type": "string",
|
|
8762
|
-
"required": false,
|
|
8763
|
-
"description": "Helper text to display below the input"
|
|
8764
|
-
},
|
|
8765
|
-
{
|
|
8766
|
-
"name": "tooltipText",
|
|
8767
|
-
"type": "string",
|
|
8768
|
-
"required": false
|
|
8769
|
-
},
|
|
8770
|
-
{
|
|
8771
|
-
"name": "iconBefore",
|
|
8772
|
-
"type": "ReactNode",
|
|
8773
|
-
"required": false,
|
|
8774
|
-
"description": "Icon or element to display before the input"
|
|
8775
|
-
},
|
|
8776
|
-
{
|
|
8777
|
-
"name": "iconAfter",
|
|
8778
|
-
"type": "ReactNode",
|
|
8779
|
-
"required": false,
|
|
8780
|
-
"description": "Icon or element to display after the input"
|
|
8781
|
-
},
|
|
8782
|
-
{
|
|
8783
|
-
"name": "prefix",
|
|
8784
|
-
"type": "string",
|
|
8785
|
-
"required": false
|
|
8786
|
-
},
|
|
8787
|
-
{
|
|
8788
|
-
"name": "postfix",
|
|
8789
|
-
"type": "string",
|
|
8790
|
-
"required": false
|
|
8791
|
-
},
|
|
8792
|
-
{
|
|
8793
|
-
"name": "inputRef",
|
|
8794
|
-
"type": "Ref<HTMLInputElement>",
|
|
8795
|
-
"required": false,
|
|
8796
|
-
"description": "Ref to access the underlying input element"
|
|
8797
|
-
},
|
|
8798
|
-
{
|
|
8799
|
-
"name": "onChange",
|
|
8800
|
-
"type": "(value?: string) => void",
|
|
8801
|
-
"required": false,
|
|
8802
|
-
"description": "Callback function called when the input value changes"
|
|
8803
|
-
},
|
|
8804
|
-
{
|
|
8805
|
-
"name": "containerClassName",
|
|
8806
|
-
"type": "string",
|
|
8807
|
-
"required": false,
|
|
8808
|
-
"description": "Additional CSS classes to apply to the container div"
|
|
8809
|
-
},
|
|
8810
|
-
{
|
|
8811
|
-
"name": "wrapperClassName",
|
|
8812
|
-
"type": "string",
|
|
8813
|
-
"required": false,
|
|
8814
|
-
"description": "Additional CSS classes to apply to the input wrapper div"
|
|
8815
|
-
}
|
|
8816
|
-
],
|
|
6848
|
+
"name": "DialLinkButton",
|
|
6849
|
+
"category": "Elements/Buttons",
|
|
6850
|
+
"generation": "1.0",
|
|
6851
|
+
"description": "A Link Button component with predefined link appearance",
|
|
6852
|
+
"props": [],
|
|
8817
6853
|
"examples": [
|
|
8818
|
-
"<
|
|
6854
|
+
"<DialLinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8819
6855
|
],
|
|
8820
|
-
"sourceFile": "components/
|
|
8821
|
-
"supersededBy": "
|
|
6856
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
6857
|
+
"supersededBy": "LinkButton"
|
|
8822
6858
|
},
|
|
8823
6859
|
{
|
|
8824
|
-
"name": "
|
|
8825
|
-
"category": "Elements/
|
|
6860
|
+
"name": "DialDangerIconButton",
|
|
6861
|
+
"category": "Elements/Buttons",
|
|
8826
6862
|
"generation": "1.0",
|
|
8827
|
-
"description": "A
|
|
8828
|
-
"props": [
|
|
8829
|
-
{
|
|
8830
|
-
"name": "integer",
|
|
8831
|
-
"type": "boolean",
|
|
8832
|
-
"required": false,
|
|
8833
|
-
"description": "When true, restricts input to integer values only — blocks decimal points, minus, plus, and scientific notation (e/E)"
|
|
8834
|
-
},
|
|
8835
|
-
{
|
|
8836
|
-
"name": "onChange",
|
|
8837
|
-
"type": "(value?: number | string) => void",
|
|
8838
|
-
"required": false,
|
|
8839
|
-
"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)"
|
|
8840
|
-
}
|
|
8841
|
-
],
|
|
6863
|
+
"description": "A Danger Icon Button component with predefined danger variant",
|
|
6864
|
+
"props": [],
|
|
8842
6865
|
"examples": [
|
|
8843
|
-
"<
|
|
6866
|
+
"<DialDangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8844
6867
|
],
|
|
8845
|
-
"sourceFile": "components/
|
|
8846
|
-
"supersededBy": "
|
|
6868
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
6869
|
+
"supersededBy": "DangerIconButton"
|
|
8847
6870
|
},
|
|
8848
6871
|
{
|
|
8849
|
-
"name": "
|
|
8850
|
-
"category": "Elements/
|
|
6872
|
+
"name": "DialGhostIconButton",
|
|
6873
|
+
"category": "Elements/Buttons",
|
|
8851
6874
|
"generation": "1.0",
|
|
8852
|
-
"description": "A
|
|
6875
|
+
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
8853
6876
|
"props": [],
|
|
8854
6877
|
"examples": [
|
|
8855
|
-
"<
|
|
6878
|
+
"<DialGhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8856
6879
|
],
|
|
8857
|
-
"sourceFile": "components/
|
|
8858
|
-
"supersededBy": "
|
|
6880
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
6881
|
+
"supersededBy": "GhostIconButton"
|
|
8859
6882
|
},
|
|
8860
6883
|
{
|
|
8861
|
-
"name": "
|
|
8862
|
-
"category": "Elements",
|
|
6884
|
+
"name": "DialNeutralIconButton",
|
|
6885
|
+
"category": "Elements/Buttons",
|
|
8863
6886
|
"generation": "1.0",
|
|
8864
|
-
"description": "A
|
|
8865
|
-
"props": [
|
|
8866
|
-
{
|
|
8867
|
-
"name": "withoutBorder",
|
|
8868
|
-
"type": "boolean",
|
|
8869
|
-
"required": false,
|
|
8870
|
-
"description": "If true, the search input will be rendered without a border."
|
|
8871
|
-
},
|
|
8872
|
-
{
|
|
8873
|
-
"name": "size",
|
|
8874
|
-
"type": "ElementSize",
|
|
8875
|
-
"required": false,
|
|
8876
|
-
"defaultValue": "ElementSize.Standard",
|
|
8877
|
-
"description": "The size of the search input. Uses the enum."
|
|
8878
|
-
},
|
|
8879
|
-
{
|
|
8880
|
-
"name": "onChange",
|
|
8881
|
-
"type": "(value: string) => void",
|
|
8882
|
-
"required": false
|
|
8883
|
-
}
|
|
8884
|
-
],
|
|
6887
|
+
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
6888
|
+
"props": [],
|
|
8885
6889
|
"examples": [
|
|
8886
|
-
"<
|
|
6890
|
+
"<DialNeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8887
6891
|
],
|
|
8888
|
-
"sourceFile": "components/
|
|
8889
|
-
"supersededBy": "
|
|
6892
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
6893
|
+
"supersededBy": "NeutralIconButton"
|
|
8890
6894
|
},
|
|
8891
6895
|
{
|
|
8892
|
-
"name": "
|
|
8893
|
-
"category": "
|
|
6896
|
+
"name": "DialPrimaryIconButton",
|
|
6897
|
+
"category": "Elements/Buttons",
|
|
8894
6898
|
"generation": "1.0",
|
|
8895
|
-
"description": "
|
|
8896
|
-
"props": [
|
|
8897
|
-
|
|
8898
|
-
|
|
8899
|
-
"type": "boolean",
|
|
8900
|
-
"required": false,
|
|
8901
|
-
"description": "The current state of the modal, indicating whether it is opened or closed."
|
|
8902
|
-
},
|
|
8903
|
-
{
|
|
8904
|
-
"name": "selectedValue",
|
|
8905
|
-
"type": "string | string[]",
|
|
8906
|
-
"required": false,
|
|
8907
|
-
"description": "The currently selected value(s). Can be a string for a single value or an array of strings for multiple values."
|
|
8908
|
-
},
|
|
8909
|
-
{
|
|
8910
|
-
"name": "children",
|
|
8911
|
-
"type": "ReactNode",
|
|
8912
|
-
"required": true,
|
|
8913
|
-
"description": "The content to render inside the modal when it is opened."
|
|
8914
|
-
},
|
|
8915
|
-
{
|
|
8916
|
-
"name": "onOpen",
|
|
8917
|
-
"type": "() => void",
|
|
8918
|
-
"required": true,
|
|
8919
|
-
"description": "A callback function triggered when the modal open button is clicked."
|
|
8920
|
-
},
|
|
8921
|
-
{
|
|
8922
|
-
"name": "disabled",
|
|
8923
|
-
"type": "boolean",
|
|
8924
|
-
"required": false,
|
|
8925
|
-
"defaultValue": "false",
|
|
8926
|
-
"description": "Whether the input is disabled, preventing user interaction."
|
|
8927
|
-
},
|
|
8928
|
-
{
|
|
8929
|
-
"name": "valueClassName",
|
|
8930
|
-
"type": "string",
|
|
8931
|
-
"required": false,
|
|
8932
|
-
"description": "Additional CSS classes applied to the displayed value."
|
|
8933
|
-
},
|
|
8934
|
-
{
|
|
8935
|
-
"name": "inputClassName",
|
|
8936
|
-
"type": "string",
|
|
8937
|
-
"required": false,
|
|
8938
|
-
"description": "Additional CSS classes applied to the input container."
|
|
8939
|
-
},
|
|
8940
|
-
{
|
|
8941
|
-
"name": "placeholder",
|
|
8942
|
-
"type": "string",
|
|
8943
|
-
"required": false,
|
|
8944
|
-
"description": "Placeholder text displayed when no value is selected."
|
|
8945
|
-
},
|
|
8946
|
-
{
|
|
8947
|
-
"name": "elementId",
|
|
8948
|
-
"type": "string",
|
|
8949
|
-
"required": false,
|
|
8950
|
-
"description": "A unique identifier for the input element, useful for accessibility and testing."
|
|
8951
|
-
},
|
|
8952
|
-
{
|
|
8953
|
-
"name": "errorText",
|
|
8954
|
-
"type": "string",
|
|
8955
|
-
"required": false,
|
|
8956
|
-
"description": "An optional error message displayed below the input when an error state is present."
|
|
8957
|
-
},
|
|
8958
|
-
{
|
|
8959
|
-
"name": "invalid",
|
|
8960
|
-
"type": "boolean",
|
|
8961
|
-
"required": false,
|
|
8962
|
-
"description": "Whether the input is in an invalid state, affecting styling. Applied automatically if errorText is provided."
|
|
8963
|
-
},
|
|
8964
|
-
{
|
|
8965
|
-
"name": "emptyValueText",
|
|
8966
|
-
"type": "string",
|
|
8967
|
-
"required": false,
|
|
8968
|
-
"description": "The text displayed when no value is selected and placeholder is not provided."
|
|
8969
|
-
},
|
|
8970
|
-
{
|
|
8971
|
-
"name": "editable",
|
|
8972
|
-
"type": "boolean",
|
|
8973
|
-
"required": false,
|
|
8974
|
-
"defaultValue": "false",
|
|
8975
|
-
"description": "When true, the input area becomes an editable text field; only the icon opens the popup."
|
|
8976
|
-
},
|
|
8977
|
-
{
|
|
8978
|
-
"name": "onValueChange",
|
|
8979
|
-
"type": "(value: string) => void",
|
|
8980
|
-
"required": false,
|
|
8981
|
-
"description": "Callback fired when the user types in the editable input."
|
|
8982
|
-
},
|
|
8983
|
-
{
|
|
8984
|
-
"name": "collapseTagOverflow",
|
|
8985
|
-
"type": "boolean",
|
|
8986
|
-
"required": false,
|
|
8987
|
-
"defaultValue": "false"
|
|
8988
|
-
},
|
|
8989
|
-
{
|
|
8990
|
-
"name": "iconBefore",
|
|
8991
|
-
"type": "ReactNode",
|
|
8992
|
-
"required": false,
|
|
8993
|
-
"description": "Optional icon rendered at the start of the field, before the value."
|
|
8994
|
-
}
|
|
6899
|
+
"description": "A Primary Icon Button component with predefined primary variant\nDesign system 1.0",
|
|
6900
|
+
"props": [],
|
|
6901
|
+
"examples": [
|
|
6902
|
+
"<DialPrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8995
6903
|
],
|
|
6904
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
6905
|
+
"supersededBy": "PrimaryIconButton"
|
|
6906
|
+
},
|
|
6907
|
+
{
|
|
6908
|
+
"name": "DialSecondaryIconButton",
|
|
6909
|
+
"category": "Elements/Buttons",
|
|
6910
|
+
"generation": "1.0",
|
|
6911
|
+
"description": "A Secondary Icon Button component with predefined secondary variant",
|
|
6912
|
+
"props": [],
|
|
8996
6913
|
"examples": [
|
|
8997
|
-
"<
|
|
6914
|
+
"<DialSecondaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
8998
6915
|
],
|
|
8999
|
-
"sourceFile": "components/
|
|
6916
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
9000
6917
|
},
|
|
9001
6918
|
{
|
|
9002
|
-
"name": "
|
|
9003
|
-
"category": "
|
|
6919
|
+
"name": "DialSuccessIconButton",
|
|
6920
|
+
"category": "Elements/Buttons",
|
|
9004
6921
|
"generation": "1.0",
|
|
9005
|
-
"description": "A
|
|
9006
|
-
"props": [
|
|
9007
|
-
|
|
9008
|
-
|
|
9009
|
-
"type": "string",
|
|
9010
|
-
"required": false,
|
|
9011
|
-
"description": "Placeholder text to display when no items are selected."
|
|
9012
|
-
},
|
|
9013
|
-
{
|
|
9014
|
-
"name": "selectedItems",
|
|
9015
|
-
"type": "string[]",
|
|
9016
|
-
"required": false,
|
|
9017
|
-
"description": "An array of strings representing the selected items to display. If empty or undefined, the component renders nothing."
|
|
9018
|
-
},
|
|
9019
|
-
{
|
|
9020
|
-
"name": "listClassName",
|
|
9021
|
-
"type": "string",
|
|
9022
|
-
"required": false,
|
|
9023
|
-
"description": "Additional CSS classes applied to the container element containing the list of selected items."
|
|
9024
|
-
},
|
|
9025
|
-
{
|
|
9026
|
-
"name": "listElementClassName",
|
|
9027
|
-
"type": "string",
|
|
9028
|
-
"required": false,
|
|
9029
|
-
"description": "Additional CSS classes applied to each tag element representing an individual selected item."
|
|
9030
|
-
},
|
|
9031
|
-
{
|
|
9032
|
-
"name": "collapseTagOverflow",
|
|
9033
|
-
"type": "boolean",
|
|
9034
|
-
"required": false,
|
|
9035
|
-
"defaultValue": "false",
|
|
9036
|
-
"description": "When true, keeps items on one line and shows `+N` chip with a tooltip for overflow items."
|
|
9037
|
-
}
|
|
6922
|
+
"description": "A Success Icon Button component with predefined success variant",
|
|
6923
|
+
"props": [],
|
|
6924
|
+
"examples": [
|
|
6925
|
+
"<DialSuccessIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
9038
6926
|
],
|
|
6927
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
6928
|
+
},
|
|
6929
|
+
{
|
|
6930
|
+
"name": "DialTertiaryIconButton",
|
|
6931
|
+
"category": "Elements/Buttons",
|
|
6932
|
+
"generation": "1.0",
|
|
6933
|
+
"description": "A Tertiary Icon Button component with predefined tertiary variant",
|
|
6934
|
+
"props": [],
|
|
9039
6935
|
"examples": [
|
|
9040
|
-
"<
|
|
6936
|
+
"<DialTertiaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
9041
6937
|
],
|
|
9042
|
-
"sourceFile": "components/
|
|
6938
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
9043
6939
|
},
|
|
9044
6940
|
{
|
|
9045
|
-
"name": "
|
|
9046
|
-
"category": "
|
|
6941
|
+
"name": "DialCloseButton",
|
|
6942
|
+
"category": "Elements/Buttons",
|
|
9047
6943
|
"generation": "1.0",
|
|
9048
|
-
"description": "A
|
|
6944
|
+
"description": "A Close button component with a customizable icon and accessible label.\naliases: DismissButton|ExitButton\nDesign system 1.0",
|
|
9049
6945
|
"props": [
|
|
9050
6946
|
{
|
|
9051
|
-
"name": "
|
|
9052
|
-
"type": "string",
|
|
9053
|
-
"required": false,
|
|
9054
|
-
"description": "Unique identifier for the input element."
|
|
9055
|
-
},
|
|
9056
|
-
{
|
|
9057
|
-
"name": "initialTags",
|
|
9058
|
-
"type": "string[]",
|
|
9059
|
-
"required": false,
|
|
9060
|
-
"defaultValue": "[]",
|
|
9061
|
-
"description": "Array of tags to be displayed initially."
|
|
9062
|
-
},
|
|
9063
|
-
{
|
|
9064
|
-
"name": "placeholder",
|
|
9065
|
-
"type": "string",
|
|
9066
|
-
"required": false,
|
|
9067
|
-
"description": "Placeholder text shown when the input is empty."
|
|
9068
|
-
},
|
|
9069
|
-
{
|
|
9070
|
-
"name": "captionDescription",
|
|
6947
|
+
"name": "ariaLabel",
|
|
9071
6948
|
"type": "string",
|
|
9072
6949
|
"required": false,
|
|
9073
|
-
"description": "
|
|
6950
|
+
"description": "Accessible label for screen readers"
|
|
9074
6951
|
},
|
|
9075
6952
|
{
|
|
9076
|
-
"name": "
|
|
6953
|
+
"name": "className",
|
|
9077
6954
|
"type": "string",
|
|
9078
6955
|
"required": false,
|
|
9079
|
-
"description": "
|
|
9080
|
-
},
|
|
9081
|
-
{
|
|
9082
|
-
"name": "invalid",
|
|
9083
|
-
"type": "boolean",
|
|
9084
|
-
"required": false,
|
|
9085
|
-
"description": "Whether the field should be styled as invalid."
|
|
9086
|
-
},
|
|
9087
|
-
{
|
|
9088
|
-
"name": "disabled",
|
|
9089
|
-
"type": "boolean",
|
|
9090
|
-
"required": false,
|
|
9091
|
-
"description": "Whether the input and remove buttons are disabled."
|
|
9092
|
-
},
|
|
9093
|
-
{
|
|
9094
|
-
"name": "collapseTagOverflow",
|
|
9095
|
-
"type": "boolean",
|
|
9096
|
-
"required": false,
|
|
9097
|
-
"defaultValue": "false",
|
|
9098
|
-
"description": "When true, keeps tags on one line and shows `+N` for overflow."
|
|
9099
|
-
},
|
|
9100
|
-
{
|
|
9101
|
-
"name": "readOnly",
|
|
9102
|
-
"type": "boolean",
|
|
9103
|
-
"required": false,
|
|
9104
|
-
"defaultValue": "false",
|
|
9105
|
-
"description": "When true, hides the text input (no new tags can be added). The outer wrapper and label/caption are also omitted so the component can be embedded inside an existing container."
|
|
6956
|
+
"description": "Additional CSS classes to apply to the button"
|
|
9106
6957
|
},
|
|
9107
6958
|
{
|
|
9108
|
-
"name": "
|
|
9109
|
-
"type": "
|
|
6959
|
+
"name": "size",
|
|
6960
|
+
"type": "number",
|
|
9110
6961
|
"required": false,
|
|
9111
|
-
"
|
|
6962
|
+
"defaultValue": "24",
|
|
6963
|
+
"description": "Size of the close icon"
|
|
9112
6964
|
},
|
|
9113
6965
|
{
|
|
9114
|
-
"name": "
|
|
9115
|
-
"type": "
|
|
9116
|
-
"required":
|
|
9117
|
-
"description": "
|
|
6966
|
+
"name": "onClose",
|
|
6967
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
6968
|
+
"required": true,
|
|
6969
|
+
"description": "Click event handler for the close button"
|
|
9118
6970
|
},
|
|
9119
6971
|
{
|
|
9120
|
-
"name": "
|
|
9121
|
-
"type": "
|
|
6972
|
+
"name": "disabled",
|
|
6973
|
+
"type": "boolean",
|
|
9122
6974
|
"required": false,
|
|
9123
|
-
"description": "
|
|
6975
|
+
"description": "Whether the button is disabled"
|
|
9124
6976
|
}
|
|
9125
6977
|
],
|
|
9126
6978
|
"examples": [
|
|
9127
|
-
"<
|
|
6979
|
+
"<DialCloseButton\n ariaLabel=\"Close dialog\"\n onClose={handleClose}\n className=\"custom-close\"\n size={32}\n/>"
|
|
9128
6980
|
],
|
|
9129
|
-
"sourceFile": "components/
|
|
9130
|
-
"supersededBy": "
|
|
6981
|
+
"sourceFile": "components/CloseButton/CloseButton.tsx",
|
|
6982
|
+
"supersededBy": "CloseButton"
|
|
9131
6983
|
},
|
|
9132
6984
|
{
|
|
9133
|
-
"name": "
|
|
9134
|
-
"category": "
|
|
6985
|
+
"name": "DialRemoveButton",
|
|
6986
|
+
"category": "Elements/Buttons",
|
|
9135
6987
|
"generation": "1.0",
|
|
9136
|
-
"description": "A
|
|
6988
|
+
"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`.",
|
|
9137
6989
|
"props": [
|
|
9138
6990
|
{
|
|
9139
|
-
"name": "
|
|
9140
|
-
"type": "SelectOption[]",
|
|
9141
|
-
"required": true,
|
|
9142
|
-
"description": "Array of options to select from."
|
|
9143
|
-
},
|
|
9144
|
-
{
|
|
9145
|
-
"name": "multiple",
|
|
9146
|
-
"type": "boolean",
|
|
9147
|
-
"required": false,
|
|
9148
|
-
"defaultValue": "false",
|
|
9149
|
-
"description": "Whether multiple selections are allowed."
|
|
9150
|
-
},
|
|
9151
|
-
{
|
|
9152
|
-
"name": "elementId",
|
|
6991
|
+
"name": "iconClassName",
|
|
9153
6992
|
"type": "string",
|
|
9154
6993
|
"required": false,
|
|
9155
|
-
"description": "
|
|
9156
|
-
}
|
|
9157
|
-
|
|
9158
|
-
|
|
9159
|
-
|
|
9160
|
-
|
|
9161
|
-
|
|
9162
|
-
|
|
9163
|
-
|
|
6994
|
+
"description": "Optional CSS class applied to the trash icon for additional styling"
|
|
6995
|
+
}
|
|
6996
|
+
],
|
|
6997
|
+
"examples": [
|
|
6998
|
+
"<DialRemoveButton\n label=\"Delete item\"\n onClick={handleDelete}\n iconClassName=\"text-error\"\n/>"
|
|
6999
|
+
],
|
|
7000
|
+
"sourceFile": "components/RemoveButton/RemoveButton.tsx"
|
|
7001
|
+
},
|
|
7002
|
+
{
|
|
7003
|
+
"name": "DialTooltip",
|
|
7004
|
+
"category": "Overlay",
|
|
7005
|
+
"generation": "1.0",
|
|
7006
|
+
"description": "A Tooltip component that displays information on hover\naliases: HoverPopover|InfoPopover\nDesign system 1.0",
|
|
7007
|
+
"props": [
|
|
9164
7008
|
{
|
|
9165
|
-
"name": "
|
|
9166
|
-
"type": "
|
|
7009
|
+
"name": "hideTooltip",
|
|
7010
|
+
"type": "boolean",
|
|
9167
7011
|
"required": false,
|
|
9168
|
-
"
|
|
9169
|
-
"description": "Visual variant."
|
|
7012
|
+
"description": "Whether to hide the tooltip completely"
|
|
9170
7013
|
},
|
|
9171
7014
|
{
|
|
9172
|
-
"name": "
|
|
9173
|
-
"type": "
|
|
7015
|
+
"name": "tooltip",
|
|
7016
|
+
"type": "ReactNode",
|
|
9174
7017
|
"required": false,
|
|
9175
|
-
"description": "
|
|
7018
|
+
"description": "The content to display in the tooltip"
|
|
9176
7019
|
},
|
|
9177
7020
|
{
|
|
9178
|
-
"name": "
|
|
9179
|
-
"type": "
|
|
9180
|
-
"required":
|
|
9181
|
-
"description": "
|
|
7021
|
+
"name": "children",
|
|
7022
|
+
"type": "ReactNode",
|
|
7023
|
+
"required": true,
|
|
7024
|
+
"description": "The element that triggers the tooltip"
|
|
9182
7025
|
},
|
|
9183
7026
|
{
|
|
9184
|
-
"name": "
|
|
7027
|
+
"name": "triggerClassName",
|
|
9185
7028
|
"type": "string",
|
|
9186
7029
|
"required": false,
|
|
9187
|
-
"description": "
|
|
9188
|
-
},
|
|
9189
|
-
{
|
|
9190
|
-
"name": "defaultValue",
|
|
9191
|
-
"type": "string | string[]",
|
|
9192
|
-
"required": false,
|
|
9193
|
-
"description": "Uncontrolled initial selected value(s)."
|
|
7030
|
+
"description": "Additional CSS classes for the trigger element"
|
|
9194
7031
|
},
|
|
9195
7032
|
{
|
|
9196
|
-
"name": "
|
|
7033
|
+
"name": "contentClassName",
|
|
9197
7034
|
"type": "string",
|
|
9198
7035
|
"required": false,
|
|
9199
|
-
"
|
|
9200
|
-
|
|
9201
|
-
|
|
9202
|
-
|
|
9203
|
-
|
|
9204
|
-
|
|
9205
|
-
|
|
9206
|
-
|
|
9207
|
-
|
|
9208
|
-
|
|
7036
|
+
"description": "Additional CSS classes for the tooltip content"
|
|
7037
|
+
}
|
|
7038
|
+
],
|
|
7039
|
+
"examples": [
|
|
7040
|
+
"<DialTooltip tooltip=\"This is helpful information\">\n <button>Hover me</button>\n</DialTooltip>"
|
|
7041
|
+
],
|
|
7042
|
+
"sourceFile": "components/Tooltip/Tooltip.tsx",
|
|
7043
|
+
"supersededBy": "Tooltip"
|
|
7044
|
+
},
|
|
7045
|
+
{
|
|
7046
|
+
"name": "DialTooltipContainer",
|
|
7047
|
+
"category": "Overlay",
|
|
7048
|
+
"generation": "1.0",
|
|
7049
|
+
"description": "The container component that provides tooltip context and state management\nDesign system 1.0",
|
|
7050
|
+
"props": [],
|
|
7051
|
+
"examples": [],
|
|
7052
|
+
"sourceFile": "components/Tooltip/TooltipContainer.tsx",
|
|
7053
|
+
"supersededBy": "TooltipContainer"
|
|
7054
|
+
},
|
|
7055
|
+
{
|
|
7056
|
+
"name": "DialTooltipContent",
|
|
7057
|
+
"category": "Overlay",
|
|
7058
|
+
"generation": "1.0",
|
|
7059
|
+
"description": "The content area of a tooltip that displays the tooltip information\nDesign system 1.0\n\nRenders nothing on a touch-only device, where no pointer can hover to reveal\nit. A narrow viewport is not itself disqualifying: an embed a few hundred\npixels wide still hovers on a desktop.",
|
|
7060
|
+
"props": [],
|
|
7061
|
+
"examples": [],
|
|
7062
|
+
"sourceFile": "components/Tooltip/TooltipContent.tsx",
|
|
7063
|
+
"supersededBy": "TooltipContent"
|
|
7064
|
+
},
|
|
7065
|
+
{
|
|
7066
|
+
"name": "DialTooltipTrigger",
|
|
7067
|
+
"category": "Overlay",
|
|
7068
|
+
"generation": "1.0",
|
|
7069
|
+
"description": "The trigger element for a tooltip that can be clicked or hovered\nDesign system 1.0",
|
|
7070
|
+
"props": [],
|
|
7071
|
+
"examples": [],
|
|
7072
|
+
"sourceFile": "components/Tooltip/TooltipTrigger.tsx",
|
|
7073
|
+
"supersededBy": "TooltipTrigger"
|
|
7074
|
+
},
|
|
7075
|
+
{
|
|
7076
|
+
"name": "DialInput",
|
|
7077
|
+
"category": "Elements/Inputs",
|
|
7078
|
+
"generation": "1.0",
|
|
7079
|
+
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput\nDesign system 1.0",
|
|
7080
|
+
"props": [
|
|
9209
7081
|
{
|
|
9210
|
-
"name": "
|
|
9211
|
-
"type": "
|
|
9212
|
-
"required": false
|
|
9213
|
-
"defaultValue": "ElementSize.Standard",
|
|
9214
|
-
"description": "Size of the overlay search input when `searchable` is enabled."
|
|
7082
|
+
"name": "labelProps",
|
|
7083
|
+
"type": "DialLabelProps",
|
|
7084
|
+
"required": false
|
|
9215
7085
|
},
|
|
9216
7086
|
{
|
|
9217
|
-
"name": "
|
|
9218
|
-
"type": "
|
|
9219
|
-
"required": false
|
|
9220
|
-
"description": "Placeholder for the search input (overlay/inline)."
|
|
7087
|
+
"name": "inputButtonProps",
|
|
7088
|
+
"type": "DialInputButtonProps",
|
|
7089
|
+
"required": false
|
|
9221
7090
|
},
|
|
9222
7091
|
{
|
|
9223
|
-
"name": "
|
|
7092
|
+
"name": "invalid",
|
|
9224
7093
|
"type": "boolean",
|
|
9225
7094
|
"required": false,
|
|
9226
|
-
"
|
|
9227
|
-
"description": "Show a \"Select All\" checkbox in multiple mode."
|
|
7095
|
+
"description": "Whether the input has validation errors (applies error styling)"
|
|
9228
7096
|
},
|
|
9229
7097
|
{
|
|
9230
|
-
"name": "
|
|
7098
|
+
"name": "error",
|
|
9231
7099
|
"type": "string",
|
|
9232
7100
|
"required": false,
|
|
9233
|
-
"
|
|
9234
|
-
"description": "Label for the \"Select All\" checkbox."
|
|
7101
|
+
"description": "Error message to display below the input (also adds error styling)"
|
|
9235
7102
|
},
|
|
9236
7103
|
{
|
|
9237
|
-
"name": "
|
|
7104
|
+
"name": "caption",
|
|
9238
7105
|
"type": "string",
|
|
9239
7106
|
"required": false,
|
|
9240
|
-
"
|
|
9241
|
-
"description": "Title text when there are no options."
|
|
7107
|
+
"description": "Helper text to display below the input"
|
|
9242
7108
|
},
|
|
9243
7109
|
{
|
|
9244
|
-
"name": "
|
|
7110
|
+
"name": "tooltipText",
|
|
9245
7111
|
"type": "string",
|
|
9246
|
-
"required": false
|
|
9247
|
-
"description": "Description text when there are no options."
|
|
7112
|
+
"required": false
|
|
9248
7113
|
},
|
|
9249
7114
|
{
|
|
9250
|
-
"name": "
|
|
7115
|
+
"name": "iconBefore",
|
|
9251
7116
|
"type": "ReactNode",
|
|
9252
7117
|
"required": false,
|
|
9253
|
-
"description": "Icon to display
|
|
7118
|
+
"description": "Icon or element to display before the input"
|
|
9254
7119
|
},
|
|
9255
7120
|
{
|
|
9256
|
-
"name": "
|
|
9257
|
-
"type": "
|
|
7121
|
+
"name": "iconAfter",
|
|
7122
|
+
"type": "ReactNode",
|
|
9258
7123
|
"required": false,
|
|
9259
|
-
"
|
|
9260
|
-
"description": "Disable the control."
|
|
7124
|
+
"description": "Icon or element to display after the input"
|
|
9261
7125
|
},
|
|
9262
7126
|
{
|
|
9263
|
-
"name": "
|
|
7127
|
+
"name": "prefix",
|
|
9264
7128
|
"type": "string",
|
|
9265
|
-
"required": false
|
|
9266
|
-
"description": "Additional CSS classes for the trigger."
|
|
7129
|
+
"required": false
|
|
9267
7130
|
},
|
|
9268
7131
|
{
|
|
9269
|
-
"name": "
|
|
7132
|
+
"name": "postfix",
|
|
9270
7133
|
"type": "string",
|
|
9271
|
-
"required": false
|
|
9272
|
-
"description": "Additional CSS classes for the list dropdown."
|
|
9273
|
-
},
|
|
9274
|
-
{
|
|
9275
|
-
"name": "closable",
|
|
9276
|
-
"type": "boolean",
|
|
9277
|
-
"required": false,
|
|
9278
|
-
"defaultValue": "false",
|
|
9279
|
-
"description": "Show a close button in the dropdown header."
|
|
9280
|
-
},
|
|
9281
|
-
{
|
|
9282
|
-
"name": "invalid",
|
|
9283
|
-
"type": "boolean",
|
|
9284
|
-
"required": false,
|
|
9285
|
-
"description": "Whether the select is in an invalid state, affecting styling."
|
|
9286
|
-
},
|
|
9287
|
-
{
|
|
9288
|
-
"name": "header",
|
|
9289
|
-
"type": "ReactNode | (() => ReactNode)",
|
|
9290
|
-
"required": false,
|
|
9291
|
-
"description": "Custom node/function rendered above the options."
|
|
9292
|
-
},
|
|
9293
|
-
{
|
|
9294
|
-
"name": "footer",
|
|
9295
|
-
"type": "ReactNode | (() => ReactNode)",
|
|
9296
|
-
"required": false,
|
|
9297
|
-
"description": "Custom node/function rendered below the options."
|
|
9298
|
-
},
|
|
9299
|
-
{
|
|
9300
|
-
"name": "open",
|
|
9301
|
-
"type": "boolean",
|
|
9302
|
-
"required": false,
|
|
9303
|
-
"description": "Controlled open state of the dropdown. When provided, makes the dropdown controlled."
|
|
9304
|
-
},
|
|
9305
|
-
{
|
|
9306
|
-
"name": "onOpenChange",
|
|
9307
|
-
"type": "(open: boolean) => void",
|
|
9308
|
-
"required": false,
|
|
9309
|
-
"description": "Called when the dropdown open state changes."
|
|
9310
|
-
},
|
|
9311
|
-
{
|
|
9312
|
-
"name": "onInlineQueryChange",
|
|
9313
|
-
"type": "(query: string) => void",
|
|
9314
|
-
"required": false,
|
|
9315
|
-
"description": "Called when the inline search query changes"
|
|
9316
|
-
},
|
|
9317
|
-
{
|
|
9318
|
-
"name": "dismissRef",
|
|
9319
|
-
"type": "Ref<unknown>",
|
|
9320
|
-
"required": false,
|
|
9321
|
-
"description": "Ref object to expose a `dismiss` method to programmatically close the select."
|
|
9322
|
-
},
|
|
9323
|
-
{
|
|
9324
|
-
"name": "onClose",
|
|
9325
|
-
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
9326
|
-
"required": false,
|
|
9327
|
-
"description": "Called when the dropdown close button is clicked."
|
|
9328
|
-
},
|
|
9329
|
-
{
|
|
9330
|
-
"name": "onChange",
|
|
9331
|
-
"type": "(next: string | string[]) => void",
|
|
9332
|
-
"required": false,
|
|
9333
|
-
"description": "Called when the selection changes."
|
|
9334
|
-
},
|
|
9335
|
-
{
|
|
9336
|
-
"name": "inlineSearch",
|
|
9337
|
-
"type": "boolean",
|
|
9338
|
-
"required": false,
|
|
9339
|
-
"defaultValue": "false",
|
|
9340
|
-
"description": "Render a plain input inside trigger (single mode only)."
|
|
7134
|
+
"required": false
|
|
9341
7135
|
},
|
|
9342
7136
|
{
|
|
9343
|
-
"name": "
|
|
9344
|
-
"type": "
|
|
7137
|
+
"name": "inputRef",
|
|
7138
|
+
"type": "Ref<HTMLInputElement>",
|
|
9345
7139
|
"required": false,
|
|
9346
|
-
"description": "
|
|
7140
|
+
"description": "Ref to access the underlying input element"
|
|
9347
7141
|
},
|
|
9348
7142
|
{
|
|
9349
|
-
"name": "
|
|
9350
|
-
"type": "(
|
|
9351
|
-
"required": false
|
|
9352
|
-
|
|
9353
|
-
|
|
9354
|
-
"examples": [
|
|
9355
|
-
"<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' }]} />"
|
|
9356
|
-
],
|
|
9357
|
-
"sourceFile": "components/Select/Select.tsx",
|
|
9358
|
-
"supersededBy": "Select"
|
|
9359
|
-
},
|
|
9360
|
-
{
|
|
9361
|
-
"name": "DialSelectField",
|
|
9362
|
-
"category": "Form",
|
|
9363
|
-
"generation": "1.0",
|
|
9364
|
-
"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).",
|
|
9365
|
-
"props": [
|
|
7143
|
+
"name": "onChange",
|
|
7144
|
+
"type": "(value?: string) => void",
|
|
7145
|
+
"required": false,
|
|
7146
|
+
"description": "Callback function called when the input value changes"
|
|
7147
|
+
},
|
|
9366
7148
|
{
|
|
9367
|
-
"name": "
|
|
7149
|
+
"name": "containerClassName",
|
|
9368
7150
|
"type": "string",
|
|
9369
7151
|
"required": false,
|
|
9370
|
-
"description": "CSS
|
|
7152
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
9371
7153
|
},
|
|
9372
7154
|
{
|
|
9373
|
-
"name": "
|
|
7155
|
+
"name": "wrapperClassName",
|
|
9374
7156
|
"type": "string",
|
|
9375
7157
|
"required": false,
|
|
9376
|
-
"description": "CSS
|
|
7158
|
+
"description": "Additional CSS classes to apply to the input wrapper div"
|
|
9377
7159
|
}
|
|
9378
7160
|
],
|
|
9379
7161
|
"examples": [
|
|
9380
|
-
"
|
|
7162
|
+
"<DialInput\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
9381
7163
|
],
|
|
9382
|
-
"sourceFile": "components/
|
|
7164
|
+
"sourceFile": "components/Input/Input.tsx",
|
|
7165
|
+
"supersededBy": "Input"
|
|
9383
7166
|
},
|
|
9384
7167
|
{
|
|
9385
7168
|
"name": "DialLoadFileArea",
|
|
@@ -9597,224 +7380,6 @@
|
|
|
9597
7380
|
"examples": [],
|
|
9598
7381
|
"sourceFile": "components/Dropdown/Dropdown.tsx",
|
|
9599
7382
|
"supersededBy": "Dropdown"
|
|
9600
|
-
},
|
|
9601
|
-
{
|
|
9602
|
-
"name": "DialButtonDropdown",
|
|
9603
|
-
"category": "Dropdown",
|
|
9604
|
-
"generation": "1.0",
|
|
9605
|
-
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton\nDesign system 1.0",
|
|
9606
|
-
"props": [
|
|
9607
|
-
{
|
|
9608
|
-
"name": "items",
|
|
9609
|
-
"type": "DropdownItem[]",
|
|
9610
|
-
"required": true,
|
|
9611
|
-
"description": "DropdownItems with actions"
|
|
9612
|
-
}
|
|
9613
|
-
],
|
|
9614
|
-
"examples": [
|
|
9615
|
-
"<DialButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
9616
|
-
],
|
|
9617
|
-
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx",
|
|
9618
|
-
"supersededBy": "ButtonDropdown"
|
|
9619
|
-
},
|
|
9620
|
-
{
|
|
9621
|
-
"name": "DialDropdownIcon",
|
|
9622
|
-
"category": "Dropdown",
|
|
9623
|
-
"generation": "1.0",
|
|
9624
|
-
"description": "A compact icon trigger with a dropdown menu.\naliases: ModelPicker|IconMenu|AvatarDropdown\nDesign system 1.0",
|
|
9625
|
-
"props": [
|
|
9626
|
-
{
|
|
9627
|
-
"name": "icon",
|
|
9628
|
-
"type": "ReactNode",
|
|
9629
|
-
"required": true,
|
|
9630
|
-
"description": "Primary trigger icon."
|
|
9631
|
-
},
|
|
9632
|
-
{
|
|
9633
|
-
"name": "ariaLabel",
|
|
9634
|
-
"type": "string",
|
|
9635
|
-
"required": true,
|
|
9636
|
-
"description": "Accessible name for the trigger button."
|
|
9637
|
-
},
|
|
9638
|
-
{
|
|
9639
|
-
"name": "size",
|
|
9640
|
-
"type": "ElementSize",
|
|
9641
|
-
"required": false,
|
|
9642
|
-
"defaultValue": "ElementSize.Standard",
|
|
9643
|
-
"description": "Trigger size."
|
|
9644
|
-
},
|
|
9645
|
-
{
|
|
9646
|
-
"name": "className",
|
|
9647
|
-
"type": "string",
|
|
9648
|
-
"required": false,
|
|
9649
|
-
"description": "Additional CSS classes applied to the dropdown wrapper."
|
|
9650
|
-
},
|
|
9651
|
-
{
|
|
9652
|
-
"name": "buttonClassName",
|
|
9653
|
-
"type": "string",
|
|
9654
|
-
"required": false,
|
|
9655
|
-
"description": "Additional CSS classes applied to the trigger button."
|
|
9656
|
-
},
|
|
9657
|
-
{
|
|
9658
|
-
"name": "iconClassName",
|
|
9659
|
-
"type": "string",
|
|
9660
|
-
"required": false,
|
|
9661
|
-
"description": "Additional CSS classes applied to the primary icon wrapper."
|
|
9662
|
-
},
|
|
9663
|
-
{
|
|
9664
|
-
"name": "caretIcon",
|
|
9665
|
-
"type": "ReactNode",
|
|
9666
|
-
"required": false,
|
|
9667
|
-
"defaultValue": "<IconChevronDown size={DIAL_ICON_SIZE.SM} />",
|
|
9668
|
-
"description": "Custom caret icon."
|
|
9669
|
-
},
|
|
9670
|
-
{
|
|
9671
|
-
"name": "showCaret",
|
|
9672
|
-
"type": "boolean",
|
|
9673
|
-
"required": false,
|
|
9674
|
-
"defaultValue": "true",
|
|
9675
|
-
"description": "Whether to render the caret."
|
|
9676
|
-
}
|
|
9677
|
-
],
|
|
9678
|
-
"examples": [
|
|
9679
|
-
"<DialDropdownIcon\n ariaLabel=\"Select model\"\n icon={<IconBrandOpenai size={18} />}\n items={items}\n/>"
|
|
9680
|
-
],
|
|
9681
|
-
"sourceFile": "components/DropdownIcon/DropdownIcon.tsx"
|
|
9682
|
-
},
|
|
9683
|
-
{
|
|
9684
|
-
"name": "DialSchemaRenderer",
|
|
9685
|
-
"category": "Name",
|
|
9686
|
-
"generation": "1.0",
|
|
9687
|
-
"description": "Renders a JSON Schema as a form UI with collapsible sections, validation, and default values.\naliases: SchemaRenderer|JsonSchemaForm\nDesign system 1.0",
|
|
9688
|
-
"props": [],
|
|
9689
|
-
"examples": [
|
|
9690
|
-
"<DialSchemaRenderer\n schema={mySchema}\n onChange={(v) => console.log(v)}\n onDefaultValues={(defaults) => console.log(defaults)}\n/>"
|
|
9691
|
-
],
|
|
9692
|
-
"sourceFile": "components/SchemaRenderer/SchemaRenderer.tsx",
|
|
9693
|
-
"supersededBy": "SchemaRenderer"
|
|
9694
|
-
},
|
|
9695
|
-
{
|
|
9696
|
-
"name": "DialJsonEditor",
|
|
9697
|
-
"category": "Data Display",
|
|
9698
|
-
"generation": "1.0",
|
|
9699
|
-
"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.",
|
|
9700
|
-
"props": [
|
|
9701
|
-
{
|
|
9702
|
-
"name": "value",
|
|
9703
|
-
"type": "string | undefined",
|
|
9704
|
-
"required": false,
|
|
9705
|
-
"description": "The JSON string value to edit"
|
|
9706
|
-
},
|
|
9707
|
-
{
|
|
9708
|
-
"name": "currentTheme",
|
|
9709
|
-
"type": "string",
|
|
9710
|
-
"required": true,
|
|
9711
|
-
"description": "The theme to apply to the editor"
|
|
9712
|
-
},
|
|
9713
|
-
{
|
|
9714
|
-
"name": "themesConfig",
|
|
9715
|
-
"type": "Record<EditorThemes, editor.IStandaloneThemeData>",
|
|
9716
|
-
"required": false,
|
|
9717
|
-
"defaultValue": "EDITOR_THEMES_CONFIG",
|
|
9718
|
-
"description": "Custom theme configurations"
|
|
9719
|
-
},
|
|
9720
|
-
{
|
|
9721
|
-
"name": "onChange",
|
|
9722
|
-
"type": "(value: string | undefined) => void",
|
|
9723
|
-
"required": true,
|
|
9724
|
-
"description": "Callback fired when the editor content changes"
|
|
9725
|
-
},
|
|
9726
|
-
{
|
|
9727
|
-
"name": "onValidateJSON",
|
|
9728
|
-
"type": "OnValidate",
|
|
9729
|
-
"required": false,
|
|
9730
|
-
"description": "Callback fired when JSON validation occurs"
|
|
9731
|
-
},
|
|
9732
|
-
{
|
|
9733
|
-
"name": "options",
|
|
9734
|
-
"type": "editor.IStandaloneEditorConstructionOptions",
|
|
9735
|
-
"required": false,
|
|
9736
|
-
"description": "Additional Monaco editor options"
|
|
9737
|
-
}
|
|
9738
|
-
],
|
|
9739
|
-
"examples": [],
|
|
9740
|
-
"sourceFile": "components/JsonEditor/JsonEditor.tsx",
|
|
9741
|
-
"lazy": {
|
|
9742
|
-
"loaderExportName": "LazyDialJsonEditor",
|
|
9743
|
-
"packageImport": "@epam/ai-dial-ui-kit",
|
|
9744
|
-
"ssr": false,
|
|
9745
|
-
"nextDynamicExample": "import dynamic from 'next/dynamic';\nimport { LazyDialJsonEditor } from '@epam/ai-dial-ui-kit';\n\nconst DialJsonEditor = dynamic(\n async () => (await LazyDialJsonEditor()).DialJsonEditor,\n { ssr: false },\n);"
|
|
9746
|
-
}
|
|
9747
|
-
},
|
|
9748
|
-
{
|
|
9749
|
-
"name": "DialMarkdownEditor",
|
|
9750
|
-
"category": "Data Display",
|
|
9751
|
-
"generation": "1.0",
|
|
9752
|
-
"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.",
|
|
9753
|
-
"props": [
|
|
9754
|
-
{
|
|
9755
|
-
"name": "value",
|
|
9756
|
-
"type": "string",
|
|
9757
|
-
"required": false,
|
|
9758
|
-
"description": "The current markdown content"
|
|
9759
|
-
},
|
|
9760
|
-
{
|
|
9761
|
-
"name": "onChange",
|
|
9762
|
-
"type": "(value: string) => void",
|
|
9763
|
-
"required": false,
|
|
9764
|
-
"description": "Callback fired when the editor content changes"
|
|
9765
|
-
},
|
|
9766
|
-
{
|
|
9767
|
-
"name": "height",
|
|
9768
|
-
"type": "number",
|
|
9769
|
-
"required": false,
|
|
9770
|
-
"defaultValue": "300",
|
|
9771
|
-
"description": "Height of the editor in pixels"
|
|
9772
|
-
},
|
|
9773
|
-
{
|
|
9774
|
-
"name": "preview",
|
|
9775
|
-
"type": "PreviewType",
|
|
9776
|
-
"required": false,
|
|
9777
|
-
"defaultValue": "'edit'",
|
|
9778
|
-
"description": "Preview mode ('edit', 'live', 'preview')"
|
|
9779
|
-
},
|
|
9780
|
-
{
|
|
9781
|
-
"name": "theme",
|
|
9782
|
-
"type": "EditorThemes",
|
|
9783
|
-
"required": false,
|
|
9784
|
-
"defaultValue": "EditorThemes.dark",
|
|
9785
|
-
"description": "Theme for the editor ('light' or 'dark')"
|
|
9786
|
-
},
|
|
9787
|
-
{
|
|
9788
|
-
"name": "className",
|
|
9789
|
-
"type": "string",
|
|
9790
|
-
"required": false,
|
|
9791
|
-
"description": "Additional CSS classes for the container"
|
|
9792
|
-
},
|
|
9793
|
-
{
|
|
9794
|
-
"name": "placeholder",
|
|
9795
|
-
"type": "ReactNode",
|
|
9796
|
-
"required": false,
|
|
9797
|
-
"description": "Content to display when the editor is empty"
|
|
9798
|
-
},
|
|
9799
|
-
{
|
|
9800
|
-
"name": "showDragbar",
|
|
9801
|
-
"type": "boolean",
|
|
9802
|
-
"required": false,
|
|
9803
|
-
"defaultValue": "true",
|
|
9804
|
-
"description": "Whether to show the bottom drag bar that resizes the editor height"
|
|
9805
|
-
}
|
|
9806
|
-
],
|
|
9807
|
-
"examples": [
|
|
9808
|
-
"<DialMarkdownEditor\nvalue=\"# Hello World\"\nonChange={(value) => console.log(value)}\nheight={400}\ntheme=\"dark\"\n/>"
|
|
9809
|
-
],
|
|
9810
|
-
"sourceFile": "components/MarkdownEditor/MarkdownEditor.tsx",
|
|
9811
|
-
"lazy": {
|
|
9812
|
-
"loaderExportName": "LazyDialMarkdownEditor",
|
|
9813
|
-
"packageImport": "@epam/ai-dial-ui-kit",
|
|
9814
|
-
"ssr": false,
|
|
9815
|
-
"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);"
|
|
9816
|
-
},
|
|
9817
|
-
"supersededBy": "MarkdownEditor"
|
|
9818
7383
|
}
|
|
9819
7384
|
],
|
|
9820
7385
|
"types": [
|
|
@@ -10217,52 +7782,6 @@
|
|
|
10217
7782
|
],
|
|
10218
7783
|
"sourceFile": "models/breadcrumb.ts"
|
|
10219
7784
|
},
|
|
10220
|
-
{
|
|
10221
|
-
"name": "FormItemOrientation",
|
|
10222
|
-
"kind": "enum",
|
|
10223
|
-
"members": [
|
|
10224
|
-
{
|
|
10225
|
-
"name": "Vertical",
|
|
10226
|
-
"value": "'vertical'"
|
|
10227
|
-
},
|
|
10228
|
-
{
|
|
10229
|
-
"name": "Horizontal",
|
|
10230
|
-
"value": "'horizontal'"
|
|
10231
|
-
}
|
|
10232
|
-
],
|
|
10233
|
-
"sourceFile": "types/form-item.ts",
|
|
10234
|
-
"description": "Orientation options for form item layout"
|
|
10235
|
-
},
|
|
10236
|
-
{
|
|
10237
|
-
"name": "SelectSize",
|
|
10238
|
-
"kind": "enum",
|
|
10239
|
-
"members": [
|
|
10240
|
-
{
|
|
10241
|
-
"name": "Sm",
|
|
10242
|
-
"value": "'sm'"
|
|
10243
|
-
},
|
|
10244
|
-
{
|
|
10245
|
-
"name": "Md",
|
|
10246
|
-
"value": "'md'"
|
|
10247
|
-
}
|
|
10248
|
-
],
|
|
10249
|
-
"sourceFile": "types/select.ts"
|
|
10250
|
-
},
|
|
10251
|
-
{
|
|
10252
|
-
"name": "SelectVariant",
|
|
10253
|
-
"kind": "enum",
|
|
10254
|
-
"members": [
|
|
10255
|
-
{
|
|
10256
|
-
"name": "Primary",
|
|
10257
|
-
"value": "'Primary'"
|
|
10258
|
-
},
|
|
10259
|
-
{
|
|
10260
|
-
"name": "Secondary",
|
|
10261
|
-
"value": "'Secondary'"
|
|
10262
|
-
}
|
|
10263
|
-
],
|
|
10264
|
-
"sourceFile": "types/select.ts"
|
|
10265
|
-
},
|
|
10266
7785
|
{
|
|
10267
7786
|
"name": "FlexibleActionsDirection",
|
|
10268
7787
|
"kind": "enum",
|
|
@@ -10465,29 +7984,6 @@
|
|
|
10465
7984
|
],
|
|
10466
7985
|
"sourceFile": "models/select.ts"
|
|
10467
7986
|
},
|
|
10468
|
-
{
|
|
10469
|
-
"name": "SegmentedControlOption",
|
|
10470
|
-
"kind": "interface",
|
|
10471
|
-
"members": [
|
|
10472
|
-
{
|
|
10473
|
-
"name": "value",
|
|
10474
|
-
"value": "T"
|
|
10475
|
-
},
|
|
10476
|
-
{
|
|
10477
|
-
"name": "label?",
|
|
10478
|
-
"value": "ReactNode"
|
|
10479
|
-
},
|
|
10480
|
-
{
|
|
10481
|
-
"name": "icon?",
|
|
10482
|
-
"value": "ReactNode"
|
|
10483
|
-
},
|
|
10484
|
-
{
|
|
10485
|
-
"name": "disabled?",
|
|
10486
|
-
"value": "boolean"
|
|
10487
|
-
}
|
|
10488
|
-
],
|
|
10489
|
-
"sourceFile": "models/segmented-control.ts"
|
|
10490
|
-
},
|
|
10491
7987
|
{
|
|
10492
7988
|
"name": "TabModel",
|
|
10493
7989
|
"kind": "interface",
|
|
@@ -11894,18 +9390,6 @@
|
|
|
11894
9390
|
"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.",
|
|
11895
9391
|
"signature": "DEFAULT_ANALYTICS_BAR_COLOR_MAP: AnalyticsBarColorStop[]"
|
|
11896
9392
|
},
|
|
11897
|
-
{
|
|
11898
|
-
"name": "DEFAULT_GRID_DATE_FORMAT_OPTIONS",
|
|
11899
|
-
"sourceFile": "components/Grid/renderers/constants.ts"
|
|
11900
|
-
},
|
|
11901
|
-
{
|
|
11902
|
-
"name": "DEFAULT_GRID_DATE_LOCALE",
|
|
11903
|
-
"sourceFile": "components/Grid/renderers/constants.ts"
|
|
11904
|
-
},
|
|
11905
|
-
{
|
|
11906
|
-
"name": "convertGridDateToDate",
|
|
11907
|
-
"sourceFile": "utils/grid-date.ts"
|
|
11908
|
-
},
|
|
11909
9393
|
{
|
|
11910
9394
|
"name": "EDITABLE_CONTAINER_ATTRIBUTE",
|
|
11911
9395
|
"sourceFile": "hooks/use-editable-item.tsx",
|
|
@@ -12084,7 +9568,7 @@
|
|
|
12084
9568
|
{
|
|
12085
9569
|
"name": "DIAL_KIT_CLASS",
|
|
12086
9570
|
"sourceFile": "constants/public-class-names.ts",
|
|
12087
|
-
"signature": "DIAL_KIT_CLASS = {\n /* ── Feedback and status ───────────────────────────────────────────────── */\n /** The `role=\"status\"` root of a `Spinner`. */\n spinner: 'dial-kit-spinner',\n /**\n * The outermost element of a `ProgressBar`: the box wrapping its label,\n * track and readout — or the track itself, which is the root when the bar\n * has neither.\n */\n progressBar: 'dial-kit-progress-bar',\n /** The root of a `Skeleton`, wrapping its avatar and text rows. */\n skeleton: 'dial-kit-skeleton',\n /**\n * The `Notification` surface. Present on every wrapper too — the toast and\n * section-message variants of error, info, success, warning, loading and\n * general all render this component.\n */\n notification: 'dial-kit-notification',\n /** The empty-state root of `NoDataContent`. */\n noDataContent: 'dial-kit-no-data-content',\n /** The `section` root of a `StateScreen`. */\n stateScreen: 'dial-kit-state-screen',\n /** The `role=\"status\"` panel of a `TransferQueue`: header, rows and aggregate bar. */\n transferQueue: 'dial-kit-transfer-queue',\n\n /* ── Text ──────────────────────────────────────────────────────────────── */\n /** The text element of a `Highlight`, which renders the matched query. */\n highlight: 'dial-kit-highlight',\n /** The caption line under a field, rendered by `CaptionText`. */\n captionText: 'dial-kit-caption-text',\n /**\n * A caption in its error variant — what `ErrorText` renders. Additive to\n * `captionText`, since one component draws both.\n */\n errorText: 'dial-kit-error-text',\n /** The `Label` root, which wraps the `label` element and its info button. */\n label: 'dial-kit-label',\n\n /* ── Containers ────────────────────────────────────────────────────────── */\n /** The `article` element of a `CardShell`. */\n cardShell: 'dial-kit-card-shell',\n /** The `aside` element of a `CollapsibleSidebar`. */\n collapsibleSidebar: 'dial-kit-collapsible-sidebar',\n /** The content box inside a `ResizableContainer`'s resize frame. */\n resizableContainer: 'dial-kit-resizable-container',\n /** The `role=\"separator\"` element of a `ResizeHandle`. */\n resizeHandle: 'dial-kit-resize-handle',\n /**\n * The `role=\"dialog\"` panel of a `Popup`. Its backdrop is reached through\n * `overlayClassName`.\n */\n popup: 'dial-kit-popup',\n /** The `role=\"dialog\"` panel of a `BottomSheet`. */\n bottomSheet: 'dial-kit-bottom-sheet',\n /**\n * The backdrop of a `BottomSheet`: the portalled, scroll-locking layer on\n * `z-popup` that holds the panel.\n */\n bottomSheetOverlay: 'dial-kit-bottom-sheet-overlay',\n /** The `role=\"dialog\"` panel of a `SideDrawer`, open or closed. */\n sideDrawer: 'dial-kit-side-drawer',\n /** The `Popup` panel of a `ConfirmationPopup`, additive to `popup`. */\n confirmationPopup: 'dial-kit-confirmation-popup',\n /** The root of an `Accordion`. */\n accordion: 'dial-kit-accordion',\n /** The breadcrumb root of a `FolderPath`. */\n folderPath: 'dial-kit-folder-path',\n /** The `nav` element of a `Breadcrumbs` trail. */\n breadcrumbs: 'dial-kit-breadcrumbs',\n /**\n * One segment of a `Breadcrumbs` trail: the link, button or plain span that\n * draws the label — not the `li`, which also holds the separator after it.\n */\n breadcrumbsItem: 'dial-kit-breadcrumbs-item',\n\n /* ── Menus and overlays ────────────────────────────────────────────────── */\n /**\n * The trigger wrapper of a `Dropdown`. Its floating panel is reached through\n * `listClassName`.\n */\n dropdown: 'dial-kit-dropdown',\n /**\n * The `role=\"none\"` item list inside a dropdown overlay — the box that holds\n * the rows and owns their vertical padding. Present in both generations, and\n * on a submenu's own list. It is *not* the floating panel.\n */\n dropdownList: 'dial-kit-dropdown-list',\n /** The search row above the item list of a `searchable` `Dropdown`. */\n dropdownSearch: 'dial-kit-dropdown-search',\n /**\n * One row of a floating overlay: a dropdown item, a `Select` option, a\n * submenu trigger, or a submenu child. It sits on the element that draws the\n * row box — so on the wrapper, not the inner button, for a row that has a\n * `rightControl` beside it.\n */\n menuItem: 'dial-kit-menuitem',\n /**\n * The trailing check of a chosen `MenuItemMark.Check` row. Decorative, like\n * the glyph itself — the row's `aria-checked` / `aria-selected` carries the\n * state.\n */\n menuItemCheck: 'dial-kit-menuitem-check',\n /** The primary icon of a `DialDropdownIcon` trigger. */\n dropdownIcon: 'dial-kit-dropdown-icon',\n /**\n * The caret badge of a `DialDropdownIcon` trigger — the round plate the\n * chevron sits on. Absent when `showCaret` is `false`.\n */\n dropdownIconCaret: 'dial-kit-dropdown-icon-caret',\n /** The bubble of a `Tooltip`, rendered by `TooltipContent` into a portal. */\n tooltip: 'dial-kit-tooltip',\n /** The panel of an `InteractiveTooltip` — the one whose content takes focus. */\n interactiveTooltip: 'dial-kit-interactive-tooltip',\n /** The text element of an `EllipsisTooltip`, which is also its trigger. */\n ellipsisTooltip: 'dial-kit-ellipsis-tooltip',\n\n /* ── Fields ────────────────────────────────────────────────────────────── */\n /** The `Search` field, additive to the `dial-kit-input` its `Input` carries. */\n search: 'dial-kit-search',\n /** The `PasswordInput` field, additive to `dial-kit-input`. */\n passwordInput: 'dial-kit-password-input',\n /** The `NumberInput` field, additive to `dial-kit-input`. */\n numberInput: 'dial-kit-number-input',\n /** The `TagInput` field, additive to `dial-kit-input`. */\n tagInput: 'dial-kit-tag-input',\n /** The `AutocompleteTagInput` field, additive to `dial-kit-input`. */\n autocompleteTagInput: 'dial-kit-autocomplete-tag-input',\n /** The root of a `Select`, wrapping its label, field and caption. */\n select: 'dial-kit-select',\n /** The trigger button of an `InlineSelect`. */\n inlineSelect: 'dial-kit-inline-select',\n /** The root of a `Calendar`, wrapping its label and date field. */\n calendar: 'dial-kit-calendar',\n /** The root of a `SchemaRenderer`, wrapping its top-level sections or fields. */\n schemaRenderer: 'dial-kit-schema-renderer',\n /**\n * The card of one collapsible `SchemaRenderer` section, at any depth: a\n * top-level property, a nested object or array, an array item, or a\n * key-value entry holding an object.\n */\n schemaRendererSection: 'dial-kit-schema-renderer-section',\n /** The drop area of a `FileDropzone`. */\n fileDropzone: 'dial-kit-file-dropzone',\n /**\n * The root of a `FileIcon`, wrapping the file or folder glyph (or\n * its spinner while loading) and the shared badge.\n */\n fileIcon: 'dial-kit-file-icon',\n /** The row of a `FileName`: its type icon, the name and any details. */\n fileName: 'dial-kit-file-name',\n /** The `FileName` row of a `FolderName`, additive to `fileName`. */\n folderName: 'dial-kit-folder-name',\n /**\n * The `role=\"img\"` badge of a `SharedEntityIndicator` — standalone, or the\n * shared badge a `FileIcon` draws over its glyph.\n */\n sharedEntityIndicator: 'dial-kit-shared-entity-indicator',\n /** The root of a `Badge`: the label box, with its icon when it has one. */\n badge: 'dial-kit-badge',\n /** The root of an `Avatar`: the image, or the initials box that replaces it. */\n avatar: 'dial-kit-avatar',\n /** The root row of an `EntityIdentity`: its icon, type label, name and version. */\n entityIdentity: 'dial-kit-entity-identity',\n /** The bordered card of a `SelectedEntityCard`, not the wrapper that also holds its error. */\n selectedEntityCard: 'dial-kit-selected-entity-card',\n /** The `section` root of a `FormSection`: its heading row, description and content. */\n formSection: 'dial-kit-form-section',\n\n /* ── Controls ──────────────────────────────────────────────────────────── */\n /** The row of a `Switch`: the control and its label. */\n switch: 'dial-kit-switch',\n /** The row of a `Checkbox`: the box and its label. */\n checkbox: 'dial-kit-checkbox',\n /** The decorative box a `CheckboxBox` draws, in a checkbox or a menu row. */\n checkboxBox: 'dial-kit-checkbox-box',\n /** The row of a `Radio`: the circle and its label. */\n radio: 'dial-kit-radio',\n /** The root of a `RadioGroup`, wrapping its label and its radios. */\n radioGroup: 'dial-kit-radio-group',\n /**\n * The root of a `RadioGroupPopupField`, wrapping its label and the collapsed\n * field that opens the group.\n */\n radioGroupPopupField: 'dial-kit-radio-group-popup-field',\n /** The `role=\"radiogroup\"` track of a `SegmentedControl`. */\n segmentedControl: 'dial-kit-segmented-control',\n /** One segment of a `SegmentedControl`. */\n segmentedControlItem: 'dial-kit-segmented-control-item',\n /**\n * The outermost element of a `Tabs`: the box wrapping its heading and tab\n * list — or the `role=\"tablist\"` itself, which is the root when the tabs\n * carry no `sectionLabel`.\n */\n tabs: 'dial-kit-tabs',\n /**\n * The `role=\"tablist\"` holding the tabs, in either orientation. Additive to\n * `tabs` when there is no heading above it, since one element is then both.\n */\n tabList: 'dial-kit-tab-list',\n /**\n * One tab inside `Tabs`, in either orientation. The selected tab of a\n * horizontal row keeps its own `dial-kit-tab-selected-underline`.\n */\n tab: 'dial-kit-tab',\n /**\n * The selected tab, additive to `tab`. A horizontal row draws its selection\n * with `dial-kit-tab-selected-underline`, which carries the gradient rule;\n * this one carries no declarations and marks the selected tab in either\n * orientation.\n */\n tabSelected: 'dial-kit-tab-selected',\n /** The `sectionLabel` heading above a `Tabs`. Absent when there is none. */\n tabsSectionLabel: 'dial-kit-tabs-section-label',\n /**\n * The `role=\"group\"` row of a `FilterChips`. Its chips are `Tag` pills, so\n * they carry `dial-kit-tag` and have no entry of their own.\n */\n filterChips: 'dial-kit-filter-chips',\n /** A `Tag` pill, wherever it is rendered — including a `TagInput`'s rows. */\n tag: 'dial-kit-tag',\n /**\n * A `ToggleIconButton`, additive to the `dial-kit-base-icon-button` it\n * already carries.\n */\n toggleIconButton: 'dial-kit-toggle-icon-button',\n /** A `CloseButton`, additive to `dial-kit-base-icon-button`. */\n closeButton: 'dial-kit-close-button',\n /** An `InfoButton`, additive to `dial-kit-base-icon-button`. */\n infoButton: 'dial-kit-info-button',\n /**\n * The wrapper of a `ButtonDropdown` — its trigger carries\n * `dial-kit-base-button`.\n */\n buttonDropdown: 'dial-kit-button-dropdown',\n} as const"
|
|
9571
|
+
"signature": "DIAL_KIT_CLASS = {\n /* ── Feedback and status ───────────────────────────────────────────────── */\n /** The `role=\"status\"` root of a `Spinner`. */\n spinner: 'dial-kit-spinner',\n /**\n * The outermost element of a `ProgressBar`: the box wrapping its label,\n * track and readout — or the track itself, which is the root when the bar\n * has neither.\n */\n progressBar: 'dial-kit-progress-bar',\n /** The root of a `Skeleton`, wrapping its avatar and text rows. */\n skeleton: 'dial-kit-skeleton',\n /**\n * The `Notification` surface. Present on every wrapper too — the toast and\n * section-message variants of error, info, success, warning, loading and\n * general all render this component.\n */\n notification: 'dial-kit-notification',\n /** The empty-state root of `NoDataContent`. */\n noDataContent: 'dial-kit-no-data-content',\n /** The `section` root of a `StateScreen`. */\n stateScreen: 'dial-kit-state-screen',\n /** The `role=\"status\"` panel of a `TransferQueue`: header, rows and aggregate bar. */\n transferQueue: 'dial-kit-transfer-queue',\n\n /* ── Text ──────────────────────────────────────────────────────────────── */\n /** The text element of a `Highlight`, which renders the matched query. */\n highlight: 'dial-kit-highlight',\n /** The caption line under a field, rendered by `CaptionText`. */\n captionText: 'dial-kit-caption-text',\n /**\n * A caption in its error variant — what `ErrorText` renders. Additive to\n * `captionText`, since one component draws both.\n */\n errorText: 'dial-kit-error-text',\n /** The `Label` root, which wraps the `label` element and its info button. */\n label: 'dial-kit-label',\n\n /* ── Containers ────────────────────────────────────────────────────────── */\n /** The `article` element of a `CardShell`. */\n cardShell: 'dial-kit-card-shell',\n /** The `aside` element of a `CollapsibleSidebar`. */\n collapsibleSidebar: 'dial-kit-collapsible-sidebar',\n /** The content box inside a `ResizableContainer`'s resize frame. */\n resizableContainer: 'dial-kit-resizable-container',\n /** The `role=\"separator\"` element of a `ResizeHandle`. */\n resizeHandle: 'dial-kit-resize-handle',\n /**\n * The `role=\"dialog\"` panel of a `Popup`. Its backdrop is reached through\n * `overlayClassName`.\n */\n popup: 'dial-kit-popup',\n /** The `role=\"dialog\"` panel of a `BottomSheet`. */\n bottomSheet: 'dial-kit-bottom-sheet',\n /**\n * The backdrop of a `BottomSheet`: the portalled, scroll-locking layer on\n * `z-popup` that holds the panel.\n */\n bottomSheetOverlay: 'dial-kit-bottom-sheet-overlay',\n /** The `role=\"dialog\"` panel of a `SideDrawer`, open or closed. */\n sideDrawer: 'dial-kit-side-drawer',\n /** The `Popup` panel of a `ConfirmationPopup`, additive to `popup`. */\n confirmationPopup: 'dial-kit-confirmation-popup',\n /** The root of an `Accordion`. */\n accordion: 'dial-kit-accordion',\n /** The breadcrumb root of a `FolderPath`. */\n folderPath: 'dial-kit-folder-path',\n /** The `nav` element of a `Breadcrumbs` trail. */\n breadcrumbs: 'dial-kit-breadcrumbs',\n /**\n * One segment of a `Breadcrumbs` trail: the link, button or plain span that\n * draws the label — not the `li`, which also holds the separator after it.\n */\n breadcrumbsItem: 'dial-kit-breadcrumbs-item',\n\n /* ── Menus and overlays ────────────────────────────────────────────────── */\n /**\n * The trigger wrapper of a `Dropdown`. Its floating panel is reached through\n * `listClassName`.\n */\n dropdown: 'dial-kit-dropdown',\n /**\n * The `role=\"none\"` item list inside a dropdown overlay — the box that holds\n * the rows and owns their vertical padding. Present in both generations, and\n * on a submenu's own list. It is *not* the floating panel.\n */\n dropdownList: 'dial-kit-dropdown-list',\n /** The search row above the item list of a `searchable` `Dropdown`. */\n dropdownSearch: 'dial-kit-dropdown-search',\n /**\n * One row of a floating overlay: a dropdown item, a `Select` option, a\n * submenu trigger, or a submenu child. It sits on the element that draws the\n * row box — so on the wrapper, not the inner button, for a row that has a\n * `rightControl` beside it.\n */\n menuItem: 'dial-kit-menuitem',\n /**\n * The trailing check of a chosen `MenuItemMark.Check` row. Decorative, like\n * the glyph itself — the row's `aria-checked` / `aria-selected` carries the\n * state.\n */\n menuItemCheck: 'dial-kit-menuitem-check',\n /** The bubble of a `Tooltip`, rendered by `TooltipContent` into a portal. */\n tooltip: 'dial-kit-tooltip',\n /** The panel of an `InteractiveTooltip` — the one whose content takes focus. */\n interactiveTooltip: 'dial-kit-interactive-tooltip',\n /** The text element of an `EllipsisTooltip`, which is also its trigger. */\n ellipsisTooltip: 'dial-kit-ellipsis-tooltip',\n\n /* ── Fields ────────────────────────────────────────────────────────────── */\n /** The `Search` field, additive to the `dial-kit-input` its `Input` carries. */\n search: 'dial-kit-search',\n /** The `PasswordInput` field, additive to `dial-kit-input`. */\n passwordInput: 'dial-kit-password-input',\n /** The `NumberInput` field, additive to `dial-kit-input`. */\n numberInput: 'dial-kit-number-input',\n /** The `TagInput` field, additive to `dial-kit-input`. */\n tagInput: 'dial-kit-tag-input',\n /** The `AutocompleteTagInput` field, additive to `dial-kit-input`. */\n autocompleteTagInput: 'dial-kit-autocomplete-tag-input',\n /** The root of a `Select`, wrapping its label, field and caption. */\n select: 'dial-kit-select',\n /** The trigger button of an `InlineSelect`. */\n inlineSelect: 'dial-kit-inline-select',\n /** The root of a `Calendar`, wrapping its label and date field. */\n calendar: 'dial-kit-calendar',\n /** The root of a `SchemaRenderer`, wrapping its top-level sections or fields. */\n schemaRenderer: 'dial-kit-schema-renderer',\n /**\n * The card of one collapsible `SchemaRenderer` section, at any depth: a\n * top-level property, a nested object or array, an array item, or a\n * key-value entry holding an object.\n */\n schemaRendererSection: 'dial-kit-schema-renderer-section',\n /** The drop area of a `FileDropzone`. */\n fileDropzone: 'dial-kit-file-dropzone',\n /**\n * The root of a `FileIcon`, wrapping the file or folder glyph (or\n * its spinner while loading) and the shared badge.\n */\n fileIcon: 'dial-kit-file-icon',\n /** The row of a `FileName`: its type icon, the name and any details. */\n fileName: 'dial-kit-file-name',\n /** The `FileName` row of a `FolderName`, additive to `fileName`. */\n folderName: 'dial-kit-folder-name',\n /**\n * The `role=\"img\"` badge of a `SharedEntityIndicator` — standalone, or the\n * shared badge a `FileIcon` draws over its glyph.\n */\n sharedEntityIndicator: 'dial-kit-shared-entity-indicator',\n /** The root of a `Badge`: the label box, with its icon when it has one. */\n badge: 'dial-kit-badge',\n /** The root of an `Avatar`: the image, or the initials box that replaces it. */\n avatar: 'dial-kit-avatar',\n /** The root row of an `EntityIdentity`: its icon, type label, name and version. */\n entityIdentity: 'dial-kit-entity-identity',\n /** The bordered card of a `SelectedEntityCard`, not the wrapper that also holds its error. */\n selectedEntityCard: 'dial-kit-selected-entity-card',\n /** The `section` root of a `FormSection`: its heading row, description and content. */\n formSection: 'dial-kit-form-section',\n\n /* ── Controls ──────────────────────────────────────────────────────────── */\n /** The row of a `Switch`: the control and its label. */\n switch: 'dial-kit-switch',\n /** The row of a `Checkbox`: the box and its label. */\n checkbox: 'dial-kit-checkbox',\n /** The decorative box a `CheckboxBox` draws, in a checkbox or a menu row. */\n checkboxBox: 'dial-kit-checkbox-box',\n /** The row of a `Radio`: the circle and its label. */\n radio: 'dial-kit-radio',\n /** The root of a `RadioGroup`, wrapping its label and its radios. */\n radioGroup: 'dial-kit-radio-group',\n /**\n * The root of a `RadioGroupPopupField`, wrapping its label and the collapsed\n * field that opens the group.\n */\n radioGroupPopupField: 'dial-kit-radio-group-popup-field',\n /** The `role=\"radiogroup\"` track of a `SegmentedControl`. */\n segmentedControl: 'dial-kit-segmented-control',\n /** One segment of a `SegmentedControl`. */\n segmentedControlItem: 'dial-kit-segmented-control-item',\n /**\n * The outermost element of a `Tabs`: the box wrapping its heading and tab\n * list — or the `role=\"tablist\"` itself, which is the root when the tabs\n * carry no `sectionLabel`.\n */\n tabs: 'dial-kit-tabs',\n /**\n * The `role=\"tablist\"` holding the tabs, in either orientation. Additive to\n * `tabs` when there is no heading above it, since one element is then both.\n */\n tabList: 'dial-kit-tab-list',\n /**\n * One tab inside `Tabs`, in either orientation. The selected tab of a\n * horizontal row keeps its own `dial-kit-tab-selected-underline`.\n */\n tab: 'dial-kit-tab',\n /**\n * The selected tab, additive to `tab`. A horizontal row draws its selection\n * with `dial-kit-tab-selected-underline`, which carries the gradient rule;\n * this one carries no declarations and marks the selected tab in either\n * orientation.\n */\n tabSelected: 'dial-kit-tab-selected',\n /** The `sectionLabel` heading above a `Tabs`. Absent when there is none. */\n tabsSectionLabel: 'dial-kit-tabs-section-label',\n /**\n * The `role=\"group\"` row of a `FilterChips`. Its chips are `Tag` pills, so\n * they carry `dial-kit-tag` and have no entry of their own.\n */\n filterChips: 'dial-kit-filter-chips',\n /** A `Tag` pill, wherever it is rendered — including a `TagInput`'s rows. */\n tag: 'dial-kit-tag',\n /**\n * A `ToggleIconButton`, additive to the `dial-kit-base-icon-button` it\n * already carries.\n */\n toggleIconButton: 'dial-kit-toggle-icon-button',\n /** A `CloseButton`, additive to `dial-kit-base-icon-button`. */\n closeButton: 'dial-kit-close-button',\n /** An `InfoButton`, additive to `dial-kit-base-icon-button`. */\n infoButton: 'dial-kit-info-button',\n /**\n * The wrapper of a `ButtonDropdown` — its trigger carries\n * `dial-kit-base-button`.\n */\n buttonDropdown: 'dial-kit-button-dropdown',\n} as const"
|
|
12088
9572
|
}
|
|
12089
9573
|
]
|
|
12090
9574
|
}
|