@aircall/blocks 0.16.0 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { Badge, Button, CounterBadge, Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle, SidebarProvider, TabsList, useSidebar } from "@aircall/ds";
1
+ import { Badge, Button, Card, CardAction, CardContent, CardDescription, CardHeader, CardTitle, CounterBadge, Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle, SidebarProvider, TabsList, useSidebar } from "@aircall/ds";
2
2
  import * as React$1 from "react";
3
- import * as react_jsx_runtime0 from "react/jsx-runtime";
4
3
  import { VariantProps } from "class-variance-authority";
5
4
  import * as _tanstack_react_form0 from "@tanstack/react-form";
6
5
  import { DeepKeys, DeepKeysOfType, DeepValue, FieldAsyncValidateOrFn, FieldListeners, FieldValidateOrFn, FieldValidators } from "@tanstack/react-form";
@@ -26,11 +25,13 @@ type EmptyStateMediaProps = Omit<React$1.ComponentProps<typeof EmptyMedia>, 'var
26
25
  declare namespace EmptyStateMedia {
27
26
  type Props = EmptyStateMediaProps;
28
27
  }
28
+ /** Title line of an empty state. Wraps the DS `EmptyTitle`. */
29
29
  declare const EmptyStateTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
30
30
  interface EmptyStateTitleProps extends React$1.ComponentProps<typeof EmptyTitle> {}
31
31
  declare namespace EmptyStateTitle {
32
32
  type Props = EmptyStateTitleProps;
33
33
  }
34
+ /** Supporting description text of an empty state. Wraps the DS `EmptyDescription`. */
34
35
  declare const EmptyStateDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
35
36
  interface EmptyStateDescriptionProps extends React$1.ComponentProps<typeof EmptyDescription> {}
