@epam/ai-dial-ui-kit 0.9.0-rc.8 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/dist/components-manifest.json +4732 -0
- package/dist/dial-ui-kit.cjs.js +40 -35
- package/dist/dial-ui-kit.es.js +22571 -18395
- package/dist/index.css +2 -2
- package/dist/mcp-server.cjs +357 -0
- package/dist/src/components/Alert/Alert.d.ts +1 -0
- package/dist/src/components/Alert/constants.d.ts +1 -1
- package/dist/src/components/AutocompleteInput/AutocompleteInputValue.d.ts +8 -3
- package/dist/src/components/Breadcrumb/Breadcrumb.d.ts +1 -0
- package/dist/src/components/Breadcrumb/BreadcrumbItem.d.ts +1 -1
- package/dist/src/components/Breadcrumb/constants.d.ts +1 -1
- package/dist/src/components/Button/Button.d.ts +1 -0
- package/dist/src/components/ButtonDropdown/ButtonDropdown.d.ts +1 -0
- package/dist/src/components/CaptionText/CaptionText.d.ts +1 -0
- package/dist/src/components/Checkbox/Checkbox.d.ts +1 -0
- package/dist/src/components/CloseButton/CloseButton.d.ts +1 -0
- package/dist/src/components/CollapsibleSidebar/CollapsibleSidebar.d.ts +2 -0
- package/dist/src/components/ConfirmationPopup/ConfirmationPopup.d.ts +1 -0
- package/dist/src/components/DraggableItem/DraggableItem.d.ts +1 -0
- package/dist/src/components/Dropdown/Dropdown.d.ts +2 -0
- package/dist/src/components/EllipsisTooltip/EllipsisTooltip.d.ts +2 -0
- package/dist/src/components/FileIcon/FileIcon.d.ts +1 -0
- package/dist/src/components/FileManager/FileManager.d.ts +20 -13
- package/dist/src/components/FileManager/FileManagerContext.d.ts +5 -0
- package/dist/src/components/FileManager/FileManagerProvider.d.ts +1 -0
- package/dist/src/components/FileManager/FileManagerTooltip.d.ts +11 -0
- package/dist/src/components/FileManager/components/DestinationFolderPopup/DestinationFolderPopup.d.ts +2 -0
- package/dist/src/components/FileManager/hooks/use-file-download.d.ts +2 -1
- package/dist/src/components/FileManager/hooks/use-file-manager-columns.d.ts +1 -0
- package/dist/src/components/FileManager/hooks/use-file-upload.d.ts +13 -0
- package/dist/src/components/FileManager/hooks/use-grid-context-menu.d.ts +3 -1
- package/dist/src/components/FileManager/utils.d.ts +4 -0
- package/dist/src/components/FileManager/utils.spec.d.ts +1 -0
- package/dist/src/components/FileName/FileName.d.ts +2 -0
- package/dist/src/components/FolderName/FolderName.d.ts +2 -0
- package/dist/src/components/FormItem/FormItem.d.ts +1 -0
- package/dist/src/components/FormPopup/FormPopup.d.ts +1 -0
- package/dist/src/components/Grid/Grid.d.ts +2 -3
- package/dist/src/components/Icon/Icon.d.ts +1 -0
- package/dist/src/components/IconButton/IconButton.d.ts +1 -0
- package/dist/src/components/InfoButton/constants.d.ts +1 -1
- package/dist/src/components/Input/Input.d.ts +2 -0
- package/dist/src/components/InputPopup/InputPopup.d.ts +9 -0
- package/dist/src/components/Label/Label.d.ts +1 -0
- package/dist/src/components/LabelledText/LabelledText.d.ts +1 -0
- package/dist/src/components/LoadFileArea/LoadFileArea.d.ts +2 -0
- package/dist/src/components/LoadFileArea/LoadFileAreaField.d.ts +2 -0
- package/dist/src/components/Loader/Loader.d.ts +1 -0
- package/dist/src/components/NoDataContent/NoDataContent.d.ts +1 -0
- package/dist/src/components/NumberInput/NumberInput.d.ts +8 -0
- package/dist/src/components/PasswordInput/PasswordInput.d.ts +1 -0
- package/dist/src/components/Popup/Popup.d.ts +1 -0
- package/dist/src/components/RadioButton/RadioButton.d.ts +1 -0
- package/dist/src/components/RadioGroup/RadioGroup.d.ts +1 -0
- package/dist/src/components/RadioGroupPopupField/RadioGroupPopupField.d.ts +1 -0
- package/dist/src/components/RemoveButton/RemoveButton.d.ts +1 -0
- package/dist/src/components/ResizableContainer/ConditionalResizableContainer.d.ts +1 -0
- package/dist/src/components/ResizableContainer/ResizableContainer.d.ts +2 -0
- package/dist/src/components/SchemeRenderer/SchemeRenderer.d.ts +26 -0
- package/dist/src/components/SchemeRenderer/components/SchemaAnyOfEditor.d.ts +31 -0
- package/dist/src/components/SchemeRenderer/components/SchemaArrayEditor.d.ts +31 -0
- package/dist/src/components/SchemeRenderer/components/SchemaField.d.ts +28 -0
- package/dist/src/components/SchemeRenderer/components/SchemaFieldContent.d.ts +25 -0
- package/dist/src/components/SchemeRenderer/components/SchemaKeyValueEditor.d.ts +25 -0
- package/dist/src/components/SchemeRenderer/components/SchemaObjectEditor.d.ts +31 -0
- package/dist/src/components/SchemeRenderer/components/SchemaOneOfEditor.d.ts +31 -0
- package/dist/src/components/SchemeRenderer/components/SchemaPrimitiveField.d.ts +27 -0
- package/dist/src/components/SchemeRenderer/components/SchemaSection.d.ts +33 -0
- package/dist/src/components/SchemeRenderer/context.d.ts +11 -0
- package/dist/src/components/SchemeRenderer/tests/utils.spec.d.ts +1 -0
- package/dist/src/components/SchemeRenderer/types.d.ts +71 -0
- package/dist/src/components/SchemeRenderer/utils.d.ts +11 -0
- package/dist/src/components/Search/Search.d.ts +2 -0
- package/dist/src/components/Select/Select.d.ts +2 -0
- package/dist/src/components/Select/constants.d.ts +2 -2
- package/dist/src/components/SelectField/SelectField.d.ts +1 -0
- package/dist/src/components/SharedEntityIndicator/SharedEntityIndicator.d.ts +1 -0
- package/dist/src/components/Skeleton/Skeleton.d.ts +1 -0
- package/dist/src/components/Steps/Steps.d.ts +1 -0
- package/dist/src/components/Switch/Switch.d.ts +1 -0
- package/dist/src/components/Tabs/Tabs.d.ts +2 -0
- package/dist/src/components/Tag/Tag.d.ts +2 -0
- package/dist/src/components/TagInput/TagInput.d.ts +9 -1
- package/dist/src/components/Textarea/Textarea.d.ts +1 -0
- package/dist/src/components/Tooltip/Tooltip.d.ts +1 -0
- package/dist/src/constants/storybook/input.d.ts +3 -1
- package/dist/src/index.d.ts +3 -1
- package/dist/src/mcp/generate-manifest.d.ts +1 -0
- package/dist/src/mcp/server.d.ts +1 -0
- package/dist/src/mcp/types.d.ts +54 -0
- package/dist/src/types/file-manager.d.ts +4 -2
- package/package.json +19 -3
|
@@ -0,0 +1,4732 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "0.9.0",
|
|
3
|
+
"generatedAt": "2026-04-29T08:28:44.352Z",
|
|
4
|
+
"kit": {
|
|
5
|
+
"name": "@epam/ai-dial-ui-kit",
|
|
6
|
+
"description": "A modern UI kit for building AI DIAL interfaces with React",
|
|
7
|
+
"installation": "npm install @epam/ai-dial-ui-kit",
|
|
8
|
+
"cssImport": "import '@epam/ai-dial-ui-kit/styles.css'",
|
|
9
|
+
"peerDependencies": {
|
|
10
|
+
"@floating-ui/react": "^0.27.16",
|
|
11
|
+
"@modelcontextprotocol/sdk": "^1.12.0",
|
|
12
|
+
"@monaco-editor/react": "^4.7.0",
|
|
13
|
+
"@tabler/icons-react": "^3.36.1",
|
|
14
|
+
"@uiw/react-markdown-preview": "^5.1.5",
|
|
15
|
+
"@uiw/react-md-editor": "^4.0.11",
|
|
16
|
+
"classnames": "^2.5.1",
|
|
17
|
+
"monaco-editor": "^0.52.2",
|
|
18
|
+
"react": "^19.1.0",
|
|
19
|
+
"react-dom": "^19.1.0"
|
|
20
|
+
},
|
|
21
|
+
"setupNotes": "## Next.js Integration\n1. Install the package and peer dependencies that are not currently in your project\n``` bash\nnpm install @epam/ai-dial-ui-kit\nnpm install react react-dom @tabler/icons-react classnames\nnpm install @floating-ui/react monaco-editor @monaco-editor/react\n```\n\n2. Import style in the root layout of the project:\n\n```tsx\n// app/layout.tsx\nimport \"@epam/ai-dial-ui-kit/styles.css\";\n```\n\n3. Usage example\n\n```tsx\n// app/page.tsx\n\"use client\";\nimport { DialPrimaryButton } from \"@epam/ai-dial-ui-kit\";\n\nexport default function Home() {\n return (\n <div className=\"w-full h-full flex flex-col gap-3 items-center justify-center\">\n <h1>Test library</h1>\n <DialPrimaryButton onClick={() => alert('Hello AI DIAL!')} />\n </div>\n );\n}\n```\nSee \"🎨 Theming & Customization\" section in README."
|
|
22
|
+
},
|
|
23
|
+
"styles": "# Typography CSS Utility Classes\n\n## Design-system-compliant classes (`dial-*-text`)\n\nUse these by default. They follow the design system type scale.\n\n| Class | Weight | Size / Line-height |\n| ----------------------- | -------- | ----------------------- |\n| `.dial-display1-text` | semibold | 32px / 48px |\n| `.dial-display2-text` | semibold | 28px / 40px |\n| `.dial-h1-text` | semibold | 22px / 32px |\n| `.dial-h2-text` | semibold | 20px / 28px |\n| `.dial-h3-text` | semibold | 18px / 26px |\n| `.dial-body-text` | normal | 16px / 24px |\n| `.dial-body-semi-text` | semibold | 16px / 24px |\n| `.dial-small-text` | normal | 14px / 20px |\n| `.dial-small-semi-text` | semibold | 14px / 20px |\n| `.dial-tiny-text` | normal | 12px / 16px |\n| `.dial-tiny-semi-text` | semibold | 12px / 16px |\n| `.dial-caption-text` | normal | 10px / 12px |\n| `.dial-code-text` | normal | 14px / 20px (monospace) |\n\n## Legacy classes (avoid in new code)\n\nClasses like `dial-h1`, `dial-h2`, `dial-body`, `dial-small*`, `dial-tiny*`, `dial-caption` are legacy. They can be used in legacy projects if user explicidly specify they need legacy typography.\n\n## Raw SCSS source\n",
|
|
24
|
+
"theming": "# Theming & CSS Variable Tokens\n\nAI DIAL UI Kit uses CSS custom properties (variables) for theming.\nDark and light themes are switched by setting different values for these variables on `:root` or a theme wrapper element.\n\n## Usage in Tailwind\n\nThe Tailwind config maps CSS variables to utility classes.\nUse these classes in your components:\n\n```tsx\n// Backgrounds\n<div className=\"bg-layer-0\" /> // darkest background\n<div className=\"bg-layer-1\" /> // main content area\n<div className=\"bg-layer-2\" /> // elevated panels\n\n// Text\n<span className=\"text-primary\" /> // main text color\n<span className=\"text-secondary\" /> // muted text\n<span className=\"text-error\" /> // error state\n\n// Borders\n<div className=\"border border-primary\" /> // standard border\n<div className=\"border border-error\" /> // error border\n```\n\n## Override CSS Variables\n\n```css\n:root {\n --bg-layer-0: #000000;\n --bg-layer-1: #0c101d;\n --bg-layer-2: #161b2d;\n --bg-layer-3: #1d2439;\n --text-primary: #eef1f7;\n --text-secondary: #9fa6bd;\n --text-error: #f76464;\n --stroke-primary: #696e7c;\n --controls-bg-accent-primary: #3664e2;\n /* ... see tailwind.config.js for full list */\n}\n```\n\n## Token Reference\n\n\n### backgroundsColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-0` | `var(--bg-layer-0)` | `#000000` |\n| `layer-1` | `var(--bg-layer-1)` | `#0C101D` |\n| `layer-2` | `var(--bg-layer-2)` | `#161B2D` |\n| `layer-3` | `var(--bg-layer-3)` | `#1D2439` |\n| `layer-4` | `var(--bg-layer-4)` | `#242C42` |\n| `accent-primary-alpha` | `var(--bg-accent-primary-alpha)` | `#7DA4FF26` |\n| `accent-secondary-alpha` | `var(--bg-accent-secondary-alpha)` | `#37BABC2E` |\n| `accent-tertiary-alpha` | `var(--bg-accent-tertiary-alpha)` | `#A972FF2E` |\n| `model-icon` | `var(--bg-model-icon)` | `#FFFFFF` |\n| `accent-primary` | `var(--bg-accent-primary)` | `#5C8DEA` |\n| `accent-secondary` | `var(--bg-accent-secondary)` | `#37BABC` |\n| `accent-tertiary` | `var(--bg-accent-tertiary)` | `#A972FF` |\n| `red-400` | `var(--bg-red-400)` | `#F76464` |\n| `orange-400` | `var(--bg-orange-400)` | `#D97C27` |\n| `orange-800` | `var(--bg-orange-800)` | `#B25500` |\n\n### controlsBgColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `controls-accent-primary` | `var(--controls-bg-accent-primary)` | `#3664E2` |\n| `controls-accent-primary-hover` | `var(--controls-bg-accent-primary-hover)` | `#2656D9` |\n| `controls-accent-primary-active` | `var(--controls-bg-accent-primary-active)` | `#124ACE` |\n| `controls-accent-primary-alpha-active` | `var(--controls-bg-accent-primary-alpha-active)` | `#7DA4FF4D` |\n| `controls-accent-secondary-alpha-active` | `var(--controls-bg-accent-secondary-alpha-active)` | `#37BABC5C` |\n| `controls-accent-tertiary-alpha-active` | `var(--controls-bg-accent-tertiary-alpha-active)` | `#A972FF5C` |\n| `controls-error` | `var(--controls-bg-error)` | `#CC4545` |\n| `controls-error-hover` | `var(--controls-bg-error-hover)` | `#BF3939` |\n| `controls-error-active` | `var(--controls-bg-error-active)` | `#AE2F2F` |\n| `controls-error-alpha-hover` | `var(--controls-bg-alpha-hover)` | `#F764642E` |\n| `controls-error-alpha-active` | `var(--controls-bg-error-alpha-active)` | `#F764645C` |\n| `controls-disable-accent` | `var(--controls-bg-disable-accent)` | `#696E7C` |\n| `controls-disable` | `var(--controls-bg-disable)` | `#242C42` |\n| `controls-neutral-hover` | `var(--controls-bg-neutral-hover)` | `#242C42` |\n| `controls-neutral-active` | `var(--controls-bg-neutral-active)` | `#575F73` |\n| `controls-accent-success-alpha-hover` | `var(--controls-bg-accent-success-alpha-hover)` | `#37BABC2E` |\n| `controls-accent-success-alpha-active` | `var(--controls-bg-accent-success-alpha-active)` | `#37BABC5C` |\n| `controls-accent` | `var(--controls-bg-accent)` | `#5C8DEA` |\n| `controls-accent-hover` | `var(--controls-bg-accent-hover)` | `#4878D2` |\n| `controls-accent-alpha` | `var(--controls-bg-accent-alpha)` | `#5C8DEA2B` |\n| `controls-enable-primary` | `var(--controls-enable-primary)` | `#FCFCFC` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--stroke-accent-primary)` | `#7DA4FF` |\n| `accent-secondary` | `var(--stroke-accent-secondary)` | `#37BABC` |\n| `accent-tertiary` | `var(--stroke-accent-tertiary)` | `#A972FF` |\n| `controls-accent` | `var(--controls-bg-accent)` | `#5C8DEA` |\n| `accent-primary-hover` | `var(--stroke-accent-primary-hover)` | `#4878d2` |\n| `red-900` | `var(--red-900)` | `#402027` |\n\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `warning-icon` | `var(--text-warning-icon)` | `#EEC840` |\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-disable` | `var(--controls-text-disable)` | `#0C101D` |\n\n### controlsTextColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `controls-permanent` | `var(--controls-text-permanent)` | `#FCFCFC` |\n| `controls-accent-disable` | `var(--controls-text-accent-disable)` | `#242C42` |\n| `controls-primary-disable` | `var(--controls-text-primary-disable)` | `#7C8293` |\n| `controls-secondary-disable` | `var(--controls-text-secondary-disable)` | `#575F73` |\n| `controls-neutral` | `var(--controls-text-neutral)` | `#FCFCFC` |\n| `controls-accent-primary-hover` | `var(--controls-text-accent-primary-hover)` | `#3664E2` |\n| `controls-accent-primary-active` | `var(--controls-text-accent-primary-active)` | `#124ACE` |\n| `controls-primary` | `var(--controls-primary)` | `#FCFCFC` |\n| `controls-disable` | `var(--controls-text-disable)` | `#575F73` |",
|
|
25
|
+
"components": [
|
|
26
|
+
{
|
|
27
|
+
"name": "DialCaptionText",
|
|
28
|
+
"category": "Elements",
|
|
29
|
+
"description": "A component for displaying error messages with consistent styling\naliases: HelperText|ValidationText",
|
|
30
|
+
"props": [
|
|
31
|
+
{
|
|
32
|
+
"name": "text",
|
|
33
|
+
"type": "string",
|
|
34
|
+
"required": false,
|
|
35
|
+
"description": "The text to display. If undefined or empty, nothing is rendered"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"name": "variant",
|
|
39
|
+
"type": "CaptionType",
|
|
40
|
+
"required": false,
|
|
41
|
+
"defaultValue": "CaptionType.Description",
|
|
42
|
+
"description": "The variant of the caption text, e.g., error or description."
|
|
43
|
+
}
|
|
44
|
+
],
|
|
45
|
+
"examples": [
|
|
46
|
+
"<DialCaptionText text=\"This field is required\" variant={CaptionType.Error} />"
|
|
47
|
+
],
|
|
48
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "DialErrorText",
|
|
52
|
+
"category": "Elements",
|
|
53
|
+
"description": "",
|
|
54
|
+
"props": [],
|
|
55
|
+
"examples": [],
|
|
56
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "DialLabel",
|
|
60
|
+
"category": "Elements",
|
|
61
|
+
"description": "A label component\naliases: FormLabel|RequiredIndicator",
|
|
62
|
+
"props": [
|
|
63
|
+
{
|
|
64
|
+
"name": "label",
|
|
65
|
+
"type": "ReactNode",
|
|
66
|
+
"required": false,
|
|
67
|
+
"description": "The label text to display for the label"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "required",
|
|
71
|
+
"type": "boolean",
|
|
72
|
+
"required": false,
|
|
73
|
+
"description": "Whether the field is required"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "caption",
|
|
77
|
+
"type": "string",
|
|
78
|
+
"required": false,
|
|
79
|
+
"description": "Additional caption text, displayed below the label."
|
|
80
|
+
}
|
|
81
|
+
],
|
|
82
|
+
"examples": [
|
|
83
|
+
"// Basic label\n<DialLabel htmlFor=\"email-input\" label=\"Email Address\" />"
|
|
84
|
+
],
|
|
85
|
+
"sourceFile": "components/Label/Label.tsx"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "DialIcon",
|
|
89
|
+
"category": "Data Display",
|
|
90
|
+
"description": "A wrapper component for rendering icons with consistent styling\naliases: IconRenderer|SVGWrapper",
|
|
91
|
+
"props": [
|
|
92
|
+
{
|
|
93
|
+
"name": "icon",
|
|
94
|
+
"type": "ReactNode",
|
|
95
|
+
"required": false,
|
|
96
|
+
"description": "The icon element to render"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "className",
|
|
100
|
+
"type": "string",
|
|
101
|
+
"required": false,
|
|
102
|
+
"description": "Additional CSS classes to apply to the icon wrapper"
|
|
103
|
+
}
|
|
104
|
+
],
|
|
105
|
+
"examples": [
|
|
106
|
+
"<DialIcon icon={<SearchIcon />} />\n<DialIcon icon={<CloseIcon />} className=\"text-primary\" />"
|
|
107
|
+
],
|
|
108
|
+
"sourceFile": "components/Icon/Icon.tsx"
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "DialAlert",
|
|
112
|
+
"category": "Feedback",
|
|
113
|
+
"description": "A contextual feedback component for displaying important messages.\naliases: Notification|StatusBanner\n\nRenders a colored container with an icon, message text, and an optional\nclose button.",
|
|
114
|
+
"props": [
|
|
115
|
+
{
|
|
116
|
+
"name": "variant",
|
|
117
|
+
"type": "AlertVariant",
|
|
118
|
+
"required": false,
|
|
119
|
+
"defaultValue": "AlertVariant.Info",
|
|
120
|
+
"description": "Defines the visual style and icon of the alert"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "message",
|
|
124
|
+
"type": "ReactNode",
|
|
125
|
+
"required": true,
|
|
126
|
+
"description": "Message text to display inside the alert"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "closable",
|
|
130
|
+
"type": "boolean",
|
|
131
|
+
"required": false,
|
|
132
|
+
"defaultValue": "false",
|
|
133
|
+
"description": "Whether the alert has a close button"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"name": "iconSize",
|
|
137
|
+
"type": "number",
|
|
138
|
+
"required": false,
|
|
139
|
+
"defaultValue": "24",
|
|
140
|
+
"description": "Size of the icon displayed in the alert"
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"name": "iconStroke",
|
|
144
|
+
"type": "number",
|
|
145
|
+
"required": false,
|
|
146
|
+
"defaultValue": "2",
|
|
147
|
+
"description": "Stroke width of the icon displayed in the alert"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "onClose",
|
|
151
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
152
|
+
"required": false,
|
|
153
|
+
"description": "Callback fired when the close button is clicked"
|
|
154
|
+
}
|
|
155
|
+
],
|
|
156
|
+
"examples": [
|
|
157
|
+
"<DialAlert\n variant={AlertVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<DialAlert\n variant={AlertVariant.Success}\n message=\"Changes saved successfully.\"\n/>\n\n<DialAlert\n variant={AlertVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<DialAlert\n variant={AlertVariant.Warning}\n message=\"Custom alert\"\n aria-live=\"polite\"\n id=\"warning-alert\"\n/>"
|
|
158
|
+
],
|
|
159
|
+
"sourceFile": "components/Alert/Alert.tsx"
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"name": "DialLoader",
|
|
163
|
+
"category": "Feedback",
|
|
164
|
+
"description": "A simple loading spinner component.\naliases: LoadingSpinner|ProgressSpinner\n\nRenders a spinning SVG with optional full-width container.",
|
|
165
|
+
"props": [
|
|
166
|
+
{
|
|
167
|
+
"name": "size",
|
|
168
|
+
"type": "number",
|
|
169
|
+
"required": false,
|
|
170
|
+
"defaultValue": "18",
|
|
171
|
+
"description": "Icon size in px"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "className",
|
|
175
|
+
"type": "string",
|
|
176
|
+
"required": false,
|
|
177
|
+
"description": "Additional classes for the container"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"name": "iconClassName",
|
|
181
|
+
"type": "string",
|
|
182
|
+
"required": false,
|
|
183
|
+
"description": "Additional classes for the SVG icon"
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "fullWidth",
|
|
187
|
+
"type": "boolean",
|
|
188
|
+
"required": false,
|
|
189
|
+
"defaultValue": "true",
|
|
190
|
+
"description": "Stretch to full width/height of container"
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "ariaLabel",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"required": false,
|
|
196
|
+
"defaultValue": "'Loading'",
|
|
197
|
+
"description": "Accessible label for screen readers"
|
|
198
|
+
}
|
|
199
|
+
],
|
|
200
|
+
"examples": [
|
|
201
|
+
"// Full width (default)\n<DialLoader />\n\n// Inline (content width)\n<DialLoader fullWidth={false} />\n\n// Custom size and classes\n<DialLoader size={24} iconClassName=\"text-accent-primary\" />"
|
|
202
|
+
],
|
|
203
|
+
"sourceFile": "components/Loader/Loader.tsx"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "DialCheckbox",
|
|
207
|
+
"category": "Form",
|
|
208
|
+
"description": "A Checkbox component with styling options\naliases: ToggleCheckbox|MultiSelectOption",
|
|
209
|
+
"props": [
|
|
210
|
+
{
|
|
211
|
+
"name": "id",
|
|
212
|
+
"type": "string",
|
|
213
|
+
"required": true,
|
|
214
|
+
"description": "Unique identifier for the checkbox element"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"name": "label",
|
|
218
|
+
"type": "ReactNode",
|
|
219
|
+
"required": false,
|
|
220
|
+
"description": "The label text for the field"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "checked",
|
|
224
|
+
"type": "boolean",
|
|
225
|
+
"required": true,
|
|
226
|
+
"description": "The current value of the checkbox"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "disabled",
|
|
230
|
+
"type": "boolean",
|
|
231
|
+
"required": false,
|
|
232
|
+
"description": "Whether the checkbox is disabled"
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "indeterminate",
|
|
236
|
+
"type": "boolean",
|
|
237
|
+
"required": false,
|
|
238
|
+
"description": "indeterminate state"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"name": "ariaLabel",
|
|
242
|
+
"type": "string",
|
|
243
|
+
"required": false,
|
|
244
|
+
"description": "Accessible label for screen readers when no title is provided"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "onChange",
|
|
248
|
+
"type": "(value?: boolean, id?: string) => void",
|
|
249
|
+
"required": false,
|
|
250
|
+
"description": "Callback function called when the checkbox value changes"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"examples": [
|
|
254
|
+
"<DialCheckbox\n id=\"checkbox\"\n label=\"Dial Checkbox\"\n checked={true}\n disabled={false}\n onChange={(value) => console.log(value)}\n/>"
|
|
255
|
+
],
|
|
256
|
+
"sourceFile": "components/Checkbox/Checkbox.tsx"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "DialSteps",
|
|
260
|
+
"category": "Navigation",
|
|
261
|
+
"description": "Props for the DialSteps component, which renders a multi-step navigation UI.\naliases: StepWizard|ProgressSteps",
|
|
262
|
+
"props": [
|
|
263
|
+
{
|
|
264
|
+
"name": "steps",
|
|
265
|
+
"type": "Step[]",
|
|
266
|
+
"required": true,
|
|
267
|
+
"description": "Array of step objects to display"
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "currentStep",
|
|
271
|
+
"type": "string",
|
|
272
|
+
"required": true,
|
|
273
|
+
"description": "The id of the currently active step"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "onChangeStep",
|
|
277
|
+
"type": "(step: string) => void",
|
|
278
|
+
"required": true,
|
|
279
|
+
"description": "Callback to set the current step by id"
|
|
280
|
+
}
|
|
281
|
+
],
|
|
282
|
+
"examples": [
|
|
283
|
+
"<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/>"
|
|
284
|
+
],
|
|
285
|
+
"sourceFile": "components/Steps/Steps.tsx"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"name": "DialRadioButton",
|
|
289
|
+
"category": "Free",
|
|
290
|
+
"description": "A stylized, accessible radio input with optional description.\naliases: ChoiceOption|RadioInput\n\nRenders a native `<input type=\"radio\" />` paired with a label. When `checked`\nand `description` are provided, a supporting text block appears under the control.",
|
|
291
|
+
"props": [
|
|
292
|
+
{
|
|
293
|
+
"name": "name",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"required": true,
|
|
296
|
+
"description": "Radio group name"
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"name": "value",
|
|
300
|
+
"type": "string",
|
|
301
|
+
"required": true,
|
|
302
|
+
"description": "Radio value emitted on change"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "label",
|
|
306
|
+
"type": "ReactNode",
|
|
307
|
+
"required": false,
|
|
308
|
+
"description": "Visible label text"
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"name": "caption",
|
|
312
|
+
"type": "ReactNode",
|
|
313
|
+
"required": false,
|
|
314
|
+
"description": "Caption text describing label"
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"name": "description",
|
|
318
|
+
"type": "ReactNode",
|
|
319
|
+
"required": false,
|
|
320
|
+
"description": "Supporting text shown when checked"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "checked",
|
|
324
|
+
"type": "boolean",
|
|
325
|
+
"required": false,
|
|
326
|
+
"defaultValue": "false",
|
|
327
|
+
"description": "Controlled checked state"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"name": "inputId",
|
|
331
|
+
"type": "string",
|
|
332
|
+
"required": true,
|
|
333
|
+
"description": "ID associated with the label"
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"name": "className",
|
|
337
|
+
"type": "string",
|
|
338
|
+
"required": false,
|
|
339
|
+
"description": "Additional classes applied to the input element"
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
"name": "labelClassName",
|
|
343
|
+
"type": "string",
|
|
344
|
+
"required": false,
|
|
345
|
+
"description": "Additional classes applied to the label element"
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"name": "disabled",
|
|
349
|
+
"type": "boolean",
|
|
350
|
+
"required": false,
|
|
351
|
+
"description": "Disabled state of the control"
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "onChange",
|
|
355
|
+
"type": "(value: string) => void",
|
|
356
|
+
"required": false,
|
|
357
|
+
"description": "Callback fired with `value` when the radio is changed"
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"name": "descriptionClassName",
|
|
361
|
+
"type": "string",
|
|
362
|
+
"required": false,
|
|
363
|
+
"description": "Additional classes applied to the description block"
|
|
364
|
+
}
|
|
365
|
+
],
|
|
366
|
+
"examples": [
|
|
367
|
+
"<DialRadioButton\n name=\"plan\"\n value=\"pro\"\n inputId=\"radio-pro\"\n title=\"Pro plan\"\n description=\"Includes all advanced features.\"\n checked\n onChange={(v) => console.log('changed', v)}\n/>"
|
|
368
|
+
],
|
|
369
|
+
"sourceFile": "components/RadioButton/RadioButton.tsx"
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "DialRadioGroup",
|
|
373
|
+
"category": "Form",
|
|
374
|
+
"description": "Groups multiple `DialRadio` options and renders custom content for the active option.\naliases: SelectionGroup|OptionGroup\n\nUses `DialField` as the field label and a container with `role=\"radiogroup\"`.\nContent provided in `radioButtons[].content` is shown under the currently active radio.",
|
|
375
|
+
"props": [
|
|
376
|
+
{
|
|
377
|
+
"name": "fieldTitle",
|
|
378
|
+
"type": "string",
|
|
379
|
+
"required": false,
|
|
380
|
+
"description": "Optional label rendered by `DialField`"
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "elementId",
|
|
384
|
+
"type": "string",
|
|
385
|
+
"required": true,
|
|
386
|
+
"description": "Name for the underlying radio group; also used for input `name`"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "disabled",
|
|
390
|
+
"type": "boolean",
|
|
391
|
+
"required": false,
|
|
392
|
+
"description": "Disables all child radios when set"
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "radioButtons",
|
|
396
|
+
"type": "RadioButtonWithContent[]",
|
|
397
|
+
"required": true,
|
|
398
|
+
"description": "Array of options with ids, labels, and optional content"
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "activeRadioButton",
|
|
402
|
+
"type": "string",
|
|
403
|
+
"required": true,
|
|
404
|
+
"description": "The id of the currently selected radio"
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "orientation",
|
|
408
|
+
"type": "RadioGroupOrientation",
|
|
409
|
+
"required": true,
|
|
410
|
+
"description": "Layout direction of radios: row or column"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "onChange",
|
|
414
|
+
"type": "(radioId: string) => void",
|
|
415
|
+
"required": true,
|
|
416
|
+
"description": "Callback fired with the selected radio id"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "radioClassName",
|
|
420
|
+
"type": "string",
|
|
421
|
+
"required": false,
|
|
422
|
+
"description": "Additional classes applied to each radio input"
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "groupLabelClassName",
|
|
426
|
+
"type": "string",
|
|
427
|
+
"required": false,
|
|
428
|
+
"description": "Optional classes applied to the group label. If not provided, `labelClassName` will be used."
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "labelClassName",
|
|
432
|
+
"type": "string",
|
|
433
|
+
"required": false,
|
|
434
|
+
"description": "Additional classes applied to each radio label"
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"name": "containerClassName",
|
|
438
|
+
"type": "string",
|
|
439
|
+
"required": false,
|
|
440
|
+
"description": "Additional classes applied to the outer container"
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "formItemChildrenClassName",
|
|
444
|
+
"type": "string",
|
|
445
|
+
"required": false,
|
|
446
|
+
"description": "Additional classes applied to the DialFormItem's children container"
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "selectedItemClassName",
|
|
450
|
+
"type": "string",
|
|
451
|
+
"required": false,
|
|
452
|
+
"description": "Additional classes applied to the selected option's content container"
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "selectedLabelClassName",
|
|
456
|
+
"type": "string",
|
|
457
|
+
"required": false,
|
|
458
|
+
"description": "Additional classes applied to the selected option's label"
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"name": "radioGroupClassName",
|
|
462
|
+
"type": "string",
|
|
463
|
+
"required": false,
|
|
464
|
+
"description": "Additional classes applied to the radio group container"
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "inputContainerClassName",
|
|
468
|
+
"type": "string",
|
|
469
|
+
"required": false,
|
|
470
|
+
"description": "Additional classes applied to each radio input's container"
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "selectedInputContainerClassName",
|
|
474
|
+
"type": "string",
|
|
475
|
+
"required": false,
|
|
476
|
+
"description": "Additional classes applied to the selected radio input's container"
|
|
477
|
+
}
|
|
478
|
+
],
|
|
479
|
+
"examples": [
|
|
480
|
+
"<DialRadioGroup\n fieldTitle=\"Delivery\"\n elementId=\"delivery\"\n orientation={RadioGroupOrientation.Column}\n activeRadioButton=\"courier\"\n radioButtons={[\n { id: 'pickup', name: 'Pickup', content: <span>Free, ready today</span> },\n { id: 'courier', name: 'Courier', content: <span>Arrives tomorrow</span> },\n ]}\n onChange={(id) => console.log('selected', id)}\n/>"
|
|
481
|
+
],
|
|
482
|
+
"sourceFile": "components/RadioGroup/RadioGroup.tsx"
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "DialNoDataContent",
|
|
486
|
+
"category": "Feedback",
|
|
487
|
+
"description": "A component for displaying a message and icon when there is no data to show.\naliases: EmptyState|NoResults",
|
|
488
|
+
"props": [
|
|
489
|
+
{
|
|
490
|
+
"name": "icon",
|
|
491
|
+
"type": "ReactNode",
|
|
492
|
+
"required": false,
|
|
493
|
+
"description": "Custom icon to display (defaults to clipboard icon)"
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "title",
|
|
497
|
+
"type": "string",
|
|
498
|
+
"required": true,
|
|
499
|
+
"description": "The message to display when no data is present"
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"name": "description",
|
|
503
|
+
"type": "string",
|
|
504
|
+
"required": false,
|
|
505
|
+
"description": "The description to display when no data is present"
|
|
506
|
+
},
|
|
507
|
+
{
|
|
508
|
+
"name": "containerClassName",
|
|
509
|
+
"type": "string",
|
|
510
|
+
"required": false,
|
|
511
|
+
"description": "Additional CSS classes for the container"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"name": "titleClassName",
|
|
515
|
+
"type": "string",
|
|
516
|
+
"required": false,
|
|
517
|
+
"description": "Additional CSS classes for the title text"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "descriptionClassName",
|
|
521
|
+
"type": "string",
|
|
522
|
+
"required": false,
|
|
523
|
+
"description": "Additional CSS classes for the description text"
|
|
524
|
+
}
|
|
525
|
+
],
|
|
526
|
+
"examples": [
|
|
527
|
+
"<NoDataContent\n emptyDataTitle=\"No results found\"\n icon={<CustomIcon />}\n/>"
|
|
528
|
+
],
|
|
529
|
+
"sourceFile": "components/NoDataContent/NoDataContent.tsx"
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"name": "DialCollapsibleSidebar",
|
|
533
|
+
"category": "Navigation",
|
|
534
|
+
"description": "A collapsible horizontal bar component that allows toggling between an expanded and collapsed state.\naliases: ToggleSidebar|CollapsiblePanel\n\nIt supports customizable width, title, icons, additional buttons, and flexible styling options.",
|
|
535
|
+
"props": [
|
|
536
|
+
{
|
|
537
|
+
"name": "children",
|
|
538
|
+
"type": "ReactNode",
|
|
539
|
+
"required": true,
|
|
540
|
+
"description": "The content to display inside the collapsible bar when expanded"
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"name": "width",
|
|
544
|
+
"type": "number",
|
|
545
|
+
"required": false,
|
|
546
|
+
"defaultValue": "280",
|
|
547
|
+
"description": "The width of the bar when expanded"
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "title",
|
|
551
|
+
"type": "ReactNode",
|
|
552
|
+
"required": true,
|
|
553
|
+
"description": "The title displayed when the bar is collapsed"
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"name": "titleClassName",
|
|
557
|
+
"type": "string",
|
|
558
|
+
"required": false,
|
|
559
|
+
"description": "Additional CSS classes applied to the title element"
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"name": "containerClassName",
|
|
563
|
+
"type": "string",
|
|
564
|
+
"required": false,
|
|
565
|
+
"description": "Additional CSS classes applied to the container element"
|
|
566
|
+
},
|
|
567
|
+
{
|
|
568
|
+
"name": "iconSize",
|
|
569
|
+
"type": "number",
|
|
570
|
+
"required": false,
|
|
571
|
+
"defaultValue": "24",
|
|
572
|
+
"description": "The size of the toggle icons. Defaults to 32"
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "additionalButtons",
|
|
576
|
+
"type": "ReactNode",
|
|
577
|
+
"required": false,
|
|
578
|
+
"description": "Additional buttons or elements displayed next to the toggle button when expanded"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "iconStroke",
|
|
582
|
+
"type": "number",
|
|
583
|
+
"required": false,
|
|
584
|
+
"defaultValue": "1.5",
|
|
585
|
+
"description": "The stroke width of the toggle icons. Defaults to 1.5"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "isOpened",
|
|
589
|
+
"type": "boolean",
|
|
590
|
+
"required": false,
|
|
591
|
+
"description": "When provided, the component becomes controlled by this value"
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"name": "onToggle",
|
|
595
|
+
"type": "(nextOpened: boolean, e: MouseEvent<HTMLButtonElement>) => void",
|
|
596
|
+
"required": false,
|
|
597
|
+
"description": "Fired when user clicks the toggle in controlled mode, with the next state"
|
|
598
|
+
}
|
|
599
|
+
],
|
|
600
|
+
"examples": [
|
|
601
|
+
"<DialCollapsibleSidebar\n width={300}\n title=\"Menu\"\n titleClassName=\"text-primary font-bold\"\n containerClassName=\"bg-gray-100 shadow-md\"\n iconSize={24}\n additionalButtons={<button>Extra</button>}\n>\n <div>Content goes here</div>\n</DialCollapsibleSidebar>"
|
|
602
|
+
],
|
|
603
|
+
"sourceFile": "components/CollapsibleSidebar/CollapsibleSidebar.tsx"
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"name": "DialLabelledText",
|
|
607
|
+
"category": "Data Display",
|
|
608
|
+
"description": "A label component for form fields with optional tooltip, content, and custom elements.\naliases: LabelValue|DisplayText",
|
|
609
|
+
"props": [
|
|
610
|
+
{
|
|
611
|
+
"name": "label",
|
|
612
|
+
"type": "ReactNode",
|
|
613
|
+
"required": true,
|
|
614
|
+
"description": "The main label text for the field"
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "text",
|
|
618
|
+
"type": "ReactNode",
|
|
619
|
+
"required": false,
|
|
620
|
+
"description": "Optional tooltip and secondary text"
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
"name": "tooltip",
|
|
624
|
+
"type": "string",
|
|
625
|
+
"required": false,
|
|
626
|
+
"description": "Optional tooltip different from main text"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"name": "children",
|
|
630
|
+
"type": "ReactNode",
|
|
631
|
+
"required": false,
|
|
632
|
+
"description": "Custom content to render instead of the default text/tooltip"
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"name": "postfix",
|
|
636
|
+
"type": "ReactNode",
|
|
637
|
+
"required": false,
|
|
638
|
+
"description": "Element to display after the text (e.g., an asterisk)"
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"name": "className",
|
|
642
|
+
"type": "string",
|
|
643
|
+
"required": false,
|
|
644
|
+
"description": "Additional CSS classes for the container element."
|
|
645
|
+
}
|
|
646
|
+
],
|
|
647
|
+
"examples": [
|
|
648
|
+
"<DialLabelledText\n label=\"Username\"\n text=\"Enter your username\"\n postfix={<span>*</span>}\n/>"
|
|
649
|
+
],
|
|
650
|
+
"sourceFile": "components/LabelledText/LabelledText.tsx"
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"name": "DialTag",
|
|
654
|
+
"category": "Data Display",
|
|
655
|
+
"description": "A small tag component used to display labeled items such as categories, filters, or selections.\naliases: Badge|Chip\n\nOptionally supports removal via a close button and multiple colors variants defined by .",
|
|
656
|
+
"props": [
|
|
657
|
+
{
|
|
658
|
+
"name": "tag",
|
|
659
|
+
"type": "string",
|
|
660
|
+
"required": true,
|
|
661
|
+
"description": "The text label displayed inside the tag."
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"name": "className",
|
|
665
|
+
"type": "string",
|
|
666
|
+
"required": false,
|
|
667
|
+
"description": "Optional additional CSS classes applied to the tag container."
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
"name": "remove",
|
|
671
|
+
"type": "(event: MouseEvent<HTMLButtonElement>) => void",
|
|
672
|
+
"required": false,
|
|
673
|
+
"description": "Optional callback invoked when the remove button is clicked.\n If not provided, the remove button will not be rendered."
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
"name": "variant",
|
|
677
|
+
"type": "TagVariant",
|
|
678
|
+
"required": false,
|
|
679
|
+
"defaultValue": "TagVariant.Default",
|
|
680
|
+
"description": "Visual style of the tag. Uses the enum."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "iconBefore",
|
|
684
|
+
"type": "ReactNode",
|
|
685
|
+
"required": false,
|
|
686
|
+
"description": "Optional icon or element to display before the tag text."
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"name": "bordered",
|
|
690
|
+
"type": "boolean",
|
|
691
|
+
"required": false,
|
|
692
|
+
"defaultValue": "true",
|
|
693
|
+
"description": "When true, adds a border to the tag for better visibility on light backgrounds."
|
|
694
|
+
}
|
|
695
|
+
],
|
|
696
|
+
"examples": [
|
|
697
|
+
"<DialTag\n tag=\"React\"\n variant={TagVariant.Default}\n remove={() => console.log('Tag removed')}\n/>"
|
|
698
|
+
],
|
|
699
|
+
"sourceFile": "components/Tag/Tag.tsx"
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"name": "DialEllipsisTooltip",
|
|
703
|
+
"category": "Overlay",
|
|
704
|
+
"description": "Single-line text with CSS ellipsis that shows a tooltip **only when actually truncated**.\naliases: TruncatedText|TruncationTooltip\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.",
|
|
705
|
+
"props": [
|
|
706
|
+
{
|
|
707
|
+
"name": "text",
|
|
708
|
+
"type": "ReactNode",
|
|
709
|
+
"required": true,
|
|
710
|
+
"description": "The text or node to display (truncated with ellipsis if too long)."
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"name": "className",
|
|
714
|
+
"type": "string",
|
|
715
|
+
"required": false,
|
|
716
|
+
"description": "Optional additional CSS classes for the text container (e.g. to set width)."
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "contentClassName",
|
|
720
|
+
"type": "string",
|
|
721
|
+
"required": false,
|
|
722
|
+
"description": "Optional additional CSS classes for the tooltip content."
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "hideTooltip",
|
|
726
|
+
"type": "boolean",
|
|
727
|
+
"required": false,
|
|
728
|
+
"description": "If true, disables the tooltip even if text is truncated."
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"name": "id",
|
|
732
|
+
"type": "string",
|
|
733
|
+
"required": false,
|
|
734
|
+
"description": "Optional attribute for unique identification"
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
"name": "customTooltipContent",
|
|
738
|
+
"type": "ReactNode",
|
|
739
|
+
"required": false,
|
|
740
|
+
"description": "If provided, this content will be shown in the tooltip instead of the full text when truncated."
|
|
741
|
+
}
|
|
742
|
+
],
|
|
743
|
+
"examples": [
|
|
744
|
+
"<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 />"
|
|
745
|
+
],
|
|
746
|
+
"sourceFile": "components/EllipsisTooltip/EllipsisTooltip.tsx"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"name": "DialDraggableItem",
|
|
750
|
+
"category": "Components",
|
|
751
|
+
"description": "A lightweight wrapper that makes its children sortable via drag-and-drop.\naliases: SortableItem|DragHandle\n\nRenders a row with a grab handle (left) and the provided content (right).\nIntegrates with `react-dnd` using a simple \"column\" drag type and delegates\nreordering logic to the provided `findItem` and `moveItem` callbacks.",
|
|
752
|
+
"props": [
|
|
753
|
+
{
|
|
754
|
+
"name": "id",
|
|
755
|
+
"type": "string",
|
|
756
|
+
"required": true,
|
|
757
|
+
"description": "Unique identifier of the draggable item"
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"name": "children",
|
|
761
|
+
"type": "ReactNode",
|
|
762
|
+
"required": true,
|
|
763
|
+
"description": "Content rendered within the draggable row"
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "className",
|
|
767
|
+
"type": "string",
|
|
768
|
+
"required": false,
|
|
769
|
+
"description": "Additional CSS classes applied to the root container"
|
|
770
|
+
},
|
|
771
|
+
{
|
|
772
|
+
"name": "ariaLabel",
|
|
773
|
+
"type": "string",
|
|
774
|
+
"required": false,
|
|
775
|
+
"defaultValue": "'Drag item'",
|
|
776
|
+
"description": "Accessible label for the handle"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "onFind",
|
|
780
|
+
"type": "(field: string) => number",
|
|
781
|
+
"required": false,
|
|
782
|
+
"description": "Function to resolve an item's current index by id"
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "onMove",
|
|
786
|
+
"type": "(field: string, atIndex: number) => void",
|
|
787
|
+
"required": false,
|
|
788
|
+
"description": "Function to move an item (by id) to a target index"
|
|
789
|
+
}
|
|
790
|
+
],
|
|
791
|
+
"examples": [
|
|
792
|
+
"<DialDraggableItem id=\"a\" findItem={find} moveItem={move}>\n <span>Item A</span>\n</DialDraggableItem>"
|
|
793
|
+
],
|
|
794
|
+
"sourceFile": "components/DraggableItem/DraggableItem.tsx"
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"name": "DialFileIcon",
|
|
798
|
+
"category": "FileManager/components",
|
|
799
|
+
"description": "Renders a file-type icon based on a file extension.\naliases: ExtensionIcon|TypeIcon\n\nUses DialIcon to provide consistent icon wrapper styling.",
|
|
800
|
+
"props": [
|
|
801
|
+
{
|
|
802
|
+
"name": "extension",
|
|
803
|
+
"type": "string",
|
|
804
|
+
"required": false,
|
|
805
|
+
"description": "File extension string (with or without leading dot)"
|
|
806
|
+
},
|
|
807
|
+
{
|
|
808
|
+
"name": "size",
|
|
809
|
+
"type": "number",
|
|
810
|
+
"required": false,
|
|
811
|
+
"defaultValue": "BASE_ICON_PROPS.size",
|
|
812
|
+
"description": "Icon pixel size"
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "stroke",
|
|
816
|
+
"type": "number",
|
|
817
|
+
"required": false,
|
|
818
|
+
"defaultValue": "BASE_ICON_PROPS.stroke",
|
|
819
|
+
"description": "Tabler icon stroke width"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"name": "className",
|
|
823
|
+
"type": "string",
|
|
824
|
+
"required": false,
|
|
825
|
+
"description": "Additional classes on the container"
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
"name": "decorative",
|
|
829
|
+
"type": "boolean",
|
|
830
|
+
"required": false,
|
|
831
|
+
"defaultValue": "false",
|
|
832
|
+
"description": "Whether the icon should be hidden from assistive technologies"
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"name": "label",
|
|
836
|
+
"type": "ReactNode",
|
|
837
|
+
"required": false,
|
|
838
|
+
"description": "Accessible label when not decorative; defaults to \"<EXT> file icon\""
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"name": "indicator",
|
|
842
|
+
"type": "ReactNode",
|
|
843
|
+
"required": false,
|
|
844
|
+
"description": "Optional indicator element to display alongside the icon"
|
|
845
|
+
}
|
|
846
|
+
],
|
|
847
|
+
"examples": [
|
|
848
|
+
"<DialFileIcon extension=\".pdf\" />\n<DialFileIcon extension=\"tsx\" size={28} stroke={1.25} />\n<DialFileIcon extension=\"unknown\" decorative /> // decorative, hidden from AT"
|
|
849
|
+
],
|
|
850
|
+
"sourceFile": "components/FileIcon/FileIcon.tsx"
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "DialFormItem",
|
|
854
|
+
"category": "Form",
|
|
855
|
+
"description": "A layout wrapper for form controls with label, helper text and error message.\naliases: FieldWrapper|FormControl\n\nUses `DialLabel` for the label and `DialErrorText` for consistent error styling.\nWires accessibility with:\n- `role=\"group\"`\n- `aria-labelledby` (when label is present)\n- `aria-describedby` (description and/or error ids)",
|
|
856
|
+
"props": [
|
|
857
|
+
{
|
|
858
|
+
"name": "id",
|
|
859
|
+
"type": "string",
|
|
860
|
+
"required": false,
|
|
861
|
+
"description": "Unique identifier for the form control element (used for accessibility)"
|
|
862
|
+
},
|
|
863
|
+
{
|
|
864
|
+
"name": "labelVisuallyHidden",
|
|
865
|
+
"type": "boolean",
|
|
866
|
+
"required": false,
|
|
867
|
+
"defaultValue": "false",
|
|
868
|
+
"description": "Whether to visually hide the label (still accessible to screen readers, default: false)"
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"name": "className",
|
|
872
|
+
"type": "string",
|
|
873
|
+
"required": false,
|
|
874
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "childrenClassName",
|
|
878
|
+
"type": "string",
|
|
879
|
+
"required": false,
|
|
880
|
+
"description": "Additional CSS classes to apply to the children container div"
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "labelClassName",
|
|
884
|
+
"type": "string",
|
|
885
|
+
"required": false,
|
|
886
|
+
"description": "Additional CSS classes to apply to the label element"
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"name": "errorClassName",
|
|
890
|
+
"type": "string",
|
|
891
|
+
"required": false,
|
|
892
|
+
"description": "Additional CSS classes to apply to the error message element"
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"name": "children",
|
|
896
|
+
"type": "ReactNode",
|
|
897
|
+
"required": true,
|
|
898
|
+
"description": "The form control element(s) to render inside the DialFormItem"
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "value",
|
|
902
|
+
"type": "ReactNode",
|
|
903
|
+
"required": false,
|
|
904
|
+
"description": "The current value of the form control (for readonly mode)"
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "defaultEmptyText",
|
|
908
|
+
"type": "string",
|
|
909
|
+
"required": false,
|
|
910
|
+
"description": "Text to display when readonly and value is empty (default: \"None\")"
|
|
911
|
+
}
|
|
912
|
+
],
|
|
913
|
+
"examples": [
|
|
914
|
+
"<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>"
|
|
915
|
+
],
|
|
916
|
+
"sourceFile": "components/FormItem/FormItem.tsx"
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"name": "DialSharedEntityIndicator",
|
|
920
|
+
"category": "FileManager/components",
|
|
921
|
+
"description": "A compact icon-only indicator to denote a \"shared\" entity.\naliases: SharedIcon|AccessIndicator\n\nRenders a small arrow-up-right icon with token-based colors.",
|
|
922
|
+
"props": [
|
|
923
|
+
{
|
|
924
|
+
"name": "label",
|
|
925
|
+
"type": "ReactNode",
|
|
926
|
+
"required": false,
|
|
927
|
+
"defaultValue": "'Shared entity'",
|
|
928
|
+
"description": "Accessible label for assistive tech"
|
|
929
|
+
},
|
|
930
|
+
{
|
|
931
|
+
"name": "size",
|
|
932
|
+
"type": "number",
|
|
933
|
+
"required": false,
|
|
934
|
+
"defaultValue": "14",
|
|
935
|
+
"description": "Pixel size for the icon"
|
|
936
|
+
},
|
|
937
|
+
{
|
|
938
|
+
"name": "stroke",
|
|
939
|
+
"type": "number",
|
|
940
|
+
"required": false,
|
|
941
|
+
"defaultValue": "1.5",
|
|
942
|
+
"description": "Stroke width for the icon"
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "className",
|
|
946
|
+
"type": "string",
|
|
947
|
+
"required": false,
|
|
948
|
+
"description": "Additional Tailwind classes applied to the icon"
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "containerClassName",
|
|
952
|
+
"type": "string",
|
|
953
|
+
"required": false,
|
|
954
|
+
"description": "Additional Tailwind classes appended to the container"
|
|
955
|
+
},
|
|
956
|
+
{
|
|
957
|
+
"name": "sharedIndicatorTooltip",
|
|
958
|
+
"type": "ReactNode",
|
|
959
|
+
"required": false,
|
|
960
|
+
"description": "Custom tooltip content, defaults to \"Shared\""
|
|
961
|
+
}
|
|
962
|
+
],
|
|
963
|
+
"examples": [
|
|
964
|
+
"<DialSharedEntityIndicator />\n<DialSharedEntityIndicator size={12} label=\"Opens in new window\" />"
|
|
965
|
+
],
|
|
966
|
+
"sourceFile": "components/SharedEntityIndicator/SharedEntityIndicator.tsx"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "DialFileName",
|
|
970
|
+
"category": "FileManager/components",
|
|
971
|
+
"description": "Component to display a file name with a file icon and shared indicator.\naliases: FileDisplay|NameDisplay\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.",
|
|
972
|
+
"props": [
|
|
973
|
+
{
|
|
974
|
+
"name": "name",
|
|
975
|
+
"type": "string",
|
|
976
|
+
"required": true,
|
|
977
|
+
"description": "Full file name with or without extension."
|
|
978
|
+
},
|
|
979
|
+
{
|
|
980
|
+
"name": "fileExtension",
|
|
981
|
+
"type": "string",
|
|
982
|
+
"required": false
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"name": "className",
|
|
986
|
+
"type": "string",
|
|
987
|
+
"required": false,
|
|
988
|
+
"description": "Additional CSS classes for the root container."
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"name": "shared",
|
|
992
|
+
"type": "boolean",
|
|
993
|
+
"required": false,
|
|
994
|
+
"defaultValue": "false",
|
|
995
|
+
"description": "Whether the file is shared."
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
"name": "iconSize",
|
|
999
|
+
"type": "number",
|
|
1000
|
+
"required": false,
|
|
1001
|
+
"defaultValue": "BASE_ICON_SIZE",
|
|
1002
|
+
"description": "Icon size in px. Default: BASE_ICON_SIZE."
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "details",
|
|
1006
|
+
"type": "ReactNode",
|
|
1007
|
+
"required": false,
|
|
1008
|
+
"description": "Optional metadata block displayed under the file name (e.g., size, modified date)."
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "sharedIndicatorClassName",
|
|
1012
|
+
"type": "string",
|
|
1013
|
+
"required": false,
|
|
1014
|
+
"description": "Additional CSS classes for the shared indicator."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "sharedIndicatorTooltip",
|
|
1018
|
+
"type": "ReactNode",
|
|
1019
|
+
"required": false,
|
|
1020
|
+
"description": "Custom tooltip content for the shared indicator; defaults to \"Shared\""
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "hideTooltip",
|
|
1024
|
+
"type": "boolean",
|
|
1025
|
+
"required": false,
|
|
1026
|
+
"defaultValue": "false"
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "isInvalidName",
|
|
1030
|
+
"type": "boolean",
|
|
1031
|
+
"required": false,
|
|
1032
|
+
"defaultValue": "false",
|
|
1033
|
+
"description": "If true, applies disabled styling to indicate the file name has invalid characters."
|
|
1034
|
+
},
|
|
1035
|
+
{
|
|
1036
|
+
"name": "tooltipContent",
|
|
1037
|
+
"type": "ReactNode",
|
|
1038
|
+
"required": false,
|
|
1039
|
+
"description": "Custom tooltip content to show when the name is truncated; defaults to showing the full name."
|
|
1040
|
+
}
|
|
1041
|
+
],
|
|
1042
|
+
"examples": [
|
|
1043
|
+
"// 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/>"
|
|
1044
|
+
],
|
|
1045
|
+
"sourceFile": "components/FileName/FileName.tsx"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "DialFolderName",
|
|
1049
|
+
"category": "FileManager/components",
|
|
1050
|
+
"description": "Component to display a folder name with a folder icon and shared indicator.\naliases: FolderDisplay|DirectoryName\n\nHandles long names with ellipsis and tooltip.",
|
|
1051
|
+
"props": [
|
|
1052
|
+
{
|
|
1053
|
+
"name": "name",
|
|
1054
|
+
"type": "string",
|
|
1055
|
+
"required": true,
|
|
1056
|
+
"description": "Folder name"
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "shared",
|
|
1060
|
+
"type": "boolean",
|
|
1061
|
+
"required": false,
|
|
1062
|
+
"defaultValue": "false",
|
|
1063
|
+
"description": "If true, shows shared indicator. Default: false."
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "loading",
|
|
1067
|
+
"type": "boolean",
|
|
1068
|
+
"required": false,
|
|
1069
|
+
"defaultValue": "false",
|
|
1070
|
+
"description": "If true, shows loading state. Default: false."
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"name": "iconSize",
|
|
1074
|
+
"type": "number",
|
|
1075
|
+
"required": false,
|
|
1076
|
+
"defaultValue": "BASE_ICON_SIZE",
|
|
1077
|
+
"description": "Icon size in px. Default: BASE_ICON_SIZE."
|
|
1078
|
+
},
|
|
1079
|
+
{
|
|
1080
|
+
"name": "className",
|
|
1081
|
+
"type": "string",
|
|
1082
|
+
"required": false,
|
|
1083
|
+
"description": "Additional CSS classes for the root container"
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "sharedIndicatorClassName",
|
|
1087
|
+
"type": "string",
|
|
1088
|
+
"required": false,
|
|
1089
|
+
"description": "Additional CSS classes for the shared indicator"
|
|
1090
|
+
},
|
|
1091
|
+
{
|
|
1092
|
+
"name": "sharedIndicatorTooltip",
|
|
1093
|
+
"type": "ReactNode",
|
|
1094
|
+
"required": false,
|
|
1095
|
+
"description": "Custom tooltip content for the shared indicator; defaults to \"Shared\""
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"name": "hideTooltip",
|
|
1099
|
+
"type": "boolean",
|
|
1100
|
+
"required": false,
|
|
1101
|
+
"defaultValue": "false",
|
|
1102
|
+
"description": "If true, disables the tooltip even if the name is truncated."
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"name": "isInvalidName",
|
|
1106
|
+
"type": "boolean",
|
|
1107
|
+
"required": false,
|
|
1108
|
+
"defaultValue": "false",
|
|
1109
|
+
"description": "If true, applies disabled styling to indicate the file name has invalid characters."
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"name": "tooltipContent",
|
|
1113
|
+
"type": "ReactNode",
|
|
1114
|
+
"required": false,
|
|
1115
|
+
"description": "Custom tooltip content to show when the name is truncated; defaults to showing the full name."
|
|
1116
|
+
}
|
|
1117
|
+
],
|
|
1118
|
+
"examples": [
|
|
1119
|
+
"<DialFolderName name=\"Organization\" />"
|
|
1120
|
+
],
|
|
1121
|
+
"sourceFile": "components/FolderName/FolderName.tsx"
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "DialResizableContainer",
|
|
1125
|
+
"category": "Components",
|
|
1126
|
+
"description": "DialResizableContainer — A reusable resizable container\naliases: ResizePanel|SizableContainer\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",
|
|
1127
|
+
"props": [
|
|
1128
|
+
{
|
|
1129
|
+
"name": "children",
|
|
1130
|
+
"type": "ReactNode",
|
|
1131
|
+
"required": true,
|
|
1132
|
+
"description": "Content placed inside the container."
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
"name": "minWidth",
|
|
1136
|
+
"type": "number",
|
|
1137
|
+
"required": true,
|
|
1138
|
+
"description": "Minimum allowed width (px)."
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"name": "maxWidth",
|
|
1142
|
+
"type": "number",
|
|
1143
|
+
"required": true,
|
|
1144
|
+
"description": "Maximum allowed width (px)."
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"name": "width",
|
|
1148
|
+
"type": "number",
|
|
1149
|
+
"required": false,
|
|
1150
|
+
"description": "Controlled width. If omitted → uncontrolled mode."
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "defaultWidth",
|
|
1154
|
+
"type": "number",
|
|
1155
|
+
"required": true,
|
|
1156
|
+
"description": "Initial width in uncontrolled mode."
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "onResizeStop",
|
|
1160
|
+
"type": "(width: number) => void",
|
|
1161
|
+
"required": false,
|
|
1162
|
+
"description": "Optional callback fired when resize ends."
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"name": "onResize",
|
|
1166
|
+
"type": "(width: number) => void",
|
|
1167
|
+
"required": false,
|
|
1168
|
+
"description": "Optional callback fired continuously during resizing with current width."
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"name": "side",
|
|
1172
|
+
"type": "ResizableContainerSide",
|
|
1173
|
+
"required": false,
|
|
1174
|
+
"defaultValue": "ResizableContainerSide.Right",
|
|
1175
|
+
"description": "Resize handle side."
|
|
1176
|
+
},
|
|
1177
|
+
{
|
|
1178
|
+
"name": "resizeHandlerClassName",
|
|
1179
|
+
"type": "string",
|
|
1180
|
+
"required": false,
|
|
1181
|
+
"description": "Optional additional CSS classes."
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
"name": "resizeHandler",
|
|
1185
|
+
"type": "ReactNode",
|
|
1186
|
+
"required": false,
|
|
1187
|
+
"description": "Optional custom handler element."
|
|
1188
|
+
}
|
|
1189
|
+
],
|
|
1190
|
+
"examples": [],
|
|
1191
|
+
"sourceFile": "components/ResizableContainer/ResizableContainer.tsx"
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "DialConditionalResizableContainer",
|
|
1195
|
+
"category": "Components",
|
|
1196
|
+
"description": "DialConditionalResizableContainer — A conditional wrapper around `DialResizableContainer`.\naliases: OptionalResize|ConditionalPanel\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.",
|
|
1197
|
+
"props": [
|
|
1198
|
+
{
|
|
1199
|
+
"name": "enabled",
|
|
1200
|
+
"type": "boolean",
|
|
1201
|
+
"required": false,
|
|
1202
|
+
"defaultValue": "true",
|
|
1203
|
+
"description": "Whether resizing is enabled. When false, children are rendered directly."
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"examples": [
|
|
1207
|
+
"<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>"
|
|
1208
|
+
],
|
|
1209
|
+
"sourceFile": "components/ResizableContainer/ConditionalResizableContainer.tsx"
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"name": "DialSkeleton",
|
|
1213
|
+
"category": "Feedback",
|
|
1214
|
+
"description": "DialSkeleton\naliases: PlaceholderUI|ShimmerLoader\n\nA placeholder component to show while content is loading.\nProvides various skeleton shapes and configurations.",
|
|
1215
|
+
"props": [
|
|
1216
|
+
{
|
|
1217
|
+
"name": "active",
|
|
1218
|
+
"type": "boolean",
|
|
1219
|
+
"required": false,
|
|
1220
|
+
"defaultValue": "true",
|
|
1221
|
+
"description": "Whether to show the loading animation"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "paragraph",
|
|
1225
|
+
"type": "boolean | { rows?: number; width?: string | string[] }",
|
|
1226
|
+
"required": false,
|
|
1227
|
+
"defaultValue": "true",
|
|
1228
|
+
"description": "Show paragraph placeholder or configure its appearance"
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"name": "avatar",
|
|
1232
|
+
"type": "| boolean\n | {\n size?: number | DialSkeletonAvatarSize;\n shape?: DialSkeletonAvatarShape;\n }",
|
|
1233
|
+
"required": false,
|
|
1234
|
+
"defaultValue": "false",
|
|
1235
|
+
"description": "Show avatar placeholder or configure its appearance"
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"name": "showTitle",
|
|
1239
|
+
"type": "boolean | { width?: string }",
|
|
1240
|
+
"required": false,
|
|
1241
|
+
"defaultValue": "true",
|
|
1242
|
+
"description": "Show title placeholder or configure its appearance"
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
"name": "loading",
|
|
1246
|
+
"type": "boolean",
|
|
1247
|
+
"required": false,
|
|
1248
|
+
"defaultValue": "true",
|
|
1249
|
+
"description": "Display the skeleton when true"
|
|
1250
|
+
},
|
|
1251
|
+
{
|
|
1252
|
+
"name": "children",
|
|
1253
|
+
"type": "ReactNode",
|
|
1254
|
+
"required": false,
|
|
1255
|
+
"description": "Content to be displayed when loading is false"
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "variant",
|
|
1259
|
+
"type": "DialSkeletonVariant",
|
|
1260
|
+
"required": false,
|
|
1261
|
+
"defaultValue": "DialSkeletonVariant.Default",
|
|
1262
|
+
"description": "Skeleton variant"
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"name": "width",
|
|
1266
|
+
"type": "string | number",
|
|
1267
|
+
"required": false,
|
|
1268
|
+
"description": "Width of the skeleton"
|
|
1269
|
+
},
|
|
1270
|
+
{
|
|
1271
|
+
"name": "height",
|
|
1272
|
+
"type": "string | number",
|
|
1273
|
+
"required": false,
|
|
1274
|
+
"description": "Height of the skeleton"
|
|
1275
|
+
}
|
|
1276
|
+
],
|
|
1277
|
+
"examples": [
|
|
1278
|
+
"// Simple skeleton\n<DialSkeleton />\n\n// Text skeleton with custom size\n<DialSkeleton variant={DialSkeletonVariant.Text} width=\"200px\" height=\"20px\" />\n\n// Circular avatar skeleton\n<DialSkeleton variant={DialSkeletonVariant.Circular} width={40} height={40} />\n\n// Complex skeleton with avatar, showTitle and paragraph\n<DialSkeleton\n avatar\n showTitle\n paragraph={{ rows: 3 }}\n active\n/>\n\n// Conditional loading\n<DialSkeleton loading={isLoading}>\n <div>Your content here</div>\n</DialSkeleton>\n\n// Custom paragraph widths\n<DialSkeleton\n paragraph={{ rows: 3, width: ['100%', '80%', '60%'] }}\n/>\n\n// Avatar with size and shape\n<DialSkeleton\n avatar={{\n size: DialSkeletonAvatarSize.Large,\n shape: DialSkeletonAvatarShape.Square\n }}\n/>"
|
|
1279
|
+
],
|
|
1280
|
+
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
"name": "DialGrid",
|
|
1284
|
+
"category": "Grid",
|
|
1285
|
+
"description": "DialGrid — A feature-rich data grid wrapper built on ag-Grid with dark theme support.\naliases: DataTable|TableGrid\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",
|
|
1286
|
+
"props": [
|
|
1287
|
+
{
|
|
1288
|
+
"name": "columnDefs",
|
|
1289
|
+
"type": "ColDef<T>[]",
|
|
1290
|
+
"required": false,
|
|
1291
|
+
"description": "Array of column definitions (ag-Grid ColDef format)"
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"name": "rowData",
|
|
1295
|
+
"type": "T[]",
|
|
1296
|
+
"required": false,
|
|
1297
|
+
"description": "Array of data objects to display in the grid"
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"name": "additionalGridOptions",
|
|
1301
|
+
"type": "GridOptions<T>",
|
|
1302
|
+
"required": false,
|
|
1303
|
+
"description": "Additional ag-Grid GridOptions to merge with defaults"
|
|
1304
|
+
},
|
|
1305
|
+
{
|
|
1306
|
+
"name": "getContextMenuItems",
|
|
1307
|
+
"type": "(row: T) => DropdownItem[]",
|
|
1308
|
+
"required": false,
|
|
1309
|
+
"description": "Function returning context menu items for a given row"
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"name": "className",
|
|
1313
|
+
"type": "string",
|
|
1314
|
+
"required": false,
|
|
1315
|
+
"description": "Additional CSS classes to apply to the grid container"
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
"name": "ariaLabel",
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"required": false,
|
|
1321
|
+
"defaultValue": "'Data grid'",
|
|
1322
|
+
"description": "Accessible label for the grid region"
|
|
1323
|
+
},
|
|
1324
|
+
{
|
|
1325
|
+
"name": "wrapCustomCellRenderers",
|
|
1326
|
+
"type": "boolean | ((col: ColDef<T>) => boolean)",
|
|
1327
|
+
"required": false,
|
|
1328
|
+
"defaultValue": "true",
|
|
1329
|
+
"description": "Whether to wrap custom cell renderers with context menu support"
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "disabledRowIds",
|
|
1333
|
+
"type": "Set<string>",
|
|
1334
|
+
"required": false,
|
|
1335
|
+
"description": "Set of row IDs that should be disabled. Disabled rows are non-interactive and cannot be selected. IDs must match values from `getRowId`."
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"name": "selectedRowIds",
|
|
1339
|
+
"type": "Set<string>",
|
|
1340
|
+
"required": false,
|
|
1341
|
+
"description": "Controlled selection: set of row IDs that should be selected"
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"name": "onGridApiChange",
|
|
1345
|
+
"type": "(api: GridApi<T>) => void",
|
|
1346
|
+
"required": false,
|
|
1347
|
+
"description": "Callback invoked when the grid API becomes available"
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
"name": "onSelectionChange",
|
|
1351
|
+
"type": "(selectedRowIds: Set<string>, selectedRows: T[]) => void",
|
|
1352
|
+
"required": false,
|
|
1353
|
+
"description": "Callback invoked when selection changes (selectedIds, selectedRows)"
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "getRowId",
|
|
1357
|
+
"type": "(row: T) => string",
|
|
1358
|
+
"required": false,
|
|
1359
|
+
"defaultValue": "(row: T) =>\n String((row as Record<string, unknown>).id ?? JSON.stringify(row))",
|
|
1360
|
+
"description": "Function to extract unique ID from a row object (defaults to 'id' field)"
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
"name": "alternateOddRowColors",
|
|
1364
|
+
"type": "boolean",
|
|
1365
|
+
"required": false,
|
|
1366
|
+
"defaultValue": "false",
|
|
1367
|
+
"description": "Whether to alternate background colors for odd/even rows"
|
|
1368
|
+
},
|
|
1369
|
+
{
|
|
1370
|
+
"name": "filterPlaceholder",
|
|
1371
|
+
"type": "string",
|
|
1372
|
+
"required": false,
|
|
1373
|
+
"defaultValue": "'Enter value'",
|
|
1374
|
+
"description": "Placeholder text for column filter inputs"
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "emptyStateIcon",
|
|
1378
|
+
"type": "ReactNode",
|
|
1379
|
+
"required": false,
|
|
1380
|
+
"description": "Optional icon for empty state"
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "emptyStateTitle",
|
|
1384
|
+
"type": "string",
|
|
1385
|
+
"required": false,
|
|
1386
|
+
"defaultValue": "'No results found'",
|
|
1387
|
+
"description": "Optional title text displayed when the grid has no rows to show."
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
"name": "emptyStateDescription",
|
|
1391
|
+
"type": "string",
|
|
1392
|
+
"required": false,
|
|
1393
|
+
"defaultValue": "\"Sorry, we couldn't find any results for your search.\"",
|
|
1394
|
+
"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\")."
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"name": "loading",
|
|
1398
|
+
"type": "boolean",
|
|
1399
|
+
"required": false,
|
|
1400
|
+
"defaultValue": "false",
|
|
1401
|
+
"description": "When true, shows AG-Grid's native loading overlay"
|
|
1402
|
+
},
|
|
1403
|
+
{
|
|
1404
|
+
"name": "wrapperBorder",
|
|
1405
|
+
"type": "boolean",
|
|
1406
|
+
"required": false,
|
|
1407
|
+
"defaultValue": "true",
|
|
1408
|
+
"description": "Whether to apply a border around the grid container"
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
"name": "withoutHeaderBorders",
|
|
1412
|
+
"type": "boolean",
|
|
1413
|
+
"required": false,
|
|
1414
|
+
"defaultValue": "false",
|
|
1415
|
+
"description": "Whether to hide the header row borders"
|
|
1416
|
+
},
|
|
1417
|
+
{
|
|
1418
|
+
"name": "selectionMode",
|
|
1419
|
+
"type": "GridSelectionMode",
|
|
1420
|
+
"required": false,
|
|
1421
|
+
"description": "Could be GridSelectionMode.MULTIPLE or GridSelectionMode.SINGLE to enable selection column"
|
|
1422
|
+
},
|
|
1423
|
+
{
|
|
1424
|
+
"name": "allowDisabledContextMenu",
|
|
1425
|
+
"type": "boolean",
|
|
1426
|
+
"required": false,
|
|
1427
|
+
"defaultValue": "false",
|
|
1428
|
+
"description": "Enables context menu actions even if row itself is disabled for selection"
|
|
1429
|
+
}
|
|
1430
|
+
],
|
|
1431
|
+
"examples": [
|
|
1432
|
+
"// 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/>"
|
|
1433
|
+
],
|
|
1434
|
+
"sourceFile": "components/Grid/Grid.tsx"
|
|
1435
|
+
},
|
|
1436
|
+
{
|
|
1437
|
+
"name": "DialTabs",
|
|
1438
|
+
"category": "Navigation",
|
|
1439
|
+
"description": "A responsive and overflow-aware tabs component that automatically adapts its layout\naliases: TabNavigation|TabBar\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.",
|
|
1440
|
+
"props": [
|
|
1441
|
+
{
|
|
1442
|
+
"name": "tabs",
|
|
1443
|
+
"type": "TabModel[]",
|
|
1444
|
+
"required": true,
|
|
1445
|
+
"description": "Array of tab models to render. Each tab must include an `id` and a display `name`."
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
"name": "activeTab",
|
|
1449
|
+
"type": "string",
|
|
1450
|
+
"required": true,
|
|
1451
|
+
"description": "The identifier of the currently active tab."
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "onClick",
|
|
1455
|
+
"type": "(id: string) => void",
|
|
1456
|
+
"required": true,
|
|
1457
|
+
"description": "Callback fired when a tab is selected. Receives the tab's `id` as an argument."
|
|
1458
|
+
},
|
|
1459
|
+
{
|
|
1460
|
+
"name": "orientation",
|
|
1461
|
+
"type": "TabOrientation",
|
|
1462
|
+
"required": false,
|
|
1463
|
+
"defaultValue": "TabOrientation.Horizontal",
|
|
1464
|
+
"description": "Layout direction of the tabs. Uses the enum."
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
"name": "screenThreshold",
|
|
1468
|
+
"type": "ScreenResolution",
|
|
1469
|
+
"required": false,
|
|
1470
|
+
"defaultValue": "ScreenResolution.Tablet",
|
|
1471
|
+
"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."
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"name": "smallScreenContainerClassName",
|
|
1475
|
+
"type": "string",
|
|
1476
|
+
"required": false,
|
|
1477
|
+
"description": "Optional CSS class applied to the dropdown container\nin small-screen (collapsed) mode."
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"name": "smallScreenDropdownItemClassName",
|
|
1481
|
+
"type": "string",
|
|
1482
|
+
"required": false,
|
|
1483
|
+
"description": "Optional CSS class applied to individual dropdown\nitems in small-screen mode."
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"name": "desktopDropdownClassName",
|
|
1487
|
+
"type": "string",
|
|
1488
|
+
"required": false,
|
|
1489
|
+
"description": "Optional CSS class applied to dropdown button in non small-screen mode."
|
|
1490
|
+
},
|
|
1491
|
+
{
|
|
1492
|
+
"name": "desktopTabClassName",
|
|
1493
|
+
"type": "string",
|
|
1494
|
+
"required": false,
|
|
1495
|
+
"description": "Optional CSS class applied to tab in non small-screed mode."
|
|
1496
|
+
}
|
|
1497
|
+
],
|
|
1498
|
+
"examples": [
|
|
1499
|
+
"<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/>"
|
|
1500
|
+
],
|
|
1501
|
+
"sourceFile": "components/Tabs/Tabs.tsx"
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"name": "DialBreadcrumb",
|
|
1505
|
+
"category": "Navigation",
|
|
1506
|
+
"description": "Breadcrumb navigation component with horizontal scroll on overflow.\naliases: NavigationPath|BreadcrumbTrail\n\nUse either the `pathItems` prop or compose with `<DialBreadcrumbItem/>` as children.\nThe last item is treated as the current page.",
|
|
1507
|
+
"props": [
|
|
1508
|
+
{
|
|
1509
|
+
"name": "pathItems",
|
|
1510
|
+
"type": "DialBreadcrumbPathItem[]",
|
|
1511
|
+
"required": false,
|
|
1512
|
+
"description": "Array of breadcrumb pathItems (see `DialBreadcrumbItem`)."
|
|
1513
|
+
},
|
|
1514
|
+
{
|
|
1515
|
+
"name": "separator",
|
|
1516
|
+
"type": "ReactNode",
|
|
1517
|
+
"required": false,
|
|
1518
|
+
"defaultValue": "defaultSeparator",
|
|
1519
|
+
"description": "Custom separator node (default: right chevron icon)."
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"name": "ariaLabel",
|
|
1523
|
+
"type": "string",
|
|
1524
|
+
"required": false,
|
|
1525
|
+
"defaultValue": "'Breadcrumb'",
|
|
1526
|
+
"description": "Aria label for the `<nav>` element (default: \"Breadcrumb\")."
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
"name": "className",
|
|
1530
|
+
"type": "string",
|
|
1531
|
+
"required": false,
|
|
1532
|
+
"description": "Additional CSS classes for the `<nav>` container."
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"name": "children",
|
|
1536
|
+
"type": "ReactNode",
|
|
1537
|
+
"required": false,
|
|
1538
|
+
"description": "Alternatively, compose with `<DialBreadcrumbItem/>` as children."
|
|
1539
|
+
},
|
|
1540
|
+
{
|
|
1541
|
+
"name": "labelClassName",
|
|
1542
|
+
"type": "string",
|
|
1543
|
+
"required": false,
|
|
1544
|
+
"description": "Additional CSS classes applied to each item when using `pathItems` prop."
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"name": "onBeforeNavigate",
|
|
1548
|
+
"type": "NavigationGuard",
|
|
1549
|
+
"required": false,
|
|
1550
|
+
"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)."
|
|
1551
|
+
}
|
|
1552
|
+
],
|
|
1553
|
+
"examples": [
|
|
1554
|
+
"<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>",
|
|
1555
|
+
"<DialBreadcrumb\n pathItems={items}\n onBeforeNavigate={async () => {\n if (hasUnsavedChanges) {\n return await confirmLeave();\n }\n return true;\n }}\n />"
|
|
1556
|
+
],
|
|
1557
|
+
"sourceFile": "components/Breadcrumb/Breadcrumb.tsx"
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"name": "DialBreadcrumbItem",
|
|
1561
|
+
"category": "Navigation",
|
|
1562
|
+
"description": "",
|
|
1563
|
+
"props": [
|
|
1564
|
+
{
|
|
1565
|
+
"name": "label",
|
|
1566
|
+
"type": "ReactNode",
|
|
1567
|
+
"required": true
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"name": "href",
|
|
1571
|
+
"type": "string",
|
|
1572
|
+
"required": false
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "onClick",
|
|
1576
|
+
"type": "MouseEventHandler<HTMLAnchorElement>",
|
|
1577
|
+
"required": false
|
|
1578
|
+
},
|
|
1579
|
+
{
|
|
1580
|
+
"name": "disabled",
|
|
1581
|
+
"type": "boolean",
|
|
1582
|
+
"required": false
|
|
1583
|
+
},
|
|
1584
|
+
{
|
|
1585
|
+
"name": "iconBefore",
|
|
1586
|
+
"type": "ReactNode",
|
|
1587
|
+
"required": false
|
|
1588
|
+
},
|
|
1589
|
+
{
|
|
1590
|
+
"name": "labelClassName",
|
|
1591
|
+
"type": "string",
|
|
1592
|
+
"required": false
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"name": "isLast",
|
|
1596
|
+
"type": "boolean",
|
|
1597
|
+
"required": false
|
|
1598
|
+
},
|
|
1599
|
+
{
|
|
1600
|
+
"name": "separator",
|
|
1601
|
+
"type": "ReactNode",
|
|
1602
|
+
"required": false,
|
|
1603
|
+
"defaultValue": "defaultSeparator"
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"name": "onBeforeNavigate",
|
|
1607
|
+
"type": "NavigationGuard",
|
|
1608
|
+
"required": false
|
|
1609
|
+
}
|
|
1610
|
+
],
|
|
1611
|
+
"examples": [],
|
|
1612
|
+
"sourceFile": "components/Breadcrumb/BreadcrumbItem.tsx"
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"name": "DialButton",
|
|
1616
|
+
"category": "Elements/Buttons",
|
|
1617
|
+
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction",
|
|
1618
|
+
"props": [
|
|
1619
|
+
{
|
|
1620
|
+
"name": "variant",
|
|
1621
|
+
"type": "ButtonVariant",
|
|
1622
|
+
"required": false,
|
|
1623
|
+
"description": "Defines the visual style of the button"
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"name": "size",
|
|
1627
|
+
"type": "ElementSize",
|
|
1628
|
+
"required": false,
|
|
1629
|
+
"defaultValue": "ElementSize.Standard",
|
|
1630
|
+
"description": "Defines the size of the button"
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "appearance",
|
|
1634
|
+
"type": "ButtonAppearance",
|
|
1635
|
+
"required": false,
|
|
1636
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
1637
|
+
"description": "Defines the type of the button"
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
"name": "textClassName",
|
|
1641
|
+
"type": "string",
|
|
1642
|
+
"required": false,
|
|
1643
|
+
"description": "Additional CSS classes to apply specifically to the button text"
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"name": "label",
|
|
1647
|
+
"type": "ReactNode",
|
|
1648
|
+
"required": false,
|
|
1649
|
+
"description": "The content of the button. Can be any React node."
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
"name": "iconBefore",
|
|
1653
|
+
"type": "ReactNode",
|
|
1654
|
+
"required": false,
|
|
1655
|
+
"description": "Icon or element to display before the button text"
|
|
1656
|
+
},
|
|
1657
|
+
{
|
|
1658
|
+
"name": "iconAfter",
|
|
1659
|
+
"type": "ReactNode",
|
|
1660
|
+
"required": false,
|
|
1661
|
+
"description": "Icon or element to display after the button text"
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
"name": "hideTitleOnMobile",
|
|
1665
|
+
"type": "boolean",
|
|
1666
|
+
"required": false,
|
|
1667
|
+
"description": "Whether to hide the title text on mobile devices"
|
|
1668
|
+
},
|
|
1669
|
+
{
|
|
1670
|
+
"name": "tooltipProps",
|
|
1671
|
+
"type": "TooltipProps",
|
|
1672
|
+
"required": false
|
|
1673
|
+
}
|
|
1674
|
+
],
|
|
1675
|
+
"examples": [
|
|
1676
|
+
"<DialButton\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
1677
|
+
"<DialButton\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
1678
|
+
],
|
|
1679
|
+
"sourceFile": "components/Button/Button.tsx"
|
|
1680
|
+
},
|
|
1681
|
+
{
|
|
1682
|
+
"name": "DialIconButton",
|
|
1683
|
+
"category": "Elements/Buttons",
|
|
1684
|
+
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton",
|
|
1685
|
+
"props": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "variant",
|
|
1688
|
+
"type": "ButtonVariant",
|
|
1689
|
+
"required": false,
|
|
1690
|
+
"description": "Defines the visual style of the button"
|
|
1691
|
+
},
|
|
1692
|
+
{
|
|
1693
|
+
"name": "size",
|
|
1694
|
+
"type": "ElementSize",
|
|
1695
|
+
"required": false,
|
|
1696
|
+
"defaultValue": "ElementSize.Standard",
|
|
1697
|
+
"description": "Defines the size of the button"
|
|
1698
|
+
},
|
|
1699
|
+
{
|
|
1700
|
+
"name": "appearance",
|
|
1701
|
+
"type": "ButtonAppearance",
|
|
1702
|
+
"required": false,
|
|
1703
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
1704
|
+
"description": "Defines the type of the button"
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"name": "icon",
|
|
1708
|
+
"type": "ReactNode",
|
|
1709
|
+
"required": true,
|
|
1710
|
+
"description": "Icon display"
|
|
1711
|
+
},
|
|
1712
|
+
{
|
|
1713
|
+
"name": "tooltipProps",
|
|
1714
|
+
"type": "TooltipProps",
|
|
1715
|
+
"required": false
|
|
1716
|
+
}
|
|
1717
|
+
],
|
|
1718
|
+
"examples": [
|
|
1719
|
+
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
1720
|
+
"<DialIconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
1721
|
+
],
|
|
1722
|
+
"sourceFile": "components/IconButton/IconButton.tsx"
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"name": "DialErrorButton",
|
|
1726
|
+
"category": "Elements/Buttons",
|
|
1727
|
+
"description": "A Error Button component with predefined error variant",
|
|
1728
|
+
"props": [],
|
|
1729
|
+
"examples": [
|
|
1730
|
+
"<DialErrorButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
1731
|
+
],
|
|
1732
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "DialNeutralButton",
|
|
1736
|
+
"category": "Elements/Buttons",
|
|
1737
|
+
"description": "A Neutral Button component with predefined neutral variant",
|
|
1738
|
+
"props": [],
|
|
1739
|
+
"examples": [
|
|
1740
|
+
"<DialNeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1741
|
+
],
|
|
1742
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
1743
|
+
},
|
|
1744
|
+
{
|
|
1745
|
+
"name": "DialPrimaryButton",
|
|
1746
|
+
"category": "Elements/Buttons",
|
|
1747
|
+
"description": "A Primary Button component with predefined primary variant",
|
|
1748
|
+
"props": [],
|
|
1749
|
+
"examples": [
|
|
1750
|
+
"<DialPrimaryButton\n label=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
1751
|
+
],
|
|
1752
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "DialGhostButton",
|
|
1756
|
+
"category": "Elements/Buttons",
|
|
1757
|
+
"description": "A Ghost Button component with predefined ghost appearance",
|
|
1758
|
+
"props": [],
|
|
1759
|
+
"examples": [
|
|
1760
|
+
"<DialGhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1761
|
+
],
|
|
1762
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "DialLinkButton",
|
|
1766
|
+
"category": "Elements/Buttons",
|
|
1767
|
+
"description": "A Link Button component with predefined link appearance",
|
|
1768
|
+
"props": [],
|
|
1769
|
+
"examples": [
|
|
1770
|
+
"<DialLinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1771
|
+
],
|
|
1772
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"name": "DialErrorIconButton",
|
|
1776
|
+
"category": "Elements/Buttons",
|
|
1777
|
+
"description": "A Error Icon Button component with predefined error variant",
|
|
1778
|
+
"props": [],
|
|
1779
|
+
"examples": [
|
|
1780
|
+
"<DialErrorIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1781
|
+
],
|
|
1782
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1783
|
+
},
|
|
1784
|
+
{
|
|
1785
|
+
"name": "DialGhostIconButton",
|
|
1786
|
+
"category": "Elements/Buttons",
|
|
1787
|
+
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
1788
|
+
"props": [],
|
|
1789
|
+
"examples": [
|
|
1790
|
+
"<DialGhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1791
|
+
],
|
|
1792
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1793
|
+
},
|
|
1794
|
+
{
|
|
1795
|
+
"name": "DialNeutralIconButton",
|
|
1796
|
+
"category": "Elements/Buttons",
|
|
1797
|
+
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
1798
|
+
"props": [],
|
|
1799
|
+
"examples": [
|
|
1800
|
+
"<DialNeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1801
|
+
],
|
|
1802
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1803
|
+
},
|
|
1804
|
+
{
|
|
1805
|
+
"name": "DialPrimaryIconButton",
|
|
1806
|
+
"category": "Elements/Buttons",
|
|
1807
|
+
"description": "A Primary Icon Button component with predefined primary variant",
|
|
1808
|
+
"props": [],
|
|
1809
|
+
"examples": [
|
|
1810
|
+
"<DialPrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1811
|
+
],
|
|
1812
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "DialSecondaryIconButton",
|
|
1816
|
+
"category": "Elements/Buttons",
|
|
1817
|
+
"description": "A Secondary Icon Button component with predefined error variant",
|
|
1818
|
+
"props": [],
|
|
1819
|
+
"examples": [
|
|
1820
|
+
"<DialSecondaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1821
|
+
],
|
|
1822
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1823
|
+
},
|
|
1824
|
+
{
|
|
1825
|
+
"name": "DialSuccessIconButton",
|
|
1826
|
+
"category": "Elements/Buttons",
|
|
1827
|
+
"description": "A Success Icon Button component with predefined error variant",
|
|
1828
|
+
"props": [],
|
|
1829
|
+
"examples": [
|
|
1830
|
+
"<DialSuccessIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1831
|
+
],
|
|
1832
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1833
|
+
},
|
|
1834
|
+
{
|
|
1835
|
+
"name": "DialTertiaryIconButton",
|
|
1836
|
+
"category": "Elements/Buttons",
|
|
1837
|
+
"description": "A Tertiary Icon Button component with predefined error variant",
|
|
1838
|
+
"props": [],
|
|
1839
|
+
"examples": [
|
|
1840
|
+
"<DialTertiaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
1841
|
+
],
|
|
1842
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
"name": "DialCloseButton",
|
|
1846
|
+
"category": "Elements/Buttons",
|
|
1847
|
+
"description": "A Close button component with a customizable icon and accessible label.\naliases: DismissButton|ExitButton",
|
|
1848
|
+
"props": [
|
|
1849
|
+
{
|
|
1850
|
+
"name": "ariaLabel",
|
|
1851
|
+
"type": "string",
|
|
1852
|
+
"required": false,
|
|
1853
|
+
"description": "Accessible label for screen readers"
|
|
1854
|
+
},
|
|
1855
|
+
{
|
|
1856
|
+
"name": "className",
|
|
1857
|
+
"type": "string",
|
|
1858
|
+
"required": false,
|
|
1859
|
+
"description": "Additional CSS classes to apply to the button"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "size",
|
|
1863
|
+
"type": "number",
|
|
1864
|
+
"required": false,
|
|
1865
|
+
"defaultValue": "24",
|
|
1866
|
+
"description": "Size of the close icon"
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"name": "onClose",
|
|
1870
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1871
|
+
"required": true,
|
|
1872
|
+
"description": "Click event handler for the close button"
|
|
1873
|
+
},
|
|
1874
|
+
{
|
|
1875
|
+
"name": "disabled",
|
|
1876
|
+
"type": "boolean",
|
|
1877
|
+
"required": false,
|
|
1878
|
+
"description": "Whether the button is disabled"
|
|
1879
|
+
}
|
|
1880
|
+
],
|
|
1881
|
+
"examples": [
|
|
1882
|
+
"<DialCloseButton\n ariaLabel=\"Close dialog\"\n onClose={handleClose}\n className=\"custom-close\"\n size={32}\n/>"
|
|
1883
|
+
],
|
|
1884
|
+
"sourceFile": "components/CloseButton/CloseButton.tsx"
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
"name": "DialRemoveButton",
|
|
1888
|
+
"category": "Elements/Buttons",
|
|
1889
|
+
"description": "A specialized button component for removal or delete actions.\naliases: DeleteButton|TrashButton\n\nRenders a `DialErrorButton` with a predefined trash icon (`IconTrashX`) as the leading icon.\nAdditional props are passed directly to the underlying `DialErrorButton`.",
|
|
1890
|
+
"props": [
|
|
1891
|
+
{
|
|
1892
|
+
"name": "iconClassName",
|
|
1893
|
+
"type": "string",
|
|
1894
|
+
"required": false,
|
|
1895
|
+
"description": "Optional CSS class applied to the trash icon for additional styling"
|
|
1896
|
+
}
|
|
1897
|
+
],
|
|
1898
|
+
"examples": [
|
|
1899
|
+
"<DialRemoveButton\n label=\"Delete item\"\n onClick={handleDelete}\n iconClassName=\"text-error\"\n/>"
|
|
1900
|
+
],
|
|
1901
|
+
"sourceFile": "components/RemoveButton/RemoveButton.tsx"
|
|
1902
|
+
},
|
|
1903
|
+
{
|
|
1904
|
+
"name": "DialTextarea",
|
|
1905
|
+
"category": "Elements",
|
|
1906
|
+
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox",
|
|
1907
|
+
"props": [
|
|
1908
|
+
{
|
|
1909
|
+
"name": "labelProps",
|
|
1910
|
+
"type": "DialLabelProps",
|
|
1911
|
+
"required": false,
|
|
1912
|
+
"description": "Props for the field label, including `label` (label text) and `required` (whether to show required indicator)"
|
|
1913
|
+
},
|
|
1914
|
+
{
|
|
1915
|
+
"name": "invalid",
|
|
1916
|
+
"type": "boolean",
|
|
1917
|
+
"required": false,
|
|
1918
|
+
"description": "Whether the textarea has validation errors (applies error styling)"
|
|
1919
|
+
},
|
|
1920
|
+
{
|
|
1921
|
+
"name": "containerClassName",
|
|
1922
|
+
"type": "string",
|
|
1923
|
+
"required": false,
|
|
1924
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "resize",
|
|
1928
|
+
"type": "boolean",
|
|
1929
|
+
"required": false,
|
|
1930
|
+
"defaultValue": "false",
|
|
1931
|
+
"description": "Whether the textarea has possibility to resize"
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"name": "error",
|
|
1935
|
+
"type": "string",
|
|
1936
|
+
"required": false,
|
|
1937
|
+
"description": "Error message to display below the textarea (also adds error styling)"
|
|
1938
|
+
},
|
|
1939
|
+
{
|
|
1940
|
+
"name": "caption",
|
|
1941
|
+
"type": "string",
|
|
1942
|
+
"required": false,
|
|
1943
|
+
"description": "Optional caption text to display below the textarea"
|
|
1944
|
+
},
|
|
1945
|
+
{
|
|
1946
|
+
"name": "onChange",
|
|
1947
|
+
"type": "(value: string) => void",
|
|
1948
|
+
"required": false,
|
|
1949
|
+
"description": "Callback function called when the textarea value changes"
|
|
1950
|
+
}
|
|
1951
|
+
],
|
|
1952
|
+
"examples": [
|
|
1953
|
+
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
1954
|
+
],
|
|
1955
|
+
"sourceFile": "components/Textarea/Textarea.tsx"
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "DialTooltip",
|
|
1959
|
+
"category": "Overlay",
|
|
1960
|
+
"description": "A Tooltip component that displays information on hover\naliases: HoverPopover|InfoPopover",
|
|
1961
|
+
"props": [
|
|
1962
|
+
{
|
|
1963
|
+
"name": "hideTooltip",
|
|
1964
|
+
"type": "boolean",
|
|
1965
|
+
"required": false,
|
|
1966
|
+
"description": "Whether to hide the tooltip completely"
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "tooltip",
|
|
1970
|
+
"type": "ReactNode",
|
|
1971
|
+
"required": false,
|
|
1972
|
+
"description": "The content to display in the tooltip"
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "children",
|
|
1976
|
+
"type": "ReactNode",
|
|
1977
|
+
"required": true,
|
|
1978
|
+
"description": "The element that triggers the tooltip"
|
|
1979
|
+
},
|
|
1980
|
+
{
|
|
1981
|
+
"name": "triggerClassName",
|
|
1982
|
+
"type": "string",
|
|
1983
|
+
"required": false,
|
|
1984
|
+
"description": "Additional CSS classes for the trigger element"
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
"name": "contentClassName",
|
|
1988
|
+
"type": "string",
|
|
1989
|
+
"required": false,
|
|
1990
|
+
"description": "Additional CSS classes for the tooltip content"
|
|
1991
|
+
}
|
|
1992
|
+
],
|
|
1993
|
+
"examples": [
|
|
1994
|
+
"<DialTooltip tooltip=\"This is helpful information\">\n <button>Hover me</button>\n</DialTooltip>"
|
|
1995
|
+
],
|
|
1996
|
+
"sourceFile": "components/Tooltip/Tooltip.tsx"
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
"name": "DialSwitch",
|
|
2000
|
+
"category": "Form",
|
|
2001
|
+
"description": "A Switch component with various styling options\naliases: ToggleSwitch|BinaryToggle",
|
|
2002
|
+
"props": [
|
|
2003
|
+
{
|
|
2004
|
+
"name": "label",
|
|
2005
|
+
"type": "ReactNode",
|
|
2006
|
+
"required": false
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"name": "switchId",
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"required": true,
|
|
2012
|
+
"description": "Unique identifier for the switch element"
|
|
2013
|
+
},
|
|
2014
|
+
{
|
|
2015
|
+
"name": "isOn",
|
|
2016
|
+
"type": "boolean",
|
|
2017
|
+
"required": false,
|
|
2018
|
+
"defaultValue": "false",
|
|
2019
|
+
"description": "The current value of the switch"
|
|
2020
|
+
},
|
|
2021
|
+
{
|
|
2022
|
+
"name": "disabled",
|
|
2023
|
+
"type": "boolean",
|
|
2024
|
+
"required": false,
|
|
2025
|
+
"description": "Whether the switch is disabled"
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
"name": "onChange",
|
|
2029
|
+
"type": "(value: boolean) => void",
|
|
2030
|
+
"required": false,
|
|
2031
|
+
"description": "Callback function called when the switch value changes"
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"name": "caption",
|
|
2035
|
+
"type": "string",
|
|
2036
|
+
"required": false,
|
|
2037
|
+
"description": "Caption text"
|
|
2038
|
+
}
|
|
2039
|
+
],
|
|
2040
|
+
"examples": [
|
|
2041
|
+
"<DialSwitch\n switchId=\"switch\"\n label=\"Toggle\"\n isOn={true}\n disabled={false}\n onChange={(value) => console.log(value)}\n caption=\"Caption\"\n/>"
|
|
2042
|
+
],
|
|
2043
|
+
"sourceFile": "components/Switch/Switch.tsx"
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"name": "DialPopup",
|
|
2047
|
+
"category": "Overlay",
|
|
2048
|
+
"description": "An accessible modal dialog component using Floating UI.\naliases: Modal|Dialog\n\nRenders in a portal with a scrim overlay, focus management, header with a title,\ncontent area, optional footer and a close control.",
|
|
2049
|
+
"props": [
|
|
2050
|
+
{
|
|
2051
|
+
"name": "open",
|
|
2052
|
+
"type": "boolean",
|
|
2053
|
+
"required": false,
|
|
2054
|
+
"defaultValue": "false",
|
|
2055
|
+
"description": "Controls visibility of the popup"
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
"name": "header",
|
|
2059
|
+
"type": "ReactNode",
|
|
2060
|
+
"required": false,
|
|
2061
|
+
"description": "Optional title rendered in the header"
|
|
2062
|
+
},
|
|
2063
|
+
{
|
|
2064
|
+
"name": "portalId",
|
|
2065
|
+
"type": "string",
|
|
2066
|
+
"required": false,
|
|
2067
|
+
"description": "Optional portal container id"
|
|
2068
|
+
},
|
|
2069
|
+
{
|
|
2070
|
+
"name": "className",
|
|
2071
|
+
"type": "string",
|
|
2072
|
+
"required": false,
|
|
2073
|
+
"description": "Additional CSS classes applied to the popup container"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"name": "overlayClassName",
|
|
2077
|
+
"type": "string",
|
|
2078
|
+
"required": false,
|
|
2079
|
+
"description": "Additional CSS classes applied to the overlay"
|
|
2080
|
+
},
|
|
2081
|
+
{
|
|
2082
|
+
"name": "titleClassName",
|
|
2083
|
+
"type": "string",
|
|
2084
|
+
"required": false,
|
|
2085
|
+
"description": "Additional CSS classes applied to the title element"
|
|
2086
|
+
},
|
|
2087
|
+
{
|
|
2088
|
+
"name": "headerClassName",
|
|
2089
|
+
"type": "string",
|
|
2090
|
+
"required": false,
|
|
2091
|
+
"description": "Additional CSS classes applied to the popup header container"
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"name": "dividers",
|
|
2095
|
+
"type": "boolean",
|
|
2096
|
+
"required": false,
|
|
2097
|
+
"defaultValue": "true",
|
|
2098
|
+
"description": "Whether to render separators between sections"
|
|
2099
|
+
},
|
|
2100
|
+
{
|
|
2101
|
+
"name": "dividerFooter",
|
|
2102
|
+
"type": "boolean",
|
|
2103
|
+
"required": false,
|
|
2104
|
+
"defaultValue": "true",
|
|
2105
|
+
"description": "Whether to render a divider above the footer when `dividers` is true"
|
|
2106
|
+
},
|
|
2107
|
+
{
|
|
2108
|
+
"name": "children",
|
|
2109
|
+
"type": "ReactNode",
|
|
2110
|
+
"required": false,
|
|
2111
|
+
"description": "Body content"
|
|
2112
|
+
},
|
|
2113
|
+
{
|
|
2114
|
+
"name": "footer",
|
|
2115
|
+
"type": "ReactNode",
|
|
2116
|
+
"required": false,
|
|
2117
|
+
"description": "Footer area for actions"
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
"name": "onClose",
|
|
2121
|
+
"type": "(e?: MouseEvent<HTMLButtonElement> | null) => void",
|
|
2122
|
+
"required": false,
|
|
2123
|
+
"description": "Callback fired when the popup requests to close"
|
|
2124
|
+
},
|
|
2125
|
+
{
|
|
2126
|
+
"name": "size",
|
|
2127
|
+
"type": "PopupSize",
|
|
2128
|
+
"required": false,
|
|
2129
|
+
"defaultValue": "PopupSize.Md",
|
|
2130
|
+
"description": "Sets the max-width of the popup"
|
|
2131
|
+
},
|
|
2132
|
+
{
|
|
2133
|
+
"name": "hideClose",
|
|
2134
|
+
"type": "boolean",
|
|
2135
|
+
"required": false,
|
|
2136
|
+
"defaultValue": "false",
|
|
2137
|
+
"description": "Whether the close button is hidden in the header (default: false)"
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"name": "closeOnOutsideClick",
|
|
2141
|
+
"type": "boolean",
|
|
2142
|
+
"required": false,
|
|
2143
|
+
"defaultValue": "true",
|
|
2144
|
+
"description": "Whether the popup closes when clicking outside (default: true)"
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"name": "preventKeyboardOnOpen",
|
|
2148
|
+
"type": "boolean",
|
|
2149
|
+
"required": false,
|
|
2150
|
+
"defaultValue": "false",
|
|
2151
|
+
"description": "When true, initial focus goes to a non-input guard to avoid opening the virtual keyboard on mobile"
|
|
2152
|
+
}
|
|
2153
|
+
],
|
|
2154
|
+
"examples": [
|
|
2155
|
+
"<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>"
|
|
2156
|
+
],
|
|
2157
|
+
"sourceFile": "components/Popup/Popup.tsx"
|
|
2158
|
+
},
|
|
2159
|
+
{
|
|
2160
|
+
"name": "DialConfirmationPopup",
|
|
2161
|
+
"category": "Overlay",
|
|
2162
|
+
"description": "A confirmation dialog built with DialPopup and DialButton.\naliases: ConfirmDialog|WarningDialog\n\nProvides an accessible modal with a title, optional description or custom content,\nand a footer with Cancel / Confirm actions.",
|
|
2163
|
+
"props": [
|
|
2164
|
+
{
|
|
2165
|
+
"name": "description",
|
|
2166
|
+
"type": "ReactNode",
|
|
2167
|
+
"required": false,
|
|
2168
|
+
"description": "Secondary text (ignored when `children` set)"
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"name": "descriptionClassName",
|
|
2172
|
+
"type": "string",
|
|
2173
|
+
"required": false,
|
|
2174
|
+
"description": "Custom CSS class for the description"
|
|
2175
|
+
},
|
|
2176
|
+
{
|
|
2177
|
+
"name": "confirmLabel",
|
|
2178
|
+
"type": "string",
|
|
2179
|
+
"required": false,
|
|
2180
|
+
"defaultValue": "defaultConfirmLabel",
|
|
2181
|
+
"description": "Label for the confirm button"
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"name": "cancelLabel",
|
|
2185
|
+
"type": "string",
|
|
2186
|
+
"required": false,
|
|
2187
|
+
"defaultValue": "defaultCancelLabel",
|
|
2188
|
+
"description": "Label for the cancel button"
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"name": "isLoading",
|
|
2192
|
+
"type": "boolean",
|
|
2193
|
+
"required": false,
|
|
2194
|
+
"defaultValue": "false",
|
|
2195
|
+
"description": "Shows loader placeholder and hides actions"
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"name": "disableConfirmButton",
|
|
2199
|
+
"type": "boolean",
|
|
2200
|
+
"required": false,
|
|
2201
|
+
"defaultValue": "false",
|
|
2202
|
+
"description": "Disables the confirm button"
|
|
2203
|
+
},
|
|
2204
|
+
{
|
|
2205
|
+
"name": "confirmClassName",
|
|
2206
|
+
"type": "string",
|
|
2207
|
+
"required": false,
|
|
2208
|
+
"description": "Extra classes merged into the confirm button"
|
|
2209
|
+
},
|
|
2210
|
+
{
|
|
2211
|
+
"name": "onConfirm",
|
|
2212
|
+
"type": "() => void",
|
|
2213
|
+
"required": true,
|
|
2214
|
+
"description": "Fired on confirm"
|
|
2215
|
+
},
|
|
2216
|
+
{
|
|
2217
|
+
"name": "onCancel",
|
|
2218
|
+
"type": "() => void",
|
|
2219
|
+
"required": false,
|
|
2220
|
+
"description": "Fired on cancel (falls back to `onClose`)"
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
"name": "children",
|
|
2224
|
+
"type": "ReactNode",
|
|
2225
|
+
"required": false,
|
|
2226
|
+
"description": "Custom body content"
|
|
2227
|
+
},
|
|
2228
|
+
{
|
|
2229
|
+
"name": "variant",
|
|
2230
|
+
"type": "ConfirmationPopupVariant",
|
|
2231
|
+
"required": false,
|
|
2232
|
+
"defaultValue": "ConfirmationPopupVariant.Info",
|
|
2233
|
+
"description": "Visual variant for the popup"
|
|
2234
|
+
}
|
|
2235
|
+
],
|
|
2236
|
+
"examples": [
|
|
2237
|
+
"<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/>"
|
|
2238
|
+
],
|
|
2239
|
+
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx"
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "DialRadioGroupPopupField",
|
|
2243
|
+
"category": "Form",
|
|
2244
|
+
"description": "A composite field that opens a popup with a radio group selector.\naliases: PopupRadio|ChoicePopup\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`.",
|
|
2245
|
+
"props": [],
|
|
2246
|
+
"examples": [
|
|
2247
|
+
"<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/>"
|
|
2248
|
+
],
|
|
2249
|
+
"sourceFile": "components/RadioGroupPopupField/RadioGroupPopupField.tsx"
|
|
2250
|
+
},
|
|
2251
|
+
{
|
|
2252
|
+
"name": "DialFormPopup",
|
|
2253
|
+
"category": "Overlay",
|
|
2254
|
+
"description": "A form-oriented popup dialog.\naliases: FormDialog|FormModal\n\nProvides an accessible popup with a title, custom body,\nand a footer with \"Cancel\" and \"Submit\" actions.",
|
|
2255
|
+
"props": [
|
|
2256
|
+
{
|
|
2257
|
+
"name": "submitLabel",
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"required": false,
|
|
2260
|
+
"defaultValue": "defaultSubmitLabel",
|
|
2261
|
+
"description": "Label for the primary action button"
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"name": "cancelLabel",
|
|
2265
|
+
"type": "string",
|
|
2266
|
+
"required": false,
|
|
2267
|
+
"defaultValue": "defaultCancelLabel",
|
|
2268
|
+
"description": "Label for the cancel button"
|
|
2269
|
+
},
|
|
2270
|
+
{
|
|
2271
|
+
"name": "isLoading",
|
|
2272
|
+
"type": "boolean",
|
|
2273
|
+
"required": false,
|
|
2274
|
+
"defaultValue": "false",
|
|
2275
|
+
"description": "Shows loader placeholder and hides actions"
|
|
2276
|
+
},
|
|
2277
|
+
{
|
|
2278
|
+
"name": "disableSubmitButton",
|
|
2279
|
+
"type": "boolean",
|
|
2280
|
+
"required": false,
|
|
2281
|
+
"defaultValue": "false",
|
|
2282
|
+
"description": "Disables the submit button"
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"name": "submitClassName",
|
|
2286
|
+
"type": "string",
|
|
2287
|
+
"required": false,
|
|
2288
|
+
"description": "Extra classes merged into the submit button"
|
|
2289
|
+
},
|
|
2290
|
+
{
|
|
2291
|
+
"name": "onSubmit",
|
|
2292
|
+
"type": "() => void",
|
|
2293
|
+
"required": true,
|
|
2294
|
+
"description": "Fired on submit"
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
"name": "onCancel",
|
|
2298
|
+
"type": "() => void",
|
|
2299
|
+
"required": false,
|
|
2300
|
+
"description": "Fired on cancel (falls back to `onClose`)"
|
|
2301
|
+
},
|
|
2302
|
+
{
|
|
2303
|
+
"name": "children",
|
|
2304
|
+
"type": "ReactNode",
|
|
2305
|
+
"required": false,
|
|
2306
|
+
"description": "Custom body content"
|
|
2307
|
+
}
|
|
2308
|
+
],
|
|
2309
|
+
"examples": [
|
|
2310
|
+
"<DialFormPopup\n open\n header=\"Create Model\"\n onClose={() => setOpen(false)}\n onSubmit={handleSubmit}\n/>"
|
|
2311
|
+
],
|
|
2312
|
+
"sourceFile": "components/FormPopup/FormPopup.tsx"
|
|
2313
|
+
},
|
|
2314
|
+
{
|
|
2315
|
+
"name": "DialInput",
|
|
2316
|
+
"category": "Elements/Inputs",
|
|
2317
|
+
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput",
|
|
2318
|
+
"props": [
|
|
2319
|
+
{
|
|
2320
|
+
"name": "labelProps",
|
|
2321
|
+
"type": "DialLabelProps",
|
|
2322
|
+
"required": false
|
|
2323
|
+
},
|
|
2324
|
+
{
|
|
2325
|
+
"name": "inputButtonProps",
|
|
2326
|
+
"type": "DialInputButtonProps",
|
|
2327
|
+
"required": false
|
|
2328
|
+
},
|
|
2329
|
+
{
|
|
2330
|
+
"name": "invalid",
|
|
2331
|
+
"type": "boolean",
|
|
2332
|
+
"required": false,
|
|
2333
|
+
"description": "Whether the input has validation errors (applies error styling)"
|
|
2334
|
+
},
|
|
2335
|
+
{
|
|
2336
|
+
"name": "error",
|
|
2337
|
+
"type": "string",
|
|
2338
|
+
"required": false,
|
|
2339
|
+
"description": "Error message to display below the input (also adds error styling)"
|
|
2340
|
+
},
|
|
2341
|
+
{
|
|
2342
|
+
"name": "caption",
|
|
2343
|
+
"type": "string",
|
|
2344
|
+
"required": false,
|
|
2345
|
+
"description": "Helper text to display below the input"
|
|
2346
|
+
},
|
|
2347
|
+
{
|
|
2348
|
+
"name": "tooltipText",
|
|
2349
|
+
"type": "string",
|
|
2350
|
+
"required": false
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
"name": "iconBefore",
|
|
2354
|
+
"type": "ReactNode",
|
|
2355
|
+
"required": false,
|
|
2356
|
+
"description": "Icon or element to display before the input"
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
"name": "iconAfter",
|
|
2360
|
+
"type": "ReactNode",
|
|
2361
|
+
"required": false,
|
|
2362
|
+
"description": "Icon or element to display after the input"
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"name": "prefix",
|
|
2366
|
+
"type": "string",
|
|
2367
|
+
"required": false
|
|
2368
|
+
},
|
|
2369
|
+
{
|
|
2370
|
+
"name": "postfix",
|
|
2371
|
+
"type": "string",
|
|
2372
|
+
"required": false
|
|
2373
|
+
},
|
|
2374
|
+
{
|
|
2375
|
+
"name": "inputRef",
|
|
2376
|
+
"type": "Ref<HTMLInputElement>",
|
|
2377
|
+
"required": false,
|
|
2378
|
+
"description": "Ref to access the underlying input element"
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"name": "onChange",
|
|
2382
|
+
"type": "(value?: string) => void",
|
|
2383
|
+
"required": false,
|
|
2384
|
+
"description": "Callback function called when the input value changes"
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"name": "containerClassName",
|
|
2388
|
+
"type": "string",
|
|
2389
|
+
"required": false,
|
|
2390
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
"name": "wrapperClassName",
|
|
2394
|
+
"type": "string",
|
|
2395
|
+
"required": false,
|
|
2396
|
+
"description": "Additional CSS classes to apply to the input wrapper div"
|
|
2397
|
+
}
|
|
2398
|
+
],
|
|
2399
|
+
"examples": [
|
|
2400
|
+
"<DialInput\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
2401
|
+
],
|
|
2402
|
+
"sourceFile": "components/Input/Input.tsx"
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"name": "DialNumberInput",
|
|
2406
|
+
"category": "Elements/Inputs",
|
|
2407
|
+
"description": "A number input field component\naliases: NumericField|NumberField",
|
|
2408
|
+
"props": [
|
|
2409
|
+
{
|
|
2410
|
+
"name": "integer",
|
|
2411
|
+
"type": "boolean",
|
|
2412
|
+
"required": false,
|
|
2413
|
+
"description": "When true, restricts input to integer values only — blocks decimal points, minus, plus, and scientific notation (e/E)"
|
|
2414
|
+
},
|
|
2415
|
+
{
|
|
2416
|
+
"name": "onChange",
|
|
2417
|
+
"type": "(value?: number | string) => void",
|
|
2418
|
+
"required": false,
|
|
2419
|
+
"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)"
|
|
2420
|
+
}
|
|
2421
|
+
],
|
|
2422
|
+
"examples": [
|
|
2423
|
+
"<DialNumberInput\n id=\"age\"\n placeholder=\"Enter your age\"\n value={25}\n onChange={(value) => setAge(value)}\n/>"
|
|
2424
|
+
],
|
|
2425
|
+
"sourceFile": "components/NumberInput/NumberInput.tsx"
|
|
2426
|
+
},
|
|
2427
|
+
{
|
|
2428
|
+
"name": "DialPasswordInput",
|
|
2429
|
+
"category": "Elements/Inputs",
|
|
2430
|
+
"description": "A password input component with show/hide functionality and customizable props.\naliases: SecureInput|ToggleablePassword",
|
|
2431
|
+
"props": [],
|
|
2432
|
+
"examples": [
|
|
2433
|
+
"<DialPasswordInput\n id=\"password\"\n label=\"Password\"\n value={password}\n onChange={e => setPassword(e.target.value)}\n disabled={false}\n/>"
|
|
2434
|
+
],
|
|
2435
|
+
"sourceFile": "components/PasswordInput/PasswordInput.tsx"
|
|
2436
|
+
},
|
|
2437
|
+
{
|
|
2438
|
+
"name": "DialSearch",
|
|
2439
|
+
"category": "Elements",
|
|
2440
|
+
"description": "A search input component with a customizable placeholder, icons, flexible props, and the ability\naliases: SearchField|QueryInput\n\nto clear the input value via a clear button. Supports multiple sizes for flexible layouts.",
|
|
2441
|
+
"props": [
|
|
2442
|
+
{
|
|
2443
|
+
"name": "size",
|
|
2444
|
+
"type": "ElementSize",
|
|
2445
|
+
"required": false,
|
|
2446
|
+
"defaultValue": "ElementSize.Standard",
|
|
2447
|
+
"description": "The size of the search input. Uses the enum."
|
|
2448
|
+
},
|
|
2449
|
+
{
|
|
2450
|
+
"name": "onChange",
|
|
2451
|
+
"type": "(value: string) => void",
|
|
2452
|
+
"required": false
|
|
2453
|
+
}
|
|
2454
|
+
],
|
|
2455
|
+
"examples": [
|
|
2456
|
+
"<DialSearch\n id=\"search\"\n value={query}\n placeholder=\"Search\"\n size={ElementSize.Small}\n onChange={(value) => setQuery(value)}\n onBlur={() => handleBlur()}\n disabled={false}\n/>"
|
|
2457
|
+
],
|
|
2458
|
+
"sourceFile": "components/Search/Search.tsx"
|
|
2459
|
+
},
|
|
2460
|
+
{
|
|
2461
|
+
"name": "DialInputPopup",
|
|
2462
|
+
"category": "Overlay",
|
|
2463
|
+
"description": "An input field that opens a popup when clicked, displaying a selected value or a list of values.\naliases: PopupInput|ReadonlyInput\n\nIt supports read-only mode, error states, and disabled state, with customizable styling.\nThe modal content is rendered using a portal for seamless integration.",
|
|
2464
|
+
"props": [
|
|
2465
|
+
{
|
|
2466
|
+
"name": "open",
|
|
2467
|
+
"type": "boolean",
|
|
2468
|
+
"required": false,
|
|
2469
|
+
"description": "The current state of the modal, indicating whether it is opened or closed."
|
|
2470
|
+
},
|
|
2471
|
+
{
|
|
2472
|
+
"name": "selectedValue",
|
|
2473
|
+
"type": "string | string[]",
|
|
2474
|
+
"required": false,
|
|
2475
|
+
"description": "The currently selected value(s). Can be a string for a single value or an array of strings for multiple values."
|
|
2476
|
+
},
|
|
2477
|
+
{
|
|
2478
|
+
"name": "children",
|
|
2479
|
+
"type": "ReactNode",
|
|
2480
|
+
"required": true,
|
|
2481
|
+
"description": "The content to render inside the modal when it is opened."
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
"name": "onOpen",
|
|
2485
|
+
"type": "() => void",
|
|
2486
|
+
"required": true,
|
|
2487
|
+
"description": "A callback function triggered when the modal open button is clicked."
|
|
2488
|
+
},
|
|
2489
|
+
{
|
|
2490
|
+
"name": "disabled",
|
|
2491
|
+
"type": "boolean",
|
|
2492
|
+
"required": false,
|
|
2493
|
+
"defaultValue": "false",
|
|
2494
|
+
"description": "Whether the input is disabled, preventing user interaction."
|
|
2495
|
+
},
|
|
2496
|
+
{
|
|
2497
|
+
"name": "valueClassName",
|
|
2498
|
+
"type": "string",
|
|
2499
|
+
"required": false,
|
|
2500
|
+
"description": "Additional CSS classes applied to the displayed value."
|
|
2501
|
+
},
|
|
2502
|
+
{
|
|
2503
|
+
"name": "inputClassName",
|
|
2504
|
+
"type": "string",
|
|
2505
|
+
"required": false,
|
|
2506
|
+
"description": "Additional CSS classes applied to the input container."
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"name": "placeholder",
|
|
2510
|
+
"type": "string",
|
|
2511
|
+
"required": false,
|
|
2512
|
+
"description": "Placeholder text displayed when no value is selected."
|
|
2513
|
+
},
|
|
2514
|
+
{
|
|
2515
|
+
"name": "elementId",
|
|
2516
|
+
"type": "string",
|
|
2517
|
+
"required": false,
|
|
2518
|
+
"description": "A unique identifier for the input element, useful for accessibility and testing."
|
|
2519
|
+
},
|
|
2520
|
+
{
|
|
2521
|
+
"name": "errorText",
|
|
2522
|
+
"type": "string",
|
|
2523
|
+
"required": false,
|
|
2524
|
+
"description": "An optional error message displayed below the input when an error state is present."
|
|
2525
|
+
},
|
|
2526
|
+
{
|
|
2527
|
+
"name": "invalid",
|
|
2528
|
+
"type": "boolean",
|
|
2529
|
+
"required": false,
|
|
2530
|
+
"description": "Whether the input is in an invalid state, affecting styling. Applied automatically if errorText is provided."
|
|
2531
|
+
},
|
|
2532
|
+
{
|
|
2533
|
+
"name": "emptyValueText",
|
|
2534
|
+
"type": "string",
|
|
2535
|
+
"required": false,
|
|
2536
|
+
"description": "The text displayed when no value is selected and placeholder is not provided."
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
"name": "editable",
|
|
2540
|
+
"type": "boolean",
|
|
2541
|
+
"required": false,
|
|
2542
|
+
"defaultValue": "false",
|
|
2543
|
+
"description": "When true, the input area becomes an editable text field; only the icon opens the popup."
|
|
2544
|
+
},
|
|
2545
|
+
{
|
|
2546
|
+
"name": "onValueChange",
|
|
2547
|
+
"type": "(value: string) => void",
|
|
2548
|
+
"required": false,
|
|
2549
|
+
"description": "Callback fired when the user types in the editable input."
|
|
2550
|
+
},
|
|
2551
|
+
{
|
|
2552
|
+
"name": "collapseTagOverflow",
|
|
2553
|
+
"type": "boolean",
|
|
2554
|
+
"required": false,
|
|
2555
|
+
"defaultValue": "false"
|
|
2556
|
+
},
|
|
2557
|
+
{
|
|
2558
|
+
"name": "iconBefore",
|
|
2559
|
+
"type": "ReactNode",
|
|
2560
|
+
"required": false,
|
|
2561
|
+
"description": "Optional icon rendered at the start of the field, before the value."
|
|
2562
|
+
}
|
|
2563
|
+
],
|
|
2564
|
+
"examples": [
|
|
2565
|
+
"<DialInputPopup\n open={true}\n selectedValue=\"Selected Item\"\n emptyValueText=\"No value selected\"\n onOpen={() => setModalState(true)}\n disabled={false}\n valueClassName=\"custom-value-class\"\n inputClassName=\"custom-input-class\"\n elementId=\"input-modal\"\n errorText=\"This field is required\"\n>\n <div>Modal Content Here</div>\n</DialInputPopup>"
|
|
2566
|
+
],
|
|
2567
|
+
"sourceFile": "components/InputPopup/InputPopup.tsx"
|
|
2568
|
+
},
|
|
2569
|
+
{
|
|
2570
|
+
"name": "DialAutocompleteInputValue",
|
|
2571
|
+
"category": "Form",
|
|
2572
|
+
"description": "A component that displays a list of selected items in a customizable, styled list. Each item is\naliases: SelectedList|ItemDisplay\n\nrendered as a tag wrapped in a tooltip, allowing for truncation and additional context when\nhovered. The component is flexible and supports custom CSS classes for styling the list and\nindividual list items.",
|
|
2573
|
+
"props": [
|
|
2574
|
+
{
|
|
2575
|
+
"name": "placeholder",
|
|
2576
|
+
"type": "string",
|
|
2577
|
+
"required": false,
|
|
2578
|
+
"description": "Placeholder text to display when no items are selected."
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
"name": "selectedItems",
|
|
2582
|
+
"type": "string[]",
|
|
2583
|
+
"required": false,
|
|
2584
|
+
"description": "An array of strings representing the selected items to display. If empty or undefined, the component renders nothing."
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"name": "listClassName",
|
|
2588
|
+
"type": "string",
|
|
2589
|
+
"required": false,
|
|
2590
|
+
"description": "Additional CSS classes applied to the container element containing the list of selected items."
|
|
2591
|
+
},
|
|
2592
|
+
{
|
|
2593
|
+
"name": "listElementClassName",
|
|
2594
|
+
"type": "string",
|
|
2595
|
+
"required": false,
|
|
2596
|
+
"description": "Additional CSS classes applied to each tag element representing an individual selected item."
|
|
2597
|
+
},
|
|
2598
|
+
{
|
|
2599
|
+
"name": "collapseTagOverflow",
|
|
2600
|
+
"type": "boolean",
|
|
2601
|
+
"required": false,
|
|
2602
|
+
"defaultValue": "false",
|
|
2603
|
+
"description": "When true, keeps items on one line and shows `+N` chip with a tooltip for overflow items."
|
|
2604
|
+
}
|
|
2605
|
+
],
|
|
2606
|
+
"examples": [
|
|
2607
|
+
"<DialAutocompleteInputValue\n selectedItems={['Item 1', 'Item 2', 'Item 3']}\n listClassName=\"custom-list-class\"\n listElementClassName=\"custom-item-class\"\n collapseTagOverflow\n/>"
|
|
2608
|
+
],
|
|
2609
|
+
"sourceFile": "components/AutocompleteInput/AutocompleteInputValue.tsx"
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"name": "DialTagInput",
|
|
2613
|
+
"category": "Form",
|
|
2614
|
+
"description": "A tag input field that allows users to add multiple tags using the Enter or comma key.\naliases: MultiTag|TagField\n\nSupports removing tags, displaying field labels, optional indicators, validation states,\nand dynamic layout adjustment when tags wrap to multiple lines.",
|
|
2615
|
+
"props": [
|
|
2616
|
+
{
|
|
2617
|
+
"name": "elementId",
|
|
2618
|
+
"type": "string",
|
|
2619
|
+
"required": false,
|
|
2620
|
+
"description": "Unique identifier for the input element."
|
|
2621
|
+
},
|
|
2622
|
+
{
|
|
2623
|
+
"name": "initialTags",
|
|
2624
|
+
"type": "string[]",
|
|
2625
|
+
"required": false,
|
|
2626
|
+
"defaultValue": "[]",
|
|
2627
|
+
"description": "Array of tags to be displayed initially."
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"name": "placeholder",
|
|
2631
|
+
"type": "string",
|
|
2632
|
+
"required": false,
|
|
2633
|
+
"description": "Placeholder text shown when the input is empty."
|
|
2634
|
+
},
|
|
2635
|
+
{
|
|
2636
|
+
"name": "captionDescription",
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"required": false,
|
|
2639
|
+
"description": "Caption text shown under the input if there is no errors."
|
|
2640
|
+
},
|
|
2641
|
+
{
|
|
2642
|
+
"name": "errorText",
|
|
2643
|
+
"type": "string",
|
|
2644
|
+
"required": false,
|
|
2645
|
+
"description": "Error message displayed below the field when validation fails."
|
|
2646
|
+
},
|
|
2647
|
+
{
|
|
2648
|
+
"name": "invalid",
|
|
2649
|
+
"type": "boolean",
|
|
2650
|
+
"required": false,
|
|
2651
|
+
"description": "Whether the field should be styled as invalid."
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
"name": "disabled",
|
|
2655
|
+
"type": "boolean",
|
|
2656
|
+
"required": false,
|
|
2657
|
+
"description": "Whether the input and remove buttons are disabled."
|
|
2658
|
+
},
|
|
2659
|
+
{
|
|
2660
|
+
"name": "collapseTagOverflow",
|
|
2661
|
+
"type": "boolean",
|
|
2662
|
+
"required": false,
|
|
2663
|
+
"defaultValue": "false",
|
|
2664
|
+
"description": "When true, keeps tags on one line and shows `+N` for overflow."
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"name": "readOnly",
|
|
2668
|
+
"type": "boolean",
|
|
2669
|
+
"required": false,
|
|
2670
|
+
"defaultValue": "false",
|
|
2671
|
+
"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."
|
|
2672
|
+
},
|
|
2673
|
+
{
|
|
2674
|
+
"name": "containerClassName",
|
|
2675
|
+
"type": "string",
|
|
2676
|
+
"required": false,
|
|
2677
|
+
"description": "Additional CSS classes applied to the tag container (the flex row wrapping all tags)."
|
|
2678
|
+
},
|
|
2679
|
+
{
|
|
2680
|
+
"name": "tagClassName",
|
|
2681
|
+
"type": "string",
|
|
2682
|
+
"required": false,
|
|
2683
|
+
"description": "Additional CSS classes applied to each individual tag."
|
|
2684
|
+
},
|
|
2685
|
+
{
|
|
2686
|
+
"name": "onChange",
|
|
2687
|
+
"type": "(tags: string[]) => void",
|
|
2688
|
+
"required": false,
|
|
2689
|
+
"description": "Callback fired whenever the tag list changes (tag added or removed)."
|
|
2690
|
+
}
|
|
2691
|
+
],
|
|
2692
|
+
"examples": [
|
|
2693
|
+
"<DialTagInput\n elementId=\"skills\"\n fieldTitle=\"Skills\"\n placeholder=\"Add a skill\"\n initialTags={['React', 'TypeScript']}\n optional\n onChange={(tags) => console.log('Updated tags:', tags)}\n/>"
|
|
2694
|
+
],
|
|
2695
|
+
"sourceFile": "components/TagInput/TagInput.tsx"
|
|
2696
|
+
},
|
|
2697
|
+
{
|
|
2698
|
+
"name": "DialSelect",
|
|
2699
|
+
"category": "Form",
|
|
2700
|
+
"description": "A versatile select supporting single and multiple selections.\naliases: OptionPicker|ChoiceSelector\n\nSingle mode mirrors the legacy visual:\n- Trigger shows the selected option's leading icon + label.\n- In the list, the selected option is indicated by a LEFT border and tinted background\n (no check icon).\n\nMultiple mode uses checkboxes (including Select All with indeterminate state).\n\nSearch:\n- `searchable`: shows a plain input in the overlay header that filters options.\n- `inlineSearch` (single mode only): the trigger renders a plain input; typing filters options;\n when closed, the input shows the selected label.",
|
|
2701
|
+
"props": [
|
|
2702
|
+
{
|
|
2703
|
+
"name": "options",
|
|
2704
|
+
"type": "SelectOption[]",
|
|
2705
|
+
"required": true,
|
|
2706
|
+
"description": "Array of options to select from."
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
"name": "multiple",
|
|
2710
|
+
"type": "boolean",
|
|
2711
|
+
"required": false,
|
|
2712
|
+
"defaultValue": "false",
|
|
2713
|
+
"description": "Whether multiple selections are allowed."
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "elementId",
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"required": false,
|
|
2719
|
+
"description": "The id attribute for the select element."
|
|
2720
|
+
},
|
|
2721
|
+
{
|
|
2722
|
+
"name": "size",
|
|
2723
|
+
"type": "SelectSize",
|
|
2724
|
+
"required": false,
|
|
2725
|
+
"defaultValue": "SelectSize.Md",
|
|
2726
|
+
"description": "Size of the control."
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "variant",
|
|
2730
|
+
"type": "SelectVariant",
|
|
2731
|
+
"required": false,
|
|
2732
|
+
"defaultValue": "SelectVariant.Primary",
|
|
2733
|
+
"description": "Visual variant."
|
|
2734
|
+
},
|
|
2735
|
+
{
|
|
2736
|
+
"name": "value",
|
|
2737
|
+
"type": "string | string[]",
|
|
2738
|
+
"required": false,
|
|
2739
|
+
"description": "Controlled selected value(s)."
|
|
2740
|
+
},
|
|
2741
|
+
{
|
|
2742
|
+
"name": "customSelectedValue",
|
|
2743
|
+
"type": "string",
|
|
2744
|
+
"required": false,
|
|
2745
|
+
"description": "Custom string to render as the selected value in single mode."
|
|
2746
|
+
},
|
|
2747
|
+
{
|
|
2748
|
+
"name": "prefix",
|
|
2749
|
+
"type": "string",
|
|
2750
|
+
"required": false,
|
|
2751
|
+
"description": "Prefix for selected value(s)."
|
|
2752
|
+
},
|
|
2753
|
+
{
|
|
2754
|
+
"name": "defaultValue",
|
|
2755
|
+
"type": "string | string[]",
|
|
2756
|
+
"required": false,
|
|
2757
|
+
"description": "Uncontrolled initial selected value(s)."
|
|
2758
|
+
},
|
|
2759
|
+
{
|
|
2760
|
+
"name": "placeholder",
|
|
2761
|
+
"type": "string",
|
|
2762
|
+
"required": false,
|
|
2763
|
+
"defaultValue": "'Select...'",
|
|
2764
|
+
"description": "Placeholder text when no selection is made."
|
|
2765
|
+
},
|
|
2766
|
+
{
|
|
2767
|
+
"name": "searchable",
|
|
2768
|
+
"type": "boolean",
|
|
2769
|
+
"required": false,
|
|
2770
|
+
"defaultValue": "false",
|
|
2771
|
+
"description": "Show a search field in the overlay header."
|
|
2772
|
+
},
|
|
2773
|
+
{
|
|
2774
|
+
"name": "searchPlaceholder",
|
|
2775
|
+
"type": "string",
|
|
2776
|
+
"required": false,
|
|
2777
|
+
"description": "Placeholder for the search input (overlay/inline)."
|
|
2778
|
+
},
|
|
2779
|
+
{
|
|
2780
|
+
"name": "selectAll",
|
|
2781
|
+
"type": "boolean",
|
|
2782
|
+
"required": false,
|
|
2783
|
+
"defaultValue": "false",
|
|
2784
|
+
"description": "Show a \"Select All\" checkbox in multiple mode."
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
"name": "selectAllLabel",
|
|
2788
|
+
"type": "string",
|
|
2789
|
+
"required": false,
|
|
2790
|
+
"defaultValue": "'Select all'",
|
|
2791
|
+
"description": "Label for the \"Select All\" checkbox."
|
|
2792
|
+
},
|
|
2793
|
+
{
|
|
2794
|
+
"name": "emptyStateTitle",
|
|
2795
|
+
"type": "string",
|
|
2796
|
+
"required": false,
|
|
2797
|
+
"defaultValue": "'No options available'",
|
|
2798
|
+
"description": "Title text when there are no options."
|
|
2799
|
+
},
|
|
2800
|
+
{
|
|
2801
|
+
"name": "emptyStateDescription",
|
|
2802
|
+
"type": "string",
|
|
2803
|
+
"required": false,
|
|
2804
|
+
"description": "Description text when there are no options."
|
|
2805
|
+
},
|
|
2806
|
+
{
|
|
2807
|
+
"name": "emptyStateIcon",
|
|
2808
|
+
"type": "ReactNode",
|
|
2809
|
+
"required": false,
|
|
2810
|
+
"description": "Icon to display when there are no options."
|
|
2811
|
+
},
|
|
2812
|
+
{
|
|
2813
|
+
"name": "disabled",
|
|
2814
|
+
"type": "boolean",
|
|
2815
|
+
"required": false,
|
|
2816
|
+
"defaultValue": "false",
|
|
2817
|
+
"description": "Disable the control."
|
|
2818
|
+
},
|
|
2819
|
+
{
|
|
2820
|
+
"name": "className",
|
|
2821
|
+
"type": "string",
|
|
2822
|
+
"required": false,
|
|
2823
|
+
"description": "Additional CSS classes for the trigger."
|
|
2824
|
+
},
|
|
2825
|
+
{
|
|
2826
|
+
"name": "listClassName",
|
|
2827
|
+
"type": "string",
|
|
2828
|
+
"required": false,
|
|
2829
|
+
"description": "Additional CSS classes for the list dropdown."
|
|
2830
|
+
},
|
|
2831
|
+
{
|
|
2832
|
+
"name": "closable",
|
|
2833
|
+
"type": "boolean",
|
|
2834
|
+
"required": false,
|
|
2835
|
+
"defaultValue": "false",
|
|
2836
|
+
"description": "Show a close button in the dropdown header."
|
|
2837
|
+
},
|
|
2838
|
+
{
|
|
2839
|
+
"name": "invalid",
|
|
2840
|
+
"type": "boolean",
|
|
2841
|
+
"required": false,
|
|
2842
|
+
"description": "Whether the select is in an invalid state, affecting styling."
|
|
2843
|
+
},
|
|
2844
|
+
{
|
|
2845
|
+
"name": "header",
|
|
2846
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
2847
|
+
"required": false,
|
|
2848
|
+
"description": "Custom node/function rendered above the options."
|
|
2849
|
+
},
|
|
2850
|
+
{
|
|
2851
|
+
"name": "footer",
|
|
2852
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
2853
|
+
"required": false,
|
|
2854
|
+
"description": "Custom node/function rendered below the options."
|
|
2855
|
+
},
|
|
2856
|
+
{
|
|
2857
|
+
"name": "open",
|
|
2858
|
+
"type": "boolean",
|
|
2859
|
+
"required": false,
|
|
2860
|
+
"description": "Controlled open state of the dropdown. When provided, makes the dropdown controlled."
|
|
2861
|
+
},
|
|
2862
|
+
{
|
|
2863
|
+
"name": "onOpenChange",
|
|
2864
|
+
"type": "(open: boolean) => void",
|
|
2865
|
+
"required": false,
|
|
2866
|
+
"description": "Called when the dropdown open state changes."
|
|
2867
|
+
},
|
|
2868
|
+
{
|
|
2869
|
+
"name": "onInlineQueryChange",
|
|
2870
|
+
"type": "(query: string) => void",
|
|
2871
|
+
"required": false,
|
|
2872
|
+
"description": "Called when the inline search query changes"
|
|
2873
|
+
},
|
|
2874
|
+
{
|
|
2875
|
+
"name": "dismissRef",
|
|
2876
|
+
"type": "Ref<unknown>",
|
|
2877
|
+
"required": false,
|
|
2878
|
+
"description": "Ref object to expose a `dismiss` method to programmatically close the select."
|
|
2879
|
+
},
|
|
2880
|
+
{
|
|
2881
|
+
"name": "onClose",
|
|
2882
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
2883
|
+
"required": false,
|
|
2884
|
+
"description": "Called when the dropdown close button is clicked."
|
|
2885
|
+
},
|
|
2886
|
+
{
|
|
2887
|
+
"name": "onChange",
|
|
2888
|
+
"type": "(next: string | string[]) => void",
|
|
2889
|
+
"required": false,
|
|
2890
|
+
"description": "Called when the selection changes."
|
|
2891
|
+
},
|
|
2892
|
+
{
|
|
2893
|
+
"name": "inlineSearch",
|
|
2894
|
+
"type": "boolean",
|
|
2895
|
+
"required": false,
|
|
2896
|
+
"defaultValue": "false",
|
|
2897
|
+
"description": "Render a plain input inside trigger (single mode only)."
|
|
2898
|
+
},
|
|
2899
|
+
{
|
|
2900
|
+
"name": "onFooterClick",
|
|
2901
|
+
"type": "(e: MouseEvent<HTMLDivElement>) => void",
|
|
2902
|
+
"required": false,
|
|
2903
|
+
"description": "Called when the footer element is clicked. When provided, automatically closes the dropdown."
|
|
2904
|
+
},
|
|
2905
|
+
{
|
|
2906
|
+
"name": "customMultiSelectTagsRenderer",
|
|
2907
|
+
"type": "(\n options: SelectOption[],\n selectedValues: string[],\n handleRemoveTag: (\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void,\n ) => ReactNode",
|
|
2908
|
+
"required": false
|
|
2909
|
+
}
|
|
2910
|
+
],
|
|
2911
|
+
"examples": [
|
|
2912
|
+
"<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' }]} />"
|
|
2913
|
+
],
|
|
2914
|
+
"sourceFile": "components/Select/Select.tsx"
|
|
2915
|
+
},
|
|
2916
|
+
{
|
|
2917
|
+
"name": "DialSelectField",
|
|
2918
|
+
"category": "Form",
|
|
2919
|
+
"description": "A Select field wrapper that composes `DialFormItem` and `DialSelect`.\naliases: SelectInput|ComboField\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).",
|
|
2920
|
+
"props": [
|
|
2921
|
+
{
|
|
2922
|
+
"name": "selectClassName",
|
|
2923
|
+
"type": "string",
|
|
2924
|
+
"required": false,
|
|
2925
|
+
"description": "CSS class for the select element"
|
|
2926
|
+
},
|
|
2927
|
+
{
|
|
2928
|
+
"name": "containerClassName",
|
|
2929
|
+
"type": "string",
|
|
2930
|
+
"required": false,
|
|
2931
|
+
"description": "CSS class for the form item container"
|
|
2932
|
+
}
|
|
2933
|
+
],
|
|
2934
|
+
"examples": [
|
|
2935
|
+
"```tsx\n<DialSelectField\n elementId=\"transport\"\n fieldTitle=\"Transport\"\n options={[\n { value: 'SSE', label: 'Server-Sent Events (SSE)' },\n { value: 'WS', label: 'WebSocket' },\n ]}\n value=\"WS\"\n onChange={(v) => setTransport(v as string)}\n/>"
|
|
2936
|
+
],
|
|
2937
|
+
"sourceFile": "components/SelectField/SelectField.tsx"
|
|
2938
|
+
},
|
|
2939
|
+
{
|
|
2940
|
+
"name": "DialLoadFileArea",
|
|
2941
|
+
"category": "Form",
|
|
2942
|
+
"description": "A drag-and-drop file upload area component that allows users to upload files\naliases: FileDropZone|DragDropUpload\n\neither by dragging them into the area or by selecting them through the file picker.\nDisplays helpful text, button prompts, and validation errors for file format or count limits.",
|
|
2943
|
+
"props": [
|
|
2944
|
+
{
|
|
2945
|
+
"name": "files",
|
|
2946
|
+
"type": "File[]",
|
|
2947
|
+
"required": false
|
|
2948
|
+
},
|
|
2949
|
+
{
|
|
2950
|
+
"name": "dynamicIcon",
|
|
2951
|
+
"type": "(name: string) => ReactNode",
|
|
2952
|
+
"required": false
|
|
2953
|
+
},
|
|
2954
|
+
{
|
|
2955
|
+
"name": "iconBeforeInput",
|
|
2956
|
+
"type": "ReactNode",
|
|
2957
|
+
"required": false
|
|
2958
|
+
},
|
|
2959
|
+
{
|
|
2960
|
+
"name": "isInvalid",
|
|
2961
|
+
"type": "(file: File) => boolean",
|
|
2962
|
+
"required": false
|
|
2963
|
+
},
|
|
2964
|
+
{
|
|
2965
|
+
"name": "errorText",
|
|
2966
|
+
"type": "string",
|
|
2967
|
+
"required": false
|
|
2968
|
+
},
|
|
2969
|
+
{
|
|
2970
|
+
"name": "removeButtonAriaLabel",
|
|
2971
|
+
"type": "string",
|
|
2972
|
+
"required": false
|
|
2973
|
+
}
|
|
2974
|
+
],
|
|
2975
|
+
"examples": [
|
|
2976
|
+
"<DialEmptyFileArea\n onChange={(files) => console.log(files)}\n emptyTextFirstLine=\"Drag & drop your files here\"\n emptyTextSecondLine=\"or click the button below to upload\"\n emptyButtonLabel=\"Upload files\"\n acceptTypes=\"application/pdf, application/txt, image/svg+xml\"\n maxFilesCount={5}\n isMultiple\n fileFormatError=\"Unsupported file format\"\n fileCountError=\"You can upload up to 5 files only\"\n getIsFileFormatError={(files) => files.some(file => !file.name.endsWith('.jpg') && !file.name.endsWith('.png'))}\n/>"
|
|
2977
|
+
],
|
|
2978
|
+
"sourceFile": "components/LoadFileArea/LoadFileArea.tsx"
|
|
2979
|
+
},
|
|
2980
|
+
{
|
|
2981
|
+
"name": "DialLoadFileAreaField",
|
|
2982
|
+
"category": "Form",
|
|
2983
|
+
"description": "A composite file upload field that combines a label, file list management,\naliases: UploadField|FileListField\n\nand a drag-and-drop upload area. Allows users to add, remove, and validate files\nwith customizable restrictions on file types and count.\n\nThe component displays a header showing the field title and file count,\nalong with \"Add\" and \"Delete All\" buttons (when multiple uploads are enabled).\nIt integrates with `DialLoadFileArea` for drag-and-drop functionality and\nprovides file validation for both format and maximum file count.",
|
|
2984
|
+
"props": [
|
|
2985
|
+
{
|
|
2986
|
+
"name": "fieldTitle",
|
|
2987
|
+
"type": "string",
|
|
2988
|
+
"required": true
|
|
2989
|
+
},
|
|
2990
|
+
{
|
|
2991
|
+
"name": "elementId",
|
|
2992
|
+
"type": "string",
|
|
2993
|
+
"required": true
|
|
2994
|
+
},
|
|
2995
|
+
{
|
|
2996
|
+
"name": "deleteAllButtonLabel",
|
|
2997
|
+
"type": "string",
|
|
2998
|
+
"required": false
|
|
2999
|
+
},
|
|
3000
|
+
{
|
|
3001
|
+
"name": "addButtonLabel",
|
|
3002
|
+
"type": "string",
|
|
3003
|
+
"required": false
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"name": "additionalActionButtons",
|
|
3007
|
+
"type": "ReactNode",
|
|
3008
|
+
"required": false
|
|
3009
|
+
}
|
|
3010
|
+
],
|
|
3011
|
+
"examples": [
|
|
3012
|
+
"<DialLoadFileAreaField\n fieldTitle=\"Attachments\"\n elementId=\"attachments\"\n files={uploadedFiles}\n onChange={setUploadedFiles}\n maxFilesCount={5}\n acceptTypes=\"image/png,image/jpeg\"\n fileFormatError=\"Only PNG and JPEG images are allowed\"\n fileCountError=\"You can upload up to 5 files\"\n deleteAllButtonLabel=\"Remove all\"\n addButtonLabel=\"Add more\"\n/>"
|
|
3013
|
+
],
|
|
3014
|
+
"sourceFile": "components/LoadFileArea/LoadFileAreaField.tsx"
|
|
3015
|
+
},
|
|
3016
|
+
{
|
|
3017
|
+
"name": "DialDropdown",
|
|
3018
|
+
"category": "Dropdown",
|
|
3019
|
+
"description": "Renders the given trigger (`children`) and a floating contextual menu overlay.\naliases: ContextMenu|PopupMenu\n\nSupports click/hover/contextMenu triggers, controlled/uncontrolled open, and an optional\nclose button inside the overlay. Placement is taken directly from Floating UI; when\n`placement` is **undefined** (default), automatic placement is handled by `autoPlacement`.",
|
|
3020
|
+
"props": [
|
|
3021
|
+
{
|
|
3022
|
+
"name": "children",
|
|
3023
|
+
"type": "ReactNode",
|
|
3024
|
+
"required": true,
|
|
3025
|
+
"description": "Trigger element(s) to anchor and open the menu"
|
|
3026
|
+
},
|
|
3027
|
+
{
|
|
3028
|
+
"name": "menu",
|
|
3029
|
+
"type": "DropdownMenuProps",
|
|
3030
|
+
"required": false,
|
|
3031
|
+
"description": "Items-based menu definition"
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
"name": "renderOverlay",
|
|
3035
|
+
"type": "() => ReactNode",
|
|
3036
|
+
"required": false,
|
|
3037
|
+
"description": "Render function for fully custom overlay content (ignored when `menu` is provided)"
|
|
3038
|
+
},
|
|
3039
|
+
{
|
|
3040
|
+
"name": "trigger",
|
|
3041
|
+
"type": "DropdownTrigger[]",
|
|
3042
|
+
"required": false,
|
|
3043
|
+
"defaultValue": "[DropdownTrigger.Click]",
|
|
3044
|
+
"description": "Interactions that open the menu"
|
|
3045
|
+
},
|
|
3046
|
+
{
|
|
3047
|
+
"name": "placement",
|
|
3048
|
+
"type": "Placement",
|
|
3049
|
+
"required": false,
|
|
3050
|
+
"description": "Floating UI placement string; when omitted, auto placement is used"
|
|
3051
|
+
},
|
|
3052
|
+
{
|
|
3053
|
+
"name": "allowedPlacements",
|
|
3054
|
+
"type": "Placement[]",
|
|
3055
|
+
"required": false,
|
|
3056
|
+
"description": "Restricts the allowed placements"
|
|
3057
|
+
},
|
|
3058
|
+
{
|
|
3059
|
+
"name": "disabled",
|
|
3060
|
+
"type": "boolean",
|
|
3061
|
+
"required": false,
|
|
3062
|
+
"defaultValue": "false",
|
|
3063
|
+
"description": "Disables interaction and prevents opening"
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
"name": "open",
|
|
3067
|
+
"type": "boolean",
|
|
3068
|
+
"required": false,
|
|
3069
|
+
"description": "Controlled open state (when provided, `defaultOpen` is ignored)"
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"name": "defaultOpen",
|
|
3073
|
+
"type": "boolean",
|
|
3074
|
+
"required": false,
|
|
3075
|
+
"defaultValue": "false",
|
|
3076
|
+
"description": "Initial open state in uncontrolled mode"
|
|
3077
|
+
},
|
|
3078
|
+
{
|
|
3079
|
+
"name": "onOpenChange",
|
|
3080
|
+
"type": "(open: boolean) => void",
|
|
3081
|
+
"required": false,
|
|
3082
|
+
"description": "Fired whenever the open state changes"
|
|
3083
|
+
},
|
|
3084
|
+
{
|
|
3085
|
+
"name": "closable",
|
|
3086
|
+
"type": "boolean",
|
|
3087
|
+
"required": false,
|
|
3088
|
+
"defaultValue": "false",
|
|
3089
|
+
"description": "Whether the overlay shows an internal close button"
|
|
3090
|
+
},
|
|
3091
|
+
{
|
|
3092
|
+
"name": "onClose",
|
|
3093
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
3094
|
+
"required": false,
|
|
3095
|
+
"description": "Fired when the close button inside the overlay is clicked"
|
|
3096
|
+
},
|
|
3097
|
+
{
|
|
3098
|
+
"name": "className",
|
|
3099
|
+
"type": "string",
|
|
3100
|
+
"required": false,
|
|
3101
|
+
"description": "Additional CSS classes applied to the trigger wrapper"
|
|
3102
|
+
},
|
|
3103
|
+
{
|
|
3104
|
+
"name": "listClassName",
|
|
3105
|
+
"type": "string",
|
|
3106
|
+
"required": false,
|
|
3107
|
+
"description": "Additional CSS classes applied to the floating overlay"
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
"name": "outsidePressIgnoreRef",
|
|
3111
|
+
"type": "RefObject<HTMLElement | null>",
|
|
3112
|
+
"required": false,
|
|
3113
|
+
"description": "Ref to an element that should not trigger outside press behavior"
|
|
3114
|
+
},
|
|
3115
|
+
{
|
|
3116
|
+
"name": "outsideClosable",
|
|
3117
|
+
"type": "boolean",
|
|
3118
|
+
"required": false,
|
|
3119
|
+
"defaultValue": "true",
|
|
3120
|
+
"description": "Whether clicks outside the overlay should close it"
|
|
3121
|
+
},
|
|
3122
|
+
{
|
|
3123
|
+
"name": "anchorToMouse",
|
|
3124
|
+
"type": "boolean",
|
|
3125
|
+
"required": false,
|
|
3126
|
+
"defaultValue": "false",
|
|
3127
|
+
"description": "Whether to anchor the dropdown to the mouse position"
|
|
3128
|
+
},
|
|
3129
|
+
{
|
|
3130
|
+
"name": "matchReferenceWidth",
|
|
3131
|
+
"type": "boolean",
|
|
3132
|
+
"required": false,
|
|
3133
|
+
"defaultValue": "true",
|
|
3134
|
+
"description": "Whether to match the reference element's width"
|
|
3135
|
+
},
|
|
3136
|
+
{
|
|
3137
|
+
"name": "maxDropdownHeight",
|
|
3138
|
+
"type": "number | null",
|
|
3139
|
+
"required": false,
|
|
3140
|
+
"description": "Maximum height of the dropdown menu; when omitted, no limit is applied"
|
|
3141
|
+
}
|
|
3142
|
+
],
|
|
3143
|
+
"examples": [
|
|
3144
|
+
"// Simple items menu\n<DialDropdown menu={{ items: [{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }] }}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Open</button>\n</DialDropdown>\n\n// Hover trigger\n<DialDropdown trigger={[DropdownTrigger.Hover]} placement=\"bottom-end\" menu={{ items }}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Hover me</button>\n</DialDropdown>\n\n// Custom overlay content\n<DialDropdown closable renderOverlay={() => <div className=\"p-3\">Custom content</div>}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Custom</button>\n</DialDropdown>"
|
|
3145
|
+
],
|
|
3146
|
+
"sourceFile": "components/Dropdown/Dropdown.tsx"
|
|
3147
|
+
},
|
|
3148
|
+
{
|
|
3149
|
+
"name": "DialButtonDropdown",
|
|
3150
|
+
"category": "Dropdown",
|
|
3151
|
+
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton",
|
|
3152
|
+
"props": [
|
|
3153
|
+
{
|
|
3154
|
+
"name": "items",
|
|
3155
|
+
"type": "DropdownItem[]",
|
|
3156
|
+
"required": true,
|
|
3157
|
+
"description": "DropdownItems with actions"
|
|
3158
|
+
}
|
|
3159
|
+
],
|
|
3160
|
+
"examples": [
|
|
3161
|
+
"<DialButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
3162
|
+
],
|
|
3163
|
+
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx"
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
"name": "DialFileManager",
|
|
3167
|
+
"category": "FileManager",
|
|
3168
|
+
"description": "File Manager layout with a collapsible folders tree, breadcrumb/search header, and a data grid.\naliases: FileExplorer|FileBrowser\n\nFeatures:\n- Global `path` drives both the breadcrumb trail and the visible folder in the grid.\n- The grid shows children of the current folder. When a search query is present, it scans all nested descendants.\n- Pluggable tree, navigation panel, and grid behaviors via `treeOptions`, `navigationPanelOptions`, and `gridOptions`.\n- Optional filters toggle via `gridOptions.filterable` (default `true`).\n- Supports bulk actions toolbar when items are selected.",
|
|
3169
|
+
"props": [
|
|
3170
|
+
{
|
|
3171
|
+
"name": "path",
|
|
3172
|
+
"type": "string",
|
|
3173
|
+
"required": false,
|
|
3174
|
+
"description": "Absolute path of the current location (e.g. \"/All files/Design/Icons\")"
|
|
3175
|
+
},
|
|
3176
|
+
{
|
|
3177
|
+
"name": "defaultPath",
|
|
3178
|
+
"type": "string",
|
|
3179
|
+
"required": false,
|
|
3180
|
+
"description": "Initial path used in uncontrolled mode (applied only on first render)"
|
|
3181
|
+
},
|
|
3182
|
+
{
|
|
3183
|
+
"name": "className",
|
|
3184
|
+
"type": "string",
|
|
3185
|
+
"required": false,
|
|
3186
|
+
"description": "Additional classes for the root container"
|
|
3187
|
+
},
|
|
3188
|
+
{
|
|
3189
|
+
"name": "managerLabel",
|
|
3190
|
+
"type": "ReactNode",
|
|
3191
|
+
"required": false
|
|
3192
|
+
},
|
|
3193
|
+
{
|
|
3194
|
+
"name": "gridClassName",
|
|
3195
|
+
"type": "string",
|
|
3196
|
+
"required": false,
|
|
3197
|
+
"description": "Additional classes for the grid container"
|
|
3198
|
+
},
|
|
3199
|
+
{
|
|
3200
|
+
"name": "allowedFileTypes",
|
|
3201
|
+
"type": "DialFileAcceptType[]",
|
|
3202
|
+
"required": false,
|
|
3203
|
+
"description": "Allowed file types (same format as the HTML `<input accept>` attribute). Controls upload filtering and which items are disabled in the File Manager UI. Supports MIME types, wildcards (e.g. `image/*`), and extensions (e.g. `.svg`)."
|
|
3204
|
+
},
|
|
3205
|
+
{
|
|
3206
|
+
"name": "items",
|
|
3207
|
+
"type": "DialFile[]",
|
|
3208
|
+
"required": false,
|
|
3209
|
+
"description": "Full hierarchical list of files and folders used by both tree and grid"
|
|
3210
|
+
},
|
|
3211
|
+
{
|
|
3212
|
+
"name": "rootItem",
|
|
3213
|
+
"type": "DialRootFolder",
|
|
3214
|
+
"required": false,
|
|
3215
|
+
"description": "Optional root folder item to represent the top-level container in the tree"
|
|
3216
|
+
},
|
|
3217
|
+
{
|
|
3218
|
+
"name": "filesLoading",
|
|
3219
|
+
"type": "boolean",
|
|
3220
|
+
"required": false,
|
|
3221
|
+
"description": "When true, shows skeleton loading state in the grid"
|
|
3222
|
+
},
|
|
3223
|
+
{
|
|
3224
|
+
"name": "sharedByMePaths",
|
|
3225
|
+
"type": "Set<string>",
|
|
3226
|
+
"required": false,
|
|
3227
|
+
"description": "Set of items paths that the user has shared with others. Enables UI indicators (icons/badges) in the tree and grid."
|
|
3228
|
+
},
|
|
3229
|
+
{
|
|
3230
|
+
"name": "maxSelectableFileSize",
|
|
3231
|
+
"type": "number",
|
|
3232
|
+
"required": false,
|
|
3233
|
+
"description": "Maximum allowed file size for selection in bytes"
|
|
3234
|
+
},
|
|
3235
|
+
{
|
|
3236
|
+
"name": "selectedPaths",
|
|
3237
|
+
"type": "Set<string>",
|
|
3238
|
+
"required": false,
|
|
3239
|
+
"description": "Controlled set of selected item paths"
|
|
3240
|
+
},
|
|
3241
|
+
{
|
|
3242
|
+
"name": "defaultSelectedPaths",
|
|
3243
|
+
"type": "Set<string>",
|
|
3244
|
+
"required": false,
|
|
3245
|
+
"description": "Initial selected paths used in uncontrolled mode"
|
|
3246
|
+
},
|
|
3247
|
+
{
|
|
3248
|
+
"name": "onSelectedPathsChange",
|
|
3249
|
+
"type": "(paths: Set<string>) => void",
|
|
3250
|
+
"required": false,
|
|
3251
|
+
"description": "Callback fired when the selected paths change"
|
|
3252
|
+
},
|
|
3253
|
+
{
|
|
3254
|
+
"name": "showHiddenFiles",
|
|
3255
|
+
"type": "boolean",
|
|
3256
|
+
"required": false
|
|
3257
|
+
},
|
|
3258
|
+
{
|
|
3259
|
+
"name": "onShowHiddenFilesChange",
|
|
3260
|
+
"type": "(value: boolean) => void",
|
|
3261
|
+
"required": false
|
|
3262
|
+
},
|
|
3263
|
+
{
|
|
3264
|
+
"name": "treeOptions",
|
|
3265
|
+
"type": "FileTreeOptions",
|
|
3266
|
+
"required": false,
|
|
3267
|
+
"description": "Options that configure the collapsible sidebar and folders tree"
|
|
3268
|
+
},
|
|
3269
|
+
{
|
|
3270
|
+
"name": "toolbarOptions",
|
|
3271
|
+
"type": "ToolbarOptions",
|
|
3272
|
+
"required": false,
|
|
3273
|
+
"description": "Options for the file manager toolbar"
|
|
3274
|
+
},
|
|
3275
|
+
{
|
|
3276
|
+
"name": "showNavigationPanel",
|
|
3277
|
+
"type": "boolean",
|
|
3278
|
+
"required": false,
|
|
3279
|
+
"description": "Determines whether to display the navigation panel."
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"name": "navigationPanelOptions",
|
|
3283
|
+
"type": "NavigationPanelOptions",
|
|
3284
|
+
"required": false,
|
|
3285
|
+
"description": "Options for the breadcrumb and search panel (value/onSearchChange for controlled search)"
|
|
3286
|
+
},
|
|
3287
|
+
{
|
|
3288
|
+
"name": "gridOptions",
|
|
3289
|
+
"type": "GridOptions",
|
|
3290
|
+
"required": false,
|
|
3291
|
+
"description": "Options forwarded to `DialGrid`; supports `columnDefs` override and `filterable` flag and date locale/options"
|
|
3292
|
+
},
|
|
3293
|
+
{
|
|
3294
|
+
"name": "bulkActionsToolbarOptions",
|
|
3295
|
+
"type": "BulkActionsToolbarOptions",
|
|
3296
|
+
"required": false,
|
|
3297
|
+
"description": "Options for the bulk actions toolbar shown when items are selected"
|
|
3298
|
+
},
|
|
3299
|
+
{
|
|
3300
|
+
"name": "deleteConfirmationOptions",
|
|
3301
|
+
"type": "DeleteConfirmationOptions",
|
|
3302
|
+
"required": false,
|
|
3303
|
+
"description": "Options for the delete confirmation popup"
|
|
3304
|
+
},
|
|
3305
|
+
{
|
|
3306
|
+
"name": "destinationFolderPopupOptions",
|
|
3307
|
+
"type": "DialFileManagerDestinationFolderPopupOptions",
|
|
3308
|
+
"required": false
|
|
3309
|
+
},
|
|
3310
|
+
{
|
|
3311
|
+
"name": "conflictResolutionPopupOptions",
|
|
3312
|
+
"type": "DialFileManagerConflictResolutionPopupOptions",
|
|
3313
|
+
"required": false
|
|
3314
|
+
},
|
|
3315
|
+
{
|
|
3316
|
+
"name": "compactViewWidthBreakpoint",
|
|
3317
|
+
"type": "number",
|
|
3318
|
+
"required": false,
|
|
3319
|
+
"description": "Width (px) below which the component switches to compact view."
|
|
3320
|
+
},
|
|
3321
|
+
{
|
|
3322
|
+
"name": "customBreakpointRef",
|
|
3323
|
+
"type": "RefObject<HTMLElement | null>",
|
|
3324
|
+
"required": false
|
|
3325
|
+
},
|
|
3326
|
+
{
|
|
3327
|
+
"name": "onPathChange",
|
|
3328
|
+
"type": "(nextPath?: string) => void",
|
|
3329
|
+
"required": false,
|
|
3330
|
+
"description": "Callback fired when user navigates via tree or breadcrumb"
|
|
3331
|
+
},
|
|
3332
|
+
{
|
|
3333
|
+
"name": "onTableFileClick",
|
|
3334
|
+
"type": "(file: GridRow) => void",
|
|
3335
|
+
"required": false,
|
|
3336
|
+
"description": "Callback fired when a file row is clicked in the grid"
|
|
3337
|
+
},
|
|
3338
|
+
{
|
|
3339
|
+
"name": "handleSelectionClick",
|
|
3340
|
+
"type": "(file: GridRow[]) => void",
|
|
3341
|
+
"required": false
|
|
3342
|
+
},
|
|
3343
|
+
{
|
|
3344
|
+
"name": "onGridApiChange",
|
|
3345
|
+
"type": "(api: GridApi) => void",
|
|
3346
|
+
"required": false
|
|
3347
|
+
},
|
|
3348
|
+
{
|
|
3349
|
+
"name": "onCopyFiles",
|
|
3350
|
+
"type": "(items: DialCopiedItem[], destinationFolder: string) => void",
|
|
3351
|
+
"required": false,
|
|
3352
|
+
"description": "Callback fired when files copy-paste"
|
|
3353
|
+
},
|
|
3354
|
+
{
|
|
3355
|
+
"name": "onMoveToFiles",
|
|
3356
|
+
"type": "(\n items: DialCopiedItem[],\n sourceFolder: string,\n destinationFolder: string,\n ) => void",
|
|
3357
|
+
"required": false,
|
|
3358
|
+
"description": "Callback fired when files cut-paste or rename"
|
|
3359
|
+
},
|
|
3360
|
+
{
|
|
3361
|
+
"name": "onDeleteFiles",
|
|
3362
|
+
"type": "(items: DialDeletedItem[], sourceFolder: string) => void",
|
|
3363
|
+
"required": false,
|
|
3364
|
+
"description": "Callback fired when files are deleted"
|
|
3365
|
+
},
|
|
3366
|
+
{
|
|
3367
|
+
"name": "onDownloadFiles",
|
|
3368
|
+
"type": "(items: DialFile[]) => void",
|
|
3369
|
+
"required": false,
|
|
3370
|
+
"description": "Callback fired when files are downloaded"
|
|
3371
|
+
},
|
|
3372
|
+
{
|
|
3373
|
+
"name": "onAddSibling",
|
|
3374
|
+
"type": "(items: DialFile[]) => void",
|
|
3375
|
+
"required": false,
|
|
3376
|
+
"description": "Callback fired when when a new folder is added as a sibling to the selected folder"
|
|
3377
|
+
},
|
|
3378
|
+
{
|
|
3379
|
+
"name": "onAddChild",
|
|
3380
|
+
"type": "(items: DialFile[]) => void",
|
|
3381
|
+
"required": false,
|
|
3382
|
+
"description": "Callback fired when when a new folder is added as a child to the selected folder"
|
|
3383
|
+
},
|
|
3384
|
+
{
|
|
3385
|
+
"name": "onRenameValidate",
|
|
3386
|
+
"type": "(value: string, item: DialFile) => string | null",
|
|
3387
|
+
"required": false,
|
|
3388
|
+
"description": "Optional callback to validate a file or folder name during renaming. Should return an error message string if the name is invalid, or null if it's valid."
|
|
3389
|
+
},
|
|
3390
|
+
{
|
|
3391
|
+
"name": "renameValidationMessages",
|
|
3392
|
+
"type": "RenameValidationMessages",
|
|
3393
|
+
"required": false,
|
|
3394
|
+
"description": "Optional custom validation messages for renaming files and folders. Note that you need to add `${AlertVariant.Warning}__` prefix to the `hiddenItemWarning` message to display it as a warning with the warning icon."
|
|
3395
|
+
},
|
|
3396
|
+
{
|
|
3397
|
+
"name": "forbiddenSymbolsRegExp",
|
|
3398
|
+
"type": "RegExp",
|
|
3399
|
+
"required": false,
|
|
3400
|
+
"description": "Optional RegExp will be used in the validation for the files and folders names. The \"g\" and \"y\" flags are not allowed in this RegExp and will be ignored."
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
"name": "forbiddenSymbolsTooltip",
|
|
3404
|
+
"type": "ReactNode",
|
|
3405
|
+
"required": false,
|
|
3406
|
+
"description": "Optional tooltip displayed when a file or folder name contains forbidden characters"
|
|
3407
|
+
},
|
|
3408
|
+
{
|
|
3409
|
+
"name": "onCreateFolder",
|
|
3410
|
+
"type": "(\n file: DialUploadFileItem,\n folderPath: string,\n fileId: string,\n ) => void | Promise<void>",
|
|
3411
|
+
"required": false
|
|
3412
|
+
},
|
|
3413
|
+
{
|
|
3414
|
+
"name": "onCreateFolderValidate",
|
|
3415
|
+
"type": "(\n name: string,\n parentFolder: DialFile,\n ) => string | null",
|
|
3416
|
+
"required": false
|
|
3417
|
+
},
|
|
3418
|
+
{
|
|
3419
|
+
"name": "folderCreationValidationMessages",
|
|
3420
|
+
"type": "CreateFolderValidationMessages",
|
|
3421
|
+
"required": false
|
|
3422
|
+
},
|
|
3423
|
+
{
|
|
3424
|
+
"name": "getDisabledTooltip",
|
|
3425
|
+
"type": "(row: FileManagerGridRow) => string | undefined",
|
|
3426
|
+
"required": false
|
|
3427
|
+
},
|
|
3428
|
+
{
|
|
3429
|
+
"name": "fileTooLargeTooltip",
|
|
3430
|
+
"type": "string",
|
|
3431
|
+
"required": false,
|
|
3432
|
+
"description": "Optional tooltip text displayed when a file is too large."
|
|
3433
|
+
},
|
|
3434
|
+
{
|
|
3435
|
+
"name": "unsupportedFileTypeTooltip",
|
|
3436
|
+
"type": "string",
|
|
3437
|
+
"required": false,
|
|
3438
|
+
"description": "Optional tooltip text displayed when an unsupported file type is selected."
|
|
3439
|
+
},
|
|
3440
|
+
{
|
|
3441
|
+
"name": "onUploadFiles",
|
|
3442
|
+
"type": "(\n files: DialUploadFileItem[],\n destinationFolder: string,\n ) => void",
|
|
3443
|
+
"required": false,
|
|
3444
|
+
"description": "Callback fired when files are uploaded"
|
|
3445
|
+
},
|
|
3446
|
+
{
|
|
3447
|
+
"name": "onValidateUpload",
|
|
3448
|
+
"type": "(\n files: DialUploadFileItem[],\n existingFiles: DialFile[],\n destinationFolder: string,\n ) => FileUploadValidationResult | Promise<FileUploadValidationResult>",
|
|
3449
|
+
"required": false,
|
|
3450
|
+
"description": "Callback to validate files before upload"
|
|
3451
|
+
},
|
|
3452
|
+
{
|
|
3453
|
+
"name": "maxFileSize",
|
|
3454
|
+
"type": "number",
|
|
3455
|
+
"required": false,
|
|
3456
|
+
"description": "Maximum allowed file size for uploads in bytes"
|
|
3457
|
+
},
|
|
3458
|
+
{
|
|
3459
|
+
"name": "uploadValidationMessages",
|
|
3460
|
+
"type": "FileUploadValidationMessages",
|
|
3461
|
+
"required": false,
|
|
3462
|
+
"description": "Custom validation messages for file uploads. Consumers can customize these strings for a11y and copy consistency."
|
|
3463
|
+
},
|
|
3464
|
+
{
|
|
3465
|
+
"name": "onUploadArchive",
|
|
3466
|
+
"type": "(\n file: File,\n name: string,\n destinationFolder: string,\n ) => void",
|
|
3467
|
+
"required": false,
|
|
3468
|
+
"description": "Callback fired when archive files are uploaded"
|
|
3469
|
+
},
|
|
3470
|
+
{
|
|
3471
|
+
"name": "uploadEnabled",
|
|
3472
|
+
"type": "boolean",
|
|
3473
|
+
"required": false,
|
|
3474
|
+
"description": "Whether files uploads are enabled"
|
|
3475
|
+
},
|
|
3476
|
+
{
|
|
3477
|
+
"name": "fileMetadataPopupOptions",
|
|
3478
|
+
"type": "FileMetadataPopupOptions",
|
|
3479
|
+
"required": false
|
|
3480
|
+
},
|
|
3481
|
+
{
|
|
3482
|
+
"name": "onGetInfo",
|
|
3483
|
+
"type": "(file: DialFile) => void | Promise<void>",
|
|
3484
|
+
"required": false
|
|
3485
|
+
},
|
|
3486
|
+
{
|
|
3487
|
+
"name": "onUnshareFiles",
|
|
3488
|
+
"type": "(files: DialFile[]) => void | Promise<void>",
|
|
3489
|
+
"required": false
|
|
3490
|
+
},
|
|
3491
|
+
{
|
|
3492
|
+
"name": "onRemoveFilesAccess",
|
|
3493
|
+
"type": "(files: DialFile[]) => void | Promise<void>",
|
|
3494
|
+
"required": false
|
|
3495
|
+
},
|
|
3496
|
+
{
|
|
3497
|
+
"name": "actionsRef",
|
|
3498
|
+
"type": "Ref<DialFileManagerActionsRef>",
|
|
3499
|
+
"required": false,
|
|
3500
|
+
"description": "Ref exposing a limited set of imperative File Manager actions (e.g., creating a folder). Allows parent components to trigger internal behaviors programmatically. This ref is not a DOM ref and should be used only for invoking the component’s public actions API."
|
|
3501
|
+
},
|
|
3502
|
+
{
|
|
3503
|
+
"name": "onSearchFiles",
|
|
3504
|
+
"type": "(folder: string, query: string) => void",
|
|
3505
|
+
"required": false
|
|
3506
|
+
},
|
|
3507
|
+
{
|
|
3508
|
+
"name": "searchInProgress",
|
|
3509
|
+
"type": "boolean",
|
|
3510
|
+
"required": false
|
|
3511
|
+
},
|
|
3512
|
+
{
|
|
3513
|
+
"name": "searchResults",
|
|
3514
|
+
"type": "DialFile[]",
|
|
3515
|
+
"required": false
|
|
3516
|
+
},
|
|
3517
|
+
{
|
|
3518
|
+
"name": "clearSearchResults",
|
|
3519
|
+
"type": "() => void",
|
|
3520
|
+
"required": false
|
|
3521
|
+
},
|
|
3522
|
+
{
|
|
3523
|
+
"name": "emptyStateIcon",
|
|
3524
|
+
"type": "ReactNode",
|
|
3525
|
+
"required": false,
|
|
3526
|
+
"description": "Optional icon for empty state"
|
|
3527
|
+
},
|
|
3528
|
+
{
|
|
3529
|
+
"name": "emptyStateTitle",
|
|
3530
|
+
"type": "string",
|
|
3531
|
+
"required": false,
|
|
3532
|
+
"description": "Optional title text displayed when there are no files."
|
|
3533
|
+
},
|
|
3534
|
+
{
|
|
3535
|
+
"name": "emptyStateDescription",
|
|
3536
|
+
"type": "string",
|
|
3537
|
+
"required": false,
|
|
3538
|
+
"description": "Optional description text displayed below the empty state title."
|
|
3539
|
+
},
|
|
3540
|
+
{
|
|
3541
|
+
"name": "sharedWithMeIds",
|
|
3542
|
+
"type": "string[]",
|
|
3543
|
+
"required": false,
|
|
3544
|
+
"description": "Optional list of file IDs that are shared with the current user."
|
|
3545
|
+
},
|
|
3546
|
+
{
|
|
3547
|
+
"name": "onFolderPopupPathChange",
|
|
3548
|
+
"type": "(newPath?: string) => void",
|
|
3549
|
+
"required": false
|
|
3550
|
+
},
|
|
3551
|
+
{
|
|
3552
|
+
"name": "onManagePermissions",
|
|
3553
|
+
"type": "(path?: string) => void",
|
|
3554
|
+
"required": false
|
|
3555
|
+
},
|
|
3556
|
+
{
|
|
3557
|
+
"name": "onPreview",
|
|
3558
|
+
"type": "(path?: string) => void",
|
|
3559
|
+
"required": false
|
|
3560
|
+
},
|
|
3561
|
+
{
|
|
3562
|
+
"name": "onOpenInNewTab",
|
|
3563
|
+
"type": "(file: DialFile) => void",
|
|
3564
|
+
"required": false
|
|
3565
|
+
},
|
|
3566
|
+
{
|
|
3567
|
+
"name": "previewExtensions",
|
|
3568
|
+
"type": "string[]",
|
|
3569
|
+
"required": false
|
|
3570
|
+
},
|
|
3571
|
+
{
|
|
3572
|
+
"name": "isRenameFileAvailable",
|
|
3573
|
+
"type": "boolean",
|
|
3574
|
+
"required": false
|
|
3575
|
+
},
|
|
3576
|
+
{
|
|
3577
|
+
"name": "isDuplicateFolderAvailable",
|
|
3578
|
+
"type": "boolean",
|
|
3579
|
+
"required": false
|
|
3580
|
+
},
|
|
3581
|
+
{
|
|
3582
|
+
"name": "customUploadFileAction",
|
|
3583
|
+
"type": "(\n currentPath?: string,\n currentFolder?: DialFile,\n ) => void",
|
|
3584
|
+
"required": false
|
|
3585
|
+
},
|
|
3586
|
+
{
|
|
3587
|
+
"name": "customCreateNewItemAction",
|
|
3588
|
+
"type": "(\n currentPath?: string,\n currentFolder?: DialFile,\n ) => void",
|
|
3589
|
+
"required": false
|
|
3590
|
+
},
|
|
3591
|
+
{
|
|
3592
|
+
"name": "customDuplicateAction",
|
|
3593
|
+
"type": "(items?: DialFile[]) => void",
|
|
3594
|
+
"required": false
|
|
3595
|
+
},
|
|
3596
|
+
{
|
|
3597
|
+
"name": "customDeleteItemsAction",
|
|
3598
|
+
"type": "(\n items: DialFile[],\n parentFolderPath: string,\n ) => void",
|
|
3599
|
+
"required": false
|
|
3600
|
+
},
|
|
3601
|
+
{
|
|
3602
|
+
"name": "customDownloadItemsAction",
|
|
3603
|
+
"type": "(items?: DialFile[]) => void",
|
|
3604
|
+
"required": false
|
|
3605
|
+
},
|
|
3606
|
+
{
|
|
3607
|
+
"name": "nonClickableTableColumns",
|
|
3608
|
+
"type": "FileManagerColumnKey[]",
|
|
3609
|
+
"required": false
|
|
3610
|
+
},
|
|
3611
|
+
{
|
|
3612
|
+
"name": "hideSearchPathItemName",
|
|
3613
|
+
"type": "boolean",
|
|
3614
|
+
"required": false
|
|
3615
|
+
},
|
|
3616
|
+
{
|
|
3617
|
+
"name": "showHiddenFileSwitcherInDestinationPopup",
|
|
3618
|
+
"type": "boolean",
|
|
3619
|
+
"required": false
|
|
3620
|
+
},
|
|
3621
|
+
{
|
|
3622
|
+
"name": "autoSelectUploadedItems",
|
|
3623
|
+
"type": "boolean",
|
|
3624
|
+
"required": false,
|
|
3625
|
+
"description": "When true, automatically selects newly uploaded or created items (files, archives, folders) after they appear in the current directory. Useful in attach flows where the user expects immediate selection feedback."
|
|
3626
|
+
}
|
|
3627
|
+
],
|
|
3628
|
+
"examples": [
|
|
3629
|
+
"// Minimal usage\n<DialFileManager items={files} path=\"/All files\" />\n\n// With loading state\n<DialFileManager items={files} path=\"/All files\" filesLoading={true} />\n\n// With controlled search and disabled grid filters\nconst [query, setQuery] = useState('');\n<DialFileManager\n items={files}\n path=\"/All files/Design\"\n navigationPanelOptions={{\n searchable: true,\n value: query,\n onSearchChange: setQuery,\n }}\n gridOptions={{ filterable: false }}\n/>\n\n// With custom tree width and title\n<DialFileManager\n items={files}\n treeOptions={{ width: 300, title: 'Explorer', showFiles: true }}\n/>\n\n// With explicit provider (advanced apps)\n<FileManagerProvider items={files} path=\"/All files\">\n <MyCustomHeader />\n <DialFileManagerView /> // internal view\n <MyCustomFooter />\n</FileManagerProvider>"
|
|
3630
|
+
],
|
|
3631
|
+
"sourceFile": "components/FileManager/FileManager.tsx"
|
|
3632
|
+
},
|
|
3633
|
+
{
|
|
3634
|
+
"name": "DialDestinationFolderPopup",
|
|
3635
|
+
"category": "FileManager/components",
|
|
3636
|
+
"description": "DestinationFolderPopup\naliases: FolderSelector|PathChooser\n\nA popup dialog for selecting a destination folder when copying or moving files.\nDisplays a File Manager interface with a footer containing action buttons and\na toggle for showing hidden files.",
|
|
3637
|
+
"props": [],
|
|
3638
|
+
"examples": [
|
|
3639
|
+
"<DestinationFolderPopup\n open={isOpen}\n onClose={handleClose}\n onConfirm={handleConfirm}\n mode=\"copy\"\n title=\"Copy 3 files\"\n items={files}\n rootItem={rootFolder}\n path={currentPath}\n onPathChange={setCurrentPath}\n/>"
|
|
3640
|
+
],
|
|
3641
|
+
"sourceFile": "components/FileManager/components/DestinationFolderPopup/DestinationFolderPopup.tsx"
|
|
3642
|
+
}
|
|
3643
|
+
],
|
|
3644
|
+
"types": [
|
|
3645
|
+
{
|
|
3646
|
+
"name": "GridOptions",
|
|
3647
|
+
"kind": "interface",
|
|
3648
|
+
"members": [
|
|
3649
|
+
{
|
|
3650
|
+
"name": "columnDefs?",
|
|
3651
|
+
"value": "(\n | ColDef<GridRow>\n | ((\n dateLocale: Intl.LocalesArgument,\n dateOptions: Intl.DateTimeFormatOptions | undefined,\n isCompactView: boolean,\n ) => ColDef<GridRow, unknown>)\n )[]"
|
|
3652
|
+
},
|
|
3653
|
+
{
|
|
3654
|
+
"name": "filterable?",
|
|
3655
|
+
"value": "boolean"
|
|
3656
|
+
},
|
|
3657
|
+
{
|
|
3658
|
+
"name": "dateLocale?",
|
|
3659
|
+
"value": "Intl.LocalesArgument"
|
|
3660
|
+
},
|
|
3661
|
+
{
|
|
3662
|
+
"name": "dateOptions?",
|
|
3663
|
+
"value": "Intl.DateTimeFormatOptions"
|
|
3664
|
+
},
|
|
3665
|
+
{
|
|
3666
|
+
"name": "showFiles?",
|
|
3667
|
+
"value": "boolean"
|
|
3668
|
+
},
|
|
3669
|
+
{
|
|
3670
|
+
"name": "showFolders?",
|
|
3671
|
+
"value": "boolean"
|
|
3672
|
+
},
|
|
3673
|
+
{
|
|
3674
|
+
"name": "visibleColumns?",
|
|
3675
|
+
"value": "FileManagerColumnKey[]"
|
|
3676
|
+
},
|
|
3677
|
+
{
|
|
3678
|
+
"name": "selectionMode?",
|
|
3679
|
+
"value": "GridSelectionMode"
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"name": "wrapCustomCellRenderers?",
|
|
3683
|
+
"value": "boolean"
|
|
3684
|
+
},
|
|
3685
|
+
{
|
|
3686
|
+
"name": "allowDisabledContextMenu?",
|
|
3687
|
+
"value": "boolean"
|
|
3688
|
+
},
|
|
3689
|
+
{
|
|
3690
|
+
"name": "actionLabels?",
|
|
3691
|
+
"value": "{\n [DialFileManagerActions.AddSibling]?: string;\n [DialFileManagerActions.AddChild]?: string;\n [DialFileManagerActions.Duplicate]?: string;\n [DialFileManagerActions.Copy]?: string;\n [DialFileManagerActions.Rename]?: string;\n [DialFileManagerActions.Download]?: string;\n [DialFileManagerActions.Delete]?: string;\n [DialFileManagerActions.Move]?: string;\n [DialFileManagerActions.Info]?: string;\n [DialFileManagerActions.Unshare]?: string;\n [DialFileManagerActions.ManagePermissions]?: string;\n [DialFileManagerActions.Preview]?: string;\n [DialFileManagerActions.RemoveAccess]?: string;\n }"
|
|
3692
|
+
}
|
|
3693
|
+
],
|
|
3694
|
+
"sourceFile": "components/FileManager/FileManager.tsx"
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
"name": "ToolbarOptions",
|
|
3698
|
+
"kind": "type",
|
|
3699
|
+
"sourceFile": "components/FileManager/FileManager.tsx",
|
|
3700
|
+
"typeBody": "Omit<\n DialFileManagerToolbarProps,\n 'areHiddenFilesVisible' | 'onToggleHiddenFiles'\n> & {\n newActions?: {\n uploadFiles?: NewAction;\n newFolder?: NewAction;\n uploadArchive?: NewAction;\n newItem?: NewAction;\n };\n showHiddenFilesToggle?: boolean;\n}"
|
|
3701
|
+
},
|
|
3702
|
+
{
|
|
3703
|
+
"name": "BulkActionsToolbarOptions",
|
|
3704
|
+
"kind": "type",
|
|
3705
|
+
"sourceFile": "components/FileManager/FileManager.tsx",
|
|
3706
|
+
"typeBody": "Omit<\n DialFileManagerBulkActionsToolbarProps,\n 'onClearSelection' | 'actions' | 'selectedCount'\n> & {\n actionLabels?: {\n [DialFileManagerActions.Duplicate]?: string;\n [DialFileManagerActions.Copy]?: string;\n [DialFileManagerActions.Download]?: string;\n [DialFileManagerActions.Delete]?: string;\n [DialFileManagerActions.Move]?: string;\n [DialFileManagerActions.Unshare]?: string;\n [DialFileManagerActions.RemoveAccess]?: string;\n };\n}"
|
|
3707
|
+
},
|
|
3708
|
+
{
|
|
3709
|
+
"name": "AlertVariant",
|
|
3710
|
+
"kind": "enum",
|
|
3711
|
+
"members": [
|
|
3712
|
+
{
|
|
3713
|
+
"name": "Info",
|
|
3714
|
+
"value": "'info'"
|
|
3715
|
+
},
|
|
3716
|
+
{
|
|
3717
|
+
"name": "Success",
|
|
3718
|
+
"value": "'success'"
|
|
3719
|
+
},
|
|
3720
|
+
{
|
|
3721
|
+
"name": "Warning",
|
|
3722
|
+
"value": "'warning'"
|
|
3723
|
+
},
|
|
3724
|
+
{
|
|
3725
|
+
"name": "Error",
|
|
3726
|
+
"value": "'error'"
|
|
3727
|
+
}
|
|
3728
|
+
],
|
|
3729
|
+
"sourceFile": "types/alert.ts"
|
|
3730
|
+
},
|
|
3731
|
+
{
|
|
3732
|
+
"name": "ButtonVariant",
|
|
3733
|
+
"kind": "enum",
|
|
3734
|
+
"members": [
|
|
3735
|
+
{
|
|
3736
|
+
"name": "Primary",
|
|
3737
|
+
"value": "'primary'"
|
|
3738
|
+
},
|
|
3739
|
+
{
|
|
3740
|
+
"name": "Neutral",
|
|
3741
|
+
"value": "'neutral'"
|
|
3742
|
+
},
|
|
3743
|
+
{
|
|
3744
|
+
"name": "Error",
|
|
3745
|
+
"value": "'error'"
|
|
3746
|
+
},
|
|
3747
|
+
{
|
|
3748
|
+
"name": "Success",
|
|
3749
|
+
"value": "'Success'"
|
|
3750
|
+
},
|
|
3751
|
+
{
|
|
3752
|
+
"name": "Secondary",
|
|
3753
|
+
"value": "'secondary'"
|
|
3754
|
+
},
|
|
3755
|
+
{
|
|
3756
|
+
"name": "Tertiary",
|
|
3757
|
+
"value": "'tertiary'"
|
|
3758
|
+
}
|
|
3759
|
+
],
|
|
3760
|
+
"sourceFile": "types/button.ts"
|
|
3761
|
+
},
|
|
3762
|
+
{
|
|
3763
|
+
"name": "ButtonAppearance",
|
|
3764
|
+
"kind": "enum",
|
|
3765
|
+
"members": [
|
|
3766
|
+
{
|
|
3767
|
+
"name": "Solid",
|
|
3768
|
+
"value": "'solid'"
|
|
3769
|
+
},
|
|
3770
|
+
{
|
|
3771
|
+
"name": "Outlined",
|
|
3772
|
+
"value": "'outlined'"
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
"name": "Ghost",
|
|
3776
|
+
"value": "'ghost'"
|
|
3777
|
+
},
|
|
3778
|
+
{
|
|
3779
|
+
"name": "Link",
|
|
3780
|
+
"value": "'link'"
|
|
3781
|
+
}
|
|
3782
|
+
],
|
|
3783
|
+
"sourceFile": "types/button.ts"
|
|
3784
|
+
},
|
|
3785
|
+
{
|
|
3786
|
+
"name": "RadioGroupOrientation",
|
|
3787
|
+
"kind": "enum",
|
|
3788
|
+
"members": [
|
|
3789
|
+
{
|
|
3790
|
+
"name": "Row",
|
|
3791
|
+
"value": "'Row'"
|
|
3792
|
+
},
|
|
3793
|
+
{
|
|
3794
|
+
"name": "Column",
|
|
3795
|
+
"value": "'Column'"
|
|
3796
|
+
}
|
|
3797
|
+
],
|
|
3798
|
+
"sourceFile": "types/radio-group.ts"
|
|
3799
|
+
},
|
|
3800
|
+
{
|
|
3801
|
+
"name": "PopupSize",
|
|
3802
|
+
"kind": "enum",
|
|
3803
|
+
"members": [
|
|
3804
|
+
{
|
|
3805
|
+
"name": "Sm",
|
|
3806
|
+
"value": "'sm'"
|
|
3807
|
+
},
|
|
3808
|
+
{
|
|
3809
|
+
"name": "Md",
|
|
3810
|
+
"value": "'md'"
|
|
3811
|
+
},
|
|
3812
|
+
{
|
|
3813
|
+
"name": "Lg",
|
|
3814
|
+
"value": "'lg'"
|
|
3815
|
+
}
|
|
3816
|
+
],
|
|
3817
|
+
"sourceFile": "types/popup.ts"
|
|
3818
|
+
},
|
|
3819
|
+
{
|
|
3820
|
+
"name": "ConfirmationPopupVariant",
|
|
3821
|
+
"kind": "enum",
|
|
3822
|
+
"members": [
|
|
3823
|
+
{
|
|
3824
|
+
"name": "Info",
|
|
3825
|
+
"value": "'info'"
|
|
3826
|
+
},
|
|
3827
|
+
{
|
|
3828
|
+
"name": "Danger",
|
|
3829
|
+
"value": "'danger'"
|
|
3830
|
+
}
|
|
3831
|
+
],
|
|
3832
|
+
"sourceFile": "types/confirmation-popup.ts"
|
|
3833
|
+
},
|
|
3834
|
+
{
|
|
3835
|
+
"name": "DropdownType",
|
|
3836
|
+
"kind": "enum",
|
|
3837
|
+
"members": [
|
|
3838
|
+
{
|
|
3839
|
+
"name": "Dropdown",
|
|
3840
|
+
"value": "'dropdown'"
|
|
3841
|
+
},
|
|
3842
|
+
{
|
|
3843
|
+
"name": "Menu",
|
|
3844
|
+
"value": "'menu'"
|
|
3845
|
+
}
|
|
3846
|
+
],
|
|
3847
|
+
"sourceFile": "types/dropdown.ts"
|
|
3848
|
+
},
|
|
3849
|
+
{
|
|
3850
|
+
"name": "DropdownTrigger",
|
|
3851
|
+
"kind": "enum",
|
|
3852
|
+
"members": [
|
|
3853
|
+
{
|
|
3854
|
+
"name": "Click",
|
|
3855
|
+
"value": "'click'"
|
|
3856
|
+
},
|
|
3857
|
+
{
|
|
3858
|
+
"name": "Hover",
|
|
3859
|
+
"value": "'hover'"
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"name": "ContextMenu",
|
|
3863
|
+
"value": "'contextMenu'"
|
|
3864
|
+
}
|
|
3865
|
+
],
|
|
3866
|
+
"sourceFile": "types/dropdown.ts"
|
|
3867
|
+
},
|
|
3868
|
+
{
|
|
3869
|
+
"name": "DropdownItemType",
|
|
3870
|
+
"kind": "enum",
|
|
3871
|
+
"members": [
|
|
3872
|
+
{
|
|
3873
|
+
"name": "Item",
|
|
3874
|
+
"value": "'item'"
|
|
3875
|
+
},
|
|
3876
|
+
{
|
|
3877
|
+
"name": "Divider",
|
|
3878
|
+
"value": "'divider'"
|
|
3879
|
+
},
|
|
3880
|
+
{
|
|
3881
|
+
"name": "PlainText",
|
|
3882
|
+
"value": "'plainText'"
|
|
3883
|
+
}
|
|
3884
|
+
],
|
|
3885
|
+
"sourceFile": "types/dropdown.ts"
|
|
3886
|
+
},
|
|
3887
|
+
{
|
|
3888
|
+
"name": "ElementSize",
|
|
3889
|
+
"kind": "enum",
|
|
3890
|
+
"members": [
|
|
3891
|
+
{
|
|
3892
|
+
"name": "Small",
|
|
3893
|
+
"value": "'small'"
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
"name": "Standard",
|
|
3897
|
+
"value": "'standard'"
|
|
3898
|
+
}
|
|
3899
|
+
],
|
|
3900
|
+
"sourceFile": "types/size.ts"
|
|
3901
|
+
},
|
|
3902
|
+
{
|
|
3903
|
+
"name": "TagVariant",
|
|
3904
|
+
"kind": "enum",
|
|
3905
|
+
"members": [
|
|
3906
|
+
{
|
|
3907
|
+
"name": "Default",
|
|
3908
|
+
"value": "'default'"
|
|
3909
|
+
}
|
|
3910
|
+
],
|
|
3911
|
+
"sourceFile": "types/tag.ts"
|
|
3912
|
+
},
|
|
3913
|
+
{
|
|
3914
|
+
"name": "TabOrientation",
|
|
3915
|
+
"kind": "enum",
|
|
3916
|
+
"members": [
|
|
3917
|
+
{
|
|
3918
|
+
"name": "Horizontal",
|
|
3919
|
+
"value": "'horizontal'"
|
|
3920
|
+
},
|
|
3921
|
+
{
|
|
3922
|
+
"name": "Vertical",
|
|
3923
|
+
"value": "'vertical'"
|
|
3924
|
+
}
|
|
3925
|
+
],
|
|
3926
|
+
"sourceFile": "types/tab.ts"
|
|
3927
|
+
},
|
|
3928
|
+
{
|
|
3929
|
+
"name": "DialBreadcrumbPathItem",
|
|
3930
|
+
"kind": "interface",
|
|
3931
|
+
"members": [
|
|
3932
|
+
{
|
|
3933
|
+
"name": "label",
|
|
3934
|
+
"value": "ReactNode"
|
|
3935
|
+
},
|
|
3936
|
+
{
|
|
3937
|
+
"name": "href?",
|
|
3938
|
+
"value": "string"
|
|
3939
|
+
},
|
|
3940
|
+
{
|
|
3941
|
+
"name": "onClick?",
|
|
3942
|
+
"value": "(e: MouseEvent<HTMLAnchorElement>) => void"
|
|
3943
|
+
},
|
|
3944
|
+
{
|
|
3945
|
+
"name": "disabled?",
|
|
3946
|
+
"value": "boolean"
|
|
3947
|
+
},
|
|
3948
|
+
{
|
|
3949
|
+
"name": "className?",
|
|
3950
|
+
"value": "string"
|
|
3951
|
+
},
|
|
3952
|
+
{
|
|
3953
|
+
"name": "iconBefore?",
|
|
3954
|
+
"value": "ReactNode"
|
|
3955
|
+
}
|
|
3956
|
+
],
|
|
3957
|
+
"sourceFile": "models/breadcrumb.ts"
|
|
3958
|
+
},
|
|
3959
|
+
{
|
|
3960
|
+
"name": "FormItemOrientation",
|
|
3961
|
+
"kind": "enum",
|
|
3962
|
+
"members": [
|
|
3963
|
+
{
|
|
3964
|
+
"name": "Vertical",
|
|
3965
|
+
"value": "'vertical'"
|
|
3966
|
+
},
|
|
3967
|
+
{
|
|
3968
|
+
"name": "Horizontal",
|
|
3969
|
+
"value": "'horizontal'"
|
|
3970
|
+
}
|
|
3971
|
+
],
|
|
3972
|
+
"sourceFile": "types/form-item.ts",
|
|
3973
|
+
"description": "Orientation options for form item layout"
|
|
3974
|
+
},
|
|
3975
|
+
{
|
|
3976
|
+
"name": "SelectSize",
|
|
3977
|
+
"kind": "enum",
|
|
3978
|
+
"members": [
|
|
3979
|
+
{
|
|
3980
|
+
"name": "Sm",
|
|
3981
|
+
"value": "'sm'"
|
|
3982
|
+
},
|
|
3983
|
+
{
|
|
3984
|
+
"name": "Md",
|
|
3985
|
+
"value": "'md'"
|
|
3986
|
+
}
|
|
3987
|
+
],
|
|
3988
|
+
"sourceFile": "types/select.ts"
|
|
3989
|
+
},
|
|
3990
|
+
{
|
|
3991
|
+
"name": "SelectVariant",
|
|
3992
|
+
"kind": "enum",
|
|
3993
|
+
"members": [
|
|
3994
|
+
{
|
|
3995
|
+
"name": "Primary",
|
|
3996
|
+
"value": "'Primary'"
|
|
3997
|
+
},
|
|
3998
|
+
{
|
|
3999
|
+
"name": "Secondary",
|
|
4000
|
+
"value": "'Secondary'"
|
|
4001
|
+
}
|
|
4002
|
+
],
|
|
4003
|
+
"sourceFile": "types/select.ts"
|
|
4004
|
+
},
|
|
4005
|
+
{
|
|
4006
|
+
"name": "DialFileManagerTabs",
|
|
4007
|
+
"kind": "enum",
|
|
4008
|
+
"members": [
|
|
4009
|
+
{
|
|
4010
|
+
"name": "MyFiles",
|
|
4011
|
+
"value": "'my_files'"
|
|
4012
|
+
},
|
|
4013
|
+
{
|
|
4014
|
+
"name": "Shared",
|
|
4015
|
+
"value": "'shared'"
|
|
4016
|
+
},
|
|
4017
|
+
{
|
|
4018
|
+
"name": "Organization",
|
|
4019
|
+
"value": "'organization'"
|
|
4020
|
+
},
|
|
4021
|
+
{
|
|
4022
|
+
"name": "Review",
|
|
4023
|
+
"value": "'review'"
|
|
4024
|
+
}
|
|
4025
|
+
],
|
|
4026
|
+
"sourceFile": "types/file-manager.ts"
|
|
4027
|
+
},
|
|
4028
|
+
{
|
|
4029
|
+
"name": "DialFileManagerActions",
|
|
4030
|
+
"kind": "enum",
|
|
4031
|
+
"members": [
|
|
4032
|
+
{
|
|
4033
|
+
"name": "AddSibling",
|
|
4034
|
+
"value": "'addSibling'"
|
|
4035
|
+
},
|
|
4036
|
+
{
|
|
4037
|
+
"name": "AddChild",
|
|
4038
|
+
"value": "'addChild'"
|
|
4039
|
+
},
|
|
4040
|
+
{
|
|
4041
|
+
"name": "Duplicate",
|
|
4042
|
+
"value": "'duplicate'"
|
|
4043
|
+
},
|
|
4044
|
+
{
|
|
4045
|
+
"name": "Copy",
|
|
4046
|
+
"value": "'copy'"
|
|
4047
|
+
},
|
|
4048
|
+
{
|
|
4049
|
+
"name": "Move",
|
|
4050
|
+
"value": "'move'"
|
|
4051
|
+
},
|
|
4052
|
+
{
|
|
4053
|
+
"name": "Download",
|
|
4054
|
+
"value": "'download'"
|
|
4055
|
+
},
|
|
4056
|
+
{
|
|
4057
|
+
"name": "Delete",
|
|
4058
|
+
"value": "'delete'"
|
|
4059
|
+
},
|
|
4060
|
+
{
|
|
4061
|
+
"name": "Rename",
|
|
4062
|
+
"value": "'rename'"
|
|
4063
|
+
},
|
|
4064
|
+
{
|
|
4065
|
+
"name": "Info",
|
|
4066
|
+
"value": "'info'"
|
|
4067
|
+
},
|
|
4068
|
+
{
|
|
4069
|
+
"name": "Unshare",
|
|
4070
|
+
"value": "'unshare'"
|
|
4071
|
+
},
|
|
4072
|
+
{
|
|
4073
|
+
"name": "RemoveAccess",
|
|
4074
|
+
"value": "'removeAccess'"
|
|
4075
|
+
},
|
|
4076
|
+
{
|
|
4077
|
+
"name": "ManagePermissions",
|
|
4078
|
+
"value": "'managePermissions'"
|
|
4079
|
+
},
|
|
4080
|
+
{
|
|
4081
|
+
"name": "Preview",
|
|
4082
|
+
"value": "'preview'"
|
|
4083
|
+
},
|
|
4084
|
+
{
|
|
4085
|
+
"name": "OpenInNewTab",
|
|
4086
|
+
"value": "'openInNewTab'"
|
|
4087
|
+
}
|
|
4088
|
+
],
|
|
4089
|
+
"sourceFile": "types/file-manager.ts"
|
|
4090
|
+
},
|
|
4091
|
+
{
|
|
4092
|
+
"name": "FileManagerColumnKey",
|
|
4093
|
+
"kind": "enum",
|
|
4094
|
+
"members": [
|
|
4095
|
+
{
|
|
4096
|
+
"name": "Name",
|
|
4097
|
+
"value": "'name'"
|
|
4098
|
+
},
|
|
4099
|
+
{
|
|
4100
|
+
"name": "UpdatedAt",
|
|
4101
|
+
"value": "'updatedAt'"
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"name": "Size",
|
|
4105
|
+
"value": "'size'"
|
|
4106
|
+
},
|
|
4107
|
+
{
|
|
4108
|
+
"name": "Author",
|
|
4109
|
+
"value": "'author'"
|
|
4110
|
+
},
|
|
4111
|
+
{
|
|
4112
|
+
"name": "Owner",
|
|
4113
|
+
"value": "'owner'"
|
|
4114
|
+
},
|
|
4115
|
+
{
|
|
4116
|
+
"name": "Path",
|
|
4117
|
+
"value": "'path'"
|
|
4118
|
+
},
|
|
4119
|
+
{
|
|
4120
|
+
"name": "Actions",
|
|
4121
|
+
"value": "'__actions'"
|
|
4122
|
+
},
|
|
4123
|
+
{
|
|
4124
|
+
"name": "Version",
|
|
4125
|
+
"value": "'version'"
|
|
4126
|
+
}
|
|
4127
|
+
],
|
|
4128
|
+
"sourceFile": "types/file-manager.ts"
|
|
4129
|
+
},
|
|
4130
|
+
{
|
|
4131
|
+
"name": "FlexibleActionsDirection",
|
|
4132
|
+
"kind": "enum",
|
|
4133
|
+
"members": [
|
|
4134
|
+
{
|
|
4135
|
+
"name": "Normal",
|
|
4136
|
+
"value": "'normal'"
|
|
4137
|
+
},
|
|
4138
|
+
{
|
|
4139
|
+
"name": "Reverse",
|
|
4140
|
+
"value": "'reverse'"
|
|
4141
|
+
}
|
|
4142
|
+
],
|
|
4143
|
+
"sourceFile": "types/flexible-actions.ts"
|
|
4144
|
+
},
|
|
4145
|
+
{
|
|
4146
|
+
"name": "DialItemType",
|
|
4147
|
+
"kind": "enum",
|
|
4148
|
+
"members": [
|
|
4149
|
+
{
|
|
4150
|
+
"name": "File",
|
|
4151
|
+
"value": "'file'"
|
|
4152
|
+
},
|
|
4153
|
+
{
|
|
4154
|
+
"name": "Folder",
|
|
4155
|
+
"value": "'folder'"
|
|
4156
|
+
}
|
|
4157
|
+
],
|
|
4158
|
+
"sourceFile": "types/item.ts"
|
|
4159
|
+
},
|
|
4160
|
+
{
|
|
4161
|
+
"name": "ResizableContainerSide",
|
|
4162
|
+
"kind": "enum",
|
|
4163
|
+
"members": [
|
|
4164
|
+
{
|
|
4165
|
+
"name": "Left",
|
|
4166
|
+
"value": "'left'"
|
|
4167
|
+
},
|
|
4168
|
+
{
|
|
4169
|
+
"name": "Right",
|
|
4170
|
+
"value": "'right'"
|
|
4171
|
+
}
|
|
4172
|
+
],
|
|
4173
|
+
"sourceFile": "types/resizable-container.ts"
|
|
4174
|
+
},
|
|
4175
|
+
{
|
|
4176
|
+
"name": "DialSkeletonVariant",
|
|
4177
|
+
"kind": "enum",
|
|
4178
|
+
"members": [
|
|
4179
|
+
{
|
|
4180
|
+
"name": "Default",
|
|
4181
|
+
"value": "'default'"
|
|
4182
|
+
},
|
|
4183
|
+
{
|
|
4184
|
+
"name": "Text",
|
|
4185
|
+
"value": "'text'"
|
|
4186
|
+
},
|
|
4187
|
+
{
|
|
4188
|
+
"name": "Circular",
|
|
4189
|
+
"value": "'circular'"
|
|
4190
|
+
},
|
|
4191
|
+
{
|
|
4192
|
+
"name": "Rectangular",
|
|
4193
|
+
"value": "'rectangular'"
|
|
4194
|
+
}
|
|
4195
|
+
],
|
|
4196
|
+
"sourceFile": "types/skeleton.ts"
|
|
4197
|
+
},
|
|
4198
|
+
{
|
|
4199
|
+
"name": "DialSkeletonAvatarSize",
|
|
4200
|
+
"kind": "enum",
|
|
4201
|
+
"members": [
|
|
4202
|
+
{
|
|
4203
|
+
"name": "Small",
|
|
4204
|
+
"value": "'small'"
|
|
4205
|
+
},
|
|
4206
|
+
{
|
|
4207
|
+
"name": "Default",
|
|
4208
|
+
"value": "'default'"
|
|
4209
|
+
},
|
|
4210
|
+
{
|
|
4211
|
+
"name": "Large",
|
|
4212
|
+
"value": "'large'"
|
|
4213
|
+
}
|
|
4214
|
+
],
|
|
4215
|
+
"sourceFile": "types/skeleton.ts"
|
|
4216
|
+
},
|
|
4217
|
+
{
|
|
4218
|
+
"name": "DialSkeletonAvatarShape",
|
|
4219
|
+
"kind": "enum",
|
|
4220
|
+
"members": [
|
|
4221
|
+
{
|
|
4222
|
+
"name": "Circle",
|
|
4223
|
+
"value": "'circle'"
|
|
4224
|
+
},
|
|
4225
|
+
{
|
|
4226
|
+
"name": "Square",
|
|
4227
|
+
"value": "'square'"
|
|
4228
|
+
}
|
|
4229
|
+
],
|
|
4230
|
+
"sourceFile": "types/skeleton.ts"
|
|
4231
|
+
},
|
|
4232
|
+
{
|
|
4233
|
+
"name": "StepStatus",
|
|
4234
|
+
"kind": "enum",
|
|
4235
|
+
"members": [
|
|
4236
|
+
{
|
|
4237
|
+
"name": "VALID",
|
|
4238
|
+
"value": "'valid'"
|
|
4239
|
+
},
|
|
4240
|
+
{
|
|
4241
|
+
"name": "ERROR",
|
|
4242
|
+
"value": "'error'"
|
|
4243
|
+
}
|
|
4244
|
+
],
|
|
4245
|
+
"sourceFile": "models/step.ts"
|
|
4246
|
+
},
|
|
4247
|
+
{
|
|
4248
|
+
"name": "Step",
|
|
4249
|
+
"kind": "interface",
|
|
4250
|
+
"members": [
|
|
4251
|
+
{
|
|
4252
|
+
"name": "id",
|
|
4253
|
+
"value": "string"
|
|
4254
|
+
},
|
|
4255
|
+
{
|
|
4256
|
+
"name": "name",
|
|
4257
|
+
"value": "string"
|
|
4258
|
+
},
|
|
4259
|
+
{
|
|
4260
|
+
"name": "status?",
|
|
4261
|
+
"value": "StepStatus"
|
|
4262
|
+
}
|
|
4263
|
+
],
|
|
4264
|
+
"sourceFile": "models/step.ts"
|
|
4265
|
+
},
|
|
4266
|
+
{
|
|
4267
|
+
"name": "RadioButtonWithContent",
|
|
4268
|
+
"kind": "interface",
|
|
4269
|
+
"members": [
|
|
4270
|
+
{
|
|
4271
|
+
"name": "id",
|
|
4272
|
+
"value": "string"
|
|
4273
|
+
},
|
|
4274
|
+
{
|
|
4275
|
+
"name": "name",
|
|
4276
|
+
"value": "string"
|
|
4277
|
+
},
|
|
4278
|
+
{
|
|
4279
|
+
"name": "content?",
|
|
4280
|
+
"value": "ReactNode"
|
|
4281
|
+
},
|
|
4282
|
+
{
|
|
4283
|
+
"name": "caption?",
|
|
4284
|
+
"value": "ReactNode"
|
|
4285
|
+
}
|
|
4286
|
+
],
|
|
4287
|
+
"sourceFile": "models/radio.ts"
|
|
4288
|
+
},
|
|
4289
|
+
{
|
|
4290
|
+
"name": "SelectOption",
|
|
4291
|
+
"kind": "interface",
|
|
4292
|
+
"members": [
|
|
4293
|
+
{
|
|
4294
|
+
"name": "value",
|
|
4295
|
+
"value": "string"
|
|
4296
|
+
},
|
|
4297
|
+
{
|
|
4298
|
+
"name": "label",
|
|
4299
|
+
"value": "string"
|
|
4300
|
+
},
|
|
4301
|
+
{
|
|
4302
|
+
"name": "description?",
|
|
4303
|
+
"value": "string"
|
|
4304
|
+
},
|
|
4305
|
+
{
|
|
4306
|
+
"name": "disabled?",
|
|
4307
|
+
"value": "boolean"
|
|
4308
|
+
},
|
|
4309
|
+
{
|
|
4310
|
+
"name": "icon?",
|
|
4311
|
+
"value": "ReactNode"
|
|
4312
|
+
}
|
|
4313
|
+
],
|
|
4314
|
+
"sourceFile": "models/select.ts"
|
|
4315
|
+
},
|
|
4316
|
+
{
|
|
4317
|
+
"name": "TabModel",
|
|
4318
|
+
"kind": "interface",
|
|
4319
|
+
"members": [
|
|
4320
|
+
{
|
|
4321
|
+
"name": "id",
|
|
4322
|
+
"value": "string"
|
|
4323
|
+
},
|
|
4324
|
+
{
|
|
4325
|
+
"name": "label",
|
|
4326
|
+
"value": "ReactNode"
|
|
4327
|
+
},
|
|
4328
|
+
{
|
|
4329
|
+
"name": "invalid?",
|
|
4330
|
+
"value": "boolean"
|
|
4331
|
+
},
|
|
4332
|
+
{
|
|
4333
|
+
"name": "warning?",
|
|
4334
|
+
"value": "boolean"
|
|
4335
|
+
},
|
|
4336
|
+
{
|
|
4337
|
+
"name": "disabled?",
|
|
4338
|
+
"value": "boolean"
|
|
4339
|
+
}
|
|
4340
|
+
],
|
|
4341
|
+
"sourceFile": "models/tab.ts"
|
|
4342
|
+
},
|
|
4343
|
+
{
|
|
4344
|
+
"name": "DropdownItem",
|
|
4345
|
+
"kind": "interface",
|
|
4346
|
+
"members": [
|
|
4347
|
+
{
|
|
4348
|
+
"name": "key",
|
|
4349
|
+
"value": "string"
|
|
4350
|
+
},
|
|
4351
|
+
{
|
|
4352
|
+
"name": "label?",
|
|
4353
|
+
"value": "ReactNode"
|
|
4354
|
+
},
|
|
4355
|
+
{
|
|
4356
|
+
"name": "icon?",
|
|
4357
|
+
"value": "ReactNode"
|
|
4358
|
+
},
|
|
4359
|
+
{
|
|
4360
|
+
"name": "disabled?",
|
|
4361
|
+
"value": "boolean"
|
|
4362
|
+
},
|
|
4363
|
+
{
|
|
4364
|
+
"name": "danger?",
|
|
4365
|
+
"value": "boolean"
|
|
4366
|
+
},
|
|
4367
|
+
{
|
|
4368
|
+
"name": "type?",
|
|
4369
|
+
"value": "DropdownItemType"
|
|
4370
|
+
},
|
|
4371
|
+
{
|
|
4372
|
+
"name": "className?",
|
|
4373
|
+
"value": "string"
|
|
4374
|
+
},
|
|
4375
|
+
{
|
|
4376
|
+
"name": "onClick?",
|
|
4377
|
+
"value": "(info: { key: string; domEvent: MouseEvent }) => void"
|
|
4378
|
+
}
|
|
4379
|
+
],
|
|
4380
|
+
"sourceFile": "models/dropdown.ts"
|
|
4381
|
+
},
|
|
4382
|
+
{
|
|
4383
|
+
"name": "DialModifiedEntity",
|
|
4384
|
+
"kind": "interface",
|
|
4385
|
+
"members": [
|
|
4386
|
+
{
|
|
4387
|
+
"name": "createdAt?",
|
|
4388
|
+
"value": "string"
|
|
4389
|
+
},
|
|
4390
|
+
{
|
|
4391
|
+
"name": "updatedAt?",
|
|
4392
|
+
"value": "string"
|
|
4393
|
+
}
|
|
4394
|
+
],
|
|
4395
|
+
"sourceFile": "models/base-entity.ts"
|
|
4396
|
+
},
|
|
4397
|
+
{
|
|
4398
|
+
"name": "DialFile",
|
|
4399
|
+
"kind": "interface",
|
|
4400
|
+
"members": [
|
|
4401
|
+
{
|
|
4402
|
+
"name": "bucket?",
|
|
4403
|
+
"value": "string"
|
|
4404
|
+
},
|
|
4405
|
+
{
|
|
4406
|
+
"name": "contentLength?",
|
|
4407
|
+
"value": "number"
|
|
4408
|
+
},
|
|
4409
|
+
{
|
|
4410
|
+
"name": "contentType?",
|
|
4411
|
+
"value": "string"
|
|
4412
|
+
},
|
|
4413
|
+
{
|
|
4414
|
+
"name": "nodeType",
|
|
4415
|
+
"value": "DialFileNodeType"
|
|
4416
|
+
},
|
|
4417
|
+
{
|
|
4418
|
+
"name": "parentPath?",
|
|
4419
|
+
"value": "string | null"
|
|
4420
|
+
},
|
|
4421
|
+
{
|
|
4422
|
+
"name": "resourceType?",
|
|
4423
|
+
"value": "DialFileResourceType"
|
|
4424
|
+
},
|
|
4425
|
+
{
|
|
4426
|
+
"name": "url?",
|
|
4427
|
+
"value": "string"
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
"name": "items?",
|
|
4431
|
+
"value": "DialFile[]"
|
|
4432
|
+
},
|
|
4433
|
+
{
|
|
4434
|
+
"name": "path",
|
|
4435
|
+
"value": "string"
|
|
4436
|
+
},
|
|
4437
|
+
{
|
|
4438
|
+
"name": "name",
|
|
4439
|
+
"value": "string"
|
|
4440
|
+
},
|
|
4441
|
+
{
|
|
4442
|
+
"name": "folderId",
|
|
4443
|
+
"value": "string"
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"name": "owner?",
|
|
4447
|
+
"value": "string"
|
|
4448
|
+
},
|
|
4449
|
+
{
|
|
4450
|
+
"name": "author?",
|
|
4451
|
+
"value": "string"
|
|
4452
|
+
},
|
|
4453
|
+
{
|
|
4454
|
+
"name": "nextToken?",
|
|
4455
|
+
"value": "string"
|
|
4456
|
+
},
|
|
4457
|
+
{
|
|
4458
|
+
"name": "extension?",
|
|
4459
|
+
"value": "string"
|
|
4460
|
+
},
|
|
4461
|
+
{
|
|
4462
|
+
"name": "id?",
|
|
4463
|
+
"value": "string"
|
|
4464
|
+
},
|
|
4465
|
+
{
|
|
4466
|
+
"name": "permissions?",
|
|
4467
|
+
"value": "DialFilePermission[]"
|
|
4468
|
+
}
|
|
4469
|
+
],
|
|
4470
|
+
"sourceFile": "models/file.ts"
|
|
4471
|
+
},
|
|
4472
|
+
{
|
|
4473
|
+
"name": "DialFileNodeType",
|
|
4474
|
+
"kind": "enum",
|
|
4475
|
+
"members": [
|
|
4476
|
+
{
|
|
4477
|
+
"name": "ITEM",
|
|
4478
|
+
"value": "'item'"
|
|
4479
|
+
},
|
|
4480
|
+
{
|
|
4481
|
+
"name": "FOLDER",
|
|
4482
|
+
"value": "'folder'"
|
|
4483
|
+
}
|
|
4484
|
+
],
|
|
4485
|
+
"sourceFile": "models/file.ts"
|
|
4486
|
+
},
|
|
4487
|
+
{
|
|
4488
|
+
"name": "DialFilePermission",
|
|
4489
|
+
"kind": "enum",
|
|
4490
|
+
"members": [
|
|
4491
|
+
{
|
|
4492
|
+
"name": "READ",
|
|
4493
|
+
"value": "'READ'"
|
|
4494
|
+
},
|
|
4495
|
+
{
|
|
4496
|
+
"name": "WRITE",
|
|
4497
|
+
"value": "'WRITE'"
|
|
4498
|
+
},
|
|
4499
|
+
{
|
|
4500
|
+
"name": "SHARE",
|
|
4501
|
+
"value": "'SHARE'"
|
|
4502
|
+
}
|
|
4503
|
+
],
|
|
4504
|
+
"sourceFile": "models/file.ts"
|
|
4505
|
+
},
|
|
4506
|
+
{
|
|
4507
|
+
"name": "DialFileResourceType",
|
|
4508
|
+
"kind": "enum",
|
|
4509
|
+
"members": [
|
|
4510
|
+
{
|
|
4511
|
+
"name": "FILE",
|
|
4512
|
+
"value": "'FILE'"
|
|
4513
|
+
},
|
|
4514
|
+
{
|
|
4515
|
+
"name": "PROMPT",
|
|
4516
|
+
"value": "'PROMPT'"
|
|
4517
|
+
},
|
|
4518
|
+
{
|
|
4519
|
+
"name": "CONVERSATION",
|
|
4520
|
+
"value": "'CONVERSATION'"
|
|
4521
|
+
},
|
|
4522
|
+
{
|
|
4523
|
+
"name": "APPLICATION",
|
|
4524
|
+
"value": "'APPLICATION'"
|
|
4525
|
+
},
|
|
4526
|
+
{
|
|
4527
|
+
"name": "TOOLSET",
|
|
4528
|
+
"value": "'TOOL_SET'"
|
|
4529
|
+
}
|
|
4530
|
+
],
|
|
4531
|
+
"sourceFile": "models/file.ts"
|
|
4532
|
+
},
|
|
4533
|
+
{
|
|
4534
|
+
"name": "DialCopiedItem",
|
|
4535
|
+
"kind": "interface",
|
|
4536
|
+
"members": [
|
|
4537
|
+
{
|
|
4538
|
+
"name": "sourceUrl",
|
|
4539
|
+
"value": "string"
|
|
4540
|
+
},
|
|
4541
|
+
{
|
|
4542
|
+
"name": "destinationUrl",
|
|
4543
|
+
"value": "string"
|
|
4544
|
+
},
|
|
4545
|
+
{
|
|
4546
|
+
"name": "overwrite?",
|
|
4547
|
+
"value": "boolean"
|
|
4548
|
+
},
|
|
4549
|
+
{
|
|
4550
|
+
"name": "nodeType",
|
|
4551
|
+
"value": "DialFileNodeType"
|
|
4552
|
+
}
|
|
4553
|
+
],
|
|
4554
|
+
"sourceFile": "models/file-manager.ts"
|
|
4555
|
+
},
|
|
4556
|
+
{
|
|
4557
|
+
"name": "DialDeletedItem",
|
|
4558
|
+
"kind": "interface",
|
|
4559
|
+
"members": [
|
|
4560
|
+
{
|
|
4561
|
+
"name": "sourceUrl",
|
|
4562
|
+
"value": "string"
|
|
4563
|
+
},
|
|
4564
|
+
{
|
|
4565
|
+
"name": "nodeType",
|
|
4566
|
+
"value": "DialFileNodeType"
|
|
4567
|
+
}
|
|
4568
|
+
],
|
|
4569
|
+
"sourceFile": "models/file-manager.ts"
|
|
4570
|
+
},
|
|
4571
|
+
{
|
|
4572
|
+
"name": "DialUploadFileItem",
|
|
4573
|
+
"kind": "interface",
|
|
4574
|
+
"members": [
|
|
4575
|
+
{
|
|
4576
|
+
"name": "fileContent",
|
|
4577
|
+
"value": "File"
|
|
4578
|
+
},
|
|
4579
|
+
{
|
|
4580
|
+
"name": "name",
|
|
4581
|
+
"value": "string"
|
|
4582
|
+
}
|
|
4583
|
+
],
|
|
4584
|
+
"sourceFile": "models/file-manager.ts"
|
|
4585
|
+
},
|
|
4586
|
+
{
|
|
4587
|
+
"name": "DialFileManagerActionsRef",
|
|
4588
|
+
"kind": "interface",
|
|
4589
|
+
"members": [
|
|
4590
|
+
{
|
|
4591
|
+
"name": "createFolder",
|
|
4592
|
+
"value": "() => void"
|
|
4593
|
+
}
|
|
4594
|
+
],
|
|
4595
|
+
"sourceFile": "models/file-manager.ts"
|
|
4596
|
+
},
|
|
4597
|
+
{
|
|
4598
|
+
"name": "DialFileAcceptType",
|
|
4599
|
+
"kind": "type",
|
|
4600
|
+
"sourceFile": "models/file-manager.ts",
|
|
4601
|
+
"typeBody": "| `${string}/${string}` // MIME (wildcard)\n | `.${string}`"
|
|
4602
|
+
},
|
|
4603
|
+
{
|
|
4604
|
+
"name": "GridSelectionMode",
|
|
4605
|
+
"kind": "enum",
|
|
4606
|
+
"members": [
|
|
4607
|
+
{
|
|
4608
|
+
"name": "MULTIPLE",
|
|
4609
|
+
"value": "'MULTIPLE'"
|
|
4610
|
+
},
|
|
4611
|
+
{
|
|
4612
|
+
"name": "SINGLE",
|
|
4613
|
+
"value": "'SINGLE'"
|
|
4614
|
+
}
|
|
4615
|
+
],
|
|
4616
|
+
"sourceFile": "models/selection-mode.ts"
|
|
4617
|
+
}
|
|
4618
|
+
],
|
|
4619
|
+
"hooks": [
|
|
4620
|
+
{
|
|
4621
|
+
"name": "useDialFileManagerTabs",
|
|
4622
|
+
"sourceFile": "components/FileManager/hooks/use-file-manager-tabs.tsx",
|
|
4623
|
+
"signature": "(tabLabels?: Record<DialFileManagerTabs, string>, initialTab: DialFileManagerTabs = DialFileManagerTabs.MyFiles) => unknown"
|
|
4624
|
+
},
|
|
4625
|
+
{
|
|
4626
|
+
"name": "useEditableItem",
|
|
4627
|
+
"sourceFile": "hooks/use-editable-item.tsx",
|
|
4628
|
+
"description": "A React hook that manages the behavior of an inline-editable text input.\nIt provides validation handling, cancel/restore logic, auto-focus behavior,\nkeyboard shortcuts, and outside-click detection.",
|
|
4629
|
+
"signature": "function useEditableItem({\n value: initialValue,\n isEditing,\n restoreOnCancel = true,\n onValidate,\n onSave,\n onCancel,\n}: UseEditableItemOptions): UseEditableItemResult"
|
|
4630
|
+
},
|
|
4631
|
+
{
|
|
4632
|
+
"name": "FileManagerProvider",
|
|
4633
|
+
"sourceFile": "components/FileManager/FileManagerProvider.tsx",
|
|
4634
|
+
"description": "Provider that encapsulates all File Manager business logic:\n- path & navigation\n- search (controlled + uncontrolled)\n- hidden files toggle\n- tree collapsed state\n- selection\n- clipboard (copy / cut / paste)\n- delete confirmation state\n- computed grid rows\n- new actions",
|
|
4635
|
+
"signature": "FileManagerProvider: FC<FileManagerProviderProps>"
|
|
4636
|
+
},
|
|
4637
|
+
{
|
|
4638
|
+
"name": "useFileManagerContext",
|
|
4639
|
+
"sourceFile": "components/FileManager/hooks/use-file-manager-context.ts",
|
|
4640
|
+
"description": "Hook to read the File Manager context.\nThrows if used outside of the provider.",
|
|
4641
|
+
"signature": "() => unknown"
|
|
4642
|
+
}
|
|
4643
|
+
],
|
|
4644
|
+
"utils": [
|
|
4645
|
+
{
|
|
4646
|
+
"name": "mergeClasses",
|
|
4647
|
+
"sourceFile": "utils/merge-classes.ts",
|
|
4648
|
+
"description": "Merge class names (classnames → tailwind-merge).",
|
|
4649
|
+
"signature": "function mergeClasses(...inputs: Parameters<typeof classNames>): string"
|
|
4650
|
+
},
|
|
4651
|
+
{
|
|
4652
|
+
"name": "wrapInRootFolder",
|
|
4653
|
+
"sourceFile": "utils/flat-to-hierarchy-convertor.ts",
|
|
4654
|
+
"description": "Helper to create a root folder wrapping flat items.\nUseful when you want the entire tree to be nested under a single root.",
|
|
4655
|
+
"signature": "function wrapInRootFolder(flatItems: FlatFileItem[], rootName = 'Prompts', rootPath = 'prompts/public/', rootFolderId = 'root'): DialFile[]"
|
|
4656
|
+
}
|
|
4657
|
+
],
|
|
4658
|
+
"constants": [
|
|
4659
|
+
{
|
|
4660
|
+
"name": "NAME_COLUMN",
|
|
4661
|
+
"sourceFile": "constants/file-grid-columns.tsx",
|
|
4662
|
+
"signature": "(headerName: string) => unknown"
|
|
4663
|
+
},
|
|
4664
|
+
{
|
|
4665
|
+
"name": "SIZE_COLUMN",
|
|
4666
|
+
"sourceFile": "constants/file-grid-columns.tsx",
|
|
4667
|
+
"signature": "(headerName: string) => ColDef"
|
|
4668
|
+
},
|
|
4669
|
+
{
|
|
4670
|
+
"name": "UPDATED_AT_COLUMN",
|
|
4671
|
+
"sourceFile": "constants/file-grid-columns.tsx",
|
|
4672
|
+
"signature": "(headerName: string) => unknown"
|
|
4673
|
+
},
|
|
4674
|
+
{
|
|
4675
|
+
"name": "DIAL_ICON_SIZE",
|
|
4676
|
+
"sourceFile": "constants/icon.ts",
|
|
4677
|
+
"signature": "enum DIAL_ICON_SIZE { LG = 24, MD = 20, SM = 16 }"
|
|
4678
|
+
},
|
|
4679
|
+
{
|
|
4680
|
+
"name": "BASE_ICON_PROPS",
|
|
4681
|
+
"sourceFile": "constants/icon.ts",
|
|
4682
|
+
"signature": "BASE_ICON_PROPS = {\n size: BASE_ICON_SIZE,\n stroke: 2,\n}"
|
|
4683
|
+
},
|
|
4684
|
+
{
|
|
4685
|
+
"name": "BASE_ICON_SIZE",
|
|
4686
|
+
"sourceFile": "constants/icon.ts",
|
|
4687
|
+
"signature": "BASE_ICON_SIZE = 18"
|
|
4688
|
+
},
|
|
4689
|
+
{
|
|
4690
|
+
"name": "NOT_ALLOWED_SYMBOLS",
|
|
4691
|
+
"sourceFile": "constants/validation.ts",
|
|
4692
|
+
"signature": "NOT_ALLOWED_SYMBOLS = ':;,=/{}%&\\\\\"'"
|
|
4693
|
+
},
|
|
4694
|
+
{
|
|
4695
|
+
"name": "NOT_ALLOWED_SPACES",
|
|
4696
|
+
"sourceFile": "constants/validation.ts",
|
|
4697
|
+
"signature": "NOT_ALLOWED_SPACES = '(\\r\\n|\\n|\\r|\\t)|[\\x00-\\x1F]'"
|
|
4698
|
+
},
|
|
4699
|
+
{
|
|
4700
|
+
"name": "NOT_ALLOWED_SYMBOLS_REGEXP",
|
|
4701
|
+
"sourceFile": "constants/validation.ts",
|
|
4702
|
+
"signature": "NOT_ALLOWED_SYMBOLS_REGEXP = new RegExp(\n `${NOT_ALLOWED_SYMBOLS_CHARACTER_CLASS}|${NOT_ALLOWED_SPACES}`,\n)"
|
|
4703
|
+
},
|
|
4704
|
+
{
|
|
4705
|
+
"name": "NOT_ALLOWED_SPACES_REGEXP",
|
|
4706
|
+
"sourceFile": "constants/validation.ts",
|
|
4707
|
+
"signature": "NOT_ALLOWED_SPACES_REGEXP = new RegExp(NOT_ALLOWED_SPACES)"
|
|
4708
|
+
},
|
|
4709
|
+
{
|
|
4710
|
+
"name": "DialSchemeRenderer",
|
|
4711
|
+
"sourceFile": "components/SchemeRenderer/SchemeRenderer.tsx",
|
|
4712
|
+
"description": "Renders a JSON Schema as a form UI with collapsible sections, validation, and default values.\naliases: SchemaRenderer|JsonSchemaForm",
|
|
4713
|
+
"signature": "DialSchemeRenderer: FC<DialSchemeRendererProps>"
|
|
4714
|
+
},
|
|
4715
|
+
{
|
|
4716
|
+
"name": "DialSchemeRendererProps",
|
|
4717
|
+
"sourceFile": "components/SchemeRenderer/types.ts"
|
|
4718
|
+
},
|
|
4719
|
+
{
|
|
4720
|
+
"name": "JsonSchema",
|
|
4721
|
+
"sourceFile": "components/SchemeRenderer/types.ts"
|
|
4722
|
+
},
|
|
4723
|
+
{
|
|
4724
|
+
"name": "JsonSchemaDef",
|
|
4725
|
+
"sourceFile": "components/SchemeRenderer/types.ts"
|
|
4726
|
+
},
|
|
4727
|
+
{
|
|
4728
|
+
"name": "ValidationError",
|
|
4729
|
+
"sourceFile": "components/SchemeRenderer/types.ts"
|
|
4730
|
+
}
|
|
4731
|
+
]
|
|
4732
|
+
}
|