Skip to content

Commit de4e28e

Browse files
pkosiecpkosiec
committed
chore: finalize the investigation docs
1 parent df4862d commit de4e28e

File tree

143 files changed

+2850
-1660
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+2850
-1660
lines changed

‎docs/docs/api/appkit-ui/components/Accordion.mdx‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Accordion
3-
---
4-
51
# Accordion
62

3+
Collapsible content sections organized in a vertical stack
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Accordion
1514

15+
Collapsible content sections organized in a vertical stack
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx)
1819

@@ -44,6 +45,8 @@ import { Accordion } from '@databricks/appkit-ui';
4445

4546
## AccordionContent
4647

48+
Content area that expands and collapses within an accordion item
49+
4750

4851
**Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx)
4952

@@ -68,6 +71,8 @@ import { AccordionContent } from '@databricks/appkit-ui';
6871

6972
## AccordionItem
7073

74+
Individual collapsible section within an accordion
75+
7176

7277
**Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx)
7378

@@ -93,6 +98,8 @@ import { AccordionItem } from '@databricks/appkit-ui';
9398

9499
## AccordionTrigger
95100

101+
Clickable button that triggers accordion content visibility
102+
96103

97104
**Source:** [`packages/appkit-ui/src/react/ui/accordion.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/accordion.tsx)
98105

‎docs/docs/api/appkit-ui/components/Alert.mdx‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Alert
3-
---
4-
51
# Alert
62

3+
Displays important information with optional icon and multiple variants
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Alert
1514

15+
Displays important information with optional icon and multiple variants
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx)
1819

@@ -36,6 +37,8 @@ import { Alert } from '@databricks/appkit-ui';
3637

3738
## AlertDescription
3839

40+
Descriptive text content for an alert component
41+
3942

4043
**Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx)
4144

@@ -57,6 +60,8 @@ import { AlertDescription } from '@databricks/appkit-ui';
5760

5861
## AlertTitle
5962

63+
Title text for an alert component
64+
6065

6166
**Source:** [`packages/appkit-ui/src/react/ui/alert.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert.tsx)
6267

‎docs/docs/api/appkit-ui/components/AlertDialog.mdx‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: AlertDialog
3-
---
4-
51
# AlertDialog
62

3+
Modal dialog that interrupts the user with critical information requiring immediate action
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## AlertDialog
1514

15+
Modal dialog that interrupts the user with critical information requiring immediate action
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
1819

@@ -38,6 +39,8 @@ import { AlertDialog } from '@databricks/appkit-ui';
3839

3940
## AlertDialogAction
4041

42+
Primary action button that confirms the alert
43+
4144

4245
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
4346

@@ -61,6 +64,8 @@ import { AlertDialogAction } from '@databricks/appkit-ui';
6164

6265
## AlertDialogCancel
6366

67+
Cancel button that dismisses the alert dialog
68+
6469

6570
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
6671

@@ -84,6 +89,8 @@ import { AlertDialogCancel } from '@databricks/appkit-ui';
8489

8590
## AlertDialogContent
8691

92+
Main content container for the alert dialog
93+
8794

8895
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
8996

@@ -112,6 +119,8 @@ import { AlertDialogContent } from '@databricks/appkit-ui';
112119

113120
## AlertDialogDescription
114121

122+
Descriptive text explaining the alert
123+
115124

116125
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
117126

@@ -135,6 +144,8 @@ import { AlertDialogDescription } from '@databricks/appkit-ui';
135144

136145
## AlertDialogFooter
137146

147+
Footer section containing action buttons
148+
138149

139150
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
140151

@@ -156,6 +167,8 @@ import { AlertDialogFooter } from '@databricks/appkit-ui';
156167

157168
## AlertDialogHeader
158169

170+
Header section containing title and description
171+
159172

160173
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
161174

@@ -177,6 +190,8 @@ import { AlertDialogHeader } from '@databricks/appkit-ui';
177190

178191
## AlertDialogOverlay
179192

193+
Background overlay that dims content behind the alert dialog
194+
180195

181196
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
182197

@@ -201,6 +216,8 @@ import { AlertDialogOverlay } from '@databricks/appkit-ui';
201216

202217
## AlertDialogPortal
203218

219+
Portal container for rendering alert dialog content outside the DOM hierarchy
220+
204221

205222
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
206223

@@ -225,6 +242,8 @@ import { AlertDialogPortal } from '@databricks/appkit-ui';
225242

226243
## AlertDialogTitle
227244

