@epam/ai-dial-ui-kit 0.13.0-dev.40 → 0.13.0-dev.43
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 +3 -0
- package/dist/CHANGELOG.md +8 -0
- package/dist/{JsonEditor-BEJaiIby.js → JsonEditor-4-qZCNDm.js} +1 -1
- package/dist/{JsonEditor-Buuy0b39.cjs → JsonEditor-xygieb6H.cjs} +1 -1
- package/dist/{MarkdownEditor-CyL_NTT9.cjs → MarkdownEditor-C-hCTUCX.cjs} +1 -1
- package/dist/MarkdownEditor-CLQJUjhx.js +75 -0
- package/dist/MarkdownEditor-Ckw8Z46X.cjs +1 -0
- package/dist/{MarkdownEditor-DID4gX3X.js → MarkdownEditor-DQj20dnS.js} +1 -1
- package/dist/components-manifest.json +2602 -407
- package/dist/dial-ui-kit.cjs.js +1 -1
- package/dist/dial-ui-kit.es.js +187 -178
- package/dist/{index-B9VwNsnG.cjs → index-Bo9jrbul.cjs} +31 -31
- package/dist/{index-orz_ei2U.js → index-Cs-3n-3R.js} +20588 -19454
- package/dist/index.css +2 -2
- package/dist/mcp-server.cjs +29 -9
- package/dist/src/components/New/CloseButton/CloseButton.d.ts +32 -0
- package/dist/src/components/New/ConfirmationPopup/ConfirmationPopup.d.ts +54 -0
- package/dist/src/components/New/ConfirmationPopup/constants.d.ts +14 -0
- package/dist/src/components/New/Dropdown/Dropdown.d.ts +86 -0
- package/dist/src/components/New/Dropdown/DropdownSubMenuItem.d.ts +8 -0
- package/dist/src/components/New/Dropdown/constants.d.ts +9 -0
- package/dist/src/components/New/InfoButton/InfoButton.stories.d.ts +0 -5
- package/dist/src/components/New/Input/Input.d.ts +9 -0
- package/dist/src/components/New/MarkdownEditor/MarkdownEditor.d.ts +32 -0
- package/dist/src/components/New/MarkdownEditor/constants.d.ts +15 -0
- package/dist/src/components/New/NumberInput/NumberInput.d.ts +35 -0
- package/dist/src/components/New/PasswordInput/PasswordInput.d.ts +32 -0
- package/dist/src/components/New/Popup/Popup.d.ts +68 -0
- package/dist/src/components/New/Popup/constants.d.ts +10 -0
- package/dist/src/components/New/Select/MultiSelectTags.d.ts +16 -0
- package/dist/src/components/New/Select/Select.d.ts +109 -0
- package/dist/src/components/New/Select/SelectSubMenuItem.d.ts +8 -0
- package/dist/src/components/New/Select/constants.d.ts +32 -0
- package/dist/src/components/New/constants/overlay.d.ts +24 -0
- package/dist/src/components/Skeleton/Skeleton.d.ts +18 -18
- package/dist/src/components/Skeleton/utils.d.ts +2 -2
- package/dist/src/index.d.ts +20 -2
- package/dist/src/mcp/types.d.ts +12 -0
- package/dist/src/types/skeleton.d.ts +3 -3
- package/dist/src/utils/sub-menu-floating.d.ts +7 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.13.0-dev.
|
|
3
|
-
"generatedAt": "2026-08-
|
|
2
|
+
"version": "0.13.0-dev.43",
|
|
3
|
+
"generatedAt": "2026-08-07T22:49:11.676Z",
|
|
4
4
|
"kit": {
|
|
5
5
|
"name": "@epam/ai-dial-ui-kit",
|
|
6
6
|
"description": "A modern UI kit for building AI DIAL interfaces with React",
|
|
@@ -23,41 +23,2295 @@
|
|
|
23
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-body-paragraph-text` | normal | 16px / 26px |\n| `.dial-body-paragraph-semi-text` | semibold | 16px / 26px |\n| `.dial-small-text` | normal | 14px / 20px |\n| `.dial-small-semi-text` | semibold | 14px / 20px |\n| `.dial-small-paragraph-text` | normal | 14px / 24px |\n| `.dial-small-paragraph-semi-text` | semibold | 14px / 24px |\n| `.dial-tiny-text` | normal | 12px / 16px |\n| `.dial-tiny-lead-text` | normal | 12px / 16px (+0.03em) |\n| `.dial-tiny-semi-text` | semibold | 12px / 16px |\n| `.dial-caption-text` | normal | 10px / 12px |\n| `.dial-caption-semi-text` | semibold | 10px / 12px (+0.06em) |\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
24
|
"theming": "# Theming & CSS Variable Tokens\n\nAI DIAL UI Kit uses CSS custom properties (variables) for theming.\nDark and light themes are switched by setting different values for these variables on `:root` or a theme wrapper element.\n\n## Usage in Tailwind\n\nThe Tailwind config maps CSS variables to utility classes.\nUse these classes in your components:\n\n```tsx\n// Backgrounds\n<div className=\"bg-layer-0\" /> // darkest background\n<div className=\"bg-layer-1\" /> // main content area\n<div className=\"bg-layer-2\" /> // elevated panels\n\n// Text\n<span className=\"text-primary\" /> // main text color\n<span className=\"text-secondary\" /> // muted text\n<span className=\"text-error\" /> // error state\n\n// Borders\n<div className=\"border border-primary\" /> // standard border\n<div className=\"border border-error\" /> // error border\n```\n\n## Override CSS Variables\n\n```css\n:root {\n --bg-layer-0: #000000;\n --bg-layer-1: #0c101d;\n --bg-layer-2: #161b2d;\n --bg-layer-3: #1d2439;\n --text-primary: #eef1f7;\n --text-secondary: #9fa6bd;\n --text-error: #f76464;\n --stroke-primary: #696e7c;\n --controls-bg-accent-primary: #3664e2;\n /* ... see tailwind.config.js for full list */\n}\n```\n\n## Token Reference\n\n\n### backgroundsColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-sunken` | `var(--bg-layer-sunken)` | `#EEF1F7` |\n| `layer-base` | `var(--bg-layer-base)` | `#F5F7FA` |\n| `layer-raised` | `var(--bg-layer-raised)` | `#FCFCFC` |\n\n### controlsBgColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `control-accent-alpha` | `var(--bg-control-accent-alpha)` | `#2764D90F` |\n| `control-accent-alpha-hover` | `var(--bg-control-accent-alpha-hover)` | `#2764D924` |\n| `control-accent-alpha-active` | `var(--bg-control-accent-alpha-active)` | `#2764D933` |\n| `control-accent` | `var(--bg-control-accent)` | `#124ACE` |\n| `control-neutral` | `var(--bg-control-neutral)` | `#FCFCFC` |\n| `control-neutral-hover` | `var(--bg-control-neutral-hover)` | `#E0E6F0` |\n| `control-neutral-active` | `var(--bg-control-neutral-active)` | `#D1DBEA` |\n| `control-error` | `var(--bg-control-error)` | `#AE2F2F` |\n| `control-error-hover` | `var(--bg-control-error-hover)` | `#BF3939` |\n| `control-error-active` | `var(--bg-control-error-active)` | `#CC4545` |\n| `control-error-alpha-hover` | `var(--bg-control-error-alpha-hover)` | `#F764641A` |\n| `control-error-alpha-active` | `var(--bg-control-error-alpha-active)` | `#F7646433` |\n| `control-disable` | `var(--bg-control-disable)` | `#848E9C` |\n\n### borderColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `hover-alpha` | `var(--stroke-hover-alpha)` | `#2764D933` |\n| `focus-black` | `var(--stroke-focus-black)` | `#161B2D` |\n| `focus-blue` | `var(--stroke-focus-blue)` | `#6785FB` |\n| `accent-alpha` | `var(--stroke-accent-alpha)` | `#2764D933` |\n| `error-alpha` | `var(--stroke-error-alpha)` | `#AE2F2F73` |\n\n### textColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `warning-icon` | `var(--text-warning-icon)` | `#EEC840` |\n\n### controlsTextColors\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `control-permanent` | `var(--text-control-permanent)` | `#FCFCFC` |\n| `control-disable-alpha` | `var(--text-control-disable-alpha)` | `#DCE0E8` |\n| `control-disable-beta` | `var(--text-control-disable-beta)` | `#848E9C` |\n| `control-blue-hover` | `var(--text-control-blue-hover)` | `#5976E9` |\n| `control-blue-active` | `var(--text-control-blue-active)` | `#6785FB` |\n\n### backgroundsColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `layer-0` | `var(--bg-layer-0)` | `#FCFCFC` |\n| `layer-1` | `var(--bg-layer-1)` | `#E0E6F0` |\n| `layer-2` | `var(--bg-layer-2)` | `#EEF1F7` |\n| `layer-3` | `var(--bg-layer-3)` | `#FCFCFC` |\n| `layer-4` | `var(--bg-layer-4)` | `#D1DBEA` |\n| `accent-primary-alpha` | `var(--bg-accent-primary-alpha)` | `#7DA4FF26` |\n| `accent-secondary-alpha` | `var(--bg-accent-secondary-alpha)` | `#37BABC2E` |\n| `accent-tertiary-alpha` | `var(--bg-accent-tertiary-alpha)` | `#A972FF2E` |\n| `accent-primary` | `var(--bg-accent-primary)` | `#5C8DEA` |\n| `accent-secondary` | `var(--bg-accent-secondary)` | `#37BABC` |\n| `red-400` | `var(--bg-red-400)` | `#F76464` |\n| `controls-accent-primary` | `var(--controls-bg-accent-primary)` | `#124ACE` |\n| `controls-accent-primary-hover` | `var(--controls-bg-accent-primary-hover)` | `#2656D9` |\n| `controls-accent-primary-active` | `var(--controls-bg-accent-primary-active)` | `#3664E2` |\n| `controls-accent-primary-alpha-active` | `var(--controls-bg-accent-primary-alpha-active)` | `#7DA4FF5C` |\n| `controls-accent-secondary-alpha-active` | `var(--controls-bg-accent-secondary-alpha-active)` | `#37BABC5C` |\n| `controls-accent-tertiary-alpha-active` | `var(--controls-bg-accent-tertiary-alpha-active)` | `#A972FF5C` |\n| `controls-error` | `var(--controls-bg-error)` | `#AE2F2F` |\n| `controls-error-hover` | `var(--controls-bg-error-hover)` | `#BF3939` |\n| `controls-error-active` | `var(--controls-bg-error-active)` | `#CC4545` |\n| `controls-error-alpha-active` | `var(--controls-bg-error-alpha-active)` | `#F764645C` |\n| `controls-disable-accent` | `var(--controls-bg-disable-accent)` | `#7C8293` |\n| `controls-disable` | `var(--controls-bg-disable)` | `#D1DBEA` |\n| `controls-neutral-hover` | `var(--controls-bg-neutral-hover)` | `#D1DBEA` |\n| `controls-neutral-active` | `var(--controls-bg-neutral-active)` | `#9FA6BD` |\n| `controls-accent-success-alpha-hover` | `var(--controls-bg-accent-success-alpha-hover)` | `#37BABC2E` |\n| `controls-accent-success-alpha-active` | `var(--controls-bg-accent-success-alpha-active)` | `#37BABC5C` |\n| `controls-enable-primary` | `var(--controls-enable-primary)` | `#FCFCFC` |\n\n### borderColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--stroke-accent-primary)` | `#124ACE` |\n| `accent-secondary` | `var(--stroke-accent-secondary)` | `#007274` |\n| `controls-accent` | `var(--controls-bg-accent)` | `#5C8DEA` |\n| `red-900` | `var(--red-900)` | `#402027` |\n\n### textColorsToRemove\n| Tailwind class suffix | CSS variable | Default value |\n|---|---|---|\n| `accent-primary` | `var(--text-accent-primary)` | `#7DA4FF` |\n| `accent-secondary` | `var(--text-accent-secondary)` | `#37BABC` |\n| `accent-tertiary` | `var(--text-accent-tertiary)` | `#A972FF` |\n| `controls-permanent` | `var(--controls-text-permanent)` | `#FCFCFC` |\n| `controls-accent-disable` | `var(--controls-text-accent-disable)` | `#D1DBEA` |\n| `controls-primary-disable` | `var(--controls-text-primary-disable)` | `#696E7C` |\n| `controls-secondary-disable` | `var(--controls-text-secondary-disable)` | `#9FA6BD` |\n| `controls-neutral` | `var(--controls-text-neutral)` | `#161B2D` |\n| `controls-accent-primary-hover` | `var(--controls-text-accent-primary-hover)` | `#3664E2` |\n| `controls-accent-primary-active` | `var(--controls-text-accent-primary-active)` | `#7DA4FF` |",
|
|
25
25
|
"components": [
|
|
26
|
+
{
|
|
27
|
+
"name": "Spinner",
|
|
28
|
+
"category": "Components_2_0",
|
|
29
|
+
"generation": "2.0",
|
|
30
|
+
"description": "",
|
|
31
|
+
"props": [
|
|
32
|
+
{
|
|
33
|
+
"name": "size",
|
|
34
|
+
"type": "number",
|
|
35
|
+
"required": false,
|
|
36
|
+
"defaultValue": "40"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "className",
|
|
40
|
+
"type": "string",
|
|
41
|
+
"required": false
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "fullWidth",
|
|
45
|
+
"type": "boolean",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": "false"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "ariaLabel",
|
|
51
|
+
"type": "string",
|
|
52
|
+
"required": false,
|
|
53
|
+
"defaultValue": "'Loading'"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"examples": [],
|
|
57
|
+
"sourceFile": "components/Spinner/Spinner.tsx"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "Skeleton",
|
|
61
|
+
"category": "Components_2_0",
|
|
62
|
+
"generation": "2.0",
|
|
63
|
+
"description": "Skeleton\naliases: PlaceholderUI|ShimmerLoader\n\nA placeholder component to show while content is loading.\nProvides various skeleton shapes and configurations.",
|
|
64
|
+
"props": [
|
|
65
|
+
{
|
|
66
|
+
"name": "active",
|
|
67
|
+
"type": "boolean",
|
|
68
|
+
"required": false,
|
|
69
|
+
"defaultValue": "true",
|
|
70
|
+
"description": "Whether to show the loading animation"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "paragraph",
|
|
74
|
+
"type": "boolean | { rows?: number; width?: string | string[] }",
|
|
75
|
+
"required": false,
|
|
76
|
+
"defaultValue": "true",
|
|
77
|
+
"description": "Show paragraph placeholder or configure its appearance"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"name": "avatar",
|
|
81
|
+
"type": "| boolean\n | {\n size?: number | SkeletonAvatarSize;\n shape?: SkeletonAvatarShape;\n }",
|
|
82
|
+
"required": false,
|
|
83
|
+
"defaultValue": "false",
|
|
84
|
+
"description": "Show avatar placeholder or configure its appearance"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "showTitle",
|
|
88
|
+
"type": "boolean | { width?: string }",
|
|
89
|
+
"required": false,
|
|
90
|
+
"defaultValue": "true",
|
|
91
|
+
"description": "Show title placeholder or configure its appearance"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "loading",
|
|
95
|
+
"type": "boolean",
|
|
96
|
+
"required": false,
|
|
97
|
+
"defaultValue": "true",
|
|
98
|
+
"description": "Display the skeleton when true"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "children",
|
|
102
|
+
"type": "ReactNode",
|
|
103
|
+
"required": false,
|
|
104
|
+
"description": "Content to be displayed when loading is false"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "variant",
|
|
108
|
+
"type": "SkeletonVariant",
|
|
109
|
+
"required": false,
|
|
110
|
+
"defaultValue": "SkeletonVariant.Default",
|
|
111
|
+
"description": "Skeleton variant"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "width",
|
|
115
|
+
"type": "string | number",
|
|
116
|
+
"required": false,
|
|
117
|
+
"description": "Width of the skeleton"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "height",
|
|
121
|
+
"type": "string | number",
|
|
122
|
+
"required": false,
|
|
123
|
+
"description": "Height of the skeleton"
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
"name": "overlay",
|
|
127
|
+
"type": "ReactNode",
|
|
128
|
+
"required": false,
|
|
129
|
+
"description": "Content to overlay on top of the skeleton (e.g., a spinner)"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"name": "color",
|
|
133
|
+
"type": "string",
|
|
134
|
+
"required": false,
|
|
135
|
+
"description": "Custom background color for the skeleton elements (overrides the default token)"
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"examples": [
|
|
139
|
+
"// Simple skeleton\n<Skeleton />\n\n// Text skeleton with custom size\n<Skeleton variant={SkeletonVariant.Text} width=\"200px\" height=\"20px\" />\n\n// Circular avatar skeleton\n<Skeleton variant={SkeletonVariant.Circular} width={40} height={40} />\n\n// Complex skeleton with avatar, showTitle and paragraph\n<Skeleton\n avatar\n showTitle\n paragraph={{ rows: 3 }}\n active\n/>\n\n// Conditional loading\n<Skeleton loading={isLoading}>\n <div>Your content here</div>\n</Skeleton>\n\n// Custom paragraph widths\n<Skeleton\n paragraph={{ rows: 3, width: ['100%', '80%', '60%'] }}\n/>\n\n// Avatar with size and shape\n<Skeleton\n avatar={{\n size: SkeletonAvatarSize.Large,\n shape: SkeletonAvatarShape.Square\n }}\n/>"
|
|
140
|
+
],
|
|
141
|
+
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"name": "Notification",
|
|
145
|
+
"category": "Components_2_0",
|
|
146
|
+
"generation": "2.0",
|
|
147
|
+
"description": "A contextual feedback component for displaying important messages.\naliases: Notification\n\nRenders a colored container with an icon, message text, and an optional\nclose button.\n\nThe container is a live region whose politeness follows the variant: `error`\nand `warning` use `role=\"alert\"` (assertive, interrupts the screen reader),\nevery other variant uses `role=\"status\"` (polite, queues). Pass an explicit\n`role` to override — including for a notification that is static page content\nrather than an update.",
|
|
148
|
+
"props": [
|
|
149
|
+
{
|
|
150
|
+
"name": "variant",
|
|
151
|
+
"type": "NotificationVariant",
|
|
152
|
+
"required": false,
|
|
153
|
+
"defaultValue": "NotificationVariant.Info",
|
|
154
|
+
"description": "Defines the visual style and icon of the alert"
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "type",
|
|
158
|
+
"type": "NotificationType",
|
|
159
|
+
"required": false,
|
|
160
|
+
"defaultValue": "NotificationType.Toast",
|
|
161
|
+
"description": "Defines the type of notification, either a toast or a section message"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"name": "title",
|
|
165
|
+
"type": "ReactNode",
|
|
166
|
+
"required": false,
|
|
167
|
+
"description": "Optional heading displayed above the message in semibold"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "message",
|
|
171
|
+
"type": "ReactNode",
|
|
172
|
+
"required": true,
|
|
173
|
+
"description": "Message text to display inside the alert"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "closable",
|
|
177
|
+
"type": "boolean",
|
|
178
|
+
"required": false,
|
|
179
|
+
"defaultValue": "false",
|
|
180
|
+
"description": "Whether the alert has a close button"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "iconSize",
|
|
184
|
+
"type": "number",
|
|
185
|
+
"required": false,
|
|
186
|
+
"defaultValue": "24",
|
|
187
|
+
"description": "Size of the icon displayed in the alert"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"name": "iconStroke",
|
|
191
|
+
"type": "number",
|
|
192
|
+
"required": false,
|
|
193
|
+
"defaultValue": "2",
|
|
194
|
+
"description": "Stroke width of the icon displayed in the alert"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "textClassName",
|
|
198
|
+
"type": "string",
|
|
199
|
+
"required": false,
|
|
200
|
+
"description": "Additional CSS classes applied to the message text"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "onClose",
|
|
204
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
205
|
+
"required": false,
|
|
206
|
+
"description": "Callback fired when the close button is clicked"
|
|
207
|
+
}
|
|
208
|
+
],
|
|
209
|
+
"examples": [
|
|
210
|
+
"<Notification\n variant={NotificationVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<Notification\n variant={NotificationVariant.Success}\n title=\"Saved\"\n message=\"Changes saved successfully.\"\n/>\n\n<Notification\n variant={NotificationVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<Notification\n variant={NotificationVariant.Loading}\n title=\"Processing\"\n message=\"Please wait...\"\n/>"
|
|
211
|
+
],
|
|
212
|
+
"sourceFile": "components/New/Notification/Notification.tsx"
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "Highlight",
|
|
216
|
+
"category": "Components_2_0",
|
|
217
|
+
"generation": "2.0",
|
|
218
|
+
"description": "Renders text with the first occurrence of `query` wrapped in a highlight mark, with ellipsis truncation and a tooltip when overflowing.",
|
|
219
|
+
"props": [
|
|
220
|
+
{
|
|
221
|
+
"name": "text",
|
|
222
|
+
"type": "string",
|
|
223
|
+
"required": true
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "query",
|
|
227
|
+
"type": "string",
|
|
228
|
+
"required": true
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "markClassName",
|
|
232
|
+
"type": "string",
|
|
233
|
+
"required": false
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"name": "className",
|
|
237
|
+
"type": "string",
|
|
238
|
+
"required": false
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"name": "maxLines",
|
|
242
|
+
"type": "number",
|
|
243
|
+
"required": false,
|
|
244
|
+
"defaultValue": "2"
|
|
245
|
+
}
|
|
246
|
+
],
|
|
247
|
+
"examples": [],
|
|
248
|
+
"sourceFile": "components/New/Highlight/Highlight.tsx"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "CardShell",
|
|
252
|
+
"category": "Components_2_0",
|
|
253
|
+
"generation": "2.0",
|
|
254
|
+
"description": "A shared elevated card shell used as the base wrapper for browse-grid cards.\n\nRenders an `<article>` with rounded corners, padding, a resting shadow, and\na hover lift with a stronger shadow. Respects `prefers-reduced-motion` by\ndisabling the transform/shadow transition and hover lift.",
|
|
255
|
+
"props": [],
|
|
256
|
+
"examples": [],
|
|
257
|
+
"sourceFile": "components/New/CardShell/CardShell.tsx"
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"name": "ErrorMessageNotification",
|
|
261
|
+
"category": "Components_2_0",
|
|
262
|
+
"generation": "2.0",
|
|
263
|
+
"description": "",
|
|
264
|
+
"props": [],
|
|
265
|
+
"examples": [],
|
|
266
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "ErrorToastNotification",
|
|
270
|
+
"category": "Components_2_0",
|
|
271
|
+
"generation": "2.0",
|
|
272
|
+
"description": "",
|
|
273
|
+
"props": [],
|
|
274
|
+
"examples": [],
|
|
275
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"name": "InfoMessageNotification",
|
|
279
|
+
"category": "Components_2_0",
|
|
280
|
+
"generation": "2.0",
|
|
281
|
+
"description": "",
|
|
282
|
+
"props": [],
|
|
283
|
+
"examples": [],
|
|
284
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "InfoToastNotification",
|
|
288
|
+
"category": "Components_2_0",
|
|
289
|
+
"generation": "2.0",
|
|
290
|
+
"description": "",
|
|
291
|
+
"props": [],
|
|
292
|
+
"examples": [],
|
|
293
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "LoadingMessageNotification",
|
|
297
|
+
"category": "Components_2_0",
|
|
298
|
+
"generation": "2.0",
|
|
299
|
+
"description": "",
|
|
300
|
+
"props": [],
|
|
301
|
+
"examples": [],
|
|
302
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "LoadingToastNotification",
|
|
306
|
+
"category": "Components_2_0",
|
|
307
|
+
"generation": "2.0",
|
|
308
|
+
"description": "",
|
|
309
|
+
"props": [],
|
|
310
|
+
"examples": [],
|
|
311
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "SuccessMessageNotification",
|
|
315
|
+
"category": "Components_2_0",
|
|
316
|
+
"generation": "2.0",
|
|
317
|
+
"description": "",
|
|
318
|
+
"props": [],
|
|
319
|
+
"examples": [],
|
|
320
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "SuccessToastNotification",
|
|
324
|
+
"category": "Components_2_0",
|
|
325
|
+
"generation": "2.0",
|
|
326
|
+
"description": "",
|
|
327
|
+
"props": [],
|
|
328
|
+
"examples": [],
|
|
329
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "WarningMessageNotification",
|
|
333
|
+
"category": "Components_2_0",
|
|
334
|
+
"generation": "2.0",
|
|
335
|
+
"description": "",
|
|
336
|
+
"props": [],
|
|
337
|
+
"examples": [],
|
|
338
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"name": "WarningToastNotification",
|
|
342
|
+
"category": "Components_2_0",
|
|
343
|
+
"generation": "2.0",
|
|
344
|
+
"description": "",
|
|
345
|
+
"props": [],
|
|
346
|
+
"examples": [],
|
|
347
|
+
"sourceFile": "components/New/Notification/NotificationWrapper.tsx"
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"name": "Calendar",
|
|
351
|
+
"category": "Components_2_0",
|
|
352
|
+
"generation": "2.0",
|
|
353
|
+
"description": "A date/time picker supporting four selection modes.\naliases: DatePicker|DateTimePicker\n\nRenders a text-field trigger that opens a rounded month-grid popover for\nthe `date`/`datetime` modes, a masked `\"HH:mm\"` text field for `time`, and\na popover list of weekday names for `weekday`. Month/weekday names and\ndate formatting are localized via the `locale` prop.",
|
|
354
|
+
"props": [
|
|
355
|
+
{
|
|
356
|
+
"name": "mode",
|
|
357
|
+
"type": "CalendarMode",
|
|
358
|
+
"required": false,
|
|
359
|
+
"defaultValue": "CalendarMode.Date",
|
|
360
|
+
"description": "Selection mode: date, datetime, time or weekday"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "value",
|
|
364
|
+
"type": "CalendarValue",
|
|
365
|
+
"required": false,
|
|
366
|
+
"description": "Controlled value: a `Date` for date/datetime, an `\"HH:mm\"` string for time, an ISO weekday number (`\"1\"`=Monday…`\"7\"`=Sunday) for weekday"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "onChange",
|
|
370
|
+
"type": "(value: CalendarValue) => void",
|
|
371
|
+
"required": false,
|
|
372
|
+
"description": "Callback fired with the next value when the selection changes"
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "label",
|
|
376
|
+
"type": "string",
|
|
377
|
+
"required": false,
|
|
378
|
+
"description": "Optional label rendered above the control"
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "placeholder",
|
|
382
|
+
"type": "string",
|
|
383
|
+
"required": false,
|
|
384
|
+
"description": "Placeholder shown when there is no value; defaults to a mode-appropriate string (\"Select date\", \"Select date and time\", \"--:--\" or \"Select day\")"
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "disabled",
|
|
388
|
+
"type": "boolean",
|
|
389
|
+
"required": false,
|
|
390
|
+
"defaultValue": "false",
|
|
391
|
+
"description": "Disables the control"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"name": "invalid",
|
|
395
|
+
"type": "boolean",
|
|
396
|
+
"required": false,
|
|
397
|
+
"defaultValue": "false",
|
|
398
|
+
"description": "Applies error styling"
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "id",
|
|
402
|
+
"type": "string",
|
|
403
|
+
"required": false,
|
|
404
|
+
"description": "id applied to the control, linked to the label"
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "className",
|
|
408
|
+
"type": "string",
|
|
409
|
+
"required": false,
|
|
410
|
+
"description": "Additional CSS classes applied to the outer container"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "minDate",
|
|
414
|
+
"type": "Date",
|
|
415
|
+
"required": false,
|
|
416
|
+
"description": "Earliest selectable date (date/datetime modes)"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "maxDate",
|
|
420
|
+
"type": "Date",
|
|
421
|
+
"required": false,
|
|
422
|
+
"description": "Latest selectable date (date/datetime modes)"
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "locale",
|
|
426
|
+
"type": "string",
|
|
427
|
+
"required": false,
|
|
428
|
+
"defaultValue": "DEFAULT_CALENDAR_LOCALE",
|
|
429
|
+
"description": "BCP 47 locale tag used to localize month/weekday names and date formatting"
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
"name": "fieldClassName",
|
|
433
|
+
"type": "string",
|
|
434
|
+
"required": false,
|
|
435
|
+
"description": "Additional classes merged onto the trigger field, overriding conflicting defaults"
|
|
436
|
+
}
|
|
437
|
+
],
|
|
438
|
+
"examples": [
|
|
439
|
+
"<Calendar mode={CalendarMode.Date} value={date} onChange={setDate} />\n<Calendar mode={CalendarMode.DateTime} value={date} onChange={setDate} />\n<Calendar mode={CalendarMode.Time} value={time} onChange={setTime} />\n<Calendar mode={CalendarMode.Weekday} value={weekday} onChange={setWeekday} />\n<Calendar mode={CalendarMode.Date} value={date} onChange={setDate} locale=\"de-DE\" />"
|
|
440
|
+
],
|
|
441
|
+
"sourceFile": "components/New/Calendar/Calendar.tsx"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"name": "FolderPath",
|
|
445
|
+
"category": "Components_2_0",
|
|
446
|
+
"generation": "2.0",
|
|
447
|
+
"description": "A read-only, non-clickable folder/location path built on top of `DialBreadcrumb`.\naliases: FolderBreadcrumb|LocationPath\n\nEvery segment is disabled (no navigation); the first segment gets a leading\nfolder icon and the last segment is styled as the current/leaf item.",
|
|
448
|
+
"props": [
|
|
449
|
+
{
|
|
450
|
+
"name": "segments",
|
|
451
|
+
"type": "string[]",
|
|
452
|
+
"required": true,
|
|
453
|
+
"description": "Path segments to display, outermost first"
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"name": "labelClassName",
|
|
457
|
+
"type": "string",
|
|
458
|
+
"required": false,
|
|
459
|
+
"defaultValue": "'dial-small-text'",
|
|
460
|
+
"description": "Additional CSS classes applied to non-leaf segments"
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"name": "leafClassName",
|
|
464
|
+
"type": "string",
|
|
465
|
+
"required": false,
|
|
466
|
+
"defaultValue": "'dial-small-semi-text'",
|
|
467
|
+
"description": "Additional CSS classes applied to the last (leaf) segment"
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "className",
|
|
471
|
+
"type": "string",
|
|
472
|
+
"required": false,
|
|
473
|
+
"description": "Additional CSS classes applied to the breadcrumb's `<nav>` element.\n`DialBreadcrumb` scrolls horizontally on overflow, so this must not shrink\nthe nav to content width (e.g. never `w-auto`)."
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "ariaLabel",
|
|
477
|
+
"type": "string",
|
|
478
|
+
"required": false,
|
|
479
|
+
"defaultValue": "'Folder path'",
|
|
480
|
+
"description": "Accessible name for the underlying `<nav>`.\n`DialBreadcrumb` would otherwise name it \"Breadcrumb\", which misdescribes a\npath with no navigable items; override it when a page shows more than one."
|
|
481
|
+
}
|
|
482
|
+
],
|
|
483
|
+
"examples": [
|
|
484
|
+
"<FolderPath segments={['Shared', 'Team Space', 'Reports']} />"
|
|
485
|
+
],
|
|
486
|
+
"sourceFile": "components/New/FolderPath/FolderPath.tsx"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"name": "DangerButton",
|
|
490
|
+
"category": "Components_2_0",
|
|
491
|
+
"generation": "2.0",
|
|
492
|
+
"description": "A Danger Button component with predefined danger variant",
|
|
493
|
+
"props": [],
|
|
494
|
+
"examples": [
|
|
495
|
+
"<DangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
496
|
+
],
|
|
497
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"name": "GhostButton",
|
|
501
|
+
"category": "Components_2_0",
|
|
502
|
+
"generation": "2.0",
|
|
503
|
+
"description": "A Ghost Button component with predefined ghost appearance",
|
|
504
|
+
"props": [],
|
|
505
|
+
"examples": [
|
|
506
|
+
"<GhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
507
|
+
],
|
|
508
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"name": "LinkButton",
|
|
512
|
+
"category": "Components_2_0",
|
|
513
|
+
"generation": "2.0",
|
|
514
|
+
"description": "A Link Button component with predefined link appearance",
|
|
515
|
+
"props": [],
|
|
516
|
+
"examples": [
|
|
517
|
+
"<LinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
518
|
+
],
|
|
519
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "NeutralButton",
|
|
523
|
+
"category": "Components_2_0",
|
|
524
|
+
"generation": "2.0",
|
|
525
|
+
"description": "A Neutral Button component with predefined neutral variant",
|
|
526
|
+
"props": [],
|
|
527
|
+
"examples": [
|
|
528
|
+
"<NeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
529
|
+
],
|
|
530
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "OutlinedButton",
|
|
534
|
+
"category": "Components_2_0",
|
|
535
|
+
"generation": "2.0",
|
|
536
|
+
"description": "An Outlined Button component with predefined outlined appearance",
|
|
537
|
+
"props": [],
|
|
538
|
+
"examples": [
|
|
539
|
+
"<OutlinedButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
540
|
+
],
|
|
541
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"name": "PrimaryButton",
|
|
545
|
+
"category": "Components_2_0",
|
|
546
|
+
"generation": "2.0",
|
|
547
|
+
"description": "A Primary Button component with predefined primary variant",
|
|
548
|
+
"props": [],
|
|
549
|
+
"examples": [
|
|
550
|
+
"<PrimaryButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
551
|
+
],
|
|
552
|
+
"sourceFile": "components/New/Button/ButtonWrappers.tsx"
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "DangerIconButton",
|
|
556
|
+
"category": "Components_2_0",
|
|
557
|
+
"generation": "2.0",
|
|
558
|
+
"description": "A Danger Icon Button component with predefined danger variant",
|
|
559
|
+
"props": [],
|
|
560
|
+
"examples": [
|
|
561
|
+
"<DangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
562
|
+
],
|
|
563
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "GhostIconButton",
|
|
567
|
+
"category": "Components_2_0",
|
|
568
|
+
"generation": "2.0",
|
|
569
|
+
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
570
|
+
"props": [],
|
|
571
|
+
"examples": [
|
|
572
|
+
"<GhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
573
|
+
],
|
|
574
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"name": "NeutralIconButton",
|
|
578
|
+
"category": "Components_2_0",
|
|
579
|
+
"generation": "2.0",
|
|
580
|
+
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
581
|
+
"props": [],
|
|
582
|
+
"examples": [
|
|
583
|
+
"<NeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
584
|
+
],
|
|
585
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "PrimaryIconButton",
|
|
589
|
+
"category": "Components_2_0",
|
|
590
|
+
"generation": "2.0",
|
|
591
|
+
"description": "A Primary Icon Button component with predefined primary variant",
|
|
592
|
+
"props": [],
|
|
593
|
+
"examples": [
|
|
594
|
+
"<PrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
595
|
+
],
|
|
596
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "StaticIconButton",
|
|
600
|
+
"category": "Components_2_0",
|
|
601
|
+
"generation": "2.0",
|
|
602
|
+
"description": "A Outlined Icon Button component with predefined outlined appearance",
|
|
603
|
+
"props": [],
|
|
604
|
+
"examples": [
|
|
605
|
+
"<StaticIconButton\n icon={<Icon />}\n onClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
606
|
+
],
|
|
607
|
+
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx"
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"name": "Button",
|
|
611
|
+
"category": "Components_2_0",
|
|
612
|
+
"generation": "2.0",
|
|
613
|
+
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction",
|
|
614
|
+
"props": [
|
|
615
|
+
{
|
|
616
|
+
"name": "variant",
|
|
617
|
+
"type": "ButtonVariant",
|
|
618
|
+
"required": false,
|
|
619
|
+
"description": "Defines the visual style of the button"
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "size",
|
|
623
|
+
"type": "ElementSize",
|
|
624
|
+
"required": false,
|
|
625
|
+
"defaultValue": "ElementSize.Standard",
|
|
626
|
+
"description": "Defines the size of the button"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"name": "appearance",
|
|
630
|
+
"type": "ButtonAppearance",
|
|
631
|
+
"required": false,
|
|
632
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
633
|
+
"description": "Defines the type of the button"
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "textClassName",
|
|
637
|
+
"type": "string",
|
|
638
|
+
"required": false,
|
|
639
|
+
"description": "Additional CSS classes to apply specifically to the button text"
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "label",
|
|
643
|
+
"type": "ReactNode",
|
|
644
|
+
"required": false,
|
|
645
|
+
"description": "The content of the button. Can be any React node."
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
"name": "iconBefore",
|
|
649
|
+
"type": "ReactNode",
|
|
650
|
+
"required": false,
|
|
651
|
+
"description": "Icon or element to display before the button text"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"name": "iconAfter",
|
|
655
|
+
"type": "ReactNode",
|
|
656
|
+
"required": false,
|
|
657
|
+
"description": "Icon or element to display after the button text"
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "tooltipProps",
|
|
661
|
+
"type": "TooltipProps",
|
|
662
|
+
"required": false
|
|
663
|
+
}
|
|
664
|
+
],
|
|
665
|
+
"examples": [
|
|
666
|
+
"<Button\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
667
|
+
"<Button\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
668
|
+
],
|
|
669
|
+
"sourceFile": "components/New/Button/Button.tsx"
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"name": "IconButton",
|
|
673
|
+
"category": "Components_2_0",
|
|
674
|
+
"generation": "2.0",
|
|
675
|
+
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton",
|
|
676
|
+
"props": [
|
|
677
|
+
{
|
|
678
|
+
"name": "variant",
|
|
679
|
+
"type": "ButtonVariant",
|
|
680
|
+
"required": false,
|
|
681
|
+
"description": "Defines the visual style of the button"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"name": "size",
|
|
685
|
+
"type": "ElementSize",
|
|
686
|
+
"required": false,
|
|
687
|
+
"defaultValue": "ElementSize.Standard",
|
|
688
|
+
"description": "Defines the size of the button"
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "appearance",
|
|
692
|
+
"type": "ButtonAppearance",
|
|
693
|
+
"required": false,
|
|
694
|
+
"defaultValue": "ButtonAppearance.Solid",
|
|
695
|
+
"description": "Defines the type of the button"
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"name": "icon",
|
|
699
|
+
"type": "ReactNode",
|
|
700
|
+
"required": true,
|
|
701
|
+
"description": "Icon display"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "tooltipProps",
|
|
705
|
+
"type": "TooltipProps",
|
|
706
|
+
"required": false
|
|
707
|
+
}
|
|
708
|
+
],
|
|
709
|
+
"examples": [
|
|
710
|
+
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
711
|
+
"<IconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
712
|
+
],
|
|
713
|
+
"sourceFile": "components/New/IconButton/IconButton.tsx"
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "FabButton",
|
|
717
|
+
"category": "Components_2_0",
|
|
718
|
+
"generation": "2.0",
|
|
719
|
+
"description": "A Floating Action Button (FAB) component — circular icon button for primary actions.\naliases: FloatingActionButton|FabButton|CircularButton",
|
|
720
|
+
"props": [
|
|
721
|
+
{
|
|
722
|
+
"name": "icon",
|
|
723
|
+
"type": "ReactNode",
|
|
724
|
+
"required": false,
|
|
725
|
+
"description": "Icon to display inside the button"
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "tooltipProps",
|
|
729
|
+
"type": "TooltipProps",
|
|
730
|
+
"required": false,
|
|
731
|
+
"description": "Optional tooltip configuration"
|
|
732
|
+
}
|
|
733
|
+
],
|
|
734
|
+
"examples": [
|
|
735
|
+
"<FabButton\n icon={<IconArrowNarrowDown size={24} stroke={1.5} />}\n onClick={handleClick}\n aria-label=\"Scroll to bottom\"\n/>"
|
|
736
|
+
],
|
|
737
|
+
"sourceFile": "components/FabButton/FabButton.tsx"
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"name": "ButtonDropdown",
|
|
741
|
+
"category": "Components_2_0",
|
|
742
|
+
"generation": "2.0",
|
|
743
|
+
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton",
|
|
744
|
+
"props": [
|
|
745
|
+
{
|
|
746
|
+
"name": "items",
|
|
747
|
+
"type": "DropdownItem[]",
|
|
748
|
+
"required": true,
|
|
749
|
+
"description": "DropdownItems with actions"
|
|
750
|
+
}
|
|
751
|
+
],
|
|
752
|
+
"examples": [
|
|
753
|
+
"<ButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
754
|
+
],
|
|
755
|
+
"sourceFile": "components/New/ButtonDropdown/ButtonDropdown.tsx"
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
"name": "MarkdownEditor",
|
|
759
|
+
"category": "Components_2_0",
|
|
760
|
+
"generation": "2.0",
|
|
761
|
+
"description": "The 2.0 Markdown editor: a formatting toolbar (bold/italic/strikethrough,\ntext style, lists, quote/link/code, table) plus an edit/live/preview mode\nswitcher and fullscreen, built on top of `@uiw/react-md-editor`.\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyMarkdownEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
762
|
+
"props": [
|
|
763
|
+
{
|
|
764
|
+
"name": "value",
|
|
765
|
+
"type": "string",
|
|
766
|
+
"required": false,
|
|
767
|
+
"description": "The current markdown content"
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
"name": "onChange",
|
|
771
|
+
"type": "(value: string) => void",
|
|
772
|
+
"required": false,
|
|
773
|
+
"description": "Callback fired when the editor content changes"
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "height",
|
|
777
|
+
"type": "number",
|
|
778
|
+
"required": false,
|
|
779
|
+
"defaultValue": "300",
|
|
780
|
+
"description": "Height of the editor in pixels"
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"name": "theme",
|
|
784
|
+
"type": "EditorThemes",
|
|
785
|
+
"required": false,
|
|
786
|
+
"defaultValue": "EditorThemes.light",
|
|
787
|
+
"description": "Theme for the editor ('light' or 'dark')"
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"name": "className",
|
|
791
|
+
"type": "string",
|
|
792
|
+
"required": false,
|
|
793
|
+
"description": "Additional CSS classes for the container"
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
"name": "placeholder",
|
|
797
|
+
"type": "string",
|
|
798
|
+
"required": false,
|
|
799
|
+
"description": "Placeholder text shown when the editor is empty"
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"name": "defaultPreview",
|
|
803
|
+
"type": "PreviewType",
|
|
804
|
+
"required": false,
|
|
805
|
+
"defaultValue": "'edit'",
|
|
806
|
+
"description": "Initial edit/live/preview mode"
|
|
807
|
+
}
|
|
808
|
+
],
|
|
809
|
+
"examples": [
|
|
810
|
+
"<MarkdownEditor value={value} onChange={setValue} height={400} />"
|
|
811
|
+
],
|
|
812
|
+
"sourceFile": "components/New/MarkdownEditor/MarkdownEditor.tsx",
|
|
813
|
+
"lazy": {
|
|
814
|
+
"loaderExportName": "LazyMarkdownEditor",
|
|
815
|
+
"packageImport": "@epam/ai-dial-ui-kit",
|
|
816
|
+
"ssr": false,
|
|
817
|
+
"nextDynamicExample": "import dynamic from 'next/dynamic';\nimport { LazyMarkdownEditor } from '@epam/ai-dial-ui-kit';\n\nconst MarkdownEditor = dynamic(\n async () => (await LazyMarkdownEditor()).MarkdownEditor,\n { ssr: false },\n);"
|
|
818
|
+
}
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"name": "InlineSelect",
|
|
822
|
+
"category": "Components_2_0",
|
|
823
|
+
"generation": "2.0",
|
|
824
|
+
"description": "An inline select control combining `InlineSelectTrigger` with `DialDropdown`.",
|
|
825
|
+
"props": [
|
|
826
|
+
{
|
|
827
|
+
"name": "items",
|
|
828
|
+
"type": "DropdownItem[]",
|
|
829
|
+
"required": true
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
"name": "selectedKey",
|
|
833
|
+
"type": "string",
|
|
834
|
+
"required": false
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "defaultSelectedKey",
|
|
838
|
+
"type": "string",
|
|
839
|
+
"required": false
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "onSelect",
|
|
843
|
+
"type": "(item: DropdownItem) => void",
|
|
844
|
+
"required": false
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "size",
|
|
848
|
+
"type": "ElementSize",
|
|
849
|
+
"required": false
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"name": "disabled",
|
|
853
|
+
"type": "boolean",
|
|
854
|
+
"required": false
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "placement",
|
|
858
|
+
"type": "Placement",
|
|
859
|
+
"required": false,
|
|
860
|
+
"defaultValue": "'bottom-end'"
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"name": "matchReferenceWidth",
|
|
864
|
+
"type": "boolean",
|
|
865
|
+
"required": false,
|
|
866
|
+
"defaultValue": "false"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"name": "listClassName",
|
|
870
|
+
"type": "string",
|
|
871
|
+
"required": false
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"name": "ariaLabel",
|
|
875
|
+
"type": "string",
|
|
876
|
+
"required": false
|
|
877
|
+
}
|
|
878
|
+
],
|
|
879
|
+
"examples": [
|
|
880
|
+
"<InlineSelect\n items={[{ key: 'a', label: 'Option A' }, { key: 'b', label: 'Option B' }]}\n onSelect={(item) => console.log(item.key)}\n/>"
|
|
881
|
+
],
|
|
882
|
+
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx"
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "InlineSelectTrigger",
|
|
886
|
+
"category": "Components_2_0",
|
|
887
|
+
"generation": "2.0",
|
|
888
|
+
"description": "",
|
|
889
|
+
"props": [
|
|
890
|
+
{
|
|
891
|
+
"name": "label",
|
|
892
|
+
"type": "string",
|
|
893
|
+
"required": true
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "size",
|
|
897
|
+
"type": "ElementSize",
|
|
898
|
+
"required": false
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "isOpen",
|
|
902
|
+
"type": "boolean",
|
|
903
|
+
"required": false,
|
|
904
|
+
"defaultValue": "false"
|
|
905
|
+
}
|
|
906
|
+
],
|
|
907
|
+
"examples": [],
|
|
908
|
+
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx"
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"name": "Select",
|
|
912
|
+
"category": "Components_2_0",
|
|
913
|
+
"generation": "2.0",
|
|
914
|
+
"description": "A versatile select supporting single and multiple selections.\naliases: OptionPicker|ChoiceSelector\n\nThe field is an , so it carries the 2.0 field styling, sizes,\nlabel, caption and error states, and it exposes the control as a `combobox`\nwhose popup is the option list.\n\nSingle mode:\n- The field shows the selected option's leading icon + label.\n- In the list, the selected option is indicated by a LEFT border, a tinted background\n and a trailing check icon.\n\nMultiple mode uses checkboxes (including Select All with indeterminate state) and\nrenders the selection as removable tags inside the field.\n\nThe field itself is never typeable: `searchable` puts a search field in the overlay\nheader that filters the options.",
|
|
915
|
+
"props": [
|
|
916
|
+
{
|
|
917
|
+
"name": "options",
|
|
918
|
+
"type": "SelectOption[]",
|
|
919
|
+
"required": true,
|
|
920
|
+
"description": "Array of options to select from."
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"name": "multiple",
|
|
924
|
+
"type": "boolean",
|
|
925
|
+
"required": false,
|
|
926
|
+
"defaultValue": "false",
|
|
927
|
+
"description": "Whether multiple selections are allowed."
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"name": "id",
|
|
931
|
+
"type": "string",
|
|
932
|
+
"required": false,
|
|
933
|
+
"description": "The id of the field, linked to the label."
|
|
934
|
+
},
|
|
935
|
+
{
|
|
936
|
+
"name": "size",
|
|
937
|
+
"type": "ElementSize",
|
|
938
|
+
"required": false,
|
|
939
|
+
"defaultValue": "ElementSize.Standard",
|
|
940
|
+
"description": "Field height: standard is 40px, small is 24px."
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"name": "value",
|
|
944
|
+
"type": "string | string[]",
|
|
945
|
+
"required": false,
|
|
946
|
+
"description": "Controlled selected value(s)."
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
"name": "customSelectedValue",
|
|
950
|
+
"type": "string",
|
|
951
|
+
"required": false,
|
|
952
|
+
"description": "Custom string to render as the selected value in single mode."
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
"name": "prefix",
|
|
956
|
+
"type": "string",
|
|
957
|
+
"required": false,
|
|
958
|
+
"description": "Prefix for selected value(s)."
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"name": "defaultValue",
|
|
962
|
+
"type": "string | string[]",
|
|
963
|
+
"required": false,
|
|
964
|
+
"description": "Uncontrolled initial selected value(s)."
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "placeholder",
|
|
968
|
+
"type": "string",
|
|
969
|
+
"required": false,
|
|
970
|
+
"defaultValue": "'Select...'",
|
|
971
|
+
"description": "Placeholder text when no selection is made."
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "labelProps",
|
|
975
|
+
"type": "LabelProps",
|
|
976
|
+
"required": false,
|
|
977
|
+
"description": "Props of the rendered above the field."
|
|
978
|
+
},
|
|
979
|
+
{
|
|
980
|
+
"name": "error",
|
|
981
|
+
"type": "string",
|
|
982
|
+
"required": false,
|
|
983
|
+
"description": "Error message rendered below the field (does not by itself apply error styling, pass `invalid` too)."
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"name": "caption",
|
|
987
|
+
"type": "string",
|
|
988
|
+
"required": false,
|
|
989
|
+
"description": "Helper text rendered below the field when there is no `error`."
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"name": "ariaLabel",
|
|
993
|
+
"type": "string",
|
|
994
|
+
"required": false,
|
|
995
|
+
"description": "Accessible name for the field; use it when there is no visible label."
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
"name": "searchable",
|
|
999
|
+
"type": "boolean",
|
|
1000
|
+
"required": false,
|
|
1001
|
+
"defaultValue": "false",
|
|
1002
|
+
"description": "Show a search field in the overlay header."
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "searchSize",
|
|
1006
|
+
"type": "ElementSize",
|
|
1007
|
+
"required": false,
|
|
1008
|
+
"defaultValue": "ElementSize.Standard",
|
|
1009
|
+
"description": "Size of the overlay search input when `searchable` is enabled."
|
|
1010
|
+
},
|
|
1011
|
+
{
|
|
1012
|
+
"name": "searchPlaceholder",
|
|
1013
|
+
"type": "string",
|
|
1014
|
+
"required": false,
|
|
1015
|
+
"description": "Placeholder for the overlay search input."
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"name": "selectAll",
|
|
1019
|
+
"type": "boolean",
|
|
1020
|
+
"required": false,
|
|
1021
|
+
"defaultValue": "false",
|
|
1022
|
+
"description": "Show a \"Select All\" checkbox in multiple mode."
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"name": "selectAllLabel",
|
|
1026
|
+
"type": "string",
|
|
1027
|
+
"required": false,
|
|
1028
|
+
"defaultValue": "'Select all'",
|
|
1029
|
+
"description": "Label for the \"Select All\" checkbox."
|
|
1030
|
+
},
|
|
1031
|
+
{
|
|
1032
|
+
"name": "emptyStateTitle",
|
|
1033
|
+
"type": "string",
|
|
1034
|
+
"required": false,
|
|
1035
|
+
"defaultValue": "'No options available'",
|
|
1036
|
+
"description": "Title text when there are no options."
|
|
1037
|
+
},
|
|
1038
|
+
{
|
|
1039
|
+
"name": "emptyStateDescription",
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"required": false,
|
|
1042
|
+
"description": "Description text when there are no options."
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"name": "emptyStateIcon",
|
|
1046
|
+
"type": "ReactNode",
|
|
1047
|
+
"required": false,
|
|
1048
|
+
"description": "Icon to display when there are no options."
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
"name": "disabled",
|
|
1052
|
+
"type": "boolean",
|
|
1053
|
+
"required": false,
|
|
1054
|
+
"defaultValue": "false",
|
|
1055
|
+
"description": "Disable the control."
|
|
1056
|
+
},
|
|
1057
|
+
{
|
|
1058
|
+
"name": "className",
|
|
1059
|
+
"type": "string",
|
|
1060
|
+
"required": false,
|
|
1061
|
+
"description": "Additional CSS classes for the outer container."
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "fieldClassName",
|
|
1065
|
+
"type": "string",
|
|
1066
|
+
"required": false,
|
|
1067
|
+
"description": "Additional CSS classes for the field itself."
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"name": "listClassName",
|
|
1071
|
+
"type": "string",
|
|
1072
|
+
"required": false,
|
|
1073
|
+
"description": "Additional CSS classes for the list dropdown."
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "closable",
|
|
1077
|
+
"type": "boolean",
|
|
1078
|
+
"required": false,
|
|
1079
|
+
"defaultValue": "false",
|
|
1080
|
+
"description": "Show a close button in the dropdown header."
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "invalid",
|
|
1084
|
+
"type": "boolean",
|
|
1085
|
+
"required": false,
|
|
1086
|
+
"description": "Whether the select is in an invalid state, affecting styling."
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "header",
|
|
1090
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1091
|
+
"required": false,
|
|
1092
|
+
"description": "Custom node/function rendered above the options."
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "footer",
|
|
1096
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1097
|
+
"required": false,
|
|
1098
|
+
"description": "Custom node/function rendered below the options."
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "open",
|
|
1102
|
+
"type": "boolean",
|
|
1103
|
+
"required": false,
|
|
1104
|
+
"description": "Controlled open state of the dropdown. When provided, makes the dropdown controlled."
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"name": "onOpenChange",
|
|
1108
|
+
"type": "(open: boolean) => void",
|
|
1109
|
+
"required": false,
|
|
1110
|
+
"description": "Called when the dropdown open state changes."
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "onSearchQueryChange",
|
|
1114
|
+
"type": "(query: string) => void",
|
|
1115
|
+
"required": false,
|
|
1116
|
+
"description": "Called when the overlay search query changes, including the reset to `''` on close. Use it to fetch options for the query."
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"name": "dismissRef",
|
|
1120
|
+
"type": "Ref<unknown>",
|
|
1121
|
+
"required": false,
|
|
1122
|
+
"description": "Ref object to expose a `dismiss` method to programmatically close the select."
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "onClose",
|
|
1126
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1127
|
+
"required": false,
|
|
1128
|
+
"description": "Called when the dropdown close button is clicked."
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "onChange",
|
|
1132
|
+
"type": "(next: string | string[]) => void",
|
|
1133
|
+
"required": false,
|
|
1134
|
+
"description": "Called when the selection changes."
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "onFooterClick",
|
|
1138
|
+
"type": "(e: MouseEvent<HTMLDivElement>) => void",
|
|
1139
|
+
"required": false,
|
|
1140
|
+
"description": "Called when the footer element is clicked. When provided, automatically closes the dropdown."
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"name": "customMultiSelectTagsRenderer",
|
|
1144
|
+
"type": "(\n options: SelectOption[],\n selectedValues: string[],\n handleRemoveTag: (\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void,\n ) => ReactNode",
|
|
1145
|
+
"required": false,
|
|
1146
|
+
"description": "Renders the selected tags of a multi-select in place of the default ones."
|
|
1147
|
+
}
|
|
1148
|
+
],
|
|
1149
|
+
"examples": [
|
|
1150
|
+
"<Select options={[{ value: 'option-1', label: 'Option 1' }]} />\n<Select searchable options={[{ value: 'a', label: 'Alpha' }, { value: 'b', label: 'Beta' }]} />\n<Select multiple selectAll options={[{ value: '1', label: 'One' }, { value: '2', label: 'Two' }]} />\n<Select labelProps={{ label: 'Operator' }} caption=\"Pick a comparison\" options={options} />"
|
|
1151
|
+
],
|
|
1152
|
+
"sourceFile": "components/New/Select/Select.tsx"
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "MultiSelectTags",
|
|
1156
|
+
"category": "Components_2_0",
|
|
1157
|
+
"generation": "2.0",
|
|
1158
|
+
"description": "The selected values of a multi-select, rendered as removable tags inside the\nfield.",
|
|
1159
|
+
"props": [
|
|
1160
|
+
{
|
|
1161
|
+
"name": "options",
|
|
1162
|
+
"type": "SelectOption[]",
|
|
1163
|
+
"required": true,
|
|
1164
|
+
"description": "All available options, used to resolve labels and icons"
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "selectedValues",
|
|
1168
|
+
"type": "string[]",
|
|
1169
|
+
"required": true,
|
|
1170
|
+
"description": "Values currently selected"
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"name": "handleRemoveTag",
|
|
1174
|
+
"type": "(\n event: MouseEvent<HTMLButtonElement, globalThis.MouseEvent>,\n val: string,\n ) => void",
|
|
1175
|
+
"required": false,
|
|
1176
|
+
"description": "Called with the value whose tag was removed; when omitted the tags are not removable"
|
|
1177
|
+
}
|
|
1178
|
+
],
|
|
1179
|
+
"examples": [],
|
|
1180
|
+
"sourceFile": "components/New/Select/MultiSelectTags.tsx"
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"name": "InfoButton",
|
|
1184
|
+
"category": "Components_2_0",
|
|
1185
|
+
"generation": "2.0",
|
|
1186
|
+
"description": "An Info button component with a customizable icon and accessible label.",
|
|
1187
|
+
"props": [
|
|
1188
|
+
{
|
|
1189
|
+
"name": "caption",
|
|
1190
|
+
"type": "string",
|
|
1191
|
+
"required": false,
|
|
1192
|
+
"description": "Text shown in the tooltip, and the fallback accessible name"
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
"name": "onClick",
|
|
1196
|
+
"type": "() => void",
|
|
1197
|
+
"required": false,
|
|
1198
|
+
"description": "Click handler for the info button"
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"name": "'aria-label'",
|
|
1202
|
+
"type": "string",
|
|
1203
|
+
"required": false
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"examples": [
|
|
1207
|
+
"<InfoButton\n caption=\"Info\"\n/>"
|
|
1208
|
+
],
|
|
1209
|
+
"sourceFile": "components/New/InfoButton/InfoButton.tsx"
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"name": "Label",
|
|
1213
|
+
"category": "Components_2_0",
|
|
1214
|
+
"generation": "2.0",
|
|
1215
|
+
"description": "A label component\naliases: FormLabel|RequiredIndicator",
|
|
1216
|
+
"props": [
|
|
1217
|
+
{
|
|
1218
|
+
"name": "label",
|
|
1219
|
+
"type": "ReactNode",
|
|
1220
|
+
"required": false,
|
|
1221
|
+
"description": "The label text to display for the label"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "required",
|
|
1225
|
+
"type": "boolean",
|
|
1226
|
+
"required": false,
|
|
1227
|
+
"description": "Whether the field is required. Renders a visual `*`\nplus visually hidden text so the requirement is announced too."
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "caption",
|
|
1231
|
+
"type": "string",
|
|
1232
|
+
"required": false,
|
|
1233
|
+
"description": "Explanatory text, exposed through an info button next to the label"
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "size",
|
|
1237
|
+
"type": "ElementSize",
|
|
1238
|
+
"required": false,
|
|
1239
|
+
"defaultValue": "ElementSize.Small",
|
|
1240
|
+
"description": "The size of the label, which can be 'small', 'medium', or 'large'."
|
|
1241
|
+
}
|
|
1242
|
+
],
|
|
1243
|
+
"examples": [
|
|
1244
|
+
"// Basic label\n<Label htmlFor=\"email-input\" label=\"Email Address\" />"
|
|
1245
|
+
],
|
|
1246
|
+
"sourceFile": "components/New/Label/Label.tsx"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "Textarea",
|
|
1250
|
+
"category": "Components_2_0",
|
|
1251
|
+
"generation": "2.0",
|
|
1252
|
+
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox",
|
|
1253
|
+
"props": [
|
|
1254
|
+
{
|
|
1255
|
+
"name": "labelProps",
|
|
1256
|
+
"type": "DialLabelProps",
|
|
1257
|
+
"required": false,
|
|
1258
|
+
"description": "Props for the field label, including `label` (label text) and `required` (whether to show required indicator)"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "invalid",
|
|
1262
|
+
"type": "boolean",
|
|
1263
|
+
"required": false,
|
|
1264
|
+
"description": "Whether the textarea has validation errors (applies error styling)"
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "containerClassName",
|
|
1268
|
+
"type": "string",
|
|
1269
|
+
"required": false,
|
|
1270
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "resize",
|
|
1274
|
+
"type": "boolean",
|
|
1275
|
+
"required": false,
|
|
1276
|
+
"defaultValue": "false",
|
|
1277
|
+
"description": "Whether the textarea has possibility to resize"
|
|
1278
|
+
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "error",
|
|
1281
|
+
"type": "string",
|
|
1282
|
+
"required": false,
|
|
1283
|
+
"description": "Error message to display below the textarea (also adds error styling)"
|
|
1284
|
+
},
|
|
1285
|
+
{
|
|
1286
|
+
"name": "caption",
|
|
1287
|
+
"type": "string",
|
|
1288
|
+
"required": false,
|
|
1289
|
+
"description": "Optional caption text to display below the textarea"
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"name": "onChange",
|
|
1293
|
+
"type": "(value: string) => void",
|
|
1294
|
+
"required": false,
|
|
1295
|
+
"description": "Callback function called when the textarea value changes"
|
|
1296
|
+
}
|
|
1297
|
+
],
|
|
1298
|
+
"examples": [
|
|
1299
|
+
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
1300
|
+
],
|
|
1301
|
+
"sourceFile": "components/New/Textarea/Textarea.tsx"
|
|
1302
|
+
},
|
|
1303
|
+
{
|
|
1304
|
+
"name": "Input",
|
|
1305
|
+
"category": "Components_2_0",
|
|
1306
|
+
"generation": "2.0",
|
|
1307
|
+
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput",
|
|
1308
|
+
"props": [
|
|
1309
|
+
{
|
|
1310
|
+
"name": "labelProps",
|
|
1311
|
+
"type": "DialLabelProps",
|
|
1312
|
+
"required": false
|
|
1313
|
+
},
|
|
1314
|
+
{
|
|
1315
|
+
"name": "inputButtonProps",
|
|
1316
|
+
"type": "InputButtonProps",
|
|
1317
|
+
"required": false
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
"name": "size",
|
|
1321
|
+
"type": "ElementSize",
|
|
1322
|
+
"required": false,
|
|
1323
|
+
"defaultValue": "ElementSize.Standard",
|
|
1324
|
+
"description": "The size of the input, which can be 'small', 'standard', or 'large'."
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"name": "invalid",
|
|
1328
|
+
"type": "boolean",
|
|
1329
|
+
"required": false,
|
|
1330
|
+
"description": "Whether the input has validation errors (applies error styling)"
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
"name": "error",
|
|
1334
|
+
"type": "string",
|
|
1335
|
+
"required": false,
|
|
1336
|
+
"description": "Error message to display below the input (also adds error styling)"
|
|
1337
|
+
},
|
|
1338
|
+
{
|
|
1339
|
+
"name": "caption",
|
|
1340
|
+
"type": "string",
|
|
1341
|
+
"required": false,
|
|
1342
|
+
"description": "Helper text to display below the input"
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "tooltipText",
|
|
1346
|
+
"type": "string",
|
|
1347
|
+
"required": false
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
"name": "iconBefore",
|
|
1351
|
+
"type": "ReactNode",
|
|
1352
|
+
"required": false,
|
|
1353
|
+
"description": "Icon or element to display before the input"
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "iconAfter",
|
|
1357
|
+
"type": "ReactNode",
|
|
1358
|
+
"required": false,
|
|
1359
|
+
"description": "Icon or element to display after the input"
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"name": "children",
|
|
1363
|
+
"type": "ReactNode",
|
|
1364
|
+
"required": false,
|
|
1365
|
+
"description": "Content rendered inside the field before the input, for values a plain `<input>` cannot hold (e.g. multi-select tags)"
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
"name": "prefix",
|
|
1369
|
+
"type": "string",
|
|
1370
|
+
"required": false
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"name": "postfix",
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"required": false
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"name": "inputRef",
|
|
1379
|
+
"type": "Ref<HTMLInputElement>",
|
|
1380
|
+
"required": false,
|
|
1381
|
+
"description": "Ref to access the underlying input element"
|
|
1382
|
+
},
|
|
1383
|
+
{
|
|
1384
|
+
"name": "onChange",
|
|
1385
|
+
"type": "(value?: string) => void",
|
|
1386
|
+
"required": false,
|
|
1387
|
+
"description": "Callback function called when the input value changes"
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
"name": "containerClassName",
|
|
1391
|
+
"type": "string",
|
|
1392
|
+
"required": false,
|
|
1393
|
+
"description": "Additional CSS classes to apply to the container div"
|
|
1394
|
+
},
|
|
1395
|
+
{
|
|
1396
|
+
"name": "wrapperClassName",
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"required": false,
|
|
1399
|
+
"description": "Additional CSS classes to apply to the input wrapper div"
|
|
1400
|
+
}
|
|
1401
|
+
],
|
|
1402
|
+
"examples": [
|
|
1403
|
+
"<Input\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
1404
|
+
],
|
|
1405
|
+
"sourceFile": "components/New/Input/Input.tsx"
|
|
1406
|
+
},
|
|
1407
|
+
{
|
|
1408
|
+
"name": "PasswordInput",
|
|
1409
|
+
"category": "Components_2_0",
|
|
1410
|
+
"generation": "2.0",
|
|
1411
|
+
"description": "A password field with a reveal toggle, built on .\naliases: SecureInput|ToggleablePassword\n\nThe toggle is a real `<button>`, so it is reachable by keyboard and announces\nboth its purpose and its state. `type` and `iconAfter` are owned by this\ncomponent; every other prop is passed through.",
|
|
1412
|
+
"props": [
|
|
1413
|
+
{
|
|
1414
|
+
"name": "showPasswordLabel",
|
|
1415
|
+
"type": "string",
|
|
1416
|
+
"required": false,
|
|
1417
|
+
"defaultValue": "'Show password'",
|
|
1418
|
+
"description": "Accessible name of the toggle while the value is masked"
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"name": "hidePasswordLabel",
|
|
1422
|
+
"type": "string",
|
|
1423
|
+
"required": false,
|
|
1424
|
+
"defaultValue": "'Hide password'",
|
|
1425
|
+
"description": "Accessible name of the toggle while the value is visible"
|
|
1426
|
+
}
|
|
1427
|
+
],
|
|
1428
|
+
"examples": [
|
|
1429
|
+
"<PasswordInput\n id=\"password\"\n labelProps={{ label: 'Password', required: true }}\n value={password}\n onChange={setPassword}\n/>"
|
|
1430
|
+
],
|
|
1431
|
+
"sourceFile": "components/New/PasswordInput/PasswordInput.tsx"
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"name": "NumberInput",
|
|
1435
|
+
"category": "Components_2_0",
|
|
1436
|
+
"generation": "2.0",
|
|
1437
|
+
"description": "A number field, built on .\naliases: NumericField|NumberField\n\n`type` is owned by this component; every other prop is passed\nthrough, so it shares the 2.0 field styling, sizes, label, caption and error\nstates.",
|
|
1438
|
+
"props": [
|
|
1439
|
+
{
|
|
1440
|
+
"name": "integer",
|
|
1441
|
+
"type": "boolean",
|
|
1442
|
+
"required": false,
|
|
1443
|
+
"description": "When true, restricts input to integer values only — blocks decimal points, minus, plus, and scientific notation (e/E)"
|
|
1444
|
+
},
|
|
1445
|
+
{
|
|
1446
|
+
"name": "onChange",
|
|
1447
|
+
"type": "(value?: number | string) => void",
|
|
1448
|
+
"required": false,
|
|
1449
|
+
"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)"
|
|
1450
|
+
}
|
|
1451
|
+
],
|
|
1452
|
+
"examples": [
|
|
1453
|
+
"<NumberInput\n id=\"age\"\n placeholder=\"Enter your age\"\n value={25}\n onChange={(value) => setAge(value)}\n/>"
|
|
1454
|
+
],
|
|
1455
|
+
"sourceFile": "components/New/NumberInput/NumberInput.tsx"
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "Popup",
|
|
1459
|
+
"category": "Components_2_0",
|
|
1460
|
+
"generation": "2.0",
|
|
1461
|
+
"description": "An accessible modal dialog using Floating UI.\naliases: Modal|Dialog\n\nRenders in a portal with a scrim overlay, focus management, a header with the\ntitle and close control, a scrollable body and an optional footer. Sections\nare separated by spacing rather than rules; add your own through\n`headerClassName` or the footer node if a surface needs them.\n\nA string `header` names the dialog automatically. A `header` node cannot —\npass `ariaLabel` in that case, or the dialog opens unnamed.",
|
|
1462
|
+
"props": [
|
|
1463
|
+
{
|
|
1464
|
+
"name": "open",
|
|
1465
|
+
"type": "boolean",
|
|
1466
|
+
"required": false,
|
|
1467
|
+
"defaultValue": "false",
|
|
1468
|
+
"description": "Controls visibility of the popup"
|
|
1469
|
+
},
|
|
1470
|
+
{
|
|
1471
|
+
"name": "header",
|
|
1472
|
+
"type": "ReactNode",
|
|
1473
|
+
"required": false,
|
|
1474
|
+
"description": "Optional title rendered in the header"
|
|
1475
|
+
},
|
|
1476
|
+
{
|
|
1477
|
+
"name": "ariaLabel",
|
|
1478
|
+
"type": "string",
|
|
1479
|
+
"required": false,
|
|
1480
|
+
"description": "Accessible name for the dialog; needed when `header` is not a string"
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
"name": "portalId",
|
|
1484
|
+
"type": "string",
|
|
1485
|
+
"required": false,
|
|
1486
|
+
"description": "Optional portal container id"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "className",
|
|
1490
|
+
"type": "string",
|
|
1491
|
+
"required": false,
|
|
1492
|
+
"description": "Additional CSS classes applied to the popup container"
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
"name": "overlayClassName",
|
|
1496
|
+
"type": "string",
|
|
1497
|
+
"required": false,
|
|
1498
|
+
"description": "Additional CSS classes applied to the overlay"
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"name": "titleClassName",
|
|
1502
|
+
"type": "string",
|
|
1503
|
+
"required": false,
|
|
1504
|
+
"description": "Additional CSS classes applied to the title element"
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "headerClassName",
|
|
1508
|
+
"type": "string",
|
|
1509
|
+
"required": false,
|
|
1510
|
+
"description": "Additional CSS classes applied to the popup header container"
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
"name": "children",
|
|
1514
|
+
"type": "ReactNode",
|
|
1515
|
+
"required": false,
|
|
1516
|
+
"description": "Body content"
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
"name": "footer",
|
|
1520
|
+
"type": "ReactNode",
|
|
1521
|
+
"required": false,
|
|
1522
|
+
"description": "Footer area for actions"
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"name": "onClose",
|
|
1526
|
+
"type": "(e?: MouseEvent<HTMLButtonElement> | null) => void",
|
|
1527
|
+
"required": false,
|
|
1528
|
+
"description": "Callback fired when the popup requests to close"
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
"name": "size",
|
|
1532
|
+
"type": "PopupSize",
|
|
1533
|
+
"required": false,
|
|
1534
|
+
"defaultValue": "PopupSize.Md",
|
|
1535
|
+
"description": "Sets the max-width of the popup"
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"name": "hideClose",
|
|
1539
|
+
"type": "boolean",
|
|
1540
|
+
"required": false,
|
|
1541
|
+
"defaultValue": "false",
|
|
1542
|
+
"description": "Whether the close button is hidden in the header"
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"name": "closeAriaLabel",
|
|
1546
|
+
"type": "string",
|
|
1547
|
+
"required": false,
|
|
1548
|
+
"defaultValue": "'Close dialog'",
|
|
1549
|
+
"description": "Accessible name of the close button"
|
|
1550
|
+
},
|
|
1551
|
+
{
|
|
1552
|
+
"name": "closeOnOutsideClick",
|
|
1553
|
+
"type": "boolean",
|
|
1554
|
+
"required": false,
|
|
1555
|
+
"defaultValue": "true",
|
|
1556
|
+
"description": "Whether the popup closes when clicking outside"
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"name": "preventKeyboardOnOpen",
|
|
1560
|
+
"type": "boolean",
|
|
1561
|
+
"required": false,
|
|
1562
|
+
"defaultValue": "false",
|
|
1563
|
+
"description": "When true, initial focus goes to a non-input guard to avoid opening the virtual keyboard on mobile"
|
|
1564
|
+
}
|
|
1565
|
+
],
|
|
1566
|
+
"examples": [
|
|
1567
|
+
"<Popup\n open\n header=\"Title\"\n size={PopupSize.Md}\n footer={\n <div className=\"flex justify-end gap-2 px-6 py-4\">\n <NeutralButton label=\"Cancel\" />\n <PrimaryButton label=\"Confirm\" />\n </div>\n }\n onClose={() => setOpen(false)}\n>\n <div className=\"px-6 py-4\">Dialog content goes here…</div>\n</Popup>"
|
|
1568
|
+
],
|
|
1569
|
+
"sourceFile": "components/New/Popup/Popup.tsx"
|
|
1570
|
+
},
|
|
1571
|
+
{
|
|
1572
|
+
"name": "CloseButton",
|
|
1573
|
+
"category": "Components_2_0",
|
|
1574
|
+
"generation": "2.0",
|
|
1575
|
+
"description": "A close button: a ghost carrying an X icon.\naliases: DismissButton|ExitButton\n\nSized through like every other 2.0 control. It defaults to\nthe small 24px box that headers and toasts want; pass `ElementSize.Standard`\nwhere the control stands alone, since only that variant carries the 44×44\npointer target. Name it after the thing it closes (\"Close dialog\", \"Close\nnotification\") — the default `\"Close\"` only keeps the control from being unnamed.",
|
|
1576
|
+
"props": [
|
|
1577
|
+
{
|
|
1578
|
+
"name": "ariaLabel",
|
|
1579
|
+
"type": "string",
|
|
1580
|
+
"required": false,
|
|
1581
|
+
"defaultValue": "'Close'",
|
|
1582
|
+
"description": "Accessible name of the button"
|
|
1583
|
+
},
|
|
1584
|
+
{
|
|
1585
|
+
"name": "className",
|
|
1586
|
+
"type": "string",
|
|
1587
|
+
"required": false,
|
|
1588
|
+
"description": "Additional CSS classes to apply to the button"
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
"name": "size",
|
|
1592
|
+
"type": "ElementSize",
|
|
1593
|
+
"required": false,
|
|
1594
|
+
"defaultValue": "ElementSize.Small",
|
|
1595
|
+
"description": "Button size: small is 24px, standard is 40px"
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"name": "onClose",
|
|
1599
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1600
|
+
"required": true,
|
|
1601
|
+
"description": "Click event handler for the close button"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "disabled",
|
|
1605
|
+
"type": "boolean",
|
|
1606
|
+
"required": false,
|
|
1607
|
+
"description": "Whether the button is disabled"
|
|
1608
|
+
}
|
|
1609
|
+
],
|
|
1610
|
+
"examples": [
|
|
1611
|
+
"<CloseButton ariaLabel=\"Close notification\" onClose={handleClose} />\n<CloseButton ariaLabel=\"Close dialog\" size={ElementSize.Standard} onClose={handleClose} />"
|
|
1612
|
+
],
|
|
1613
|
+
"sourceFile": "components/New/CloseButton/CloseButton.tsx"
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
"name": "ConfirmationPopup",
|
|
1617
|
+
"category": "Components_2_0",
|
|
1618
|
+
"generation": "2.0",
|
|
1619
|
+
"description": "A confirmation dialog built from and the 2.0 .\naliases: ConfirmDialog|WarningDialog\n\nProvides an accessible modal with a title, optional description or custom content,\nand a footer with Cancel / Confirm actions.",
|
|
1620
|
+
"props": [
|
|
1621
|
+
{
|
|
1622
|
+
"name": "description",
|
|
1623
|
+
"type": "ReactNode",
|
|
1624
|
+
"required": false,
|
|
1625
|
+
"description": "Secondary text (ignored when `children` set)"
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
"name": "descriptionClassName",
|
|
1629
|
+
"type": "string",
|
|
1630
|
+
"required": false,
|
|
1631
|
+
"description": "Custom CSS class for the description"
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "confirmLabel",
|
|
1635
|
+
"type": "string",
|
|
1636
|
+
"required": false,
|
|
1637
|
+
"defaultValue": "defaultConfirmLabel",
|
|
1638
|
+
"description": "Label for the confirm button"
|
|
1639
|
+
},
|
|
1640
|
+
{
|
|
1641
|
+
"name": "cancelLabel",
|
|
1642
|
+
"type": "string",
|
|
1643
|
+
"required": false,
|
|
1644
|
+
"defaultValue": "defaultCancelLabel",
|
|
1645
|
+
"description": "Label for the cancel button"
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"name": "isLoading",
|
|
1649
|
+
"type": "boolean",
|
|
1650
|
+
"required": false,
|
|
1651
|
+
"defaultValue": "false",
|
|
1652
|
+
"description": "Shows loader placeholder and hides actions"
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"name": "disableConfirmButton",
|
|
1656
|
+
"type": "boolean",
|
|
1657
|
+
"required": false,
|
|
1658
|
+
"defaultValue": "false",
|
|
1659
|
+
"description": "Disables the confirm button"
|
|
1660
|
+
},
|
|
1661
|
+
{
|
|
1662
|
+
"name": "confirmClassName",
|
|
1663
|
+
"type": "string",
|
|
1664
|
+
"required": false,
|
|
1665
|
+
"description": "Extra classes merged into the confirm button"
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
"name": "onConfirm",
|
|
1669
|
+
"type": "() => void",
|
|
1670
|
+
"required": true,
|
|
1671
|
+
"description": "Fired on confirm"
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "onCancel",
|
|
1675
|
+
"type": "() => void",
|
|
1676
|
+
"required": false,
|
|
1677
|
+
"description": "Fired on cancel (falls back to `onClose`)"
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "children",
|
|
1681
|
+
"type": "ReactNode",
|
|
1682
|
+
"required": false,
|
|
1683
|
+
"description": "Custom body content"
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "variant",
|
|
1687
|
+
"type": "ConfirmationPopupVariant",
|
|
1688
|
+
"required": false,
|
|
1689
|
+
"defaultValue": "ConfirmationPopupVariant.Info",
|
|
1690
|
+
"description": "Visual variant for the popup"
|
|
1691
|
+
}
|
|
1692
|
+
],
|
|
1693
|
+
"examples": [
|
|
1694
|
+
"<ConfirmationPopup\n open\n header=\"Delete item?\"\n description=\"This action cannot be undone.\"\n confirmLabel=\"Delete\"\n variant={ConfirmationPopupVariant.Danger}\n onClose={() => setOpen(false)}\n onConfirm={handleDelete}\n/>"
|
|
1695
|
+
],
|
|
1696
|
+
"sourceFile": "components/New/ConfirmationPopup/ConfirmationPopup.tsx"
|
|
1697
|
+
},
|
|
1698
|
+
{
|
|
1699
|
+
"name": "Dropdown",
|
|
1700
|
+
"category": "Components_2_0",
|
|
1701
|
+
"generation": "2.0",
|
|
1702
|
+
"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`.",
|
|
1703
|
+
"props": [
|
|
1704
|
+
{
|
|
1705
|
+
"name": "children",
|
|
1706
|
+
"type": "ReactNode",
|
|
1707
|
+
"required": true,
|
|
1708
|
+
"description": "Trigger element(s) to anchor and open the menu"
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"name": "items",
|
|
1712
|
+
"type": "DropdownItem[]",
|
|
1713
|
+
"required": false,
|
|
1714
|
+
"description": "Menu items to render"
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"name": "onItemClick",
|
|
1718
|
+
"type": "(info: { key: string; domEvent: MouseEvent }) => void",
|
|
1719
|
+
"required": false,
|
|
1720
|
+
"description": "Global handler fired when any item is clicked"
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"name": "menuHeader",
|
|
1724
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1725
|
+
"required": false,
|
|
1726
|
+
"description": "Content rendered above the items list"
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
"name": "menuFooter",
|
|
1730
|
+
"type": "ReactNode | (() => ReactNode)",
|
|
1731
|
+
"required": false,
|
|
1732
|
+
"description": "Content rendered below the items list"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "renderOverlay",
|
|
1736
|
+
"type": "() => ReactNode",
|
|
1737
|
+
"required": false,
|
|
1738
|
+
"description": "Render function for fully custom overlay content (ignored when `items` is provided)"
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "trigger",
|
|
1742
|
+
"type": "DropdownTrigger[]",
|
|
1743
|
+
"required": false,
|
|
1744
|
+
"defaultValue": "[DropdownTrigger.Click]",
|
|
1745
|
+
"description": "Interactions that open the menu"
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
"name": "placement",
|
|
1749
|
+
"type": "Placement",
|
|
1750
|
+
"required": false,
|
|
1751
|
+
"description": "Floating UI placement string; when omitted, auto placement is used"
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
"name": "allowedPlacements",
|
|
1755
|
+
"type": "Placement[]",
|
|
1756
|
+
"required": false,
|
|
1757
|
+
"description": "Restricts the allowed placements"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"name": "disabled",
|
|
1761
|
+
"type": "boolean",
|
|
1762
|
+
"required": false,
|
|
1763
|
+
"defaultValue": "false",
|
|
1764
|
+
"description": "Disables interaction and prevents opening"
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "open",
|
|
1768
|
+
"type": "boolean",
|
|
1769
|
+
"required": false,
|
|
1770
|
+
"description": "Controlled open state (when provided, `defaultOpen` is ignored)"
|
|
1771
|
+
},
|
|
1772
|
+
{
|
|
1773
|
+
"name": "defaultOpen",
|
|
1774
|
+
"type": "boolean",
|
|
1775
|
+
"required": false,
|
|
1776
|
+
"defaultValue": "false",
|
|
1777
|
+
"description": "Initial open state in uncontrolled mode"
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"name": "onOpenChange",
|
|
1781
|
+
"type": "(open: boolean) => void",
|
|
1782
|
+
"required": false,
|
|
1783
|
+
"description": "Fired whenever the open state changes"
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"name": "closable",
|
|
1787
|
+
"type": "boolean",
|
|
1788
|
+
"required": false,
|
|
1789
|
+
"defaultValue": "false",
|
|
1790
|
+
"description": "Whether the overlay shows an internal close button"
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
"name": "onClose",
|
|
1794
|
+
"type": "(e: MouseEvent<HTMLButtonElement>) => void",
|
|
1795
|
+
"required": false,
|
|
1796
|
+
"description": "Fired when the close button inside the overlay is clicked"
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"name": "className",
|
|
1800
|
+
"type": "string",
|
|
1801
|
+
"required": false,
|
|
1802
|
+
"description": "Additional CSS classes applied to the trigger wrapper"
|
|
1803
|
+
},
|
|
1804
|
+
{
|
|
1805
|
+
"name": "overlayContentClassName",
|
|
1806
|
+
"type": "string",
|
|
1807
|
+
"required": false,
|
|
1808
|
+
"description": "Additional CSS classes applied to the overlay content"
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
"name": "separatorClassName",
|
|
1812
|
+
"type": "string",
|
|
1813
|
+
"required": false,
|
|
1814
|
+
"description": "Additional CSS classes applied to the separators between items"
|
|
1815
|
+
},
|
|
1816
|
+
{
|
|
1817
|
+
"name": "listClassName",
|
|
1818
|
+
"type": "string",
|
|
1819
|
+
"required": false,
|
|
1820
|
+
"description": "Additional CSS classes applied to the floating overlay"
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"name": "outsidePressIgnoreRef",
|
|
1824
|
+
"type": "RefObject<HTMLElement | null>",
|
|
1825
|
+
"required": false,
|
|
1826
|
+
"description": "Ref to an element that should not trigger outside press behavior"
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "outsideClosable",
|
|
1830
|
+
"type": "boolean",
|
|
1831
|
+
"required": false,
|
|
1832
|
+
"defaultValue": "true",
|
|
1833
|
+
"description": "Whether clicks outside the overlay should close it"
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"name": "anchorToMouse",
|
|
1837
|
+
"type": "boolean",
|
|
1838
|
+
"required": false,
|
|
1839
|
+
"defaultValue": "false",
|
|
1840
|
+
"description": "Whether to anchor the dropdown to the mouse position"
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "matchReferenceWidth",
|
|
1844
|
+
"type": "boolean",
|
|
1845
|
+
"required": false,
|
|
1846
|
+
"defaultValue": "true",
|
|
1847
|
+
"description": "Whether to match the reference element's width"
|
|
1848
|
+
},
|
|
1849
|
+
{
|
|
1850
|
+
"name": "maxDropdownHeight",
|
|
1851
|
+
"type": "number | null",
|
|
1852
|
+
"required": false,
|
|
1853
|
+
"description": "Maximum height of the dropdown menu; when omitted, no limit is applied"
|
|
1854
|
+
}
|
|
1855
|
+
],
|
|
1856
|
+
"examples": [
|
|
1857
|
+
"// Simple items menu\n<Dropdown items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Open</button>\n</Dropdown>\n\n// Hover trigger\n<Dropdown trigger={[DropdownTrigger.Hover]} placement=\"bottom-end\" items={items}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Hover me</button>\n</Dropdown>\n\n// Custom overlay content\n<Dropdown closable renderOverlay={() => <div className=\"p-3\">Custom content</div>}>\n <button type=\"button\" className=\"px-3 py-2 rounded border\">Custom</button>\n</Dropdown>"
|
|
1858
|
+
],
|
|
1859
|
+
"sourceFile": "components/New/Dropdown/Dropdown.tsx"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "CaptionText",
|
|
1863
|
+
"category": "Components_2_0",
|
|
1864
|
+
"generation": "2.0",
|
|
1865
|
+
"description": "A component for displaying caption text with consistent styling\naliases: HelperText|ValidationText",
|
|
1866
|
+
"props": [
|
|
1867
|
+
{
|
|
1868
|
+
"name": "text",
|
|
1869
|
+
"type": "string",
|
|
1870
|
+
"required": false,
|
|
1871
|
+
"description": "The text to display. If undefined or empty, nothing is rendered"
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"name": "variant",
|
|
1875
|
+
"type": "CaptionType",
|
|
1876
|
+
"required": false,
|
|
1877
|
+
"defaultValue": "CaptionType.Description",
|
|
1878
|
+
"description": "The variant of the caption text, e.g., error or description."
|
|
1879
|
+
}
|
|
1880
|
+
],
|
|
1881
|
+
"examples": [
|
|
1882
|
+
"<CaptionText text=\"This field is required\" variant={CaptionType.Error} />"
|
|
1883
|
+
],
|
|
1884
|
+
"sourceFile": "components/New/CaptionText/CaptionText.tsx"
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
"name": "ErrorText",
|
|
1888
|
+
"category": "Components_2_0",
|
|
1889
|
+
"generation": "2.0",
|
|
1890
|
+
"description": "",
|
|
1891
|
+
"props": [],
|
|
1892
|
+
"examples": [],
|
|
1893
|
+
"sourceFile": "components/New/CaptionText/CaptionText.tsx"
|
|
1894
|
+
},
|
|
26
1895
|
{
|
|
27
1896
|
"name": "DialCaptionText",
|
|
28
1897
|
"category": "Elements",
|
|
1898
|
+
"generation": "1.0",
|
|
29
1899
|
"description": "A component for displaying error messages with consistent styling\naliases: HelperText|ValidationText",
|
|
30
1900
|
"props": [
|
|
31
1901
|
{
|
|
32
|
-
"name": "text",
|
|
1902
|
+
"name": "text",
|
|
1903
|
+
"type": "string",
|
|
1904
|
+
"required": false,
|
|
1905
|
+
"description": "The text to display. If undefined or empty, nothing is rendered"
|
|
1906
|
+
},
|
|
1907
|
+
{
|
|
1908
|
+
"name": "variant",
|
|
1909
|
+
"type": "CaptionType",
|
|
1910
|
+
"required": false,
|
|
1911
|
+
"defaultValue": "CaptionType.Description",
|
|
1912
|
+
"description": "The variant of the caption text, e.g., error or description."
|
|
1913
|
+
}
|
|
1914
|
+
],
|
|
1915
|
+
"examples": [
|
|
1916
|
+
"<DialCaptionText text=\"This field is required\" variant={CaptionType.Error} />"
|
|
1917
|
+
],
|
|
1918
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx",
|
|
1919
|
+
"supersededBy": "CaptionText"
|
|
1920
|
+
},
|
|
1921
|
+
{
|
|
1922
|
+
"name": "DialErrorText",
|
|
1923
|
+
"category": "Elements",
|
|
1924
|
+
"generation": "1.0",
|
|
1925
|
+
"description": "",
|
|
1926
|
+
"props": [],
|
|
1927
|
+
"examples": [],
|
|
1928
|
+
"sourceFile": "components/CaptionText/CaptionText.tsx",
|
|
1929
|
+
"supersededBy": "ErrorText"
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"name": "DialAnalyticsCard",
|
|
1933
|
+
"category": "Analytics",
|
|
1934
|
+
"generation": "1.0",
|
|
1935
|
+
"description": "A simple analytics summary card that displays a single metric as a title,\na prominent value, and an optional description.\naliases: MetricCard|StatCard|KpiCard\n\nTwo visual variants are available via the enum:\n- `Default` — `bg-layer-3`, large `dial-display2-text` value, supports a description.\n- `Compact` — denser `bg-layer-2` card with a `dial-body-semi-text` value and no\n description (the `description` prop is ignored in this variant).\n\n**Compare mode** — pass `compareValues` to split the value area 50/50 between two\nmetrics, each with its own sub-title. Pair with `delta` to show a change badge next\nto the card title.",
|
|
1936
|
+
"props": [
|
|
1937
|
+
{
|
|
1938
|
+
"name": "title",
|
|
1939
|
+
"type": "ReactNode",
|
|
1940
|
+
"required": true,
|
|
1941
|
+
"description": "Short label describing the metric, rendered above the value."
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "value",
|
|
1945
|
+
"type": "ReactNode",
|
|
1946
|
+
"required": false,
|
|
1947
|
+
"description": "The primary metric value. Ignored when `compareValues` is set."
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "description",
|
|
1951
|
+
"type": "ReactNode",
|
|
1952
|
+
"required": false,
|
|
1953
|
+
"description": "Optional supporting text. Ignored when `variant` is `Compact`."
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"name": "variant",
|
|
1957
|
+
"type": "AnalyticsCardVariant",
|
|
1958
|
+
"required": false,
|
|
1959
|
+
"defaultValue": "AnalyticsCardVariant.Default",
|
|
1960
|
+
"description": "Visual style of the card."
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"name": "error",
|
|
1964
|
+
"type": "boolean",
|
|
1965
|
+
"required": false,
|
|
1966
|
+
"description": "Renders an error tag in place of the value."
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "isLoading",
|
|
1970
|
+
"type": "boolean",
|
|
1971
|
+
"required": false,
|
|
1972
|
+
"description": "Renders a loader in place of the value."
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "className",
|
|
1976
|
+
"type": "string",
|
|
1977
|
+
"required": false,
|
|
1978
|
+
"description": "Additional CSS classes for the card container."
|
|
1979
|
+
},
|
|
1980
|
+
{
|
|
1981
|
+
"name": "delta",
|
|
1982
|
+
"type": "number",
|
|
1983
|
+
"required": false,
|
|
1984
|
+
"description": "Numeric change shown as a badge next to the title. ≥0 = success, <0 = error."
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
"name": "deltaPositive",
|
|
1988
|
+
"type": "boolean",
|
|
1989
|
+
"required": false
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"name": "compareValues",
|
|
1993
|
+
"type": "[AnalyticsCardCompareItem, AnalyticsCardCompareItem]",
|
|
1994
|
+
"required": false,
|
|
1995
|
+
"description": "Enables compare mode with two side-by-side metrics."
|
|
1996
|
+
}
|
|
1997
|
+
],
|
|
1998
|
+
"examples": [
|
|
1999
|
+
"<DialAnalyticsCard\n title=\"Total requests\"\n value=\"12,480\"\n description=\"+12% vs last week\"\n/>",
|
|
2000
|
+
"<DialAnalyticsCard\n title=\"Response time\"\n delta={12}\n compareValues={[\n { title: 'This week', value: '248ms' },\n { title: 'Last week', value: '220ms' },\n ]}\n/>"
|
|
2001
|
+
],
|
|
2002
|
+
"sourceFile": "components/Analytics/Card/Card.tsx"
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
"name": "DialAnalyticsBar",
|
|
2006
|
+
"category": "Analytics",
|
|
2007
|
+
"generation": "1.0",
|
|
2008
|
+
"description": "A compact analytics meter: a horizontal bar whose fill width and color reflect a\nvalue relative to `maxValue`, with an optional title on the left and value on the right.\naliases: MetricBar|Meter|ScoreBar\n\nThe fill color is resolved from `colorMap` based on the normalized ratio\n(`value / maxValue`), so the bar shifts hue as the value grows. An empty bar\n(value `0`) shows only the `bg-layer-1` track.",
|
|
2009
|
+
"props": [
|
|
2010
|
+
{
|
|
2011
|
+
"name": "value",
|
|
2012
|
+
"type": "number",
|
|
2013
|
+
"required": false,
|
|
2014
|
+
"description": "Current value used to size and color the bar. Omit it when `error` is set."
|
|
2015
|
+
},
|
|
2016
|
+
{
|
|
2017
|
+
"name": "maxValue",
|
|
2018
|
+
"type": "number",
|
|
2019
|
+
"required": false,
|
|
2020
|
+
"defaultValue": "1",
|
|
2021
|
+
"description": "Upper bound of the scale."
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
"name": "error",
|
|
2025
|
+
"type": "boolean",
|
|
2026
|
+
"required": false,
|
|
2027
|
+
"description": "Renders the error state (error-colored bar + error tag)."
|
|
2028
|
+
},
|
|
2029
|
+
{
|
|
2030
|
+
"name": "isLoading",
|
|
2031
|
+
"type": "boolean",
|
|
2032
|
+
"required": false,
|
|
2033
|
+
"description": "Renders the loading state (loader + empty track)."
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "title",
|
|
2037
|
+
"type": "ReactNode",
|
|
2038
|
+
"required": false,
|
|
2039
|
+
"description": "Optional label rendered above the bar, on the left."
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"name": "valueLabel",
|
|
2043
|
+
"type": "ReactNode",
|
|
2044
|
+
"required": false,
|
|
2045
|
+
"description": "Text rendered above the bar, on the right. Defaults to `value`."
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "colorMap",
|
|
2049
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2050
|
+
"required": false,
|
|
2051
|
+
"defaultValue": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
2052
|
+
"description": "Color bands keyed by ratio."
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "className",
|
|
2056
|
+
"type": "string",
|
|
2057
|
+
"required": false,
|
|
2058
|
+
"description": "Additional CSS classes for the outer container."
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"name": "titleClassName",
|
|
2062
|
+
"type": "string",
|
|
2063
|
+
"required": false,
|
|
2064
|
+
"description": "Additional CSS classes for the title label."
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
"name": "valueClassName",
|
|
2068
|
+
"type": "string",
|
|
2069
|
+
"required": false,
|
|
2070
|
+
"description": "Additional CSS classes for the value label."
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"name": "inline",
|
|
2074
|
+
"type": "boolean",
|
|
2075
|
+
"required": false,
|
|
2076
|
+
"description": "Renders the title and bar on a single row (50% / 50%)."
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"name": "ariaLabel",
|
|
2080
|
+
"type": "string",
|
|
2081
|
+
"required": false,
|
|
2082
|
+
"description": "Accessible label for the bar."
|
|
2083
|
+
}
|
|
2084
|
+
],
|
|
2085
|
+
"examples": [
|
|
2086
|
+
"<DialAnalyticsBar title=\"Relevance\" value={0.82} valueLabel=\"82%\" />",
|
|
2087
|
+
"<DialAnalyticsBar\n title=\"Score\"\n value={640}\n maxValue={1000}\n colorMap={customColorMap}\n/>"
|
|
2088
|
+
],
|
|
2089
|
+
"sourceFile": "components/Analytics/Bar/Bar.tsx"
|
|
2090
|
+
},
|
|
2091
|
+
{
|
|
2092
|
+
"name": "DialAnalyticsErrorTag",
|
|
2093
|
+
"category": "Analytics",
|
|
2094
|
+
"generation": "1.0",
|
|
2095
|
+
"description": "A non-interactive error tag used across analytics components to indicate that a\nmetric value could not be provided. Renders a styled with the\nerror palette (`bg-error`, `text-error`, `border-error`).",
|
|
2096
|
+
"props": [
|
|
2097
|
+
{
|
|
2098
|
+
"name": "label",
|
|
2099
|
+
"type": "string",
|
|
2100
|
+
"required": false,
|
|
2101
|
+
"defaultValue": "'Error'",
|
|
2102
|
+
"description": "Text shown inside the tag."
|
|
2103
|
+
},
|
|
2104
|
+
{
|
|
2105
|
+
"name": "className",
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"required": false,
|
|
2108
|
+
"description": "Additional CSS classes applied to the tag."
|
|
2109
|
+
}
|
|
2110
|
+
],
|
|
2111
|
+
"examples": [
|
|
2112
|
+
"<DialAnalyticsErrorTag />"
|
|
2113
|
+
],
|
|
2114
|
+
"sourceFile": "components/Analytics/ErrorTag/ErrorTag.tsx"
|
|
2115
|
+
},
|
|
2116
|
+
{
|
|
2117
|
+
"name": "DialAnalyticsBarGroup",
|
|
2118
|
+
"category": "Analytics",
|
|
2119
|
+
"generation": "1.0",
|
|
2120
|
+
"description": "A collapsible group of analytics bars built from a key/value map. Wraps\n: the `title` is shown in the header, the number of entries\nis shown as the header description, and each entry renders a \nwith the key as its title and the value as its value.\naliases: MetricBarGroup|BarList|NumericResults",
|
|
2121
|
+
"props": [
|
|
2122
|
+
{
|
|
2123
|
+
"name": "title",
|
|
2124
|
+
"type": "ReactNode",
|
|
2125
|
+
"required": true,
|
|
2126
|
+
"description": "Title passed to the accordion header."
|
|
2127
|
+
},
|
|
2128
|
+
{
|
|
2129
|
+
"name": "titleTooltip",
|
|
2130
|
+
"type": "ReactNode",
|
|
2131
|
+
"required": false,
|
|
2132
|
+
"description": "Tooltip shown when hovering the accordion header title."
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
"name": "description",
|
|
2136
|
+
"type": "ReactNode",
|
|
2137
|
+
"required": false,
|
|
2138
|
+
"description": "Description passed to the accordion header. Defaults to the number of entries."
|
|
2139
|
+
},
|
|
2140
|
+
{
|
|
2141
|
+
"name": "data",
|
|
2142
|
+
"type": "Record<string, number>",
|
|
2143
|
+
"required": true,
|
|
2144
|
+
"description": "Map of metric name to numeric value. Each entry renders one bar."
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"name": "compareData",
|
|
2148
|
+
"type": "Record<string, number>",
|
|
2149
|
+
"required": false,
|
|
2150
|
+
"description": "Enables compare mode: each entry shows a delta badge and two bars."
|
|
2151
|
+
},
|
|
2152
|
+
{
|
|
2153
|
+
"name": "compareLabels",
|
|
2154
|
+
"type": "[ReactNode, ReactNode]",
|
|
2155
|
+
"required": false,
|
|
2156
|
+
"description": "Labels for the two bars in compare mode: first for `data`, second for `compareData`."
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"name": "maxValue",
|
|
2160
|
+
"type": "number",
|
|
2161
|
+
"required": false,
|
|
2162
|
+
"description": "Upper bound passed to every bar."
|
|
2163
|
+
},
|
|
2164
|
+
{
|
|
2165
|
+
"name": "colorMap",
|
|
2166
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2167
|
+
"required": false,
|
|
2168
|
+
"description": "Color map passed to every bar."
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"name": "defaultExpanded",
|
|
2172
|
+
"type": "boolean",
|
|
2173
|
+
"required": false,
|
|
2174
|
+
"defaultValue": "true",
|
|
2175
|
+
"description": "Whether the accordion is expanded initially."
|
|
2176
|
+
},
|
|
2177
|
+
{
|
|
2178
|
+
"name": "nonCollapsible",
|
|
2179
|
+
"type": "boolean",
|
|
2180
|
+
"required": false,
|
|
2181
|
+
"description": "Renders the group permanently expanded without a toggle or chevron."
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"name": "isLoading",
|
|
2185
|
+
"type": "boolean",
|
|
2186
|
+
"required": false,
|
|
2187
|
+
"description": "Renders a loader in place of the bars while the data is being fetched."
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"name": "onBarClick",
|
|
2191
|
+
"type": "(key: string, value: number) => void",
|
|
2192
|
+
"required": false,
|
|
2193
|
+
"description": "Invoked with the entry key and value when a bar is clicked."
|
|
2194
|
+
},
|
|
2195
|
+
{
|
|
2196
|
+
"name": "inline",
|
|
2197
|
+
"type": "boolean",
|
|
2198
|
+
"required": false,
|
|
2199
|
+
"description": "Renders every bar on a single row (50% title, 50% bar + value)."
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"name": "barTitleClassName",
|
|
33
2203
|
"type": "string",
|
|
34
2204
|
"required": false,
|
|
35
|
-
"description": "
|
|
2205
|
+
"description": "Additional CSS classes for each bar's title label."
|
|
36
2206
|
},
|
|
37
2207
|
{
|
|
38
|
-
"name": "
|
|
39
|
-
"type": "
|
|
2208
|
+
"name": "barValueClassName",
|
|
2209
|
+
"type": "string",
|
|
40
2210
|
"required": false,
|
|
41
|
-
"
|
|
42
|
-
|
|
2211
|
+
"description": "Additional CSS classes for each bar's value label."
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"name": "barClassName",
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"required": false,
|
|
2217
|
+
"description": "Additional CSS classes for each bar's outer container."
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "barDescriptions",
|
|
2221
|
+
"type": "Record<string, ReactNode>",
|
|
2222
|
+
"required": false,
|
|
2223
|
+
"description": "Map of bar key to tooltip content. Hovering each bar shows its description. Not applied in compare mode."
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
"name": "className",
|
|
2227
|
+
"type": "string",
|
|
2228
|
+
"required": false,
|
|
2229
|
+
"description": "Additional CSS classes for the accordion container."
|
|
43
2230
|
}
|
|
44
2231
|
],
|
|
45
2232
|
"examples": [
|
|
46
|
-
"<
|
|
2233
|
+
"<DialAnalyticsBarGroup\n title=\"Relevance\"\n data={{ accuracy: 0.82, recall: 0.64, precision: 0.91 }}\n/>"
|
|
47
2234
|
],
|
|
48
|
-
"sourceFile": "components/
|
|
2235
|
+
"sourceFile": "components/Analytics/BarGroup/BarGroup.tsx"
|
|
49
2236
|
},
|
|
50
2237
|
{
|
|
51
|
-
"name": "
|
|
52
|
-
"category": "
|
|
53
|
-
"
|
|
54
|
-
"
|
|
55
|
-
"
|
|
56
|
-
|
|
2238
|
+
"name": "DialAnalyticsHistogram",
|
|
2239
|
+
"category": "Analytics",
|
|
2240
|
+
"generation": "1.0",
|
|
2241
|
+
"description": "A histogram that distributes `values` across the bands of a color map and draws a\ncolumn per band. Each column's height is relative to the most populated band; empty\ncolumns are outlined, populated columns are filled with their band color. A baseline\nseparates the columns from the interval labels, and hovering a column reveals a\ntooltip with its share of the total.\naliases: Distribution|ColumnChart|FrequencyChart",
|
|
2242
|
+
"props": [
|
|
2243
|
+
{
|
|
2244
|
+
"name": "title",
|
|
2245
|
+
"type": "ReactNode",
|
|
2246
|
+
"required": true,
|
|
2247
|
+
"description": "Title rendered above the histogram."
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"name": "values",
|
|
2251
|
+
"type": "number[]",
|
|
2252
|
+
"required": true,
|
|
2253
|
+
"description": "Values to distribute across the columns."
|
|
2254
|
+
},
|
|
2255
|
+
{
|
|
2256
|
+
"name": "colorMap",
|
|
2257
|
+
"type": "AnalyticsBarColorStop[]",
|
|
2258
|
+
"required": false,
|
|
2259
|
+
"defaultValue": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
2260
|
+
"description": "Color bands defining the columns."
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
"name": "valueTitle",
|
|
2264
|
+
"type": "string",
|
|
2265
|
+
"required": false,
|
|
2266
|
+
"defaultValue": "'values'",
|
|
2267
|
+
"description": "Noun used in the hover tooltip."
|
|
2268
|
+
},
|
|
2269
|
+
{
|
|
2270
|
+
"name": "showCount",
|
|
2271
|
+
"type": "boolean",
|
|
2272
|
+
"required": false,
|
|
2273
|
+
"description": "When `true`, renders each column's count inside its bar."
|
|
2274
|
+
},
|
|
2275
|
+
{
|
|
2276
|
+
"name": "isLoading",
|
|
2277
|
+
"type": "boolean",
|
|
2278
|
+
"required": false,
|
|
2279
|
+
"description": "Renders a loader in place of the histogram while the data is being fetched."
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
"name": "className",
|
|
2283
|
+
"type": "string",
|
|
2284
|
+
"required": false,
|
|
2285
|
+
"description": "Additional CSS classes for the outer container."
|
|
2286
|
+
},
|
|
2287
|
+
{
|
|
2288
|
+
"name": "compareValues",
|
|
2289
|
+
"type": "number[]",
|
|
2290
|
+
"required": false,
|
|
2291
|
+
"description": "Second set of values; enables compare mode (primary striped, compare solid)."
|
|
2292
|
+
},
|
|
2293
|
+
{
|
|
2294
|
+
"name": "valueSetLabel",
|
|
2295
|
+
"type": "string",
|
|
2296
|
+
"required": false,
|
|
2297
|
+
"description": "Label for the primary values set (compare mode tooltip)."
|
|
2298
|
+
},
|
|
2299
|
+
{
|
|
2300
|
+
"name": "compareValueSetLabel",
|
|
2301
|
+
"type": "string",
|
|
2302
|
+
"required": false,
|
|
2303
|
+
"description": "Label for the compare values set (compare mode tooltip)."
|
|
2304
|
+
}
|
|
2305
|
+
],
|
|
2306
|
+
"examples": [
|
|
2307
|
+
"<DialAnalyticsHistogram\n title=\"Score distribution\"\n values={[0.1, 0.15, 0.4, 0.42, 0.43, 0.9, 1]}\n valueTitle=\"responses\"\n/>"
|
|
2308
|
+
],
|
|
2309
|
+
"sourceFile": "components/Analytics/Histogram/Histogram.tsx"
|
|
57
2310
|
},
|
|
58
2311
|
{
|
|
59
2312
|
"name": "DialLabel",
|
|
60
2313
|
"category": "Elements",
|
|
2314
|
+
"generation": "1.0",
|
|
61
2315
|
"description": "A label component\naliases: FormLabel|RequiredIndicator",
|
|
62
2316
|
"props": [
|
|
63
2317
|
{
|
|
@@ -82,11 +2336,13 @@
|
|
|
82
2336
|
"examples": [
|
|
83
2337
|
"// Basic label\n<DialLabel htmlFor=\"email-input\" label=\"Email Address\" />"
|
|
84
2338
|
],
|
|
85
|
-
"sourceFile": "components/Label/Label.tsx"
|
|
2339
|
+
"sourceFile": "components/Label/Label.tsx",
|
|
2340
|
+
"supersededBy": "Label"
|
|
86
2341
|
},
|
|
87
2342
|
{
|
|
88
2343
|
"name": "DialAccordion",
|
|
89
2344
|
"category": "Layout",
|
|
2345
|
+
"generation": "1.0",
|
|
90
2346
|
"description": "A collapsible panel that toggles its content when the header is clicked.\naliases: Collapse|Disclosure|ExpandablePanel\n\nWorks as a controlled component when `expanded` is provided, otherwise it manages\nits own state from `defaultExpanded`. The header shows a chevron that rotates when\nexpanded, a title, and an optional description.",
|
|
91
2347
|
"props": [
|
|
92
2348
|
{
|
|
@@ -165,6 +2421,7 @@
|
|
|
165
2421
|
{
|
|
166
2422
|
"name": "DialIcon",
|
|
167
2423
|
"category": "Data Display",
|
|
2424
|
+
"generation": "1.0",
|
|
168
2425
|
"description": "A wrapper component for rendering icons with consistent styling\naliases: IconRenderer|SVGWrapper",
|
|
169
2426
|
"props": [
|
|
170
2427
|
{
|
|
@@ -188,6 +2445,7 @@
|
|
|
188
2445
|
{
|
|
189
2446
|
"name": "DialNotification",
|
|
190
2447
|
"category": "Elements",
|
|
2448
|
+
"generation": "1.0",
|
|
191
2449
|
"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.",
|
|
192
2450
|
"props": [
|
|
193
2451
|
{
|
|
@@ -247,11 +2505,13 @@
|
|
|
247
2505
|
"examples": [
|
|
248
2506
|
"<DialNotification\n variant={NotificationVariant.Info}\n message=\"This is an info alert.\"\n/>\n\n<DialNotification\n variant={NotificationVariant.Success}\n title=\"Saved\"\n message=\"Changes saved successfully.\"\n/>\n\n<DialNotification\n variant={NotificationVariant.Error}\n closable\n message=\"Something went wrong.\"\n onClose={(e) => console.log('closed', e)}\n/>\n\n<DialNotification\n variant={NotificationVariant.Loading}\n title=\"Processing\"\n message=\"Please wait...\"\n/>"
|
|
249
2507
|
],
|
|
250
|
-
"sourceFile": "components/Notification/Notification.tsx"
|
|
2508
|
+
"sourceFile": "components/Notification/Notification.tsx",
|
|
2509
|
+
"supersededBy": "Notification"
|
|
251
2510
|
},
|
|
252
2511
|
{
|
|
253
2512
|
"name": "DialLoader",
|
|
254
2513
|
"category": "Feedback",
|
|
2514
|
+
"generation": "1.0",
|
|
255
2515
|
"description": "A simple loading spinner component.\naliases: LoadingSpinner|ProgressSpinner\n\nRenders a spinning SVG with optional full-width container.",
|
|
256
2516
|
"props": [
|
|
257
2517
|
{
|
|
@@ -296,6 +2556,7 @@
|
|
|
296
2556
|
{
|
|
297
2557
|
"name": "DialProgressBar",
|
|
298
2558
|
"category": "Status",
|
|
2559
|
+
"generation": "1.0",
|
|
299
2560
|
"description": "",
|
|
300
2561
|
"props": [
|
|
301
2562
|
{
|
|
@@ -333,6 +2594,7 @@
|
|
|
333
2594
|
{
|
|
334
2595
|
"name": "DialPagination",
|
|
335
2596
|
"category": "Navigation",
|
|
2597
|
+
"generation": "1.0",
|
|
336
2598
|
"description": "",
|
|
337
2599
|
"props": [
|
|
338
2600
|
{
|
|
@@ -362,6 +2624,7 @@
|
|
|
362
2624
|
{
|
|
363
2625
|
"name": "DialCheckbox",
|
|
364
2626
|
"category": "Form",
|
|
2627
|
+
"generation": "1.0",
|
|
365
2628
|
"description": "A Checkbox component with styling options\naliases: ToggleCheckbox|MultiSelectOption",
|
|
366
2629
|
"props": [
|
|
367
2630
|
{
|
|
@@ -415,6 +2678,7 @@
|
|
|
415
2678
|
{
|
|
416
2679
|
"name": "DialSteps",
|
|
417
2680
|
"category": "Navigation",
|
|
2681
|
+
"generation": "1.0",
|
|
418
2682
|
"description": "Props for the DialSteps component, which renders a multi-step navigation UI.\naliases: StepWizard|ProgressSteps",
|
|
419
2683
|
"props": [
|
|
420
2684
|
{
|
|
@@ -444,6 +2708,7 @@
|
|
|
444
2708
|
{
|
|
445
2709
|
"name": "DialRadioButton",
|
|
446
2710
|
"category": "Free",
|
|
2711
|
+
"generation": "1.0",
|
|
447
2712
|
"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.",
|
|
448
2713
|
"props": [
|
|
449
2714
|
{
|
|
@@ -541,6 +2806,7 @@
|
|
|
541
2806
|
{
|
|
542
2807
|
"name": "DialRadioGroup",
|
|
543
2808
|
"category": "Form",
|
|
2809
|
+
"generation": "1.0",
|
|
544
2810
|
"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.",
|
|
545
2811
|
"props": [
|
|
546
2812
|
{
|
|
@@ -660,6 +2926,7 @@
|
|
|
660
2926
|
{
|
|
661
2927
|
"name": "DialSlider",
|
|
662
2928
|
"category": "Form",
|
|
2929
|
+
"generation": "1.0",
|
|
663
2930
|
"description": "A range slider with a custom thumb showing the current value and optional labels.\naliases: RangeInput|TemperatureSlider",
|
|
664
2931
|
"props": [
|
|
665
2932
|
{
|
|
@@ -753,6 +3020,7 @@
|
|
|
753
3020
|
{
|
|
754
3021
|
"name": "DialNoDataContent",
|
|
755
3022
|
"category": "Feedback",
|
|
3023
|
+
"generation": "1.0",
|
|
756
3024
|
"description": "A component for displaying a message and icon when there is no data to show.\naliases: EmptyState|NoResults",
|
|
757
3025
|
"props": [
|
|
758
3026
|
{
|
|
@@ -800,6 +3068,7 @@
|
|
|
800
3068
|
{
|
|
801
3069
|
"name": "DialCollapsibleSidebar",
|
|
802
3070
|
"category": "Navigation",
|
|
3071
|
+
"generation": "1.0",
|
|
803
3072
|
"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.",
|
|
804
3073
|
"props": [
|
|
805
3074
|
{
|
|
@@ -874,6 +3143,7 @@
|
|
|
874
3143
|
{
|
|
875
3144
|
"name": "DialLabelledText",
|
|
876
3145
|
"category": "Data Display",
|
|
3146
|
+
"generation": "1.0",
|
|
877
3147
|
"description": "A label component for form fields with optional tooltip, content, and custom elements.\naliases: LabelValue|DisplayText",
|
|
878
3148
|
"props": [
|
|
879
3149
|
{
|
|
@@ -921,6 +3191,7 @@
|
|
|
921
3191
|
{
|
|
922
3192
|
"name": "DialTag",
|
|
923
3193
|
"category": "Tag",
|
|
3194
|
+
"generation": "1.0",
|
|
924
3195
|
"description": "A compact label element used for selections, filters, or categories.",
|
|
925
3196
|
"props": [
|
|
926
3197
|
{
|
|
@@ -965,6 +3236,7 @@
|
|
|
965
3236
|
{
|
|
966
3237
|
"name": "DialEllipsisTooltip",
|
|
967
3238
|
"category": "Overlay",
|
|
3239
|
+
"generation": "1.0",
|
|
968
3240
|
"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.",
|
|
969
3241
|
"props": [
|
|
970
3242
|
{
|
|
@@ -1012,6 +3284,7 @@
|
|
|
1012
3284
|
{
|
|
1013
3285
|
"name": "DialDraggableItem",
|
|
1014
3286
|
"category": "Components",
|
|
3287
|
+
"generation": "1.0",
|
|
1015
3288
|
"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.",
|
|
1016
3289
|
"props": [
|
|
1017
3290
|
{
|
|
@@ -1060,6 +3333,7 @@
|
|
|
1060
3333
|
{
|
|
1061
3334
|
"name": "DialFileIcon",
|
|
1062
3335
|
"category": "FileManager/components",
|
|
3336
|
+
"generation": "1.0",
|
|
1063
3337
|
"description": "Renders a file-type icon based on a file extension.\naliases: ExtensionIcon|TypeIcon\n\nUses DialIcon to provide consistent icon wrapper styling.",
|
|
1064
3338
|
"props": [
|
|
1065
3339
|
{
|
|
@@ -1116,6 +3390,7 @@
|
|
|
1116
3390
|
{
|
|
1117
3391
|
"name": "DialFormItem",
|
|
1118
3392
|
"category": "Form",
|
|
3393
|
+
"generation": "1.0",
|
|
1119
3394
|
"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)",
|
|
1120
3395
|
"props": [
|
|
1121
3396
|
{
|
|
@@ -1182,6 +3457,7 @@
|
|
|
1182
3457
|
{
|
|
1183
3458
|
"name": "DialSharedEntityIndicator",
|
|
1184
3459
|
"category": "FileManager/components",
|
|
3460
|
+
"generation": "1.0",
|
|
1185
3461
|
"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.",
|
|
1186
3462
|
"props": [
|
|
1187
3463
|
{
|
|
@@ -1232,6 +3508,7 @@
|
|
|
1232
3508
|
{
|
|
1233
3509
|
"name": "DialFileName",
|
|
1234
3510
|
"category": "FileManager/components",
|
|
3511
|
+
"generation": "1.0",
|
|
1235
3512
|
"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.",
|
|
1236
3513
|
"props": [
|
|
1237
3514
|
{
|
|
@@ -1311,6 +3588,7 @@
|
|
|
1311
3588
|
{
|
|
1312
3589
|
"name": "DialFolderName",
|
|
1313
3590
|
"category": "FileManager/components",
|
|
3591
|
+
"generation": "1.0",
|
|
1314
3592
|
"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.",
|
|
1315
3593
|
"props": [
|
|
1316
3594
|
{
|
|
@@ -1387,6 +3665,7 @@
|
|
|
1387
3665
|
{
|
|
1388
3666
|
"name": "DialResizableContainer",
|
|
1389
3667
|
"category": "Components",
|
|
3668
|
+
"generation": "1.0",
|
|
1390
3669
|
"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",
|
|
1391
3670
|
"props": [
|
|
1392
3671
|
{
|
|
@@ -1457,6 +3736,7 @@
|
|
|
1457
3736
|
{
|
|
1458
3737
|
"name": "DialConditionalResizableContainer",
|
|
1459
3738
|
"category": "Components",
|
|
3739
|
+
"generation": "1.0",
|
|
1460
3740
|
"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.",
|
|
1461
3741
|
"props": [
|
|
1462
3742
|
{
|
|
@@ -1472,92 +3752,10 @@
|
|
|
1472
3752
|
],
|
|
1473
3753
|
"sourceFile": "components/ResizableContainer/ConditionalResizableContainer.tsx"
|
|
1474
3754
|
},
|
|
1475
|
-
{
|
|
1476
|
-
"name": "DialSkeleton",
|
|
1477
|
-
"category": "Feedback",
|
|
1478
|
-
"description": "DialSkeleton\naliases: PlaceholderUI|ShimmerLoader\n\nA placeholder component to show while content is loading.\nProvides various skeleton shapes and configurations.",
|
|
1479
|
-
"props": [
|
|
1480
|
-
{
|
|
1481
|
-
"name": "active",
|
|
1482
|
-
"type": "boolean",
|
|
1483
|
-
"required": false,
|
|
1484
|
-
"defaultValue": "true",
|
|
1485
|
-
"description": "Whether to show the loading animation"
|
|
1486
|
-
},
|
|
1487
|
-
{
|
|
1488
|
-
"name": "paragraph",
|
|
1489
|
-
"type": "boolean | { rows?: number; width?: string | string[] }",
|
|
1490
|
-
"required": false,
|
|
1491
|
-
"defaultValue": "true",
|
|
1492
|
-
"description": "Show paragraph placeholder or configure its appearance"
|
|
1493
|
-
},
|
|
1494
|
-
{
|
|
1495
|
-
"name": "avatar",
|
|
1496
|
-
"type": "| boolean\n | {\n size?: number | DialSkeletonAvatarSize;\n shape?: DialSkeletonAvatarShape;\n }",
|
|
1497
|
-
"required": false,
|
|
1498
|
-
"defaultValue": "false",
|
|
1499
|
-
"description": "Show avatar placeholder or configure its appearance"
|
|
1500
|
-
},
|
|
1501
|
-
{
|
|
1502
|
-
"name": "showTitle",
|
|
1503
|
-
"type": "boolean | { width?: string }",
|
|
1504
|
-
"required": false,
|
|
1505
|
-
"defaultValue": "true",
|
|
1506
|
-
"description": "Show title placeholder or configure its appearance"
|
|
1507
|
-
},
|
|
1508
|
-
{
|
|
1509
|
-
"name": "loading",
|
|
1510
|
-
"type": "boolean",
|
|
1511
|
-
"required": false,
|
|
1512
|
-
"defaultValue": "true",
|
|
1513
|
-
"description": "Display the skeleton when true"
|
|
1514
|
-
},
|
|
1515
|
-
{
|
|
1516
|
-
"name": "children",
|
|
1517
|
-
"type": "ReactNode",
|
|
1518
|
-
"required": false,
|
|
1519
|
-
"description": "Content to be displayed when loading is false"
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
"name": "variant",
|
|
1523
|
-
"type": "DialSkeletonVariant",
|
|
1524
|
-
"required": false,
|
|
1525
|
-
"defaultValue": "DialSkeletonVariant.Default",
|
|
1526
|
-
"description": "Skeleton variant"
|
|
1527
|
-
},
|
|
1528
|
-
{
|
|
1529
|
-
"name": "width",
|
|
1530
|
-
"type": "string | number",
|
|
1531
|
-
"required": false,
|
|
1532
|
-
"description": "Width of the skeleton"
|
|
1533
|
-
},
|
|
1534
|
-
{
|
|
1535
|
-
"name": "height",
|
|
1536
|
-
"type": "string | number",
|
|
1537
|
-
"required": false,
|
|
1538
|
-
"description": "Height of the skeleton"
|
|
1539
|
-
},
|
|
1540
|
-
{
|
|
1541
|
-
"name": "overlay",
|
|
1542
|
-
"type": "ReactNode",
|
|
1543
|
-
"required": false,
|
|
1544
|
-
"description": "Content to overlay on top of the skeleton (e.g., a spinner)"
|
|
1545
|
-
},
|
|
1546
|
-
{
|
|
1547
|
-
"name": "color",
|
|
1548
|
-
"type": "string",
|
|
1549
|
-
"required": false,
|
|
1550
|
-
"description": "Custom background color for the skeleton elements (overrides the default token)"
|
|
1551
|
-
}
|
|
1552
|
-
],
|
|
1553
|
-
"examples": [
|
|
1554
|
-
"// 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/>"
|
|
1555
|
-
],
|
|
1556
|
-
"sourceFile": "components/Skeleton/Skeleton.tsx"
|
|
1557
|
-
},
|
|
1558
3755
|
{
|
|
1559
3756
|
"name": "DialGrid",
|
|
1560
3757
|
"category": "Grid",
|
|
3758
|
+
"generation": "1.0",
|
|
1561
3759
|
"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",
|
|
1562
3760
|
"props": [
|
|
1563
3761
|
{
|
|
@@ -1712,6 +3910,7 @@
|
|
|
1712
3910
|
{
|
|
1713
3911
|
"name": "DialDateCellRenderer",
|
|
1714
3912
|
"category": "Grid",
|
|
3913
|
+
"generation": "1.0",
|
|
1715
3914
|
"description": "Minimal date cell renderer (ag-Grid compatible).\n\nRenders the value in the **\"MMM dd, yyyy\"** format (e.g., \"Jul 20, 2025\"),\nwrapped in `DialEllipsisTooltip` (tooltip only appears if truncated).",
|
|
1716
3915
|
"props": [
|
|
1717
3916
|
{
|
|
@@ -1760,6 +3959,7 @@
|
|
|
1760
3959
|
{
|
|
1761
3960
|
"name": "DialTabs",
|
|
1762
3961
|
"category": "Navigation",
|
|
3962
|
+
"generation": "1.0",
|
|
1763
3963
|
"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.",
|
|
1764
3964
|
"props": [
|
|
1765
3965
|
{
|
|
@@ -1849,6 +4049,7 @@
|
|
|
1849
4049
|
{
|
|
1850
4050
|
"name": "DialBreadcrumb",
|
|
1851
4051
|
"category": "Navigation",
|
|
4052
|
+
"generation": "1.0",
|
|
1852
4053
|
"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.",
|
|
1853
4054
|
"props": [
|
|
1854
4055
|
{
|
|
@@ -1905,6 +4106,7 @@
|
|
|
1905
4106
|
{
|
|
1906
4107
|
"name": "DialBreadcrumbItem",
|
|
1907
4108
|
"category": "Navigation",
|
|
4109
|
+
"generation": "1.0",
|
|
1908
4110
|
"description": "",
|
|
1909
4111
|
"props": [
|
|
1910
4112
|
{
|
|
@@ -1965,6 +4167,7 @@
|
|
|
1965
4167
|
{
|
|
1966
4168
|
"name": "DialButton",
|
|
1967
4169
|
"category": "Elements/Buttons",
|
|
4170
|
+
"generation": "1.0",
|
|
1968
4171
|
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction",
|
|
1969
4172
|
"props": [
|
|
1970
4173
|
{
|
|
@@ -2027,11 +4230,13 @@
|
|
|
2027
4230
|
"<DialButton\n label=\"Click me\"\n onClick={handleClick}\n iconBefore={<Icon />}\n className=\"custom-button\"\n/>",
|
|
2028
4231
|
"<DialButton\n label={<span>Custom <strong>Label</strong></span>}\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
2029
4232
|
],
|
|
2030
|
-
"sourceFile": "components/Button/Button.tsx"
|
|
4233
|
+
"sourceFile": "components/Button/Button.tsx",
|
|
4234
|
+
"supersededBy": "Button"
|
|
2031
4235
|
},
|
|
2032
4236
|
{
|
|
2033
4237
|
"name": "DialIconButton",
|
|
2034
4238
|
"category": "Elements/Buttons",
|
|
4239
|
+
"generation": "1.0",
|
|
2035
4240
|
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton",
|
|
2036
4241
|
"props": [
|
|
2037
4242
|
{
|
|
@@ -2070,101 +4275,121 @@
|
|
|
2070
4275
|
"<DialIconButton\n onClick={handleClick}\n icon={<Icon />}\n className=\"custom-button\"\n/>",
|
|
2071
4276
|
"<DialIconButton\n aria-label=\"Custom Label\"\n onClick={handleClick}\n/>"
|
|
2072
4277
|
],
|
|
2073
|
-
"sourceFile": "components/IconButton/IconButton.tsx"
|
|
4278
|
+
"sourceFile": "components/IconButton/IconButton.tsx",
|
|
4279
|
+
"supersededBy": "IconButton"
|
|
2074
4280
|
},
|
|
2075
4281
|
{
|
|
2076
4282
|
"name": "DialDangerButton",
|
|
2077
4283
|
"category": "Elements/Buttons",
|
|
4284
|
+
"generation": "1.0",
|
|
2078
4285
|
"description": "A Danger Button component with predefined danger variant",
|
|
2079
4286
|
"props": [],
|
|
2080
4287
|
"examples": [
|
|
2081
4288
|
"<DialDangerButton\nlabel=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
2082
4289
|
],
|
|
2083
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4290
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4291
|
+
"supersededBy": "DangerButton"
|
|
2084
4292
|
},
|
|
2085
4293
|
{
|
|
2086
4294
|
"name": "DialNeutralButton",
|
|
2087
4295
|
"category": "Elements/Buttons",
|
|
4296
|
+
"generation": "1.0",
|
|
2088
4297
|
"description": "A Neutral Button component with predefined neutral variant",
|
|
2089
4298
|
"props": [],
|
|
2090
4299
|
"examples": [
|
|
2091
4300
|
"<DialNeutralButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2092
4301
|
],
|
|
2093
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4302
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4303
|
+
"supersededBy": "NeutralButton"
|
|
2094
4304
|
},
|
|
2095
4305
|
{
|
|
2096
4306
|
"name": "DialPrimaryButton",
|
|
2097
4307
|
"category": "Elements/Buttons",
|
|
4308
|
+
"generation": "1.0",
|
|
2098
4309
|
"description": "A Primary Button component with predefined primary variant",
|
|
2099
4310
|
"props": [],
|
|
2100
4311
|
"examples": [
|
|
2101
4312
|
"<DialPrimaryButton\n label=\"Click me\"\nonClick={handleClick}\nclassName=\"custom-button\"\n/>"
|
|
2102
4313
|
],
|
|
2103
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4314
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4315
|
+
"supersededBy": "PrimaryButton"
|
|
2104
4316
|
},
|
|
2105
4317
|
{
|
|
2106
4318
|
"name": "DialGhostButton",
|
|
2107
4319
|
"category": "Elements/Buttons",
|
|
4320
|
+
"generation": "1.0",
|
|
2108
4321
|
"description": "A Ghost Button component with predefined ghost appearance",
|
|
2109
4322
|
"props": [],
|
|
2110
4323
|
"examples": [
|
|
2111
4324
|
"<DialGhostButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2112
4325
|
],
|
|
2113
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4326
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4327
|
+
"supersededBy": "GhostButton"
|
|
2114
4328
|
},
|
|
2115
4329
|
{
|
|
2116
4330
|
"name": "DialLinkButton",
|
|
2117
4331
|
"category": "Elements/Buttons",
|
|
4332
|
+
"generation": "1.0",
|
|
2118
4333
|
"description": "A Link Button component with predefined link appearance",
|
|
2119
4334
|
"props": [],
|
|
2120
4335
|
"examples": [
|
|
2121
4336
|
"<DialLinkButton\n label=\"Click me\"\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2122
4337
|
],
|
|
2123
|
-
"sourceFile": "components/Button/ButtonWrappers.tsx"
|
|
4338
|
+
"sourceFile": "components/Button/ButtonWrappers.tsx",
|
|
4339
|
+
"supersededBy": "LinkButton"
|
|
2124
4340
|
},
|
|
2125
4341
|
{
|
|
2126
4342
|
"name": "DialDangerIconButton",
|
|
2127
4343
|
"category": "Elements/Buttons",
|
|
4344
|
+
"generation": "1.0",
|
|
2128
4345
|
"description": "A Danger Icon Button component with predefined danger variant",
|
|
2129
4346
|
"props": [],
|
|
2130
4347
|
"examples": [
|
|
2131
4348
|
"<DialDangerIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2132
4349
|
],
|
|
2133
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4350
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4351
|
+
"supersededBy": "DangerIconButton"
|
|
2134
4352
|
},
|
|
2135
4353
|
{
|
|
2136
4354
|
"name": "DialGhostIconButton",
|
|
2137
4355
|
"category": "Elements/Buttons",
|
|
4356
|
+
"generation": "1.0",
|
|
2138
4357
|
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
2139
4358
|
"props": [],
|
|
2140
4359
|
"examples": [
|
|
2141
4360
|
"<DialGhostIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2142
4361
|
],
|
|
2143
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4362
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4363
|
+
"supersededBy": "GhostIconButton"
|
|
2144
4364
|
},
|
|
2145
4365
|
{
|
|
2146
4366
|
"name": "DialNeutralIconButton",
|
|
2147
4367
|
"category": "Elements/Buttons",
|
|
4368
|
+
"generation": "1.0",
|
|
2148
4369
|
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
2149
4370
|
"props": [],
|
|
2150
4371
|
"examples": [
|
|
2151
4372
|
"<DialNeutralIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2152
4373
|
],
|
|
2153
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4374
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4375
|
+
"supersededBy": "NeutralIconButton"
|
|
2154
4376
|
},
|
|
2155
4377
|
{
|
|
2156
4378
|
"name": "DialPrimaryIconButton",
|
|
2157
4379
|
"category": "Elements/Buttons",
|
|
4380
|
+
"generation": "1.0",
|
|
2158
4381
|
"description": "A Primary Icon Button component with predefined primary variant",
|
|
2159
4382
|
"props": [],
|
|
2160
4383
|
"examples": [
|
|
2161
4384
|
"<DialPrimaryIconButton\n icon={<Icon />}\n onClick={handleClick}\n className=\"custom-button\"\n/>"
|
|
2162
4385
|
],
|
|
2163
|
-
"sourceFile": "components/IconButton/IconButtonWrappers.tsx"
|
|
4386
|
+
"sourceFile": "components/IconButton/IconButtonWrappers.tsx",
|
|
4387
|
+
"supersededBy": "PrimaryIconButton"
|
|
2164
4388
|
},
|
|
2165
4389
|
{
|
|
2166
4390
|
"name": "DialSecondaryIconButton",
|
|
2167
4391
|
"category": "Elements/Buttons",
|
|
4392
|
+
"generation": "1.0",
|
|
2168
4393
|
"description": "A Secondary Icon Button component with predefined secondary variant",
|
|
2169
4394
|
"props": [],
|
|
2170
4395
|
"examples": [
|
|
@@ -2175,6 +4400,7 @@
|
|
|
2175
4400
|
{
|
|
2176
4401
|
"name": "DialSuccessIconButton",
|
|
2177
4402
|
"category": "Elements/Buttons",
|
|
4403
|
+
"generation": "1.0",
|
|
2178
4404
|
"description": "A Success Icon Button component with predefined success variant",
|
|
2179
4405
|
"props": [],
|
|
2180
4406
|
"examples": [
|
|
@@ -2185,6 +4411,7 @@
|
|
|
2185
4411
|
{
|
|
2186
4412
|
"name": "DialTertiaryIconButton",
|
|
2187
4413
|
"category": "Elements/Buttons",
|
|
4414
|
+
"generation": "1.0",
|
|
2188
4415
|
"description": "A Tertiary Icon Button component with predefined tertiary variant",
|
|
2189
4416
|
"props": [],
|
|
2190
4417
|
"examples": [
|
|
@@ -2195,6 +4422,7 @@
|
|
|
2195
4422
|
{
|
|
2196
4423
|
"name": "DialCloseButton",
|
|
2197
4424
|
"category": "Elements/Buttons",
|
|
4425
|
+
"generation": "1.0",
|
|
2198
4426
|
"description": "A Close button component with a customizable icon and accessible label.\naliases: DismissButton|ExitButton",
|
|
2199
4427
|
"props": [
|
|
2200
4428
|
{
|
|
@@ -2232,11 +4460,13 @@
|
|
|
2232
4460
|
"examples": [
|
|
2233
4461
|
"<DialCloseButton\n ariaLabel=\"Close dialog\"\n onClose={handleClose}\n className=\"custom-close\"\n size={32}\n/>"
|
|
2234
4462
|
],
|
|
2235
|
-
"sourceFile": "components/CloseButton/CloseButton.tsx"
|
|
4463
|
+
"sourceFile": "components/CloseButton/CloseButton.tsx",
|
|
4464
|
+
"supersededBy": "CloseButton"
|
|
2236
4465
|
},
|
|
2237
4466
|
{
|
|
2238
4467
|
"name": "DialRemoveButton",
|
|
2239
4468
|
"category": "Elements/Buttons",
|
|
4469
|
+
"generation": "1.0",
|
|
2240
4470
|
"description": "A specialized button component for removal or delete actions.\naliases: DeleteButton|TrashButton\n\nRenders a `DialDangerButton` with a predefined trash icon (`IconTrashX`) as the leading icon.\nAdditional props are passed directly to the underlying `DialDangerButton`.",
|
|
2241
4471
|
"props": [
|
|
2242
4472
|
{
|
|
@@ -2254,6 +4484,7 @@
|
|
|
2254
4484
|
{
|
|
2255
4485
|
"name": "DialTextarea",
|
|
2256
4486
|
"category": "Elements",
|
|
4487
|
+
"generation": "1.0",
|
|
2257
4488
|
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox",
|
|
2258
4489
|
"props": [
|
|
2259
4490
|
{
|
|
@@ -2303,11 +4534,13 @@
|
|
|
2303
4534
|
"examples": [
|
|
2304
4535
|
"<DialTextarea\n id=\"description\"\n placeholder=\"Enter description...\"\n value={value}\n onChange={(value) => setValue(value)}\n/>"
|
|
2305
4536
|
],
|
|
2306
|
-
"sourceFile": "components/Textarea/Textarea.tsx"
|
|
4537
|
+
"sourceFile": "components/Textarea/Textarea.tsx",
|
|
4538
|
+
"supersededBy": "Textarea"
|
|
2307
4539
|
},
|
|
2308
4540
|
{
|
|
2309
4541
|
"name": "DialTooltip",
|
|
2310
4542
|
"category": "Overlay",
|
|
4543
|
+
"generation": "1.0",
|
|
2311
4544
|
"description": "A Tooltip component that displays information on hover\naliases: HoverPopover|InfoPopover",
|
|
2312
4545
|
"props": [
|
|
2313
4546
|
{
|
|
@@ -2349,6 +4582,7 @@
|
|
|
2349
4582
|
{
|
|
2350
4583
|
"name": "DialTooltipContainer",
|
|
2351
4584
|
"category": "Overlay",
|
|
4585
|
+
"generation": "1.0",
|
|
2352
4586
|
"description": "The container component that provides tooltip context and state management",
|
|
2353
4587
|
"props": [],
|
|
2354
4588
|
"examples": [],
|
|
@@ -2357,6 +4591,7 @@
|
|
|
2357
4591
|
{
|
|
2358
4592
|
"name": "DialTooltipContent",
|
|
2359
4593
|
"category": "Overlay",
|
|
4594
|
+
"generation": "1.0",
|
|
2360
4595
|
"description": "The content area of a tooltip that displays the tooltip information",
|
|
2361
4596
|
"props": [],
|
|
2362
4597
|
"examples": [],
|
|
@@ -2365,6 +4600,7 @@
|
|
|
2365
4600
|
{
|
|
2366
4601
|
"name": "DialTooltipTrigger",
|
|
2367
4602
|
"category": "Overlay",
|
|
4603
|
+
"generation": "1.0",
|
|
2368
4604
|
"description": "The trigger element for a tooltip that can be clicked or hovered",
|
|
2369
4605
|
"props": [],
|
|
2370
4606
|
"examples": [],
|
|
@@ -2373,6 +4609,7 @@
|
|
|
2373
4609
|
{
|
|
2374
4610
|
"name": "DialSwitch",
|
|
2375
4611
|
"category": "Form",
|
|
4612
|
+
"generation": "1.0",
|
|
2376
4613
|
"description": "A Switch component with various styling options\naliases: ToggleSwitch|BinaryToggle",
|
|
2377
4614
|
"props": [
|
|
2378
4615
|
{
|
|
@@ -2420,6 +4657,7 @@
|
|
|
2420
4657
|
{
|
|
2421
4658
|
"name": "DialSegmentedControl",
|
|
2422
4659
|
"category": "Form",
|
|
4660
|
+
"generation": "1.0",
|
|
2423
4661
|
"description": "A single-select control for switching between a small set of mutually exclusive,\nequally-sized options (e.g. view switchers).\naliases: SegmentedButton|ViewSwitcher\n\nRenders a horizontal group of segments where every option is always visible and\nequally sized. Supports 2 or more segments, optional per-option icons, and\nkeyboard navigation (Arrow keys, Home, End).",
|
|
2424
4662
|
"props": [
|
|
2425
4663
|
{
|
|
@@ -2467,6 +4705,7 @@
|
|
|
2467
4705
|
{
|
|
2468
4706
|
"name": "DialPopup",
|
|
2469
4707
|
"category": "Overlay",
|
|
4708
|
+
"generation": "1.0",
|
|
2470
4709
|
"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.",
|
|
2471
4710
|
"props": [
|
|
2472
4711
|
{
|
|
@@ -2576,11 +4815,13 @@
|
|
|
2576
4815
|
"examples": [
|
|
2577
4816
|
"<DialPopup\n open\n title=\"Title\"\n size={PopupSize.Md}\n footer={\n <div className=\"flex justify-end gap-2\">\n <button className=\"btn-secondary px-3 py-1 rounded\">Cancel</button>\n <button className=\"btn-primary px-3 py-1 rounded\">Confirm</button>\n </div>\n }\n onClose={() => console.log('closed')}\n>\n <div className=\"p-6\">Dialog content goes here…</div>\n</DialPopup>"
|
|
2578
4817
|
],
|
|
2579
|
-
"sourceFile": "components/Popup/Popup.tsx"
|
|
4818
|
+
"sourceFile": "components/Popup/Popup.tsx",
|
|
4819
|
+
"supersededBy": "Popup"
|
|
2580
4820
|
},
|
|
2581
4821
|
{
|
|
2582
4822
|
"name": "DialConfirmationPopup",
|
|
2583
4823
|
"category": "Overlay",
|
|
4824
|
+
"generation": "1.0",
|
|
2584
4825
|
"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.",
|
|
2585
4826
|
"props": [
|
|
2586
4827
|
{
|
|
@@ -2658,11 +4899,13 @@
|
|
|
2658
4899
|
"examples": [
|
|
2659
4900
|
"<ConfirmationModal\n open\n header=\"Delete item?\"\n description=\"This action cannot be undone.\"\n confirmLabel=\"Delete\"\n onClose={() => setOpen(false)}\n onConfirm={handleDelete}\n/>"
|
|
2660
4901
|
],
|
|
2661
|
-
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx"
|
|
4902
|
+
"sourceFile": "components/ConfirmationPopup/ConfirmationPopup.tsx",
|
|
4903
|
+
"supersededBy": "ConfirmationPopup"
|
|
2662
4904
|
},
|
|
2663
4905
|
{
|
|
2664
4906
|
"name": "DialRadioGroupPopupField",
|
|
2665
4907
|
"category": "Form",
|
|
4908
|
+
"generation": "1.0",
|
|
2666
4909
|
"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`.",
|
|
2667
4910
|
"props": [],
|
|
2668
4911
|
"examples": [
|
|
@@ -2673,6 +4916,7 @@
|
|
|
2673
4916
|
{
|
|
2674
4917
|
"name": "DialFormPopup",
|
|
2675
4918
|
"category": "Overlay",
|
|
4919
|
+
"generation": "1.0",
|
|
2676
4920
|
"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.",
|
|
2677
4921
|
"props": [
|
|
2678
4922
|
{
|
|
@@ -2736,6 +4980,7 @@
|
|
|
2736
4980
|
{
|
|
2737
4981
|
"name": "DialInput",
|
|
2738
4982
|
"category": "Elements/Inputs",
|
|
4983
|
+
"generation": "1.0",
|
|
2739
4984
|
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput",
|
|
2740
4985
|
"props": [
|
|
2741
4986
|
{
|
|
@@ -2821,11 +5066,13 @@
|
|
|
2821
5066
|
"examples": [
|
|
2822
5067
|
"<DialInput\n id=\"search\"\n placeholder=\"Search...\"\n iconBefore={<SearchIcon />}\n iconAfter={<ClearIcon />}\n onChange={(value) => console.log(value)}\n/>"
|
|
2823
5068
|
],
|
|
2824
|
-
"sourceFile": "components/Input/Input.tsx"
|
|
5069
|
+
"sourceFile": "components/Input/Input.tsx",
|
|
5070
|
+
"supersededBy": "Input"
|
|
2825
5071
|
},
|
|
2826
5072
|
{
|
|
2827
5073
|
"name": "DialNumberInput",
|
|
2828
5074
|
"category": "Elements/Inputs",
|
|
5075
|
+
"generation": "1.0",
|
|
2829
5076
|
"description": "A number input field component\naliases: NumericField|NumberField",
|
|
2830
5077
|
"props": [
|
|
2831
5078
|
{
|
|
@@ -2844,21 +5091,25 @@
|
|
|
2844
5091
|
"examples": [
|
|
2845
5092
|
"<DialNumberInput\n id=\"age\"\n placeholder=\"Enter your age\"\n value={25}\n onChange={(value) => setAge(value)}\n/>"
|
|
2846
5093
|
],
|
|
2847
|
-
"sourceFile": "components/NumberInput/NumberInput.tsx"
|
|
5094
|
+
"sourceFile": "components/NumberInput/NumberInput.tsx",
|
|
5095
|
+
"supersededBy": "NumberInput"
|
|
2848
5096
|
},
|
|
2849
5097
|
{
|
|
2850
5098
|
"name": "DialPasswordInput",
|
|
2851
5099
|
"category": "Elements/Inputs",
|
|
5100
|
+
"generation": "1.0",
|
|
2852
5101
|
"description": "A password input component with show/hide functionality and customizable props.\naliases: SecureInput|ToggleablePassword",
|
|
2853
5102
|
"props": [],
|
|
2854
5103
|
"examples": [
|
|
2855
5104
|
"<DialPasswordInput\n id=\"password\"\n label=\"Password\"\n value={password}\n onChange={e => setPassword(e.target.value)}\n disabled={false}\n/>"
|
|
2856
5105
|
],
|
|
2857
|
-
"sourceFile": "components/PasswordInput/PasswordInput.tsx"
|
|
5106
|
+
"sourceFile": "components/PasswordInput/PasswordInput.tsx",
|
|
5107
|
+
"supersededBy": "PasswordInput"
|
|
2858
5108
|
},
|
|
2859
5109
|
{
|
|
2860
5110
|
"name": "DialSearch",
|
|
2861
5111
|
"category": "Elements",
|
|
5112
|
+
"generation": "1.0",
|
|
2862
5113
|
"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.",
|
|
2863
5114
|
"props": [
|
|
2864
5115
|
{
|
|
@@ -2888,6 +5139,7 @@
|
|
|
2888
5139
|
{
|
|
2889
5140
|
"name": "DialInputPopup",
|
|
2890
5141
|
"category": "Overlay",
|
|
5142
|
+
"generation": "1.0",
|
|
2891
5143
|
"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.",
|
|
2892
5144
|
"props": [
|
|
2893
5145
|
{
|
|
@@ -2997,6 +5249,7 @@
|
|
|
2997
5249
|
{
|
|
2998
5250
|
"name": "DialAutocompleteInputValue",
|
|
2999
5251
|
"category": "Form",
|
|
5252
|
+
"generation": "1.0",
|
|
3000
5253
|
"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.",
|
|
3001
5254
|
"props": [
|
|
3002
5255
|
{
|
|
@@ -3039,6 +5292,7 @@
|
|
|
3039
5292
|
{
|
|
3040
5293
|
"name": "DialTagInput",
|
|
3041
5294
|
"category": "Form",
|
|
5295
|
+
"generation": "1.0",
|
|
3042
5296
|
"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.",
|
|
3043
5297
|
"props": [
|
|
3044
5298
|
{
|
|
@@ -3125,6 +5379,7 @@
|
|
|
3125
5379
|
{
|
|
3126
5380
|
"name": "DialSelect",
|
|
3127
5381
|
"category": "Form",
|
|
5382
|
+
"generation": "1.0",
|
|
3128
5383
|
"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.",
|
|
3129
5384
|
"props": [
|
|
3130
5385
|
{
|
|
@@ -3346,11 +5601,13 @@
|
|
|
3346
5601
|
"examples": [
|
|
3347
5602
|
"<DialSelect options={[{ value: 'option-1', label: 'Option 1' }]} />\n<DialSelect searchable options={[{ value: 'a', label: 'Alpha' }, { value: 'b', label: 'Beta' }]} />\n<DialSelect multiple selectAll options={[{ value: '1', label: 'One' }, { value: '2', label: 'Two' }]} />\n<DialSelect inlineSearch options={[{ value: 'r', label: 'Relax-Name' }, { value: 'rep2', label: 'rep2' }]} />"
|
|
3348
5603
|
],
|
|
3349
|
-
"sourceFile": "components/Select/Select.tsx"
|
|
5604
|
+
"sourceFile": "components/Select/Select.tsx",
|
|
5605
|
+
"supersededBy": "Select"
|
|
3350
5606
|
},
|
|
3351
5607
|
{
|
|
3352
5608
|
"name": "DialSelectField",
|
|
3353
5609
|
"category": "Form",
|
|
5610
|
+
"generation": "1.0",
|
|
3354
5611
|
"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).",
|
|
3355
5612
|
"props": [
|
|
3356
5613
|
{
|
|
@@ -3374,6 +5631,7 @@
|
|
|
3374
5631
|
{
|
|
3375
5632
|
"name": "DialLoadFileArea",
|
|
3376
5633
|
"category": "Form",
|
|
5634
|
+
"generation": "1.0",
|
|
3377
5635
|
"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.",
|
|
3378
5636
|
"props": [
|
|
3379
5637
|
{
|
|
@@ -3415,6 +5673,7 @@
|
|
|
3415
5673
|
{
|
|
3416
5674
|
"name": "DialLoadFileAreaField",
|
|
3417
5675
|
"category": "Form",
|
|
5676
|
+
"generation": "1.0",
|
|
3418
5677
|
"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.",
|
|
3419
5678
|
"props": [
|
|
3420
5679
|
{
|
|
@@ -3451,6 +5710,7 @@
|
|
|
3451
5710
|
{
|
|
3452
5711
|
"name": "DialDropdown",
|
|
3453
5712
|
"category": "Dropdown",
|
|
5713
|
+
"generation": "1.0",
|
|
3454
5714
|
"description": "",
|
|
3455
5715
|
"props": [
|
|
3456
5716
|
{
|
|
@@ -3582,11 +5842,13 @@
|
|
|
3582
5842
|
}
|
|
3583
5843
|
],
|
|
3584
5844
|
"examples": [],
|
|
3585
|
-
"sourceFile": "components/Dropdown/Dropdown.tsx"
|
|
5845
|
+
"sourceFile": "components/Dropdown/Dropdown.tsx",
|
|
5846
|
+
"supersededBy": "Dropdown"
|
|
3586
5847
|
},
|
|
3587
5848
|
{
|
|
3588
5849
|
"name": "DialButtonDropdown",
|
|
3589
5850
|
"category": "Dropdown",
|
|
5851
|
+
"generation": "1.0",
|
|
3590
5852
|
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton",
|
|
3591
5853
|
"props": [
|
|
3592
5854
|
{
|
|
@@ -3599,11 +5861,13 @@
|
|
|
3599
5861
|
"examples": [
|
|
3600
5862
|
"<DialButtonDropdown\n title=\"Click me\"\n variant={ButtonVariant.Neutral}\n items={[{ key: 'profile', label: 'Profile' }, { key: 'logout', label: 'Logout' }]}\n/>"
|
|
3601
5863
|
],
|
|
3602
|
-
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx"
|
|
5864
|
+
"sourceFile": "components/ButtonDropdown/ButtonDropdown.tsx",
|
|
5865
|
+
"supersededBy": "ButtonDropdown"
|
|
3603
5866
|
},
|
|
3604
5867
|
{
|
|
3605
5868
|
"name": "DialDropdownIcon",
|
|
3606
5869
|
"category": "Dropdown",
|
|
5870
|
+
"generation": "1.0",
|
|
3607
5871
|
"description": "A compact icon trigger with a dropdown menu.\naliases: ModelPicker|IconMenu|AvatarDropdown",
|
|
3608
5872
|
"props": [
|
|
3609
5873
|
{
|
|
@@ -3666,6 +5930,7 @@
|
|
|
3666
5930
|
{
|
|
3667
5931
|
"name": "DialFileManager",
|
|
3668
5932
|
"category": "FileManager",
|
|
5933
|
+
"generation": "1.0",
|
|
3669
5934
|
"description": "File Manager layout with a collapsible folders tree, breadcrumb/search header, and a data grid.\naliases: FileExplorer|FileBrowser",
|
|
3670
5935
|
"props": [
|
|
3671
5936
|
{
|
|
@@ -4148,6 +6413,7 @@
|
|
|
4148
6413
|
{
|
|
4149
6414
|
"name": "DialDestinationFolderPopup",
|
|
4150
6415
|
"category": "FileManager/components",
|
|
6416
|
+
"generation": "1.0",
|
|
4151
6417
|
"description": "DestinationFolderPopup\naliases: FolderSelector|PathChooser",
|
|
4152
6418
|
"props": [],
|
|
4153
6419
|
"examples": [
|
|
@@ -4158,6 +6424,7 @@
|
|
|
4158
6424
|
{
|
|
4159
6425
|
"name": "DialFoldersTree",
|
|
4160
6426
|
"category": "Data Display",
|
|
6427
|
+
"generation": "1.0",
|
|
4161
6428
|
"description": "DialFoldersTree — A hierarchical folder tree component with nested expand/collapse support, selection highlighting,\nand optional file display.",
|
|
4162
6429
|
"props": [
|
|
4163
6430
|
{
|
|
@@ -4330,6 +6597,7 @@
|
|
|
4330
6597
|
{
|
|
4331
6598
|
"name": "DialSchemaRenderer",
|
|
4332
6599
|
"category": "Name",
|
|
6600
|
+
"generation": "1.0",
|
|
4333
6601
|
"description": "Renders a JSON Schema as a form UI with collapsible sections, validation, and default values.\naliases: SchemaRenderer|JsonSchemaForm",
|
|
4334
6602
|
"props": [],
|
|
4335
6603
|
"examples": [
|
|
@@ -4340,6 +6608,7 @@
|
|
|
4340
6608
|
{
|
|
4341
6609
|
"name": "DialJsonEditor",
|
|
4342
6610
|
"category": "Data Display",
|
|
6611
|
+
"generation": "1.0",
|
|
4343
6612
|
"description": "A JSON editor component built on top of Monaco Editor.\nProvides syntax highlighting, validation, and theme support for JSON editing.\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyDialJsonEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
4344
6613
|
"props": [
|
|
4345
6614
|
{
|
|
@@ -4392,6 +6661,7 @@
|
|
|
4392
6661
|
{
|
|
4393
6662
|
"name": "DialMarkdownEditor",
|
|
4394
6663
|
"category": "Data Display",
|
|
6664
|
+
"generation": "1.0",
|
|
4395
6665
|
"description": "A Markdown editor component built on top of\n\nLazy-loaded component. This component is not exported directly from the UI kit to avoid errors when using with SSR. Use `LazyDialMarkdownEditor` and the manifest `lazy` field for dynamic import guidance.",
|
|
4396
6666
|
"props": [
|
|
4397
6667
|
{
|
|
@@ -4449,10 +6719,26 @@
|
|
|
4449
6719
|
"packageImport": "@epam/ai-dial-ui-kit",
|
|
4450
6720
|
"ssr": false,
|
|
4451
6721
|
"nextDynamicExample": "import dynamic from 'next/dynamic';\nimport { LazyDialMarkdownEditor } from '@epam/ai-dial-ui-kit';\n\nconst DialMarkdownEditor = dynamic(\n async () => (await LazyDialMarkdownEditor()).DialMarkdownEditor,\n { ssr: false },\n);"
|
|
4452
|
-
}
|
|
6722
|
+
},
|
|
6723
|
+
"supersededBy": "MarkdownEditor"
|
|
4453
6724
|
}
|
|
4454
6725
|
],
|
|
4455
6726
|
"types": [
|
|
6727
|
+
{
|
|
6728
|
+
"name": "AnalyticsCardVariant",
|
|
6729
|
+
"kind": "enum",
|
|
6730
|
+
"members": [
|
|
6731
|
+
{
|
|
6732
|
+
"name": "Default",
|
|
6733
|
+
"value": "'default'"
|
|
6734
|
+
},
|
|
6735
|
+
{
|
|
6736
|
+
"name": "Compact",
|
|
6737
|
+
"value": "'compact'"
|
|
6738
|
+
}
|
|
6739
|
+
],
|
|
6740
|
+
"sourceFile": "types/analytics.ts"
|
|
6741
|
+
},
|
|
4456
6742
|
{
|
|
4457
6743
|
"name": "AnalyticsBarColorStop",
|
|
4458
6744
|
"kind": "interface",
|
|
@@ -4487,6 +6773,21 @@
|
|
|
4487
6773
|
],
|
|
4488
6774
|
"sourceFile": "models/analytics.ts"
|
|
4489
6775
|
},
|
|
6776
|
+
{
|
|
6777
|
+
"name": "DialProgressBarSize",
|
|
6778
|
+
"kind": "enum",
|
|
6779
|
+
"members": [
|
|
6780
|
+
{
|
|
6781
|
+
"name": "Small",
|
|
6782
|
+
"value": "'sm'"
|
|
6783
|
+
},
|
|
6784
|
+
{
|
|
6785
|
+
"name": "Medium",
|
|
6786
|
+
"value": "'md'"
|
|
6787
|
+
}
|
|
6788
|
+
],
|
|
6789
|
+
"sourceFile": "components/ProgressBar/ProgressBar.tsx"
|
|
6790
|
+
},
|
|
4490
6791
|
{
|
|
4491
6792
|
"name": "DialTooltipContainerOptions",
|
|
4492
6793
|
"kind": "interface",
|
|
@@ -5127,7 +7428,7 @@
|
|
|
5127
7428
|
"sourceFile": "types/resizable-container.ts"
|
|
5128
7429
|
},
|
|
5129
7430
|
{
|
|
5130
|
-
"name": "
|
|
7431
|
+
"name": "SkeletonVariant",
|
|
5131
7432
|
"kind": "enum",
|
|
5132
7433
|
"members": [
|
|
5133
7434
|
{
|
|
@@ -5150,7 +7451,7 @@
|
|
|
5150
7451
|
"sourceFile": "types/skeleton.ts"
|
|
5151
7452
|
},
|
|
5152
7453
|
{
|
|
5153
|
-
"name": "
|
|
7454
|
+
"name": "SkeletonAvatarSize",
|
|
5154
7455
|
"kind": "enum",
|
|
5155
7456
|
"members": [
|
|
5156
7457
|
{
|
|
@@ -5169,7 +7470,7 @@
|
|
|
5169
7470
|
"sourceFile": "types/skeleton.ts"
|
|
5170
7471
|
},
|
|
5171
7472
|
{
|
|
5172
|
-
"name": "
|
|
7473
|
+
"name": "SkeletonAvatarShape",
|
|
5173
7474
|
"kind": "enum",
|
|
5174
7475
|
"members": [
|
|
5175
7476
|
{
|
|
@@ -5573,47 +7874,131 @@
|
|
|
5573
7874
|
"kind": "interface",
|
|
5574
7875
|
"members": [
|
|
5575
7876
|
{
|
|
5576
|
-
"name": "fileContent",
|
|
5577
|
-
"value": "File"
|
|
7877
|
+
"name": "fileContent",
|
|
7878
|
+
"value": "File"
|
|
7879
|
+
},
|
|
7880
|
+
{
|
|
7881
|
+
"name": "name",
|
|
7882
|
+
"value": "string"
|
|
7883
|
+
}
|
|
7884
|
+
],
|
|
7885
|
+
"sourceFile": "models/file-manager.ts"
|
|
7886
|
+
},
|
|
7887
|
+
{
|
|
7888
|
+
"name": "DialFileManagerActionsRef",
|
|
7889
|
+
"kind": "interface",
|
|
7890
|
+
"members": [
|
|
7891
|
+
{
|
|
7892
|
+
"name": "createFolder",
|
|
7893
|
+
"value": "() => void"
|
|
7894
|
+
}
|
|
7895
|
+
],
|
|
7896
|
+
"sourceFile": "models/file-manager.ts"
|
|
7897
|
+
},
|
|
7898
|
+
{
|
|
7899
|
+
"name": "DialFileAcceptType",
|
|
7900
|
+
"kind": "type",
|
|
7901
|
+
"sourceFile": "models/file-manager.ts",
|
|
7902
|
+
"typeBody": "| `${string}/${string}` // MIME (wildcard)\n | `.${string}`"
|
|
7903
|
+
},
|
|
7904
|
+
{
|
|
7905
|
+
"name": "GridSelectionMode",
|
|
7906
|
+
"kind": "enum",
|
|
7907
|
+
"members": [
|
|
7908
|
+
{
|
|
7909
|
+
"name": "MULTIPLE",
|
|
7910
|
+
"value": "'MULTIPLE'"
|
|
7911
|
+
},
|
|
7912
|
+
{
|
|
7913
|
+
"name": "SINGLE",
|
|
7914
|
+
"value": "'SINGLE'"
|
|
7915
|
+
}
|
|
7916
|
+
],
|
|
7917
|
+
"sourceFile": "models/selection-mode.ts"
|
|
7918
|
+
},
|
|
7919
|
+
{
|
|
7920
|
+
"name": "SchemaRendererVariant",
|
|
7921
|
+
"kind": "enum",
|
|
7922
|
+
"members": [
|
|
7923
|
+
{
|
|
7924
|
+
"name": "Sections",
|
|
7925
|
+
"value": "'sections'"
|
|
7926
|
+
},
|
|
7927
|
+
{
|
|
7928
|
+
"name": "Flat",
|
|
7929
|
+
"value": "'flat'"
|
|
7930
|
+
},
|
|
7931
|
+
{
|
|
7932
|
+
"name": "FlatSections",
|
|
7933
|
+
"value": "'flat-sections'"
|
|
7934
|
+
}
|
|
7935
|
+
],
|
|
7936
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
7937
|
+
},
|
|
7938
|
+
{
|
|
7939
|
+
"name": "SchemaDisplayMode",
|
|
7940
|
+
"kind": "enum",
|
|
7941
|
+
"members": [
|
|
7942
|
+
{
|
|
7943
|
+
"name": "Select",
|
|
7944
|
+
"value": "'select'"
|
|
5578
7945
|
},
|
|
5579
7946
|
{
|
|
5580
|
-
"name": "
|
|
5581
|
-
"value": "
|
|
7947
|
+
"name": "Radio",
|
|
7948
|
+
"value": "'radio'"
|
|
5582
7949
|
}
|
|
5583
7950
|
],
|
|
5584
|
-
"sourceFile": "
|
|
7951
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
5585
7952
|
},
|
|
5586
7953
|
{
|
|
5587
|
-
"name": "
|
|
5588
|
-
"kind": "
|
|
7954
|
+
"name": "SchemaOrientation",
|
|
7955
|
+
"kind": "enum",
|
|
5589
7956
|
"members": [
|
|
5590
7957
|
{
|
|
5591
|
-
"name": "
|
|
5592
|
-
"value": "
|
|
7958
|
+
"name": "Row",
|
|
7959
|
+
"value": "'row'"
|
|
7960
|
+
},
|
|
7961
|
+
{
|
|
7962
|
+
"name": "Column",
|
|
7963
|
+
"value": "'column'"
|
|
5593
7964
|
}
|
|
5594
7965
|
],
|
|
5595
|
-
"sourceFile": "
|
|
5596
|
-
},
|
|
5597
|
-
{
|
|
5598
|
-
"name": "DialFileAcceptType",
|
|
5599
|
-
"kind": "type",
|
|
5600
|
-
"sourceFile": "models/file-manager.ts",
|
|
5601
|
-
"typeBody": "| `${string}/${string}` // MIME (wildcard)\n | `.${string}`"
|
|
7966
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
5602
7967
|
},
|
|
5603
7968
|
{
|
|
5604
|
-
"name": "
|
|
7969
|
+
"name": "JsonSchemaType",
|
|
5605
7970
|
"kind": "enum",
|
|
5606
7971
|
"members": [
|
|
5607
7972
|
{
|
|
5608
|
-
"name": "
|
|
5609
|
-
"value": "'
|
|
7973
|
+
"name": "String",
|
|
7974
|
+
"value": "'string'"
|
|
5610
7975
|
},
|
|
5611
7976
|
{
|
|
5612
|
-
"name": "
|
|
5613
|
-
"value": "'
|
|
7977
|
+
"name": "Number",
|
|
7978
|
+
"value": "'number'"
|
|
7979
|
+
},
|
|
7980
|
+
{
|
|
7981
|
+
"name": "Integer",
|
|
7982
|
+
"value": "'integer'"
|
|
7983
|
+
},
|
|
7984
|
+
{
|
|
7985
|
+
"name": "Boolean",
|
|
7986
|
+
"value": "'boolean'"
|
|
7987
|
+
},
|
|
7988
|
+
{
|
|
7989
|
+
"name": "Object",
|
|
7990
|
+
"value": "'object'"
|
|
7991
|
+
},
|
|
7992
|
+
{
|
|
7993
|
+
"name": "Array",
|
|
7994
|
+
"value": "'array'"
|
|
7995
|
+
},
|
|
7996
|
+
{
|
|
7997
|
+
"name": "Null",
|
|
7998
|
+
"value": "'null'"
|
|
5614
7999
|
}
|
|
5615
8000
|
],
|
|
5616
|
-
"sourceFile": "
|
|
8001
|
+
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
5617
8002
|
},
|
|
5618
8003
|
{
|
|
5619
8004
|
"name": "JsonSchema",
|
|
@@ -5740,6 +8125,71 @@
|
|
|
5740
8125
|
],
|
|
5741
8126
|
"sourceFile": "components/SchemaRenderer/types.ts"
|
|
5742
8127
|
},
|
|
8128
|
+
{
|
|
8129
|
+
"name": "NotificationVariant",
|
|
8130
|
+
"kind": "enum",
|
|
8131
|
+
"members": [
|
|
8132
|
+
{
|
|
8133
|
+
"name": "Info",
|
|
8134
|
+
"value": "'info'"
|
|
8135
|
+
},
|
|
8136
|
+
{
|
|
8137
|
+
"name": "Success",
|
|
8138
|
+
"value": "'success'"
|
|
8139
|
+
},
|
|
8140
|
+
{
|
|
8141
|
+
"name": "Warning",
|
|
8142
|
+
"value": "'warning'"
|
|
8143
|
+
},
|
|
8144
|
+
{
|
|
8145
|
+
"name": "Error",
|
|
8146
|
+
"value": "'error'"
|
|
8147
|
+
},
|
|
8148
|
+
{
|
|
8149
|
+
"name": "Loading",
|
|
8150
|
+
"value": "'loading'"
|
|
8151
|
+
}
|
|
8152
|
+
],
|
|
8153
|
+
"sourceFile": "types/notification.ts"
|
|
8154
|
+
},
|
|
8155
|
+
{
|
|
8156
|
+
"name": "NotificationType",
|
|
8157
|
+
"kind": "enum",
|
|
8158
|
+
"members": [
|
|
8159
|
+
{
|
|
8160
|
+
"name": "Toast",
|
|
8161
|
+
"value": "'toast'"
|
|
8162
|
+
},
|
|
8163
|
+
{
|
|
8164
|
+
"name": "SectionMessage",
|
|
8165
|
+
"value": "'section-message'"
|
|
8166
|
+
}
|
|
8167
|
+
],
|
|
8168
|
+
"sourceFile": "types/notification.ts"
|
|
8169
|
+
},
|
|
8170
|
+
{
|
|
8171
|
+
"name": "CalendarMode",
|
|
8172
|
+
"kind": "enum",
|
|
8173
|
+
"members": [
|
|
8174
|
+
{
|
|
8175
|
+
"name": "Date",
|
|
8176
|
+
"value": "'date'"
|
|
8177
|
+
},
|
|
8178
|
+
{
|
|
8179
|
+
"name": "DateTime",
|
|
8180
|
+
"value": "'datetime'"
|
|
8181
|
+
},
|
|
8182
|
+
{
|
|
8183
|
+
"name": "Time",
|
|
8184
|
+
"value": "'time'"
|
|
8185
|
+
},
|
|
8186
|
+
{
|
|
8187
|
+
"name": "Weekday",
|
|
8188
|
+
"value": "'weekday'"
|
|
8189
|
+
}
|
|
8190
|
+
],
|
|
8191
|
+
"sourceFile": "types/calendar.ts"
|
|
8192
|
+
},
|
|
5743
8193
|
{
|
|
5744
8194
|
"name": "CalendarValue",
|
|
5745
8195
|
"kind": "type",
|
|
@@ -5749,14 +8199,10 @@
|
|
|
5749
8199
|
],
|
|
5750
8200
|
"hooks": [
|
|
5751
8201
|
{
|
|
5752
|
-
"name": "
|
|
5753
|
-
"sourceFile": "
|
|
5754
|
-
"
|
|
5755
|
-
|
|
5756
|
-
{
|
|
5757
|
-
"name": "Spinner",
|
|
5758
|
-
"sourceFile": "components/Spinner/Spinner.tsx",
|
|
5759
|
-
"signature": "Spinner: FC<SpinnerProps>"
|
|
8202
|
+
"name": "DEFAULT_ANALYTICS_BAR_COLOR_MAP",
|
|
8203
|
+
"sourceFile": "components/Analytics/Bar/utils.ts",
|
|
8204
|
+
"description": "Default color map for , expressed as ratios (value / maxValue).\nA value of `0` leaves the bar empty (track shows through); a value at the maximum\nuses the dedicated full-bar color.",
|
|
8205
|
+
"signature": "DEFAULT_ANALYTICS_BAR_COLOR_MAP: AnalyticsBarColorStop[]"
|
|
5760
8206
|
},
|
|
5761
8207
|
{
|
|
5762
8208
|
"name": "DEFAULT_GRID_DATE_FORMAT_OPTIONS",
|
|
@@ -5806,257 +8252,6 @@
|
|
|
5806
8252
|
"sourceFile": "components/FileManager/hooks/use-file-manager-context.ts",
|
|
5807
8253
|
"description": "Hook to read the File Manager context.\nThrows if used outside of the provider.",
|
|
5808
8254
|
"signature": "() => unknown"
|
|
5809
|
-
},
|
|
5810
|
-
{
|
|
5811
|
-
"name": "SchemaRendererVariant",
|
|
5812
|
-
"sourceFile": "components/SchemaRenderer/types.ts",
|
|
5813
|
-
"signature": "enum SchemaRendererVariant { Sections = 'sections', Flat = 'flat', FlatSections = 'flat-sections' }"
|
|
5814
|
-
},
|
|
5815
|
-
{
|
|
5816
|
-
"name": "SchemaDisplayMode",
|
|
5817
|
-
"sourceFile": "components/SchemaRenderer/types.ts",
|
|
5818
|
-
"signature": "enum SchemaDisplayMode { Select = 'select', Radio = 'radio' }"
|
|
5819
|
-
},
|
|
5820
|
-
{
|
|
5821
|
-
"name": "SchemaOrientation",
|
|
5822
|
-
"sourceFile": "components/SchemaRenderer/types.ts",
|
|
5823
|
-
"signature": "enum SchemaOrientation { Row = 'row', Column = 'column' }"
|
|
5824
|
-
},
|
|
5825
|
-
{
|
|
5826
|
-
"name": "JsonSchemaType",
|
|
5827
|
-
"sourceFile": "components/SchemaRenderer/types.ts",
|
|
5828
|
-
"signature": "enum JsonSchemaType { String = 'string', Number = 'number', Integer = 'integer', Boolean = 'boolean', Object = 'object', Array = 'array', Null = 'null' }"
|
|
5829
|
-
},
|
|
5830
|
-
{
|
|
5831
|
-
"name": "NotificationVariant",
|
|
5832
|
-
"sourceFile": "types/notification.ts",
|
|
5833
|
-
"signature": "enum NotificationVariant { Info = 'info', Success = 'success', Warning = 'warning', Error = 'error', Loading = 'loading' }"
|
|
5834
|
-
},
|
|
5835
|
-
{
|
|
5836
|
-
"name": "NotificationType",
|
|
5837
|
-
"sourceFile": "types/notification.ts",
|
|
5838
|
-
"signature": "enum NotificationType { Toast = 'toast', SectionMessage = 'section-message' }"
|
|
5839
|
-
},
|
|
5840
|
-
{
|
|
5841
|
-
"name": "Notification",
|
|
5842
|
-
"sourceFile": "components/New/Notification/Notification.tsx",
|
|
5843
|
-
"description": "A contextual feedback component for displaying important messages.\naliases: Notification\n\nRenders a colored container with an icon, message text, and an optional\nclose button.\n\nThe container is a live region whose politeness follows the variant: `error`\nand `warning` use `role=\"alert\"` (assertive, interrupts the screen reader),\nevery other variant uses `role=\"status\"` (polite, queues). Pass an explicit\n`role` to override — including for a notification that is static page content\nrather than an update.",
|
|
5844
|
-
"signature": "Notification: FC<NotificationProps>"
|
|
5845
|
-
},
|
|
5846
|
-
{
|
|
5847
|
-
"name": "Highlight",
|
|
5848
|
-
"sourceFile": "components/New/Highlight/Highlight.tsx",
|
|
5849
|
-
"description": "Renders text with the first occurrence of `query` wrapped in a highlight mark, with ellipsis truncation and a tooltip when overflowing.",
|
|
5850
|
-
"signature": "Highlight: FC<HighlightProps>"
|
|
5851
|
-
},
|
|
5852
|
-
{
|
|
5853
|
-
"name": "CardShell",
|
|
5854
|
-
"sourceFile": "components/New/CardShell/CardShell.tsx",
|
|
5855
|
-
"description": "A shared elevated card shell used as the base wrapper for browse-grid cards.\n\nRenders an `<article>` with rounded corners, padding, a resting shadow, and\na hover lift with a stronger shadow. Respects `prefers-reduced-motion` by\ndisabling the transform/shadow transition and hover lift.",
|
|
5856
|
-
"signature": "CardShell: FC<CardShellProps>"
|
|
5857
|
-
},
|
|
5858
|
-
{
|
|
5859
|
-
"name": "ErrorMessageNotification",
|
|
5860
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5861
|
-
"signature": "ErrorMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Error,\n)"
|
|
5862
|
-
},
|
|
5863
|
-
{
|
|
5864
|
-
"name": "ErrorToastNotification",
|
|
5865
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5866
|
-
"signature": "ErrorToastNotification = NotificationVariantCreator(\n NotificationVariant.Error,\n NotificationType.Toast,\n)"
|
|
5867
|
-
},
|
|
5868
|
-
{
|
|
5869
|
-
"name": "InfoMessageNotification",
|
|
5870
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5871
|
-
"signature": "InfoMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Info,\n)"
|
|
5872
|
-
},
|
|
5873
|
-
{
|
|
5874
|
-
"name": "InfoToastNotification",
|
|
5875
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5876
|
-
"signature": "InfoToastNotification = NotificationVariantCreator(\n NotificationVariant.Info,\n NotificationType.Toast,\n)"
|
|
5877
|
-
},
|
|
5878
|
-
{
|
|
5879
|
-
"name": "LoadingMessageNotification",
|
|
5880
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5881
|
-
"signature": "LoadingMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Loading,\n)"
|
|
5882
|
-
},
|
|
5883
|
-
{
|
|
5884
|
-
"name": "LoadingToastNotification",
|
|
5885
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5886
|
-
"signature": "LoadingToastNotification = NotificationVariantCreator(\n NotificationVariant.Loading,\n NotificationType.Toast,\n)"
|
|
5887
|
-
},
|
|
5888
|
-
{
|
|
5889
|
-
"name": "SuccessMessageNotification",
|
|
5890
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5891
|
-
"signature": "SuccessMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Success,\n)"
|
|
5892
|
-
},
|
|
5893
|
-
{
|
|
5894
|
-
"name": "SuccessToastNotification",
|
|
5895
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5896
|
-
"signature": "SuccessToastNotification = NotificationVariantCreator(\n NotificationVariant.Success,\n NotificationType.Toast,\n)"
|
|
5897
|
-
},
|
|
5898
|
-
{
|
|
5899
|
-
"name": "WarningMessageNotification",
|
|
5900
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5901
|
-
"signature": "WarningMessageNotification = NotificationTypeCreator(\n NotificationType.SectionMessage,\n NotificationVariant.Warning,\n)"
|
|
5902
|
-
},
|
|
5903
|
-
{
|
|
5904
|
-
"name": "WarningToastNotification",
|
|
5905
|
-
"sourceFile": "components/New/Notification/NotificationWrapper.tsx",
|
|
5906
|
-
"signature": "WarningToastNotification = NotificationVariantCreator(\n NotificationVariant.Warning,\n NotificationType.Toast,\n)"
|
|
5907
|
-
},
|
|
5908
|
-
{
|
|
5909
|
-
"name": "CalendarMode",
|
|
5910
|
-
"sourceFile": "types/calendar.ts",
|
|
5911
|
-
"signature": "enum CalendarMode { Date = 'date', DateTime = 'datetime', Time = 'time', Weekday = 'weekday' }"
|
|
5912
|
-
},
|
|
5913
|
-
{
|
|
5914
|
-
"name": "Calendar",
|
|
5915
|
-
"sourceFile": "components/New/Calendar/Calendar.tsx",
|
|
5916
|
-
"description": "A date/time picker supporting four selection modes.\naliases: DatePicker|DateTimePicker\n\nRenders a text-field trigger that opens a rounded month-grid popover for\nthe `date`/`datetime` modes, a masked `\"HH:mm\"` text field for `time`, and\na popover list of weekday names for `weekday`. Month/weekday names and\ndate formatting are localized via the `locale` prop.",
|
|
5917
|
-
"signature": "Calendar: FC<CalendarProps>"
|
|
5918
|
-
},
|
|
5919
|
-
{
|
|
5920
|
-
"name": "FolderPath",
|
|
5921
|
-
"sourceFile": "components/New/FolderPath/FolderPath.tsx",
|
|
5922
|
-
"description": "A read-only, non-clickable folder/location path built on top of `DialBreadcrumb`.\naliases: FolderBreadcrumb|LocationPath\n\nEvery segment is disabled (no navigation); the first segment gets a leading\nfolder icon and the last segment is styled as the current/leaf item.",
|
|
5923
|
-
"signature": "FolderPath: FC<FolderPathProps>"
|
|
5924
|
-
},
|
|
5925
|
-
{
|
|
5926
|
-
"name": "DangerButton",
|
|
5927
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5928
|
-
"description": "A Danger Button component with predefined danger variant",
|
|
5929
|
-
"signature": "DangerButton = ButtonVariantCreator(\n ButtonVariant.Danger,\n ButtonAppearance.Solid,\n)"
|
|
5930
|
-
},
|
|
5931
|
-
{
|
|
5932
|
-
"name": "GhostButton",
|
|
5933
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5934
|
-
"description": "A Ghost Button component with predefined ghost appearance",
|
|
5935
|
-
"signature": "GhostButton = ButtonAppearanceCreator(\n ButtonAppearance.Ghost,\n ButtonVariant.Primary,\n)"
|
|
5936
|
-
},
|
|
5937
|
-
{
|
|
5938
|
-
"name": "LinkButton",
|
|
5939
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5940
|
-
"description": "A Link Button component with predefined link appearance",
|
|
5941
|
-
"signature": "LinkButton = ButtonAppearanceCreator(\n ButtonAppearance.Link,\n ButtonVariant.Primary,\n)"
|
|
5942
|
-
},
|
|
5943
|
-
{
|
|
5944
|
-
"name": "NeutralButton",
|
|
5945
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5946
|
-
"description": "A Neutral Button component with predefined neutral variant",
|
|
5947
|
-
"signature": "NeutralButton = ButtonVariantCreator(\n ButtonVariant.Neutral,\n ButtonAppearance.Solid,\n)"
|
|
5948
|
-
},
|
|
5949
|
-
{
|
|
5950
|
-
"name": "OutlinedButton",
|
|
5951
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5952
|
-
"description": "An Outlined Button component with predefined outlined appearance",
|
|
5953
|
-
"signature": "OutlinedButton = ButtonAppearanceCreator(\n ButtonAppearance.Outlined,\n ButtonVariant.Neutral,\n)"
|
|
5954
|
-
},
|
|
5955
|
-
{
|
|
5956
|
-
"name": "PrimaryButton",
|
|
5957
|
-
"sourceFile": "components/New/Button/ButtonWrappers.tsx",
|
|
5958
|
-
"description": "A Primary Button component with predefined primary variant",
|
|
5959
|
-
"signature": "PrimaryButton = ButtonVariantCreator(\n ButtonVariant.Primary,\n ButtonAppearance.Solid,\n)"
|
|
5960
|
-
},
|
|
5961
|
-
{
|
|
5962
|
-
"name": "DangerIconButton",
|
|
5963
|
-
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx",
|
|
5964
|
-
"description": "A Danger Icon Button component with predefined danger variant",
|
|
5965
|
-
"signature": "DangerIconButton = IconButtonVariantCreator(\n ButtonVariant.Danger,\n ButtonAppearance.Ghost,\n)"
|
|
5966
|
-
},
|
|
5967
|
-
{
|
|
5968
|
-
"name": "GhostIconButton",
|
|
5969
|
-
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx",
|
|
5970
|
-
"description": "A Ghost Icon Button component with predefined ghost appearance",
|
|
5971
|
-
"signature": "GhostIconButton = IconButtonAppearanceCreator(\n ButtonAppearance.Ghost,\n ButtonVariant.Primary,\n)"
|
|
5972
|
-
},
|
|
5973
|
-
{
|
|
5974
|
-
"name": "NeutralIconButton",
|
|
5975
|
-
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx",
|
|
5976
|
-
"description": "A Neutral Icon Button component with predefined neutral variant",
|
|
5977
|
-
"signature": "NeutralIconButton = IconButtonVariantCreator(\n ButtonVariant.Neutral,\n ButtonAppearance.Solid,\n)"
|
|
5978
|
-
},
|
|
5979
|
-
{
|
|
5980
|
-
"name": "PrimaryIconButton",
|
|
5981
|
-
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx",
|
|
5982
|
-
"description": "A Primary Icon Button component with predefined primary variant",
|
|
5983
|
-
"signature": "PrimaryIconButton = IconButtonVariantCreator(\n ButtonVariant.Primary,\n ButtonAppearance.Solid,\n)"
|
|
5984
|
-
},
|
|
5985
|
-
{
|
|
5986
|
-
"name": "StaticIconButton",
|
|
5987
|
-
"sourceFile": "components/New/IconButton/IconButtonWrappers.tsx",
|
|
5988
|
-
"description": "A Outlined Icon Button component with predefined outlined appearance",
|
|
5989
|
-
"signature": "StaticIconButton = IconButtonAppearanceCreator(\n ButtonAppearance.Solid,\n ButtonVariant.Static,\n)"
|
|
5990
|
-
},
|
|
5991
|
-
{
|
|
5992
|
-
"name": "Button",
|
|
5993
|
-
"sourceFile": "components/New/Button/Button.tsx",
|
|
5994
|
-
"description": "A Button component with flexible icon and text positioning\naliases: ActionButton|CallToAction",
|
|
5995
|
-
"signature": "Button: FC<ButtonProps>"
|
|
5996
|
-
},
|
|
5997
|
-
{
|
|
5998
|
-
"name": "IconButton",
|
|
5999
|
-
"sourceFile": "components/New/IconButton/IconButton.tsx",
|
|
6000
|
-
"description": "A Icon Button component with flexible icon and text positioning\naliases: IconicButton|SymbolButton",
|
|
6001
|
-
"signature": "IconButton: FC<IconButtonProps>"
|
|
6002
|
-
},
|
|
6003
|
-
{
|
|
6004
|
-
"name": "FabButton",
|
|
6005
|
-
"sourceFile": "components/FabButton/FabButton.tsx",
|
|
6006
|
-
"description": "A Floating Action Button (FAB) component — circular icon button for primary actions.\naliases: FloatingActionButton|FabButton|CircularButton",
|
|
6007
|
-
"signature": "FabButton: FC<FabButtonProps>"
|
|
6008
|
-
},
|
|
6009
|
-
{
|
|
6010
|
-
"name": "ButtonDropdown",
|
|
6011
|
-
"sourceFile": "components/New/ButtonDropdown/ButtonDropdown.tsx",
|
|
6012
|
-
"description": "A Button dropdown component based on DialDropdown component\naliases: SplitButton|MenuButton",
|
|
6013
|
-
"signature": "ButtonDropdown: FC<ButtonDropdownProps>"
|
|
6014
|
-
},
|
|
6015
|
-
{
|
|
6016
|
-
"name": "InlineSelect",
|
|
6017
|
-
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx",
|
|
6018
|
-
"description": "An inline select control combining `InlineSelectTrigger` with `DialDropdown`.",
|
|
6019
|
-
"signature": "InlineSelect: FC<InlineSelectProps>"
|
|
6020
|
-
},
|
|
6021
|
-
{
|
|
6022
|
-
"name": "InlineSelectTrigger",
|
|
6023
|
-
"sourceFile": "components/New/InlineSelect/InlineSelect.tsx",
|
|
6024
|
-
"signature": "InlineSelectTrigger: FC<InlineSelectTriggerProps>"
|
|
6025
|
-
},
|
|
6026
|
-
{
|
|
6027
|
-
"name": "InfoButton",
|
|
6028
|
-
"sourceFile": "components/New/InfoButton/InfoButton.tsx",
|
|
6029
|
-
"description": "An Info button component with a customizable icon and accessible label.",
|
|
6030
|
-
"signature": "InfoButton: FC<InfoButtonProps>"
|
|
6031
|
-
},
|
|
6032
|
-
{
|
|
6033
|
-
"name": "Label",
|
|
6034
|
-
"sourceFile": "components/New/Label/Label.tsx",
|
|
6035
|
-
"description": "A label component\naliases: FormLabel|RequiredIndicator",
|
|
6036
|
-
"signature": "Label: FC<LabelProps>"
|
|
6037
|
-
},
|
|
6038
|
-
{
|
|
6039
|
-
"name": "Textarea",
|
|
6040
|
-
"sourceFile": "components/New/Textarea/Textarea.tsx",
|
|
6041
|
-
"description": "A flexible textarea component with validation support and consistent styling\naliases: MultilineInput|TextBox",
|
|
6042
|
-
"signature": "Textarea: FC<TextareaProps>"
|
|
6043
|
-
},
|
|
6044
|
-
{
|
|
6045
|
-
"name": "Input",
|
|
6046
|
-
"sourceFile": "components/New/Input/Input.tsx",
|
|
6047
|
-
"description": "A flexible input component with icon support and various styling options\naliases: TextField|FormInput",
|
|
6048
|
-
"signature": "Input: FC<InputProps>"
|
|
6049
|
-
},
|
|
6050
|
-
{
|
|
6051
|
-
"name": "CaptionText",
|
|
6052
|
-
"sourceFile": "components/New/CaptionText/CaptionText.tsx",
|
|
6053
|
-
"description": "A component for displaying caption text with consistent styling\naliases: HelperText|ValidationText",
|
|
6054
|
-
"signature": "CaptionText: FC<CaptionTextProps>"
|
|
6055
|
-
},
|
|
6056
|
-
{
|
|
6057
|
-
"name": "ErrorText",
|
|
6058
|
-
"sourceFile": "components/New/CaptionText/CaptionText.tsx",
|
|
6059
|
-
"signature": "ErrorText: FC<Omit<CaptionTextProps, 'variant'>>"
|
|
6060
8255
|
}
|
|
6061
8256
|
],
|
|
6062
8257
|
"utils": [
|