36
37
  declare namespace EmptyStateDescription {
@@ -47,6 +48,11 @@ declare namespace EmptyStateActions {
47
48
  type Props = EmptyStateActionsProps;
48
49
  }
49
50
  type EmptyStateButtonProps = Omit<React$1.ComponentProps<typeof Button>, 'size'>;
51
+ /**
52
+ * Action button for an empty state — the only button allowed inside one. Wraps
53
+ * the DS `Button` with `size` locked to `default` for visual consistency across
54
+ * empty states; consumers still choose the `variant`.
55
+ */
50
56
  declare const EmptyStateButton: React$1.ForwardRefExoticComponent<Omit<EmptyStateButtonProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
51
57
  declare namespace EmptyStateButton {
52
58
  type Props = EmptyStateButtonProps;
@@ -54,49 +60,193 @@ declare namespace EmptyStateButton {
54
60
  type EmptyStateExternalLinkProps = Omit<EmptyStateButtonProps, 'variant' | 'render'> & {
55
61
  href: string;
56
62
  };
63
+ /**
64
+ * External "Learn more"-style link for an empty state. Renders a real `<a>` (via
65
+ * `EmptyStateButton` with `variant="link"`) that opens in a new tab. Pass
66
+ * `children` to override the default "Learn more" label, including any icon.
67
+ *
68
+ * @default children "Learn more"
69
+ */
57
70
  declare const EmptyStateExternalLink: React$1.ForwardRefExoticComponent<Omit<EmptyStateExternalLinkProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
58
71
  declare namespace EmptyStateExternalLink {
59
72
  type Props = EmptyStateExternalLinkProps;
60
73
  }
61
74
  //#endregion
62
75
  //#region src/components/coming-soon.d.ts
76
+ /**
77
+ * Root of the "Coming soon" empty state — shown when a feature exists in the UI
78
+ * but is not yet available. Renders a `<div>` (the DS `Empty` container); compose
79
+ * it from its parts.
80
+ *
81
+ * @example
82
+ * ```tsx
83
+ * <ComingSoonEmptyState>
84
+ * <EmptyStateHeader>
85
+ * <ComingSoonMedia />
86
+ * <ComingSoonTitle />
87
+ * <ComingSoonDescription />
88
+ * </EmptyStateHeader>
89
+ * <EmptyStateActions>
90
+ * <EmptyStateButton variant="outline" onClick={goBack}>Go back</EmptyStateButton>
91
+ * <EmptyStateExternalLink href={docsUrl} />
92
+ * </EmptyStateActions>
93
+ * </ComingSoonEmptyState>
94
+ * ```
95
+ */
63
96
  declare const ComingSoonEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
97
+ /** Decorative media slot of the "Coming soon" empty state (a sprout icon). Renders a `<div>`, hidden from assistive tech. */
64
98
  declare const ComingSoonMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
99
+ /** Title line of the "Coming soon" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
65
100
  declare const ComingSoonTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
101
+ /** Supporting description text of the "Coming soon" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
66
102
  declare const ComingSoonDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
67
103
  //#endregion
68
104
  //#region src/components/restricted-access.d.ts
105
+ /**
106
+ * Root of the "Restricted access" empty state — shown when the user lacks
107
+ * permission to view a page. Renders a `<div>` (the DS `Empty` container); pair
108
+ * it with an `EmptyStateExternalLink` for the "Learn more" action.
109
+ *
110
+ * @example
111
+ * ```tsx
112
+ * <RestrictedAccessEmptyState>
113
+ * <EmptyStateHeader>
114
+ * <RestrictedAccessMedia />
115
+ * <RestrictedAccessTitle />
116
+ * <RestrictedAccessDescription />
117
+ * </EmptyStateHeader>
118
+ * <EmptyStateActions>
119
+ * <EmptyStateExternalLink href={docsUrl} />
120
+ * </EmptyStateActions>
121
+ * </RestrictedAccessEmptyState>
122
+ * ```
123
+ */
69
124
  declare const RestrictedAccessEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
125
+ /** Decorative media slot of the "Restricted access" empty state (a locked padlock icon). Renders a `<div>`, hidden from assistive tech. */
70
126
  declare const RestrictedAccessMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
127
+ /** Title line of the "Restricted access" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
71
128
  declare const RestrictedAccessTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
129
+ /** Supporting description text of the "Restricted access" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
72
130
  declare const RestrictedAccessDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
73
131
  //#endregion
74
132
  //#region src/components/not-found.d.ts
133
+ /**
134
+ * Root of the "Not found" empty state — shown when a page or route cannot be
135
+ * found. Renders a `<div>` (the DS `Empty` container); pair it with an
136
+ * `EmptyStateButton` for the navigation action (e.g. "Go to inbox").
137
+ *
138
+ * @example
139
+ * ```tsx
140
+ * <NotFoundEmptyState>
141
+ * <EmptyStateHeader>
142
+ * <NotFoundMedia />
143
+ * <NotFoundTitle />
144
+ * <NotFoundDescription />
145
+ * </EmptyStateHeader>
146
+ * <EmptyStateActions>
147
+ * <EmptyStateButton onClick={goToInbox}>Go to inbox</EmptyStateButton>
148
+ * </EmptyStateActions>
149
+ * </NotFoundEmptyState>
150
+ * ```
151
+ */
75
152
  declare const NotFoundEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
153
+ /** Decorative media slot of the "Not found" empty state (a search icon). Renders a `<div>`, hidden from assistive tech. */
76
154
  declare const NotFoundMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
155
+ /** Title line of the "Not found" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
77
156
  declare const NotFoundTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
157
+ /** Supporting description text of the "Not found" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
78
158
  declare const NotFoundDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
79
159
  //#endregion
80
160
  //#region src/components/no-data.d.ts
161
+ /**
162
+ * Root of the "No data" empty state — shown when a search or filter returns no
163
+ * results. Renders a `<div>` (the DS `Empty` container) with `role="status"` so
164
+ * it announces politely after a user action; pair it with an `EmptyStateButton`
165
+ * for the "Reset" action.
166
+ *
167
+ * @example
168
+ * ```tsx
169
+ * <NoDataEmptyState>
170
+ * <EmptyStateHeader>
171
+ * <NoDataMedia />
172
+ * <NoDataTitle />
173
+ * <NoDataDescription />
174
+ * </EmptyStateHeader>
175
+ * <EmptyStateActions>
176
+ * <EmptyStateButton variant="outline" onClick={resetFilters}>Reset</EmptyStateButton>
177
+ * </EmptyStateActions>
178
+ * </NoDataEmptyState>
179
+ * ```
180
+ */
81
181
  declare const NoDataEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
182
+ /** Decorative media slot of the "No data" empty state (a search icon). Renders a `<div>`, hidden from assistive tech. */
82
183
  declare const NoDataMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
184
+ /** Title line of the "No data" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
83
185
  declare const NoDataTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
186
+ /** Supporting description text of the "No data" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
84
187
  declare const NoDataDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
85
188
  //#endregion
86
189
  //#region src/components/no-support.d.ts
190
+ /**
191
+ * Root of the "No support" empty state — shown when the current browser can't
192
+ * render a page. Renders a `<div>` (the DS `Empty` container); pair it with an
193
+ * `EmptyStateExternalLink` for the "Learn more" action.
194
+ *
195
+ * @example
196
+ * ```tsx
197
+ * <NoSupportEmptyState>
198
+ * <EmptyStateHeader>
199
+ * <NoSupportMedia />
200
+ * <NoSupportTitle />
201
+ * <NoSupportDescription />
202
+ * </EmptyStateHeader>
203
+ * <EmptyStateActions>
204
+ * <EmptyStateExternalLink href={docsUrl} />
205
+ * </EmptyStateActions>
206
+ * </NoSupportEmptyState>
207
+ * ```
208
+ */
87
209
  declare const NoSupportEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
210
+ /** Decorative media slot of the "No support" empty state (a settings icon). Renders a `<div>`, hidden from assistive tech. */
88
211
  declare const NoSupportMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
212
+ /** Title line of the "No support" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
89
213
  declare const NoSupportTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
214
+ /** Supporting description text of the "No support" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
90
215
  declare const NoSupportDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
91
216
  //#endregion
92
217
  //#region src/components/unknown-error.d.ts
218
+ /**
219
+ * Root of the "Unknown error" empty state — shown when content fails to load
220
+ * unexpectedly. Renders a `<div>` (the DS `Empty` container) with `role="alert"`
221
+ * so it announces assertively; pair it with a primary `EmptyStateButton` for the
222
+ * "Try again" action.
223
+ *
224
+ * @example
225
+ * ```tsx
226
+ * <UnknownErrorEmptyState>
227
+ * <EmptyStateHeader>
228
+ * <UnknownErrorMedia />
229
+ * <UnknownErrorTitle />
230
+ * <UnknownErrorDescription />
231
+ * </EmptyStateHeader>
232
+ * <EmptyStateActions>
233
+ * <EmptyStateButton onClick={retry}>Try again</EmptyStateButton>
234
+ * </EmptyStateActions>
235
+ * </UnknownErrorEmptyState>
236
+ * ```
237
+ */
93
238
  declare const UnknownErrorEmptyState: React$1.ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
239
+ /** Decorative media slot of the "Unknown error" empty state (a warning triangle icon). Renders a `<div>`, hidden from assistive tech. */
94
240
  declare const UnknownErrorMedia: React$1.ForwardRefExoticComponent<Omit<Omit<EmptyStateMediaProps, "children">, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
241
+ /** Title line of the "Unknown error" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
95
242
  declare const UnknownErrorTitle: React$1.ForwardRefExoticComponent<Omit<EmptyStateTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
243
+ /** Supporting description text of the "Unknown error" empty state. Renders a `<div>` with the design copy by default; pass children to override. */
96
244
  declare const UnknownErrorDescription: React$1.ForwardRefExoticComponent<Omit<EmptyStateDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
97
245
  //#endregion
98
246
  //#region src/components/chatbot-response-block.d.ts
247
+ /** Feedback state for a response: thumbs up, thumbs down, or none. */
99
248
  type ChatbotResponseBlockFeedback = 'up' | 'down' | null;
249
+ /** A cited source shown in the response's sources hover card. */
100
250
  type ChatbotResponseBlockSource = {
101
251
  title: string;
102
252
  url: string;
@@ -112,6 +262,22 @@ type ChatbotResponseBlockProps = {
112
262
  onFeedback?: (value: ChatbotResponseBlockFeedback) => void;
113
263
  className?: string;
114
264
  };
265
+ /**
266
+ * Renders a chatbot response from markdown, splitting it into markdown text and
267
+ * embedded component blocks (table, audio, transcript, loading), with a sources
268
+ * hover card and copy / thumbs-up / thumbs-down feedback controls. Renders a
269
+ * `<div>` (`data-slot="chatbot-response-block"`).
270
+ *
271
+ * @example
272
+ * ```tsx
273
+ * <ChatbotResponseBlock
274
+ * messageId="msg-1"
275
+ * markdown="**Hello** from the assistant"
276
+ * sources={[{ title: 'Help center', url: 'https://help.aircall.io' }]}
277
+ * onFeedback={value => console.log(value)}
278
+ * />
279
+ * ```
280
+ */
115
281
  declare function ChatbotResponseBlock({
116
282
  messageId,
117
283
  markdown,
@@ -119,7 +285,7 @@ declare function ChatbotResponseBlock({
119
285
  sources,
120
286
  onFeedback,
121
287
  className
122
- }: ChatbotResponseBlockProps): react_jsx_runtime0.JSX.Element;
288
+ }: ChatbotResponseBlockProps): React$1.JSX.Element;
123
289
  //#endregion
124
290
  //#region src/components/chatbot-response-loading.d.ts
125
291
  interface ChatbotResponseLoadingProps {
@@ -146,9 +312,29 @@ interface ChatbotResponseLoadingProps {
146
312
  declare function ChatbotResponseLoading({
147
313
  text,
148
314
  className
149
- }: ChatbotResponseLoadingProps): react_jsx_runtime0.JSX.Element;
315
+ }: ChatbotResponseLoadingProps): React$1.JSX.Element;
150
316
  //#endregion
151
317
  //#region src/components/chatbot-page.d.ts
318
+ /**
319
+ * Root layout shell for the AI chatbot experience; provides the `SidebarProvider`
320
+ * context required by `ChatbotSidebar` and lays out the sidebar and content
321
+ * columns. Renders a `SidebarProvider` (a `<div>` wrapper) with the sidebar width
322
+ * preset and full-height overrides for panel/modal contexts.
323
+ *
324
+ * @example
325
+ * ```tsx
326
+ * <ChatbotPage>
327
+ * <ChatbotSidebar conversations={[...]} />
328
+ * <ChatbotPageContent>
329
+ * <ChatbotPageBody>
330
+ * <ChatbotPageHeading>Need help?</ChatbotPageHeading>
331
+ * <ChatbotInput />
332
+ * </ChatbotPageBody>
333
+ * <ChatbotPageFooter betaTermsHref="https://legal.aircall.io/..." />
334
+ * </ChatbotPageContent>
335
+ * </ChatbotPage>
336
+ * ```
337
+ */
152
338
  declare const ChatbotPage: React$1.ForwardRefExoticComponent<ChatbotPageProps & React$1.RefAttributes<HTMLDivElement>>;
153
339
  interface ChatbotPageProps {
154
340
  children?: React$1.ReactNode;
@@ -322,9 +508,10 @@ declare function ChatbotPanelHeader({
322
508
  onClose,
323
509
  className,
324
510
  ...props
325
- }: ChatbotPanelHeaderProps): react_jsx_runtime0.JSX.Element;
511
+ }: ChatbotPanelHeaderProps): React$1.JSX.Element;
326
512
  //#endregion
327
513
  //#region src/components/chatbot-sidebar.d.ts
514
+ /** A single conversation row in the `ChatbotSidebar` recent list. */
328
515
  interface ChatbotSidebarConversation {
329
516
  id: string;
330
517
  /** Display title — truncated with ellipsis when it overflows. */
@@ -365,12 +552,26 @@ interface ChatbotSidebarProps {
365
552
  popup?: boolean;
366
553
  className?: string;
367
554
  }
555
+ /**
556
+ * Conversation-history sidebar: an optional "New Chat" entry plus a scrollable,
557
+ * resizable list of recent conversations, each with an optional trailing ⋯ menu.
558
+ * Renders the DS `Sidebar` (a `<div>`), or a plain `<div>` when `popup`. Must be
559
+ * rendered inside a `SidebarProvider`.
560
+ *
561
+ * @example
562
+ * ```tsx
563
+ * <SidebarProvider>
564
+ * <ChatbotSidebar conversations={items} onSelectConversation={open} />
565
+ * </SidebarProvider>
566
+ * ```
567
+ */
368
568
  declare const ChatbotSidebar: React$1.ForwardRefExoticComponent<ChatbotSidebarProps & React$1.RefAttributes<HTMLDivElement>>;
369
569
  declare namespace ChatbotSidebar {
370
570
  type Props = ChatbotSidebarProps;
371
571
  }
372
572
  //#endregion
373
573
  //#region src/components/chatbot-input.d.ts
574
+ /** A suggestion pill shown in a row below the `ChatbotInput`. */
374
575
  interface ChatbotInputSuggestion {
375
576
  id: string;
376
577
  /** Text shown on the pill button. */
@@ -408,6 +609,18 @@ type ChatbotInputProps = Omit<React$1.ComponentProps<'textarea'>, 'onChange' | '
408
609
  activeConversationId?: string; /** Called when the user selects a conversation from the history popover. */
409
610
  onSelectConversation?: (id: string) => void;
410
611
  };
612
+ /**
613
+ * Chatbot message composer: an auto-growing `InputGroup` textarea with a send/stop
614
+ * button, plus optional suggestion pills and a conversation-history popover. Works
615
+ * controlled (`value` + `onValueChange`) or uncontrolled. Enter submits;
616
+ * Shift+Enter inserts a newline. Renders the DS `InputGroup` (a `<div>`) wrapping a
617
+ * `<textarea>`.
618
+ *
619
+ * @example
620
+ * ```tsx
621
+ * <ChatbotInput value={text} onValueChange={setText} onSubmit={send} />
622
+ * ```
623
+ */
411
624
  declare function ChatbotInput({
412
625
  className,
413
626
  value,
@@ -425,9 +638,22 @@ declare function ChatbotInput({
425
638
  activeConversationId,
426
639
  onSelectConversation,
427
640
  ...textareaProps
428
- }: ChatbotInputProps): react_jsx_runtime0.JSX.Element;
641
+ }: ChatbotInputProps): React$1.JSX.Element;
429
642
  //#endregion
430
643
  //#region src/components/copy-button.d.ts
644
+ /**
645
+ * Copy-to-clipboard button. Composes DS `Button`; copies `value` on click and
646
+ * exposes a `copied` state (auto-reset after `timeout`) to its `CopyButtonIcon`
647
+ * and `CopyButtonLabel` children via context. Renders a `<button>`.
648
+ *
649
+ * @example
650
+ * ```tsx
651
+ * <CopyButton value="npm i @aircall/ds">
652
+ * <CopyButtonIcon />
653
+ * <CopyButtonLabel />
654
+ * </CopyButton>
655
+ * ```
656
+ */
431
657
  declare const CopyButton: React$1.ForwardRefExoticComponent<Omit<CopyButtonProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
432
658
  interface CopyButtonProps extends Omit<React$1.ComponentProps<typeof Button>, 'onClick' | 'variant'> {
433
659
  value: string;
@@ -439,6 +665,10 @@ interface CopyButtonProps extends Omit<React$1.ComponentProps<typeof Button>, 'o
439
665
  declare namespace CopyButton {
440
666
  type Props = CopyButtonProps;
441
667
  }
668
+ /**
669
+ * Icon for `CopyButton` that swaps between a copy glyph and a check glyph based on
670
+ * the parent's copied state. Renders an `<svg>`. Must be used inside a `CopyButton`.
671
+ */
442
672
  declare const CopyButtonIcon: React$1.ForwardRefExoticComponent<CopyButtonIconProps & React$1.RefAttributes<SVGSVGElement>>;
443
673
  interface CopyButtonIconProps {
444
674
  className?: string;
@@ -446,6 +676,10 @@ interface CopyButtonIconProps {
446
676
  declare namespace CopyButtonIcon {
447
677
  type Props = CopyButtonIconProps;
448
678
  }
679
+ /**
680
+ * Text label for `CopyButton` that shows `label` normally and `copiedLabel` after a
681
+ * successful copy. Renders a `<span>`. Must be used inside a `CopyButton`.
682
+ */
449
683
  declare const CopyButtonLabel: React$1.ForwardRefExoticComponent<CopyButtonLabelProps & React$1.RefAttributes<HTMLSpanElement>>;
450
684
  interface CopyButtonLabelProps {
451
685
  label?: string;
@@ -458,45 +692,103 @@ declare namespace CopyButtonLabel {
458
692
  //#endregion
459
693
  //#region src/components/chatbot-panel-suggestion.d.ts
460
694
  type ChatbotPanelSuggestionProps = Omit<React.ComponentProps<typeof Button>, 'variant' | 'size'>;
695
+ /**
696
+ * Pill-shaped prompt suggestion shown in the chatbot panel; a preset styling of
697
+ * `Button` with a green border and surface background. Renders a `<button>`.
698
+ *
699
+ * @example
700
+ * ```tsx
701
+ * <ChatbotPanelSuggestion onClick={() => ask('How do I set my phone line?')}>
702
+ * How do I set my phone line?
703
+ * </ChatbotPanelSuggestion>
704
+ * ```
705
+ */
461
706
  declare function ChatbotPanelSuggestion({
462
707
  className,
463
708
  ...props
464
- }: ChatbotPanelSuggestionProps): react_jsx_runtime0.JSX.Element;
709
+ }: ChatbotPanelSuggestionProps): React$1.JSX.Element;
465
710
  //#endregion
466
711
  //#region src/components/chatbot-user-message.d.ts
467
712
  type ChatbotUserMessageProps = React.ComponentProps<'div'>;
713
+ /**
714
+ * Right-aligned chat bubble for a user's message; clamps long content to six
715
+ * lines with a "Show more" / "Show less" toggle. Renders a `<div>`
716
+ * (`data-slot="chatbot-user-message"`).
717
+ *
718
+ * @example
719
+ * ```tsx
720
+ * <ChatbotUserMessage>How do I set up my phone number?</ChatbotUserMessage>
721
+ * ```
722
+ */
468
723
  declare function ChatbotUserMessage({
469
724
  className,
470
725
  children,
471
726
  ...props
472
- }: ChatbotUserMessageProps): react_jsx_runtime0.JSX.Element;
727
+ }: ChatbotUserMessageProps): React$1.JSX.Element;
473
728
  //#endregion
474
729
  //#region src/components/dashboard-standalone-page.d.ts
730
+ /**
731
+ * Full-screen takeover shell for focused, sidebar-less flows; renders a flex-row `<div>`
732
+ * holding one or more `DashboardStandalonePageContent` panels side by side.
733
+ *
734
+ * @example
735
+ * ```tsx
736
+ * <DashboardStandalonePage>
737
+ * <DashboardStandalonePageContent>
738
+ * <DashboardStandalonePageHeader>
739
+ * <DashboardStandalonePageTitle>Create user</DashboardStandalonePageTitle>
740
+ * <DashboardStandalonePageActions side="start">
741
+ * <DashboardStandalonePageAction>Cancel</DashboardStandalonePageAction>
742
+ * </DashboardStandalonePageActions>
743
+ * </DashboardStandalonePageHeader>
744
+ * <DashboardStandalonePageMain>…</DashboardStandalonePageMain>
745
+ * </DashboardStandalonePageContent>
746
+ * </DashboardStandalonePage>
747
+ * ```
748
+ */
475
749
  declare const DashboardStandalonePage: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
476
750
  interface DashboardStandalonePageProps extends React$1.ComponentProps<'div'> {}
477
751
  declare namespace DashboardStandalonePage {
478
752
  type Props = DashboardStandalonePageProps;
479
753
  }
754
+ /**
755
+ * Rounded, bordered content panel that fills the shell; renders a `<div>`.
756
+ * Typically wraps a `DashboardStandalonePageHeader` above a `DashboardStandalonePageMain`.
757
+ */
480
758
  declare const DashboardStandalonePageContent: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageContentProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
481
759
  interface DashboardStandalonePageContentProps extends React$1.ComponentProps<'div'> {}
482
760
  declare namespace DashboardStandalonePageContent {
483
761
  type Props = DashboardStandalonePageContentProps;
484
762
  }
763
+ /**
764
+ * Fixed-height (64px) header bar with an optically centered title and absolutely
765
+ * positioned action slots; renders a `<header>`.
766
+ */
485
767
  declare const DashboardStandalonePageHeader: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageHeaderProps, "ref"> & React$1.RefAttributes<HTMLElement>>;
486
768
  interface DashboardStandalonePageHeaderProps extends React$1.ComponentProps<'header'> {}
487
769
  declare namespace DashboardStandalonePageHeader {
488
770
  type Props = DashboardStandalonePageHeaderProps;
489
771
  }
772
+ /**
773
+ * Centered, truncated page title in the header; renders an `<h1>`.
774
+ */
490
775
  declare const DashboardStandalonePageTitle: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageTitleProps, "ref"> & React$1.RefAttributes<HTMLHeadingElement>>;
491
776
  interface DashboardStandalonePageTitleProps extends React$1.ComponentProps<'h1'> {}
492
777
  declare namespace DashboardStandalonePageTitle {
493
778
  type Props = DashboardStandalonePageTitleProps;
494
779
  }
780
+ /**
781
+ * Optional subtitle stacked beneath the title in the header; renders a `<p>`.
782
+ */
495
783
  declare const DashboardStandalonePageDescription: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageDescriptionProps, "ref"> & React$1.RefAttributes<HTMLParagraphElement>>;
496
784
  interface DashboardStandalonePageDescriptionProps extends React$1.ComponentProps<'p'> {}
497
785
  declare namespace DashboardStandalonePageDescription {
498
786
  type Props = DashboardStandalonePageDescriptionProps;
499
787
  }
788
+ /**
789
+ * Action slot absolutely pinned to the header's left or right edge; renders a `<div>`.
790
+ * Sitting outside the flow, it never shifts the centered title.
791
+ */
500
792
  declare const DashboardStandalonePageActions: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageActionsProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
501
793
  interface DashboardStandalonePageActionsProps extends React$1.ComponentProps<'div'> {
502
794
  side?: 'start' | 'end';
@@ -504,11 +796,17 @@ interface DashboardStandalonePageActionsProps extends React$1.ComponentProps<'di
504
796
  declare namespace DashboardStandalonePageActions {
505
797
  type Props = DashboardStandalonePageActionsProps;
506
798
  }
799
+ /**
800
+ * Header action button rendering a ds `Button` (ghost, `lg` by default); renders a `<button>`.
801
+ */
507
802
  declare const DashboardStandalonePageAction: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageActionProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
508
803
  interface DashboardStandalonePageActionProps extends React$1.ComponentProps<typeof Button> {}
509
804
  declare namespace DashboardStandalonePageAction {
510
805
  type Props = DashboardStandalonePageActionProps;
511
806
  }
807
+ /**
808
+ * Scrollable, transparent content area below the header inside the panel; renders a `<main>`.
809
+ */
512
810
  declare const DashboardStandalonePageMain: React$1.ForwardRefExoticComponent<Omit<DashboardStandalonePageMainProps, "ref"> & React$1.RefAttributes<HTMLElement>>;
513
811
  interface DashboardStandalonePageMainProps extends React$1.ComponentProps<'main'> {}
514
812
  declare namespace DashboardStandalonePageMain {
@@ -516,26 +814,54 @@ declare namespace DashboardStandalonePageMain {
516
814
  }
517
815
  //#endregion
518
816
  //#region src/components/dashboard-page.d.ts
817
+ /**
818
+ * Full-screen outer shell for a dashboard view; renders a `<div>`.
819
+ * Stacks an optional `DashboardPageBanner` above a `DashboardSidebarProvider`
820
+ * that holds the sidebar and a `DashboardPageContent`.
821
+ *
822
+ * @example
823
+ * ```tsx
824
+ * <DashboardPage>
825
+ * <DashboardSidebarProvider>
826
+ * <DashboardSidebar>…</DashboardSidebar>
827
+ * <DashboardPageContent>…</DashboardPageContent>
828
+ * </DashboardSidebarProvider>
829
+ * </DashboardPage>
830
+ * ```
831
+ */
519
832
  declare const DashboardPage: React$1.ForwardRefExoticComponent<Omit<DashboardPageProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
520
833
  interface DashboardPageProps extends React$1.ComponentProps<'div'> {}
521
834
  declare namespace DashboardPage {
522
835
  type Props = DashboardPageProps;
523
836
  }
837
+ /**
838
+ * Full-width top row that sits flush above the sidebar/content row; renders a `<div>`.
839
+ * Use to host trial notices, announcements, or any ds `Banner`.
840
+ */
524
841
  declare const DashboardPageBanner: React$1.ForwardRefExoticComponent<Omit<DashboardPageBannerProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
525
842
  interface DashboardPageBannerProps extends React$1.ComponentProps<'div'> {}
526
843
  declare namespace DashboardPageBanner {
527
844
  type Props = DashboardPageBannerProps;
528
845
  }
846
+ /**
847
+ * White content card filling the right column beside the sidebar; renders a `<div>`.
848
+ */
529
849
  declare const DashboardPageContent: React$1.ForwardRefExoticComponent<Omit<DashboardPageContentProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
530
850
  interface DashboardPageContentProps extends React$1.ComponentProps<'div'> {}
531
851
  declare namespace DashboardPageContent {
532
852
  type Props = DashboardPageContentProps;
533
853
  }
854
+ /**
855
+ * Scrollable content area inside `DashboardPageContent`; renders a `<main>`.
856
+ */
534
857
  declare const DashboardPageMain: React$1.ForwardRefExoticComponent<Omit<DashboardPageMainProps, "ref"> & React$1.RefAttributes<HTMLElement>>;
535
858
  interface DashboardPageMainProps extends React$1.ComponentProps<'main'> {}
536
859
  declare namespace DashboardPageMain {
537
860
  type Props = DashboardPageMainProps;
538
861
  }
862
+ /**
863
+ * Left-aligned tab bar placed as a sibling of `DashboardPageHeader`; renders a ds `TabsList`.
864
+ */
539
865
  declare const DashboardPageTabs: React$1.ForwardRefExoticComponent<Omit<DashboardPageTabsProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
540
866
  interface DashboardPageTabsProps extends React$1.ComponentProps<typeof TabsList> {}
541
867
  declare namespace DashboardPageTabs {
@@ -543,31 +869,62 @@ declare namespace DashboardPageTabs {
543
869
  }
544
870
  //#endregion
545
871
  //#region src/components/dashboard-page-header.d.ts
872
+ /**
873
+ * Header for a `DashboardPageContent`; renders a `<div>` that establishes a
874
+ * `@container` context with an inner CSS-grid its sub-components self-place into.
875
+ *
876
+ * @example
877
+ * ```tsx
878
+ * <DashboardPageHeader>
879
+ * <DashboardPageHeaderTitle>Team</DashboardPageHeaderTitle>
880
+ * <DashboardPageHeaderActions>
881
+ * <DashboardPageHeaderAction>Invite</DashboardPageHeaderAction>
882
+ * </DashboardPageHeaderActions>
883
+ * </DashboardPageHeader>
884
+ * ```
885
+ */
546
886
  declare const DashboardPageHeader: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
547
887
  interface DashboardPageHeaderProps extends React$1.ComponentProps<'div'> {}
548
888
  declare namespace DashboardPageHeader {
549
889
  type Props = DashboardPageHeaderProps;
550
890
  }
891
+ /**
892
+ * Back-navigation row for Level 2 headers; renders a `<div>` in the grid `nav` area.
893
+ */
551
894
  declare const DashboardPageHeaderNav: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderNavProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
552
895
  interface DashboardPageHeaderNavProps extends React$1.ComponentProps<'div'> {}
553
896
  declare namespace DashboardPageHeaderNav {
554
897
  type Props = DashboardPageHeaderNavProps;
555
898
  }
899
+ /**
900
+ * Back button rendering a ghost, small ds `Button` with a leading chevron icon.
901
+ * Accepts a render prop so it can become an `<a>` or router `<Link>`.
902
+ */
556
903
  declare const DashboardPageHeaderNavBack: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderNavBackProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
557
904
  interface DashboardPageHeaderNavBackProps extends Omit<React$1.ComponentProps<typeof Button>, 'variant' | 'size'> {}
558
905
  declare namespace DashboardPageHeaderNavBack {
559
906
  type Props = DashboardPageHeaderNavBackProps;
560
907
  }
908
+ /**
909
+ * Icon/flag slot shown left of the title; renders a `<div>` in the grid `prefix` area.
910
+ */
561
911
  declare const DashboardPageHeaderPrefix: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderPrefixProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
562
912
  interface DashboardPageHeaderPrefixProps extends React$1.ComponentProps<'div'> {}
563
913
  declare namespace DashboardPageHeaderPrefix {
564
914
  type Props = DashboardPageHeaderPrefixProps;
565
915
  }
916
+ /**
917
+ * Wrapper that stacks the title and subtitle; renders a `<div>` in the grid `info` area.
918
+ */
566
919
  declare const DashboardPageHeaderTitleGroup: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderTitleGroupProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
567
920
  interface DashboardPageHeaderTitleGroupProps extends React$1.ComponentProps<'div'> {}
568
921
  declare namespace DashboardPageHeaderTitleGroup {
569
922
  type Props = DashboardPageHeaderTitleGroupProps;
570
923
  }
924
+ /**
925
+ * Page title; renders an `<h1>`, self-placing in the grid `info` area or deferring
926
+ * layout to `DashboardPageHeaderTitleGroup` when nested inside one.
927
+ */
571
928
  declare const DashboardPageHeaderTitle: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderTitleProps, "ref"> & React$1.RefAttributes<HTMLHeadingElement>>;
572
929
  interface DashboardPageHeaderTitleProps extends React$1.ComponentProps<'h1'> {
573
930
  size?: 'lg' | 'sm';
@@ -575,21 +932,34 @@ interface DashboardPageHeaderTitleProps extends React$1.ComponentProps<'h1'> {
575
932
  declare namespace DashboardPageHeaderTitle {
576
933
  type Props = DashboardPageHeaderTitleProps;
577
934
  }
935
+ /**
936
+ * Optional subtitle line/block placed beneath the title; renders a `<div>`.
937
+ */
578
938
  declare const DashboardPageHeaderSubtitle: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderSubtitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
579
939
  interface DashboardPageHeaderSubtitleProps extends React$1.ComponentProps<'div'> {}
580
940
  declare namespace DashboardPageHeaderSubtitle {
581
941
  type Props = DashboardPageHeaderSubtitleProps;
582
942
  }
943
+ /**
944
+ * Muted, clamped description text under the title; renders a `<div>`.
945
+ */
583
946
  declare const DashboardPageHeaderDescription: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
584
947
  interface DashboardPageHeaderDescriptionProps extends React$1.ComponentProps<'div'> {}
585
948
  declare namespace DashboardPageHeaderDescription {
586
949
  type Props = DashboardPageHeaderDescriptionProps;
587
950
  }
951
+ /**
952
+ * Flex container for header actions; renders a `<div>` in the grid `actions` area.
953
+ */
588
954
  declare const DashboardPageHeaderActions: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderActionsProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
589
955
  interface DashboardPageHeaderActionsProps extends React$1.ComponentProps<'div'> {}
590
956
  declare namespace DashboardPageHeaderActions {
591
957
  type Props = DashboardPageHeaderActionsProps;
592
958
  }
959
+ /**
960
+ * Header action button rendering a ds `Button` locked to the actions area sizes;
961
+ * renders a `<button>` (defaults to a labeled `lg` CTA, or `icon-lg` for icon-only triggers).
962
+ */
593
963
  declare const DashboardPageHeaderAction: React$1.ForwardRefExoticComponent<Omit<DashboardPageHeaderActionProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
594
964
  interface DashboardPageHeaderActionProps extends Omit<React$1.ComponentProps<typeof Button>, 'size'> {
595
965
  size?: 'lg' | 'icon-lg';
@@ -735,13 +1105,15 @@ declare function ChatbotPanelTrigger({
735
1105
  icon,
736
1106
  className,
737
1107
  ...buttonProps
738
- }: ChatbotPanelTriggerProps): react_jsx_runtime0.JSX.Element;
1108
+ }: ChatbotPanelTriggerProps): React$1.JSX.Element;
739
1109
  //#endregion
740
1110
  //#region src/components/chatbot-expand-suggestion.d.ts
1111
+ /** A selectable category filter pill shown above the suggestions list. */
741
1112
  interface ChatbotExpandSuggestionCategory {
742
1113
  value: string;
743
1114
  label: string;
744
1115
  }
1116
+ /** A single clickable suggestion row. */
745
1117
  interface ChatbotExpandSuggestionItem {
746
1118
  id: string;
747
1119
  text: string;
@@ -761,12 +1133,27 @@ interface ChatbotExpandSuggestionProps {
761
1133
  onSuggestionClick?: (suggestion: ChatbotExpandSuggestionItem) => void;
762
1134
  className?: string;
763
1135
  }
1136
+ /**
1137
+ * Displays category filter pills and a list of clickable suggestion rows for the
1138
+ * chatbot idle state. Renders a `<div>` wrapping an optional `ToggleGroup` of
1139
+ * category pills and a list of `Item` rows separated by `Separator`.
1140
+ *
1141
+ * @example
1142
+ * ```tsx
1143
+ * <ChatbotExpandSuggestion
1144
+ * categories={[{ value: 'billing', label: 'Billing' }]}
1145
+ * suggestions={[{ id: '1', text: 'How do I reset my password?' }]}
1146
+ * onSuggestionClick={suggestion => console.log(suggestion.text)}
1147
+ * />
1148
+ * ```
1149
+ */
764
1150
  declare const ChatbotExpandSuggestion: React$1.ForwardRefExoticComponent<ChatbotExpandSuggestionProps & React$1.RefAttributes<HTMLDivElement>>;
765
1151
  declare namespace ChatbotExpandSuggestion {
766
1152
  type Props = ChatbotExpandSuggestionProps;
767
1153
  }
768
1154
  //#endregion
769
1155
  //#region src/components/chatbot-panel.d.ts
1156
+ /** A suggestion pill shown in the panel's empty state. */
770
1157
  type ChatbotPanelSuggestionItem = {
771
1158
  /** Stable id; falls back to the label when omitted. */id?: string; /** Pill copy, also used as the message text on select. */
772
1159
  label: string;
@@ -809,6 +1196,21 @@ type ChatbotPanelProps = Omit<React$1.ComponentProps<'div'>, 'title' | 'onSubmit
809
1196
  onWidthChange?: (width: number) => void; /** Conversation content. When empty, the empty state renders instead. */
810
1197
  children?: React$1.ReactNode;
811
1198
  };
1199
+ /**
1200
+ * Presentational chatbot surface — header, scrollable conversation area (or a
1201
+ * built-in empty state), composer, and disclaimer — in a width-resizable shell.
1202
+ * Owns no visibility state (the consumer controls show/hide); pass the conversation
1203
+ * as `children`, and no children renders the empty state. Renders a `<div>`
1204
+ * container.
1205
+ *
1206
+ * @example
1207
+ * ```tsx
1208
+ * <ChatbotPanel onClose={close} onSubmit={send}>
1209
+ * <ChatbotUserMessage>Hi</ChatbotUserMessage>
1210
+ * <ChatbotResponseBlock>Hello!</ChatbotResponseBlock>
1211
+ * </ChatbotPanel>
1212
+ * ```
1213
+ */
812
1214
  declare function ChatbotPanel({
813
1215
  title,
814
1216
  onMenu,
@@ -841,7 +1243,7 @@ declare function ChatbotPanel({
841
1243
  style,
842
1244
  children,
843
1245
  ...props
844
- }: ChatbotPanelProps): react_jsx_runtime0.JSX.Element;
1246
+ }: ChatbotPanelProps): React$1.JSX.Element;
845
1247
  //#endregion
846
1248
  //#region src/hooks/use-copy-to-clipboard.d.ts
847
1249
  interface UseCopyToClipboardOptions {
@@ -857,34 +1259,40 @@ declare function useCopyToClipboard(value: string, {
857
1259
  };
858
1260
  //#endregion
859
1261
  //#region src/components/card-save-bar.d.ts
1262
+ type CardSaveBarProps = {
1263
+ submitLabel?: string;
1264
+ savingLabel?: string;
1265
+ resetLabel?: string;
1266
+ };
860
1267
  /**
861
- * Animated save/discard bar for card-layout forms. Slides in when the form is dirty, collapses when clean.
1268
+ * Save/discard bar for card-layout forms the TanStack Form adapter around
1269
+ * `SaveBar`. Reads `isDirty`, `isSubmitting`, and `canSubmit` from form context
1270
+ * and renders `SaveBar` (which owns the animation, buttons, and the
1271
+ * `data-slot="card-footer"` that flushes it to the card edge).
862
1272
  *
863
- * Reads `isDirty`, `isSubmitting`, and `canSubmit` from context no props needed for form wiring.
864
- * Must be placed **inside** the `<form>` element and wrapped by `form.AppForm` (or any `formContext` provider).
865
- * Pair with `<Card className="overflow-hidden pb-0">` so the bar's border sits flush at the card edge.
1273
+ * Must be placed **inside** the `<form>` element and wrapped by `form.AppForm`
1274
+ * (or any `formContext` provider).
866
1275
  *
867
1276
  * @example
868
1277
  * <form.AppForm>
869
1278
  * <form.CardSaveBar submitLabel="Save" resetLabel="Discard" />
870
1279
  * </form.AppForm>
871
1280
  */
872
- type CardSaveBarProps = {
873
- submitLabel?: string;
874
- savingLabel?: string;
875
- resetLabel?: string;
876
- };
877
1281
  declare function CardSaveBar({
878
1282
  submitLabel,
879
1283
  savingLabel,
880
1284
  resetLabel
881
- }: CardSaveBarProps): react_jsx_runtime0.JSX.Element;
1285
+ }: CardSaveBarProps): React$1.JSX.Element;
882
1286
  //#endregion
883
1287
  //#region src/components/submit-button.d.ts
1288
+ type SubmitButtonProps = Omit<React.ComponentProps<typeof Button>, 'type' | 'disabled'> & {
1289
+ loadingLabel?: string;
1290
+ };
884
1291
  /**
885
1292
  * Context-aware submit button. Disables itself when the form cannot be submitted or is submitting.
886
1293
  * Shows `loadingLabel` (default `"Saving…"`) while submitting.
887
1294
  *
1295
+ * Renders a DS `<Button type="submit">` (a `<button>` element).
888
1296
  * Must be a descendant of `form.AppForm` (or any `formContext` provider).
889
1297
  * Use for inline/flat layouts where `CardSaveBar` is not needed.
890
1298
  * Accepts all `Button` props except `type` and `disabled` (managed internally).
@@ -894,15 +1302,12 @@ declare function CardSaveBar({
894
1302
  * <form.SubmitButton loadingLabel="Saving…">Save</form.SubmitButton>
895
1303
  * </form.AppForm>
896
1304
  */
897
- type SubmitButtonProps = Omit<React.ComponentProps<typeof Button>, 'type' | 'disabled'> & {
898
- loadingLabel?: string;
899
- };
900
1305
  declare function SubmitButton({
901
1306
  children,
902
1307
  loadingLabel,
903
1308
  className,
904
1309
  ...buttonProps
905
- }: SubmitButtonProps): react_jsx_runtime0.JSX.Element;
1310
+ }: SubmitButtonProps): React$1.JSX.Element;
906
1311
  //#endregion
907
1312
  //#region src/form/use-form.d.ts
908
1313
  /**
@@ -1539,6 +1944,7 @@ type LayoutProps = {
1539
1944
  * and error share one growing column on the opposite side.
1540
1945
  */
1541
1946
  type ControlVariant = 'inline' | 'fill';
1947
+ /** Props for `FormFieldShell` — the normalized label / description / layout inputs it renders from. */
1542
1948
  type FormFieldShellProps = {
1543
1949
  label?: LabelProp;
1544
1950
  description?: DescriptionProp;
@@ -1555,6 +1961,13 @@ type FormFieldShellProps = {
1555
1961
  controlPosition?: LayoutProps['controlPosition'];
1556
1962
  controlVariant?: ControlVariant;
1557
1963
  };
1964
+ /**
1965
+ * Internal layout shell shared by every `Form*Field` wrapper. Normalizes the
1966
+ * `label` / `description` props, lays out the `Field → label row → description →
1967
+ * control → error` skeleton per `orientation` / `controlVariant`, and applies the
1968
+ * error-display policy plus `data-invalid`. Reads the bound field from context,
1969
+ * so it must render inside `form.AppField`. Renders a DS `Field`.
1970
+ */
1558
1971
  declare function FormFieldShell({
1559
1972
  label,
1560
1973
  description,
@@ -1564,7 +1977,7 @@ declare function FormFieldShell({
1564
1977
  orientation,
1565
1978
  controlPosition,
1566
1979
  controlVariant
1567
- }: FormFieldShellProps): react_jsx_runtime0.JSX.Element;
1980
+ }: FormFieldShellProps): React$1.JSX.Element;
1568
1981
  /**
1569
1982
  * Precisely-typed view of the bound field handed to a wrapper's `children`.
1570
1983
  * `TData` is `DeepValue<TFormData, TName>` — so `value` and `handleChange` are the field's
@@ -1688,7 +2101,7 @@ type FormFieldBaseProps<TData, TControl> = {
1688
2101
  * Field-name/value/validator typing is enforced at each wrapper's boundary; this just renders
1689
2102
  * the AppField + shared shell. `TData`/`TControl` carry the precise field + bundle shapes through.
1690
2103
  */
1691
- declare function FormFieldBase<TData, TControl>(props: FormFieldBaseProps<TData, TControl>): react_jsx_runtime0.JSX.Element;
2104
+ declare function FormFieldBase<TData, TControl>(props: FormFieldBaseProps<TData, TControl>): React$1.JSX.Element;
1692
2105
  //#endregion
1693
2106
  //#region src/components/form-select-field.d.ts
1694
2107
  /**
@@ -1734,7 +2147,7 @@ type FormSelectFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<
1734
2147
  * )}
1735
2148
  * </FormSelectField>
1736
2149
  */
1737
- declare function FormSelectField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormSelectFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2150
+ declare function FormSelectField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormSelectFieldProps<TForm, TName>): React$1.JSX.Element;
1738
2151
  //#endregion
1739
2152
  //#region src/components/form-input-field.d.ts
1740
2153
  /**
@@ -1768,7 +2181,7 @@ type FormInputFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<T
1768
2181
  * {(field, { inputProps }) => <Input {...inputProps} type="email" placeholder="you@co.com" />}
1769
2182
  * </FormInputField>
1770
2183
  */
1771
- declare function FormInputField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormInputFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2184
+ declare function FormInputField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormInputFieldProps<TForm, TName>): React$1.JSX.Element;
1772
2185
  //#endregion
1773
2186
  //#region src/components/form-combobox-field.d.ts
1774
2187
  /**
@@ -1815,7 +2228,7 @@ type FormComboboxFieldProps<TForm extends BoundForm, TName extends DeepKeysOfTyp
1815
2228
  * )}
1816
2229
  * </FormComboboxField>
1817
2230
  */
1818
- declare function FormComboboxField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormComboboxFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2231
+ declare function FormComboboxField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormComboboxFieldProps<TForm, TName>): React$1.JSX.Element;
1819
2232
  //#endregion
1820
2233
  //#region src/components/form-multi-combobox-field.d.ts
1821
2234
  /**
@@ -1856,7 +2269,7 @@ type FormMultiComboboxFieldProps<TForm extends BoundForm, TName extends DeepKeys
1856
2269
  * )}
1857
2270
  * </FormMultiComboboxField>
1858
2271
  */
1859
- declare function FormMultiComboboxField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string[]>>(props: FormMultiComboboxFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2272
+ declare function FormMultiComboboxField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string[]>>(props: FormMultiComboboxFieldProps<TForm, TName>): React$1.JSX.Element;
1860
2273
  //#endregion
1861
2274
  //#region src/components/form-array-field.d.ts
1862
2275
  /**
@@ -1930,7 +2343,7 @@ type FormArrayFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<T
1930
2343
  * )}
1931
2344
  * </FormArrayField>
1932
2345
  */
1933
- declare function FormArrayField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], unknown[]>>(props: FormArrayFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2346
+ declare function FormArrayField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], unknown[]>>(props: FormArrayFieldProps<TForm, TName>): React$1.JSX.Element;
1934
2347
  //#endregion
1935
2348
  //#region src/components/form-textarea-field.d.ts
1936
2349
  /**
@@ -1964,7 +2377,7 @@ type FormTextareaFieldProps<TForm extends BoundForm, TName extends DeepKeysOfTyp
1964
2377
  * {(field, { textareaProps }) => <Textarea {...textareaProps} rows={4} />}
1965
2378
  * </FormTextareaField>
1966
2379
  */
1967
- declare function FormTextareaField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormTextareaFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2380
+ declare function FormTextareaField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormTextareaFieldProps<TForm, TName>): React$1.JSX.Element;
1968
2381
  //#endregion
1969
2382
  //#region src/components/form-radio-group-field.d.ts
1970
2383
  /**
@@ -2005,7 +2418,7 @@ type FormRadioGroupFieldProps<TForm extends BoundForm, TName extends DeepKeysOfT
2005
2418
  * )}
2006
2419
  * </FormRadioGroupField>
2007
2420
  */
2008
- declare function FormRadioGroupField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormRadioGroupFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2421
+ declare function FormRadioGroupField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormRadioGroupFieldProps<TForm, TName>): React$1.JSX.Element;
2009
2422
  //#endregion
2010
2423
  //#region src/components/form-otp-field.d.ts
2011
2424
  /**
@@ -2040,7 +2453,7 @@ type FormOTPFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TFo
2040
2453
  * {(field, { otpProps }) => <InputOTP maxLength={6} {...otpProps}>{slots}</InputOTP>}
2041
2454
  * </FormOTPField>
2042
2455
  */
2043
- declare function FormOTPField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormOTPFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2456
+ declare function FormOTPField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>>(props: FormOTPFieldProps<TForm, TName>): React$1.JSX.Element;
2044
2457
  //#endregion
2045
2458
  //#region src/components/form-switch-field.d.ts
2046
2459
  /**
@@ -2077,7 +2490,7 @@ type FormSwitchFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<
2077
2490
  * {(field, { switchProps }) => <Switch {...switchProps} />}
2078
2491
  * </FormSwitchField>
2079
2492
  */
2080
- declare function FormSwitchField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], boolean>>(props: FormSwitchFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2493
+ declare function FormSwitchField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], boolean>>(props: FormSwitchFieldProps<TForm, TName>): React$1.JSX.Element;
2081
2494
  //#endregion
2082
2495
  //#region src/components/form-numeric-field.d.ts
2083
2496
  /**
@@ -2111,7 +2524,7 @@ type FormNumericFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType
2111
2524
  * {(field, { numericProps }) => <NumericInput {...numericProps} />}
2112
2525
  * </FormNumericField>
2113
2526
  */
2114
- declare function FormNumericField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>>(props: FormNumericFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2527
+ declare function FormNumericField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>>(props: FormNumericFieldProps<TForm, TName>): React$1.JSX.Element;
2115
2528
  //#endregion
2116
2529
  //#region src/components/form-slider-field.d.ts
2117
2530
  /**
@@ -2151,7 +2564,7 @@ type FormSliderFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<
2151
2564
  * {(field, { sliderProps }) => <Slider min={0} max={100} step={1} {...sliderProps} />}
2152
2565
  * </FormSliderField>
2153
2566
  */
2154
- declare function FormSliderField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>>(props: FormSliderFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2567
+ declare function FormSliderField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>>(props: FormSliderFieldProps<TForm, TName>): React$1.JSX.Element;
2155
2568
  //#endregion
2156
2569
  //#region src/components/form-toggle-group-field.d.ts
2157
2570
  /**
@@ -2192,7 +2605,7 @@ type FormToggleGroupFieldProps<TForm extends BoundForm, TName extends DeepKeysOf
2192
2605
  * )}
2193
2606
  * </FormToggleGroupField>
2194
2607
  */
2195
- declare function FormToggleGroupField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string | null>>(props: FormToggleGroupFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
2608
+ declare function FormToggleGroupField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string | null>>(props: FormToggleGroupFieldProps<TForm, TName>): React$1.JSX.Element;
2196
2609
  //#endregion
2197
2610
  //#region src/form/field-errors.d.ts
2198
2611
  /**
@@ -2209,12 +2622,127 @@ declare function toFieldErrors(errors: readonly unknown[]): Array<{
2209
2622
  message: string;
2210
2623
  }>;
2211
2624
  //#endregion
2625
+ //#region src/components/setting-card.d.ts
2626
+ /**
2627
+ * Root container for a setting card. Renders the DS `Card`.
2628
+ *
2629
+ * By default the level (and therefore the background) is detected automatically:
2630
+ * a top-level card is level 1 (muted background, borderless); a card nested
2631
+ * inside another card's `SettingCardContent` becomes level 2 (white background,
2632
+ * border). Pass `level` to force a specific level — needed for the rare third
2633
+ * nesting level, which reuses the level-1 look (`level={1}`).
2634
+ *
2635
+ * @example
2636
+ * ```tsx
2637
+ * <SettingCard>
2638
+ * <SettingCardHeader>
2639
+ * <SettingCardTitle>Call recording</SettingCardTitle>
2640
+ * <SettingCardDescription>Record inbound and outbound calls.</SettingCardDescription>
2641
+ * <SettingCardAction>
2642
+ * <Switch checked={enabled} onCheckedChange={setEnabled} />
2643
+ * </SettingCardAction>
2644
+ * </SettingCardHeader>
2645
+ * {enabled && <SettingCardContent>…</SettingCardContent>}
2646
+ * </SettingCard>
2647
+ * ```
2648
+ *
2649
+ * @example
2650
+ * ```tsx
2651
+ * // With a save/discard bar: put the form on the OUTER level and drop
2652
+ * // `form.CardSaveBar` in as the last child. It reads dirty/submitting/canSubmit
2653
+ * // from form context, slides in when dirty, and carries `data-slot="card-footer"`
2654
+ * // so the card flushes it to the edge automatically. No `className` needed.
2655
+ * <form onSubmit={e => { e.preventDefault(); void form.handleSubmit(); }}>
2656
+ * <SettingCard>
2657
+ * <SettingCardHeader>
2658
+ * <SettingCardTitle>Profile</SettingCardTitle>
2659
+ * <SettingCardDescription>Update your display name.</SettingCardDescription>
2660
+ * </SettingCardHeader>
2661
+ * <SettingCardContent>…</SettingCardContent>
2662
+ * <form.AppForm>
2663
+ * <form.CardSaveBar resetLabel="Undo" />
2664
+ * </form.AppForm>
2665
+ * </SettingCard>
2666
+ * </form>
2667
+ * ```
2668
+ */
2669
+ declare const SettingCard: React$1.ForwardRefExoticComponent<Omit<SettingCardProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2670
+ interface SettingCardProps extends React$1.ComponentProps<typeof Card> {
2671
+ /**
2672
+ * Force the visual level instead of auto-detecting from nesting.
2673
+ * `1` = muted background, borderless. `2` = white background, border.
2674
+ * Leave undefined to detect automatically (top-level → 1, nested → 2).
2675
+ */
2676
+ level?: 1 | 2;
2677
+ }
2678
+ declare namespace SettingCard {
2679
+ type Props = SettingCardProps;
2680
+ }
2681
+ /**
2682
+ * Header row of a setting card. Wraps DS `CardHeader`, which lays out the
2683
+ * title/description on the left and the `SettingCardAction` on the right.
2684
+ */
2685
+ declare const SettingCardHeader: React$1.ForwardRefExoticComponent<Omit<SettingCardHeaderProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2686
+ interface SettingCardHeaderProps extends React$1.ComponentProps<typeof CardHeader> {}
2687
+ declare namespace SettingCardHeader {
2688
+ type Props = SettingCardHeaderProps;
2689
+ }
2690
+ /**
2691
+ * Title of a setting card. Wraps DS `CardTitle`, overriding its type ramp so
2692
+ * weight and size follow the card's level (auto-detected from nesting, like the
2693
+ * background): level 1 is 18px bold, level 2 (nested) is 16px medium. A forced
2694
+ * level-1 card that is still nested (the rare 3rd level) keeps the 16px-medium
2695
+ * title, matching the design guidance for that case.
2696
+ */
2697
+ declare const SettingCardTitle: React$1.ForwardRefExoticComponent<Omit<SettingCardTitleProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2698
+ interface SettingCardTitleProps extends React$1.ComponentProps<typeof CardTitle> {}
2699
+ declare namespace SettingCardTitle {
2700
+ type Props = SettingCardTitleProps;
2701
+ }
2702
+ /**
2703
+ * Supporting description under the title. Wraps DS `CardDescription` (14px muted).
2704
+ * Inline links (e.g. "Learn more") can be placed inside its children.
2705
+ */
2706
+ declare const SettingCardDescription: React$1.ForwardRefExoticComponent<Omit<SettingCardDescriptionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2707
+ interface SettingCardDescriptionProps extends React$1.ComponentProps<typeof CardDescription> {}
2708
+ declare namespace SettingCardDescription {
2709
+ type Props = SettingCardDescriptionProps;
2710
+ }
2711
+ /**
2712
+ * Top-right control slot of the header — holds a single control, either a
2713
+ * `<Switch>` (toggle card) or a `<Button>` (action card). Wraps DS `CardAction`.
2714
+ * The two never co-occur, so this is one slot, not two.
2715
+ */
2716
+ declare const SettingCardAction: React$1.ForwardRefExoticComponent<Omit<SettingCardActionProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2717
+ interface SettingCardActionProps extends React$1.ComponentProps<typeof CardAction> {}
2718
+ declare namespace SettingCardAction {
2719
+ type Props = SettingCardActionProps;
2720
+ }
2721
+ /**
2722
+ * Body of a setting card. Wraps DS `CardContent` and carries the
2723
+ * `data-setting-card-content` marker that drives nesting detection: any
2724
+ * `SettingCard` rendered inside here auto-detects level 2.
2725
+ *
2726
+ * For progressive disclosure, render this conditionally — mount it only when
2727
+ * the header's toggle is on — so gated fields never mount while disabled.
2728
+ */
2729
+ declare const SettingCardContent: React$1.ForwardRefExoticComponent<Omit<SettingCardContentProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2730
+ interface SettingCardContentProps extends React$1.ComponentProps<typeof CardContent> {}
2731
+ declare namespace SettingCardContent {
2732
+ type Props = SettingCardContentProps;
2733
+ }
2734
+ //#endregion
2212
2735
  //#region src/components/save-bar.d.ts
2213
2736
  /**
2214
- * Headless animated save/discard bar. Slides in when `isDirty`, collapses when clean.
2737
+ * Headless animated save/discard bar the shared UI behind `CardSaveBar`.
2738
+ * Slides in when `isDirty`, collapses when clean (animates real content height
2739
+ * via a grid-rows transition, so appear and disappear are both smooth).
2215
2740
  *
2216
- * Unlike `CardSaveBar`, this component is form-library agnostic wire it manually via `form.Subscribe`.
2217
- * Use when you need the save-bar UI outside of a card layout, or with a custom form setup.
2741
+ * Form-library agnostic: wire the state yourself (via `form.Subscribe`, a store,
2742
+ * or local state). Its root carries `data-slot="card-footer"`, so a surrounding
2743
+ * `Card` collapses its bottom padding (`has-data-[slot=card-footer]:pb-0`) and
2744
+ * the bar sits flush at the card edge. For TanStack Form, prefer `CardSaveBar`,
2745
+ * which reads the state from context and renders this.
2218
2746
  *
2219
2747
  * @example
2220
2748
  * <form.Subscribe selector={s => ({ isDirty: s.isDirty, isSubmitting: s.isSubmitting, canSubmit: s.canSubmit })}>
@@ -2240,7 +2768,7 @@ declare function SaveBar({
2240
2768
  savingLabel,
2241
2769
  resetLabel,
2242
2770
  className
2243
- }: SaveBarProps): react_jsx_runtime0.JSX.Element;
2771
+ }: SaveBarProps): React$1.JSX.Element;
2244
2772
  //#endregion
2245
2773
  //#region src/components/dashboard-sidebar-nav.d.ts
2246
2774
  type DashboardSidebarNavSubmenuSeparator = {
@@ -2321,62 +2849,130 @@ type DashboardSidebarNavProps = {
2321
2849
  */
2322
2850
  renderLink?: (href: string) => React$1.ReactElement;
2323
2851
  };
2852
+ /**
2853
+ * Data-driven sidebar navigation. Maps a `groups` array into the
2854
+ * `DashboardSidebar` primitives, rendering each item as a link, a dropdown
2855
+ * submenu, or an action button (with optional badges, counts, and tooltips).
2856
+ *
2857
+ * Renders a fragment of `DashboardSidebarGroup` sections — it has no wrapper
2858
+ * element of its own, so place it inside a `DashboardSidebarContent`.
2859
+ *
2860
+ * @example
2861
+ * <DashboardSidebarNav
2862
+ * groups={groups}
2863
+ * renderLink={href => <Link to={href} />}
2864
+ * />
2865
+ */
2324
2866
  declare function DashboardSidebarNav({
2325
2867
  groups,
2326
2868
  renderLink
2327
- }: DashboardSidebarNavProps): react_jsx_runtime0.JSX.Element;
2869
+ }: DashboardSidebarNavProps): React$1.JSX.Element;
2328
2870
  //#endregion
2329
2871
  //#region src/components/dashboard-sidebar.d.ts
2872
+ /**
2873
+ * Context provider and flex-row layout wrapping the sidebar and page content;
2874
+ * renders a ds `SidebarProvider`. Provides the state consumed by `useDashboardSidebar`.
2875
+ *
2876
+ * @example
2877
+ * ```tsx
2878
+ * <DashboardSidebarProvider>
2879
+ * <DashboardSidebar>
2880
+ * <DashboardSidebarContent>
2881
+ * <DashboardSidebarMenu>
2882
+ * <DashboardSidebarMenuItem>
2883
+ * <DashboardSidebarMenuButton icon={<Home />}>Home</DashboardSidebarMenuButton>
2884
+ * </DashboardSidebarMenuItem>
2885
+ * </DashboardSidebarMenu>
2886
+ * </DashboardSidebarContent>
2887
+ * </DashboardSidebar>
2888
+ * <DashboardPageContent>…</DashboardPageContent>
2889
+ * </DashboardSidebarProvider>
2890
+ * ```
2891
+ */
2330
2892
  declare const DashboardSidebarProvider: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarProviderProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2331
2893
  interface DashboardSidebarProviderProps extends React$1.ComponentProps<typeof SidebarProvider> {}
2332
2894
  declare namespace DashboardSidebarProvider {
2333
2895
  type Props = DashboardSidebarProviderProps;
2334
2896
  }
2897
+ /**
2898
+ * Root sidebar column that grows/shrinks with the collapse state; renders a `<div>`.
2899
+ * Holds `DashboardSidebarHeader`, `DashboardSidebarContent`, and `DashboardSidebarFooter`.
2900
+ */
2335
2901
  declare const DashboardSidebar: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2336
2902
  interface DashboardSidebarProps extends React$1.ComponentProps<'div'> {}
2337
2903
  declare namespace DashboardSidebar {
2338
2904
  type Props = DashboardSidebarProps;
2339
2905
  }
2906
+ /**
2907
+ * Top bar of the sidebar that houses the collapse toggle; renders a `<div>`.
2908
+ */
2340
2909
  declare const DashboardSidebarHeader: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarHeaderProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2341
2910
  interface DashboardSidebarHeaderProps extends React$1.ComponentProps<'div'> {}
2342
2911
  declare namespace DashboardSidebarHeader {
2343
2912
  type Props = DashboardSidebarHeaderProps;
2344
2913
  }
2914
+ /**
2915
+ * Collapse/expand toggle rendering a ghost, icon ds `Button`; renders a `<button>`.
2916
+ * Swaps its icon and aria-label based on the sidebar state.
2917
+ */
2345
2918
  declare const DashboardSidebarTrigger: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarTriggerProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
2346
2919
  interface DashboardSidebarTriggerProps extends React$1.ComponentProps<typeof Button> {}
2347
2920
  declare namespace DashboardSidebarTrigger {
2348
2921
  type Props = DashboardSidebarTriggerProps;
2349
2922
  }
2923
+ /**
2924
+ * Scrollable middle section of the sidebar (scrollbar hidden); renders a `<div>`.
2925
+ */
2350
2926
  declare const DashboardSidebarContent: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarContentProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2351
2927
  interface DashboardSidebarContentProps extends React$1.ComponentProps<'div'> {}
2352
2928
  declare namespace DashboardSidebarContent {
2353
2929
  type Props = DashboardSidebarContentProps;
2354
2930
  }
2931
+ /**
2932
+ * Frosted-glass bottom section of the sidebar; renders a `<div>`.
2933
+ */
2355
2934
  declare const DashboardSidebarFooter: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarFooterProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2356
2935
  interface DashboardSidebarFooterProps extends React$1.ComponentProps<'div'> {}
2357
2936
  declare namespace DashboardSidebarFooter {
2358
2937
  type Props = DashboardSidebarFooterProps;
2359
2938
  }
2939
+ /**
2940
+ * Groups a set of menu items (optionally labelled); renders a `<div>`.
2941
+ */
2360
2942
  declare const DashboardSidebarGroup: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarGroupProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2361
2943
  interface DashboardSidebarGroupProps extends React$1.ComponentProps<'div'> {}
2362
2944
  declare namespace DashboardSidebarGroup {
2363
2945
  type Props = DashboardSidebarGroupProps;
2364
2946
  }
2947
+ /**
2948
+ * Section heading for a group, hidden when the sidebar is collapsed; renders a `<div>`
2949
+ * by default, overridable via the `render` prop.
2950
+ */
2365
2951
  declare const DashboardSidebarGroupLabel: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarGroupLabelProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2366
2952
  type DashboardSidebarGroupLabelProps = useRender.ComponentProps<'div'> & React$1.ComponentProps<'div'>;
2367
2953
  declare namespace DashboardSidebarGroupLabel {
2368
2954
  type Props = DashboardSidebarGroupLabelProps;
2369
2955
  }
2956
+ /**
2957
+ * List container for menu items; renders a `<ul>`.
2958
+ */
2370
2959
  declare const DashboardSidebarMenu: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarMenuProps, "ref"> & React$1.RefAttributes<HTMLUListElement>>;
2371
2960
  interface DashboardSidebarMenuProps extends React$1.ComponentProps<'ul'> {}
2372
2961
  declare namespace DashboardSidebarMenu {
2373
2962
  type Props = DashboardSidebarMenuProps;
2374
2963
  }
2964
+ /**
2965
+ * Wrapper for a single menu row; renders a `<li>` (relative, for badge positioning).
2966
+ */
2375
2967
  declare const DashboardSidebarMenuItem: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarMenuItemProps, "ref"> & React$1.RefAttributes<HTMLLIElement>>;
2376
2968
  interface DashboardSidebarMenuItemProps extends React$1.ComponentProps<'li'> {}
2377
2969
  declare namespace DashboardSidebarMenuItem {
2378
2970
  type Props = DashboardSidebarMenuItemProps;
2379
2971
  }
2972
+ /**
2973
+ * Pill-shaped navigation item with a leading icon circle and optional trailing action;
2974
+ * renders a `<button>` by default, overridable via the `render` prop (e.g. a router `<Link>`).
2975
+ */
2380
2976
  declare const DashboardSidebarMenuButton: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarMenuButtonProps, "ref"> & React$1.RefAttributes<HTMLButtonElement>>;
2381
2977
  type DashboardSidebarMenuButtonProps = useRender.ComponentProps<'button'> & React$1.ComponentProps<'button'> & {
2382
2978
  isActive?: boolean;
@@ -2399,16 +2995,29 @@ type DashboardSidebarMenuButtonProps = useRender.ComponentProps<'button'> & Reac
2399
2995
  declare namespace DashboardSidebarMenuButton {
2400
2996
  type Props = DashboardSidebarMenuButtonProps;
2401
2997
  }
2998
+ /**
2999
+ * Notification count badge for a menu item; renders a ds `CounterBadge` positioned
3000
+ * absolutely at the row's right edge (moves to the icon corner when collapsed).
3001
+ * Place it inside `DashboardSidebarMenuItem`, as a sibling of the button.
3002
+ */
2402
3003
  declare const DashboardSidebarMenuBadge: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarMenuBadgeProps, "ref"> & React$1.RefAttributes<HTMLSpanElement>>;
2403
3004
  interface DashboardSidebarMenuBadgeProps extends React$1.ComponentProps<typeof CounterBadge> {}
2404
3005
  declare namespace DashboardSidebarMenuBadge {
2405
3006
  type Props = DashboardSidebarMenuBadgeProps;
2406
3007
  }
3008
+ /**
3009
+ * Popover-style panel (white card with border and shadow) opening beside a trigger;
3010
+ * renders a `<div>`. Hosts `DashboardSidebarSubmenuItem` and `DashboardSidebarSubmenuSeparator`.
3011
+ */
2407
3012
  declare const DashboardSidebarSubmenu: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarSubmenuProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2408
3013
  interface DashboardSidebarSubmenuProps extends React$1.ComponentProps<'div'> {}
2409
3014
  declare namespace DashboardSidebarSubmenu {
2410
3015
  type Props = DashboardSidebarSubmenuProps;
2411
3016
  }
3017
+ /**
3018
+ * One row inside a submenu; renders a `<div>` by default, overridable via the `render`
3019
+ * prop (e.g. an `<a>` or router `<Link>` for navigation).
3020
+ */
2412
3021
  declare const DashboardSidebarSubmenuItem: React$1.ForwardRefExoticComponent<Omit<DashboardSidebarSubmenuItemProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
2413
3022
  type DashboardSidebarSubmenuItemProps = useRender.ComponentProps<'div'> & React$1.ComponentProps<'div'> & {
2414
3023
  isActive?: boolean;
@@ -2416,6 +3025,9 @@ type DashboardSidebarSubmenuItemProps = useRender.ComponentProps<'div'> & React$
2416
3025
  declare namespace DashboardSidebarSubmenuItem {
2417
3026
  type Props = DashboardSidebarSubmenuItemProps;
2418
3027
  }
3028
+ /**
3029
+ * Thin horizontal divider between submenu items; renders a `<div>`.
3030
+ */
2419
3031
  declare const DashboardSidebarSubmenuSeparator: React$1.ForwardRefExoticComponent<DashboardSidebarSubmenuSeparatorProps & React$1.RefAttributes<HTMLDivElement>>;
2420
3032
  interface DashboardSidebarSubmenuSeparatorProps {
2421
3033
  className?: string;
@@ -2424,4 +3036,4 @@ declare namespace DashboardSidebarSubmenuSeparator {
2424
3036
  type Props = DashboardSidebarSubmenuSeparatorProps;
2425
3037
  }
2426
3038
  //#endregion
2427
- export { type ArrayField, type ArrayItem, BetaBadge, type BoundForm, CardSaveBar, type CardSaveBarProps, ChatbotExpandSuggestion, type ChatbotExpandSuggestionProps, ChatbotInput, type ChatbotInputProps, type ChatbotInputSuggestion, ChatbotPage, ChatbotPageBody, type ChatbotPageBodyProps, ChatbotPageContent, type ChatbotPageContentProps, ChatbotPageConversation, type ChatbotPageConversationProps, ChatbotPageFooter, type ChatbotPageFooterProps, ChatbotPageHeading, type ChatbotPageHeadingProps, ChatbotPageInputBar, type ChatbotPageInputBarProps, type ChatbotPageProps, ChatbotPanel, ChatbotPanelHeader, type ChatbotPanelHeaderProps, type ChatbotPanelProps, ChatbotPanelSuggestion, type ChatbotPanelSuggestionItem, type ChatbotPanelSuggestionProps, ChatbotPanelTrigger, type ChatbotPanelTriggerProps, ChatbotResponseBlock, type ChatbotResponseBlockFeedback, type ChatbotResponseBlockProps, ChatbotResponseLoading, type ChatbotResponseLoadingProps, ChatbotSidebar, type ChatbotSidebarConversation, ChatbotUserMessage, type ChatbotUserMessageProps, type ComboboxControl, ComingSoonDescription, ComingSoonEmptyState, ComingSoonMedia, ComingSoonTitle, CommonForm, CopyButton, CopyButtonIcon, CopyButtonLabel, DashboardPage, DashboardPageBanner, DashboardPageContent, DashboardPageHeader, DashboardPageHeaderAction, DashboardPageHeaderActions, DashboardPageHeaderDescription, DashboardPageHeaderNav, DashboardPageHeaderNavBack, DashboardPageHeaderPrefix, DashboardPageHeaderSubtitle, DashboardPageHeaderTitle, DashboardPageHeaderTitleGroup, DashboardPageMain, DashboardPageTabs, DashboardSidebar, DashboardSidebarContent, DashboardSidebarFooter, DashboardSidebarGroup, DashboardSidebarGroupLabel, DashboardSidebarHeader, DashboardSidebarMenu, DashboardSidebarMenuBadge, DashboardSidebarMenuButton, DashboardSidebarMenuItem, DashboardSidebarNav, type DashboardSidebarNavGroup, type DashboardSidebarNavItem, type DashboardSidebarNavItemAction, type DashboardSidebarNavItemLink, type DashboardSidebarNavItemSubmenu, type DashboardSidebarNavSubmenuItem, DashboardSidebarProvider, DashboardSidebarSubmenu, DashboardSidebarSubmenuItem, DashboardSidebarSubmenuSeparator, DashboardSidebarTrigger, DashboardStandalonePage, DashboardStandalonePageAction, DashboardStandalonePageActions, DashboardStandalonePageContent, DashboardStandalonePageDescription, DashboardStandalonePageHeader, DashboardStandalonePageMain, DashboardStandalonePageTitle, DeprecatedBadge, EmptyState, EmptyStateActions, EmptyStateButton, EmptyStateDescription, EmptyStateExternalLink, EmptyStateHeader, EmptyStateMedia, EmptyStateTitle, type FieldBindingProps, FormArrayField, type FormArrayFieldProps, FormComboboxField, type FormComboboxFieldProps, FormFieldBase, FormFieldShell, type FormFieldShellProps, type FormFieldValidators, FormInputField, type FormInputFieldProps, FormMultiComboboxField, type FormMultiComboboxFieldProps, FormNumericField, type FormNumericFieldProps, FormOTPField, type FormOTPFieldProps, FormRadioGroupField, type FormRadioGroupFieldProps, FormSelectField, type FormSelectFieldProps, FormSliderField, type FormSliderFieldProps, FormSwitchField, type FormSwitchFieldProps, FormTextareaField, type FormTextareaFieldProps, FormToggleGroupField, type FormToggleGroupFieldProps, type InputControl, type MultiComboboxControl, type NecessityProps, NewBadge, NoDataDescription, NoDataEmptyState, NoDataMedia, NoDataTitle, NoSupportDescription, NoSupportEmptyState, NoSupportMedia, NoSupportTitle, NotFoundDescription, NotFoundEmptyState, NotFoundMedia, NotFoundTitle, type NumericControl, type OTPControl, PERCENTAGE_THRESHOLDS, ProfessionalBadge, type RadioGroupControl, RestrictedAccessDescription, RestrictedAccessEmptyState, RestrictedAccessMedia, RestrictedAccessTitle, RoleBadge, type RoleBadgeRole, SaveBar, type SaveBarProps, ScoreBadge, type ScoreKind, type ScoreThreshold, type ScoreThresholds, type ScoreTone, type SelectControl, type Sentiment, SentimentBadge, type SliderControl, SubmitButton, type SubmitButtonProps, type SwitchControl, type TextareaControl, type ToggleGroupControl, TrialBadge, type TypedField, UnknownErrorDescription, UnknownErrorEmptyState, UnknownErrorMedia, UnknownErrorTitle, fieldContext, formContext, toFieldErrors, useCopyToClipboard, useSidebar as useDashboardSidebar, useFieldContext, useForm, useFormContext, withFieldGroup, withForm };
3039
+ export { type ArrayField, type ArrayItem, BetaBadge, type BoundForm, CardSaveBar, type CardSaveBarProps, ChatbotExpandSuggestion, type ChatbotExpandSuggestionProps, ChatbotInput, type ChatbotInputProps, type ChatbotInputSuggestion, ChatbotPage, ChatbotPageBody, type ChatbotPageBodyProps, ChatbotPageContent, type ChatbotPageContentProps, ChatbotPageConversation, type ChatbotPageConversationProps, ChatbotPageFooter, type ChatbotPageFooterProps, ChatbotPageHeading, type ChatbotPageHeadingProps, ChatbotPageInputBar, type ChatbotPageInputBarProps, type ChatbotPageProps, ChatbotPanel, ChatbotPanelHeader, type ChatbotPanelHeaderProps, type ChatbotPanelProps, ChatbotPanelSuggestion, type ChatbotPanelSuggestionItem, type ChatbotPanelSuggestionProps, ChatbotPanelTrigger, type ChatbotPanelTriggerProps, ChatbotResponseBlock, type ChatbotResponseBlockFeedback, type ChatbotResponseBlockProps, ChatbotResponseLoading, type ChatbotResponseLoadingProps, ChatbotSidebar, type ChatbotSidebarConversation, ChatbotUserMessage, type ChatbotUserMessageProps, type ComboboxControl, ComingSoonDescription, ComingSoonEmptyState, ComingSoonMedia, ComingSoonTitle, CommonForm, CopyButton, CopyButtonIcon, CopyButtonLabel, DashboardPage, DashboardPageBanner, DashboardPageContent, DashboardPageHeader, DashboardPageHeaderAction, DashboardPageHeaderActions, DashboardPageHeaderDescription, DashboardPageHeaderNav, DashboardPageHeaderNavBack, DashboardPageHeaderPrefix, DashboardPageHeaderSubtitle, DashboardPageHeaderTitle, DashboardPageHeaderTitleGroup, DashboardPageMain, DashboardPageTabs, DashboardSidebar, DashboardSidebarContent, DashboardSidebarFooter, DashboardSidebarGroup, DashboardSidebarGroupLabel, DashboardSidebarHeader, DashboardSidebarMenu, DashboardSidebarMenuBadge, DashboardSidebarMenuButton, DashboardSidebarMenuItem, DashboardSidebarNav, type DashboardSidebarNavGroup, type DashboardSidebarNavItem, type DashboardSidebarNavItemAction, type DashboardSidebarNavItemLink, type DashboardSidebarNavItemSubmenu, type DashboardSidebarNavSubmenuItem, DashboardSidebarProvider, DashboardSidebarSubmenu, DashboardSidebarSubmenuItem, DashboardSidebarSubmenuSeparator, DashboardSidebarTrigger, DashboardStandalonePage, DashboardStandalonePageAction, DashboardStandalonePageActions, DashboardStandalonePageContent, DashboardStandalonePageDescription, DashboardStandalonePageHeader, DashboardStandalonePageMain, DashboardStandalonePageTitle, DeprecatedBadge, EmptyState, EmptyStateActions, EmptyStateButton, EmptyStateDescription, EmptyStateExternalLink, EmptyStateHeader, EmptyStateMedia, EmptyStateTitle, type FieldBindingProps, FormArrayField, type FormArrayFieldProps, FormComboboxField, type FormComboboxFieldProps, FormFieldBase, FormFieldShell, type FormFieldShellProps, type FormFieldValidators, FormInputField, type FormInputFieldProps, FormMultiComboboxField, type FormMultiComboboxFieldProps, FormNumericField, type FormNumericFieldProps, FormOTPField, type FormOTPFieldProps, FormRadioGroupField, type FormRadioGroupFieldProps, FormSelectField, type FormSelectFieldProps, FormSliderField, type FormSliderFieldProps, FormSwitchField, type FormSwitchFieldProps, FormTextareaField, type FormTextareaFieldProps, FormToggleGroupField, type FormToggleGroupFieldProps, type InputControl, type MultiComboboxControl, type NecessityProps, NewBadge, NoDataDescription, NoDataEmptyState, NoDataMedia, NoDataTitle, NoSupportDescription, NoSupportEmptyState, NoSupportMedia, NoSupportTitle, NotFoundDescription, NotFoundEmptyState, NotFoundMedia, NotFoundTitle, type NumericControl, type OTPControl, PERCENTAGE_THRESHOLDS, ProfessionalBadge, type RadioGroupControl, RestrictedAccessDescription, RestrictedAccessEmptyState, RestrictedAccessMedia, RestrictedAccessTitle, RoleBadge, type RoleBadgeRole, SaveBar, type SaveBarProps, ScoreBadge, type ScoreKind, type ScoreThreshold, type ScoreThresholds, type ScoreTone, type SelectControl, type Sentiment, SentimentBadge, SettingCard, SettingCardAction, SettingCardContent, SettingCardDescription, SettingCardHeader, SettingCardTitle, type SliderControl, SubmitButton, type SubmitButtonProps, type SwitchControl, type TextareaControl, type ToggleGroupControl, TrialBadge, type TypedField, UnknownErrorDescription, UnknownErrorEmptyState, UnknownErrorMedia, UnknownErrorTitle, fieldContext, formContext, toFieldErrors, useCopyToClipboard, useSidebar as useDashboardSidebar, useFieldContext, useForm, useFormContext, withFieldGroup, withForm };