245+
Title heading for the alert dialog
246+
228247

229248
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
230249

@@ -248,6 +267,8 @@ import { AlertDialogTitle } from '@databricks/appkit-ui';
248267

249268
## AlertDialogTrigger
250269

270+
Button that triggers the alert dialog to open
271+
251272

252273
**Source:** [`packages/appkit-ui/src/react/ui/alert-dialog.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/alert-dialog.tsx)
253274

‎docs/docs/api/appkit-ui/components/AspectRatio.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: AspectRatio
3-
---
4-
51
# AspectRatio
62

3+
Container that maintains a specific aspect ratio for its content
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## AspectRatio
1514

15+
Container that maintains a specific aspect ratio for its content
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/aspect-ratio.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/aspect-ratio.tsx)
1819

‎docs/docs/api/appkit-ui/components/Avatar.mdx‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Avatar
3-
---
4-
51
# Avatar
62

3+
Displays user profile picture or initials in a circular container
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Avatar
1514

15+
Displays user profile picture or initials in a circular container
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx)
1819

@@ -36,6 +37,8 @@ import { Avatar } from '@databricks/appkit-ui';
3637

3738
## AvatarFallback
3839

40+
Fallback content displayed when avatar image fails to load
41+
3942

4043
**Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx)
4144

@@ -60,6 +63,8 @@ import { AvatarFallback } from '@databricks/appkit-ui';
6063

6164
## AvatarImage
6265

66+
Image element for the avatar
67+
6368

6469
**Source:** [`packages/appkit-ui/src/react/ui/avatar.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/avatar.tsx)
6570

‎docs/docs/api/appkit-ui/components/Badge.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Badge
3-
---
4-
51
# Badge
62

3+
Small label for displaying status, categories, or counts
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Badge
1514

15+
Small label for displaying status, categories, or counts
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/badge.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/badge.tsx)
1819

‎docs/docs/api/appkit-ui/components/Breadcrumb.mdx‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Breadcrumb
3-
---
4-
51
# Breadcrumb
62

3+
Navigation component showing the current page's location in the site hierarchy
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Breadcrumb
1514

15+
Navigation component showing the current page's location in the site hierarchy
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
1819

@@ -34,6 +35,8 @@ import { Breadcrumb } from '@databricks/appkit-ui';
3435

3536
## BreadcrumbEllipsis
3637

38+
Ellipsis indicator for collapsed breadcrumb items
39+
3740

3841
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
3942

@@ -55,6 +58,8 @@ import { BreadcrumbEllipsis } from '@databricks/appkit-ui';
5558

5659
## BreadcrumbItem
5760

61+
Individual item in the breadcrumb trail
62+
5863

5964
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
6065

@@ -76,6 +81,8 @@ import { BreadcrumbItem } from '@databricks/appkit-ui';
7681

7782
## BreadcrumbLink
7883

84+
Clickable link within a breadcrumb item
85+
7986

8087
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
8188

@@ -99,6 +106,8 @@ import { BreadcrumbLink } from '@databricks/appkit-ui';
99106

100107
## BreadcrumbList
101108

109+
Ordered list container for breadcrumb items
110+
102111

103112
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
104113

@@ -120,6 +129,8 @@ import { BreadcrumbList } from '@databricks/appkit-ui';
120129

121130
## BreadcrumbPage
122131

132+
Current page indicator in the breadcrumb trail
133+
123134

124135
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
125136

@@ -141,6 +152,8 @@ import { BreadcrumbPage } from '@databricks/appkit-ui';
141152

142153
## BreadcrumbSeparator
143154

155+
Visual separator between breadcrumb items
156+
144157

145158
**Source:** [`packages/appkit-ui/src/react/ui/breadcrumb.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/breadcrumb.tsx)
146159

‎docs/docs/api/appkit-ui/components/Button.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
---
2-
title: Button
3-
---
4-
51
# Button
62

3+
Clickable button with multiple variants and sizes
4+
5+
76
## Example
87

98
import { DocExample } from "@site/src/components/DocExample";
@@ -13,6 +12,8 @@ import { DocExample } from "@site/src/components/DocExample";
1312

1413
## Button
1514

15+
Clickable button with multiple variants and sizes
16+
1617

1718
**Source:** [`packages/appkit-ui/src/react/ui/button.tsx`](https://github.com/databricks/appkit/blob/main/packages/appkit-ui/src/react/ui/button.tsx)
1819

0 commit comments

Comments
 (0)