@nimbus-ds/patterns 1.4.1-rc.1 → 1.4.1

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 DELETED
@@ -1,716 +0,0 @@
1
- // Generated by dts-bundle-generator v8.0.0
2
-
3
- import { BoxProperties, BoxProps, ButtonProperties, CheckboxProperties, CheckboxProps, IconButtonProperties, IconButtonProps, InputProperties, PaginationProperties, PopoverProperties, RadioProperties, SelectProperties, SidebarProperties, TableCellProperties, TableProperties, TableRowProperties, TextareaProperties, ThumbnailProperties, ThumbnailProps, ToggleProperties } from '@nimbus-ds/components';
4
- import { IconProps } from '@nimbus-ds/icons';
5
- import { PolymorphicForwardRefComponent } from '@nimbus-ds/typings';
6
- import React from 'react';
7
- import { ButtonHTMLAttributes, ComponentPropsWithRef, FC, HTMLAttributes, MouseEventHandler, ReactNode } from 'react';
8
-
9
- export interface AppShellHeaderProperties {
10
- /**
11
- * Optional content for the left-hand-side slot.
12
- * @TJS-type React.ReactNode
13
- */
14
- leftSlot?: ReactNode;
15
- /**
16
- * Optional content for the right-hand-side slot.
17
- * @TJS-type React.ReactNode
18
- */
19
- rightSlot?: ReactNode;
20
- }
21
- export type AppShellHeaderProps = AppShellHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProperties, "display" | "justifyContent">;
22
- declare const AppShellHeader: React.FC<AppShellHeaderProps>;
23
- export interface AppShellComponents {
24
- Header: typeof AppShellHeader;
25
- }
26
- export interface AppShellProperties {
27
- /**
28
- * Content for the body of the application.
29
- * @TJS-type React.ReactNode
30
- */
31
- children: ReactNode;
32
- /**
33
- * Optional slot for left sidebar menu.
34
- * @TJS-type React.ReactNode
35
- */
36
- menu?: ReactNode;
37
- }
38
- export type AppShellProps = AppShellProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
39
- export declare const AppShell: React.FC<AppShellProps> & AppShellComponents;
40
- export interface CalloutCardProperties {
41
- /**
42
- * CalloutCard color.
43
- */
44
- appearance: "primary" | "success" | "warning" | "danger" | "neutral";
45
- /**
46
- * The SVG contents to display in the Icon.
47
- * @TJS-type React.FC<IconProps>
48
- */
49
- icon: FC<IconProps>;
50
- /**
51
- * Title.
52
- */
53
- title: string;
54
- /**
55
- * Subtitle.
56
- */
57
- subtitle: string;
58
- /**
59
- * Slot intended to position the Callout Card link correctly.
60
- * @TJS-type <Link />
61
- */
62
- link?: ReactNode;
63
- /**
64
- * Event fired when clicking the component.
65
- * @TJS-type () => void;
66
- */
67
- onClick?: MouseEventHandler<HTMLElement>;
68
- }
69
- export type CalloutCardProps = CalloutCardProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
70
- export declare const CalloutCard: React.FC<CalloutCardProps>;
71
- export interface DataListRowProperties extends Omit<BoxProperties, "padding"> {
72
- /**
73
- * Optional padding for the row.
74
- * @default base
75
- */
76
- padding?: "small" | "base" | "none";
77
- /**
78
- * Content of the row.
79
- * @TJS-type React.ReactNode
80
- */
81
- children: ReactNode;
82
- /**
83
- * Determines if the row has a top border.
84
- * @default true
85
- */
86
- topDivider?: boolean;
87
- }
88
- export type DataListRowProps = DataListRowProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
89
- declare const DataListRow: React.FC<DataListRowProps>;
90
- export interface DataListComponents {
91
- Row: typeof DataListRow;
92
- }
93
- export interface DataListProperties {
94
- /**
95
- * Content of the List component.
96
- * @TJS-type React.ReactNode
97
- */
98
- children: ReactNode;
99
- /**
100
- * Defines whether the List has a bottom border.
101
- * @default true
102
- */
103
- bottomDivider?: boolean;
104
- }
105
- export type DataListProps = DataListProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
106
- export declare const DataList: React.FC<DataListProps> & DataListComponents;
107
- export interface DataTableBulkActionsProperties {
108
- /**
109
- * Properties of the checkbox element rendered in the Bulk Actions component.
110
- */
111
- checkbox: Omit<CheckboxProperties, "label" | "id">;
112
- /**
113
- * Optional link element rendered next to the Bulk Actions controller.
114
- * @TJS-type <Link />
115
- */
116
- link?: ReactNode;
117
- /**
118
- * Action component that controls the Bulk Actions.
119
- * @TJS-type React.ReactNode
120
- */
121
- action: ReactNode;
122
- /**
123
- * Lable for the checkbox element.
124
- */
125
- label: string;
126
- }
127
- export type DataTableBulkActionsProps = DataTableBulkActionsProperties & {
128
- checkbox: Omit<CheckboxProps, "label" | "id">;
129
- } & Omit<HTMLAttributes<HTMLElement>, "color">;
130
- declare const DataTableBulkActions: React.FC<DataTableBulkActionsProps>;
131
- export interface DataTableFooterProperties {
132
- /**
133
- * Left-hand side text intended for displaying an item count.
134
- */
135
- itemCount: string;
136
- /**
137
- * Pagination element rendered on the right-side of the footer.
138
- */
139
- pagination?: PaginationProperties;
140
- }
141
- export type DataTableFooterProps = DataTableFooterProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
142
- declare const DataTableFooter: React.FC<DataTableFooterProps>;
143
- export interface DataTableHeaderProperties {
144
- /**
145
- * Checkbox element rendered on the table header that controls all rows.
146
- */
147
- checkbox: CheckboxProperties;
148
- /**
149
- * Row content.
150
- * @TJS-type React.ReactNode
151
- */
152
- children: ReactNode;
153
- }
154
- export type DataTableHeaderProps = DataTableHeaderProperties & {
155
- checkbox: CheckboxProps;
156
- } & HTMLAttributes<HTMLElement>;
157
- declare const DataTableHeader: React.FC<DataTableHeaderProps>;
158
- export interface DataTableRowProperties {
159
- /**
160
- * Checkbox element rendered on the row that controls whether the row is selected.
161
- */
162
- checkbox: CheckboxProperties;
163
- /**
164
- * Content of the row.
165
- * @TJS-type React.ReactNode
166
- */
167
- children: ReactNode;
168
- }
169
- export type DataTableRowProps = DataTableRowProperties & {
170
- checkbox: CheckboxProps;
171
- } & TableRowProperties & HTMLAttributes<HTMLElement>;
172
- declare const DataTableRow: React.FC<DataTableRowProps>;
173
- export interface DataTableCellProperties {
174
- /**
175
- * Content of the List component.
176
- * @TJS-type React.ReactNode
177
- */
178
- children: ReactNode;
179
- }
180
- export type DataTableCellProps = DataTableCellProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & TableCellProperties;
181
- declare const DataTableCell: React.FC<DataTableCellProps>;
182
- export interface DataTableComponents {
183
- BulkActions: typeof DataTableBulkActions;
184
- Header: typeof DataTableHeader;
185
- Footer: typeof DataTableFooter;
186
- Row: typeof DataTableRow;
187
- Cell: typeof DataTableCell;
188
- }
189
- export interface DataTableProperties {
190
- /**
191
- * Bulk actions component rendered with a sticky position over the top of the table element.
192
- * @TJS-type React.ReactNode
193
- */
194
- bulkActions?: ReactNode;
195
- /**
196
- * Table header content.
197
- * @TJS-type React.ReactNode
198
- */
199
- header: ReactNode;
200
- /**
201
- * Optional table footer content.
202
- * @TJS-type React.ReactNode
203
- */
204
- footer?: ReactNode;
205
- /**
206
- * Table body content.
207
- * @TJS-type React.ReactNode
208
- */
209
- children: ReactNode;
210
- }
211
- export type DataTableProps = DataTableProperties & TableProperties & HTMLAttributes<HTMLElement>;
212
- export declare const DataTable: React.FC<DataTableProps> & DataTableComponents;
213
- export interface EmptyMessageProperties {
214
- /**
215
- * Optional node that contains an illustration for the component. Will stack vertically on mobile and horizontally on desktop.
216
- * @TJS-type React.ReactNode
217
- */
218
- illustration?: ReactNode;
219
- /**
220
- * Optional icon to display on top of the text.
221
- * @TJS-type React.ReactNode
222
- */
223
- icon?: ReactNode;
224
- /**
225
- * Title of the component.
226
- */
227
- title: string;
228
- /**
229
- * Optional content text for additional context.
230
- */
231
- text?: string;
232
- /**
233
- * Optional node to showcase buttons or actions.
234
- * @TJS-type React.ReactNode
235
- */
236
- actions?: ReactNode;
237
- }
238
- export type EmptyMessageProps = EmptyMessageProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
239
- export declare const EmptyMessage: React.FC<EmptyMessageProps>;
240
- export type FormFieldSelectProperties = Omit<FormFieldProperties, "children"> & Omit<SelectProperties, "appearance">;
241
- export type FormFieldSelectProps = FormFieldSelectProperties & HTMLAttributes<HTMLElement>;
242
- declare const FormFieldSelect: React.FC<FormFieldSelectProps>;
243
- export type FormFieldTextareaProperties = Omit<FormFieldProperties, "children"> & Omit<TextareaProperties, "appearance">;
244
- export type FormFieldTextareaProps = FormFieldTextareaProperties & HTMLAttributes<HTMLElement>;
245
- declare const FormFieldTextarea: React.FC<FormFieldTextareaProps>;
246
- export type FormFieldInputProperties = Omit<FormFieldProperties, "children"> & Omit<InputProperties, "appearance">;
247
- export type FormFieldInputProps = FormFieldInputProperties & HTMLAttributes<HTMLElement>;
248
- declare const FormFieldInput: React.FC<FormFieldInputProps>;
249
- export interface FormFieldComponents {
250
- Select: typeof FormFieldSelect;
251
- Textarea: typeof FormFieldTextarea;
252
- Input: typeof FormFieldInput;
253
- }
254
- export interface FormFieldProperties {
255
- /**
256
- * Optional label for the field component.
257
- * @TJS-type React.ReactNode
258
- */
259
- label?: ReactNode;
260
- /**
261
- * Help text displaying optional hints or validation messages under the field.
262
- */
263
- helpText?: string;
264
- /**
265
- * Icon supporting the help text message.
266
- * @TJS-type React.FC<IconProps>
267
- */
268
- helpIcon?: FC<IconProps>;
269
- /**
270
- * Appearance of the field and help text elements.
271
- * @default none
272
- */
273
- appearance?: "danger" | "warning" | "success" | "none";
274
- /**
275
- * Control to conditionally show the help text and icon.
276
- * @default false
277
- */
278
- showHelpText?: boolean;
279
- /**
280
- * Content of the field.
281
- * @TJS-type React.ReactNode
282
- */
283
- children: ReactNode;
284
- }
285
- export type FormFieldProps = FormFieldProperties & HTMLAttributes<HTMLElement>;
286
- export declare const FormField: React.FC<FormFieldProps> & FormFieldComponents;
287
- export interface HelpLinkProperties {
288
- /**
289
- * Content to be rendered inside the HelpLink component.
290
- * @TJS-type ReactNode
291
- */
292
- children: ReactNode;
293
- }
294
- export type HelpLinkProps = HelpLinkProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
295
- export declare const HelpLink: React.FC<HelpLinkProps>;
296
- export interface InteractiveListStructureProperties {
297
- /**
298
- * Title of the list item element. Also used to generate the ID for the interactive element.
299
- */
300
- title: string;
301
- /**
302
- * Determines if the title is visible or not.
303
- */
304
- showTitle?: boolean;
305
- /**
306
- * Description of the list item element.
307
- */
308
- description?: string;
309
- /**
310
- * Custom content for the list item element.
311
- * @TJS-type React.ReactNode
312
- */
313
- children?: ReactNode;
314
- }
315
- export type InteractiveListStructureProps = InteractiveListStructureProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
316
- declare const InteractiveListStructure: React.FC<InteractiveListStructureProps>;
317
- export type InteractiveListStructureSkeletonProperties = InteractiveListStructureProperties;
318
- export type InteractiveListStructureSkeletonProps = InteractiveListStructureSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
319
- declare const InteractiveListStructureSkeleton: React.FC<InteractiveListStructureSkeletonProps>;
320
- export interface InteractiveListRowProperties extends Omit<BoxProperties, "padding"> {
321
- /**
322
- * Content of the row.
323
- * @TJS-type React.ReactNode
324
- */
325
- children: ReactNode;
326
- /**
327
- * Determines if the row has a top border.
328
- * @default true
329
- */
330
- topDivider?: boolean;
331
- }
332
- export type InteractiveListRowProps = InteractiveListRowProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
333
- export interface InteractiveListCheckboxItemProperties extends InteractiveListStructureProperties {
334
- /**
335
- * Checkbox props inherited from Nimbus components.
336
- */
337
- checkbox: CheckboxProperties;
338
- }
339
- export type InteractiveListCheckboxItemProps = InteractiveListCheckboxItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
340
- declare const InteractiveListCheckboxItem: React.FC<InteractiveListCheckboxItemProps>;
341
- export type InteractiveListCheckboxItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
342
- export type InteractiveListCheckboxItemSkeletonProps = InteractiveListCheckboxItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
343
- declare const InteractiveListCheckboxItemSkeleton: React.FC<InteractiveListCheckboxItemSkeletonProps>;
344
- export interface InteractiveListRadioItemProperties extends InteractiveListStructureProperties {
345
- /**
346
- * Radio props inherited from Nimbus components.
347
- */
348
- radio: RadioProperties;
349
- }
350
- export type InteractiveListRadioItemProps = InteractiveListRadioItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
351
- declare const InteractiveListRadioItem: React.FC<InteractiveListRadioItemProps>;
352
- export type InteractiveListRadioItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
353
- export type InteractiveListRadioItemSkeletonProps = InteractiveListRadioItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
354
- declare const InteractiveListRadioItemSkeleton: React.FC<InteractiveListRadioItemSkeletonProps>;
355
- export interface InteractiveListToggleItemProperties extends InteractiveListStructureProperties {
356
- /**
357
- * Toggle props inherited from Nimbus components.
358
- */
359
- toggle: ToggleProperties;
360
- }
361
- export type InteractiveListToggleItemProps = InteractiveListToggleItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
362
- declare const InteractiveListToggleItem: React.FC<InteractiveListToggleItemProps>;
363
- export interface InteractiveListToggleItemSkeletonProperties extends InteractiveListStructureProperties {
364
- /**
365
- * Toggle props inherited from Nimbus components.
366
- */
367
- toggle: ToggleProperties;
368
- }
369
- export type InteractiveListToggleItemSkeletonProps = InteractiveListToggleItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
370
- declare const InteractiveListToggleItemSkeleton: React.FC<InteractiveListToggleItemSkeletonProps>;
371
- export interface InteractiveListButtonItemProperties extends InteractiveListStructureProperties {
372
- /**
373
- * Button props inherited from Nimbus components
374
- */
375
- iconButton: Omit<IconButtonProperties, "backgroundColor" | "borderColor" | "size" | "source">;
376
- }
377
- export type InteractiveListButtonItemProps = InteractiveListButtonItemProperties & {
378
- iconButton: Omit<IconButtonProps, "backgroundColor" | "borderColor" | "size" | "source">;
379
- } & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
380
- declare const InteractiveListButtonItem: React.FC<InteractiveListButtonItemProps>;
381
- export type InteractiveListButtonItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
382
- export type InteractiveListButtonItemSkeletonProps = InteractiveListButtonItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
383
- declare const InteractiveListButtonItemSkeleton: React.FC<InteractiveListButtonItemSkeletonProps>;
384
- export interface InteractiveListComponents {
385
- Structure: typeof InteractiveListStructure;
386
- StructureSkeleton: typeof InteractiveListStructureSkeleton;
387
- ButtonItem: typeof InteractiveListButtonItem;
388
- ButtonItemSkeleton: typeof InteractiveListButtonItemSkeleton;
389
- CheckboxItem: typeof InteractiveListCheckboxItem;
390
- CheckboxItemSkeleton: typeof InteractiveListCheckboxItemSkeleton;
391
- ToggleItem: typeof InteractiveListToggleItem;
392
- ToggleItemSkeleton: typeof InteractiveListToggleItemSkeleton;
393
- RadioItem: typeof InteractiveListRadioItem;
394
- RadioItemSkeleton: typeof InteractiveListRadioItemSkeleton;
395
- }
396
- export interface InteractiveListProperties extends DataListProps {
397
- /**
398
- * Content of the InteractiveList
399
- * @TJS-type React.ReactNode
400
- */
401
- children: ReactNode;
402
- }
403
- export type InteractiveListProps = InteractiveListProperties & HTMLAttributes<HTMLElement>;
404
- export declare const InteractiveList: React.FC<InteractiveListProps> & InteractiveListComponents;
405
- export interface LayoutSectionProperties extends Omit<BoxProperties, "children" | "boxSizing" | "display" | "flexDirection"> {
406
- /**
407
- * Content of the section body.
408
- * @TJS-type React.ReactNode
409
- */
410
- children: ReactNode;
411
- }
412
- export type LayoutSectionProps = LayoutSectionProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
413
- declare const LayoutSection: React.FC<LayoutSectionProps>;
414
- export interface LayoutComponents {
415
- Section: typeof LayoutSection;
416
- }
417
- export interface LayoutProperties extends Omit<BoxProperties, "children" | "boxSizing" | "display" | "gridTemplateColumns"> {
418
- /**
419
- * Content to be rendered inside the layout.
420
- * @TJS-type React.ReactNode
421
- */
422
- children: ReactNode;
423
- /**
424
- * Number of columns to be rendered for the children.
425
- */
426
- columns?: "1" | "2 - symmetric" | "2 - asymmetric" | "3";
427
- }
428
- export type LayoutProps = LayoutProperties & HTMLAttributes<HTMLElement>;
429
- export declare const Layout: React.FC<LayoutProps> & LayoutComponents;
430
- export interface MenuButtonAccordionProperties {
431
- /**
432
- * Content of the menu.
433
- * @TJS-type React.ReactNode
434
- */
435
- children: ReactNode;
436
- /**
437
- * It will be the accordion anchor and can contain all the props available in the MenuButton component's API.
438
- * @TJS-type React.ReactNode
439
- */
440
- menuButton: MenuButtonProperties;
441
- /**
442
- * Required ID used to maintain correct component accessibility, it will be passed on to MenuButtonAccordion's children.
443
- */
444
- contentid: string;
445
- /**
446
- * Changes the component usage so that control of open and close is controlled from outside the component.
447
- */
448
- open?: boolean;
449
- /**
450
- * Sets the state of the button as active/inactive.
451
- */
452
- active?: boolean;
453
- }
454
- export type MenuButtonAccordionBaseProps = MenuButtonAccordionProperties & {
455
- menuButton: MenuButtonProps;
456
- } & Omit<HTMLAttributes<HTMLElement>, "color">;
457
- declare const MenuButtonAccordion: PolymorphicForwardRefComponent<"a" | "button", MenuButtonAccordionBaseProps>;
458
- export interface MenuButtonComponents {
459
- Accordion: typeof MenuButtonAccordion;
460
- }
461
- export interface MenuButtonProperties {
462
- /**
463
- * Text label for the button.
464
- */
465
- label: string;
466
- /**
467
- * Function executed when clicking the button.
468
- * @TJS-type () => void;
469
- */
470
- onClick?: () => void;
471
- /**
472
- * Sets an icon element on the left of the button.
473
- * @TJS-type React.FC<IconProps>
474
- */
475
- startIcon?: FC<IconProps>;
476
- /**
477
- * Sets the state of the button as active/inactive.
478
- */
479
- active?: boolean;
480
- /**
481
- * Inner components displayed on the right of the button component.
482
- * @TJS-type React.ReactNode
483
- */
484
- children?: ReactNode;
485
- }
486
- export type MenuButtonBaseProps = MenuButtonProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "color">;
487
- export declare const MenuButton: PolymorphicForwardRefComponent<"a" | "button", MenuButtonBaseProps> & MenuButtonComponents;
488
- export type MenuButtonProps = ComponentPropsWithRef<typeof MenuButton>;
489
- export interface MenuHeaderProperties {
490
- /**
491
- * Content of the menu header.
492
- * @TJS-type React.ReactNode
493
- */
494
- children: ReactNode;
495
- }
496
- export type MenuHeaderProps = MenuHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
497
- declare const MenuHeader: React.FC<MenuHeaderProps>;
498
- export interface MenuBodyProperties {
499
- /**
500
- * Content of the menu body.
501
- * @TJS-type React.ReactNode
502
- */
503
- children: ReactNode;
504
- }
505
- export type MenuBodyProps = MenuBodyProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
506
- declare const MenuBody: React.FC<MenuBodyProps>;
507
- export type MenuFooterProperties = Omit<MenuButtonProperties, "children">;
508
- export type MenuFooterProps = MenuFooterProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "color">;
509
- declare const MenuFooter: React.FC<MenuFooterProps>;
510
- export interface MenuSectionProperties {
511
- /**
512
- * Optional title of the section.
513
- */
514
- title?: string;
515
- /**
516
- * Content of the menu section.
517
- * @TJS-type React.ReactNode
518
- */
519
- children: ReactNode;
520
- }
521
- export type MenuSectionProps = MenuSectionProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
522
- declare const MenuSection: React.FC<MenuSectionProps>;
523
- export interface MenuComponents {
524
- Section: typeof MenuSection;
525
- Button: typeof MenuButton;
526
- ButtonAccordion: typeof MenuButton.Accordion;
527
- Header: typeof MenuHeader;
528
- Body: typeof MenuBody;
529
- Footer: typeof MenuFooter;
530
- }
531
- export interface MenuProperties {
532
- /**
533
- * Content of the menu.
534
- * @TJS-type React.ReactNode
535
- */
536
- children: ReactNode;
537
- }
538
- export type MenuProps = MenuProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
539
- export declare const Menu: React.FC<MenuProps> & MenuComponents;
540
- export interface NavTabsItemProperties extends BoxProperties {
541
- /**
542
- * Icon element to be rendered inside the button.
543
- * @TJS-type React.ReactNode
544
- */
545
- icon: ReactNode;
546
- /**
547
- * Controls whether the button is active or not.
548
- */
549
- active?: boolean;
550
- /**
551
- * Displays a small badge on top of the button.
552
- */
553
- badge?: boolean;
554
- /**
555
- * Function executed on click.
556
- * @TJS-type onClick: () => void;
557
- */
558
- onClick: () => void;
559
- /**
560
- * Text label used for accessibility.
561
- */
562
- ariaLabel: string;
563
- }
564
- export type NavTabsItemProps = NavTabsItemProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
565
- declare const NavTabsItem: React.FC<NavTabsItemProps>;
566
- export interface NavTabsComponents {
567
- Item: typeof NavTabsItem;
568
- }
569
- export interface NavTabsProperties {
570
- /**
571
- * Content to be rendered inside the Nav element.
572
- * @TJS-type React.ReactNode
573
- */
574
- children: ReactNode;
575
- }
576
- export type NavTabsProps = NavTabsProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
577
- export declare const NavTabs: React.FC<NavTabsProps> & NavTabsComponents;
578
- export interface PageHeaderProperties extends Omit<BoxProperties, "display" | "flexDirection"> {
579
- /**
580
- * Main title of the page. Corresponds to an h1 HTML tag.
581
- */
582
- title: string;
583
- /**
584
- * Optional subtitle for the page.
585
- */
586
- subtitle?: string;
587
- /**
588
- * Button stack that appears on the right-hand side of the title.
589
- * @TJS-type React.ReactNode
590
- */
591
- buttonStack?: ReactNode;
592
- /**
593
- * Optional header content that appears underneath the title and button stack.
594
- * @TJS-type React.ReactNode
595
- */
596
- children?: ReactNode;
597
- }
598
- export type PageHeaderProps = PageHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProps, "display" | "flexDirection">;
599
- declare const PageHeader: React.FC<PageHeaderProps>;
600
- export interface PageBodyProperties extends BoxProperties {
601
- /**
602
- * Content of the page body.
603
- * @TJS-type React.ReactNode
604
- */
605
- children: ReactNode;
606
- }
607
- export type PageBodyProps = PageBodyProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & BoxProps;
608
- declare const PageBody: React.FC<PageBodyProps>;
609
- export interface PageComponents {
610
- Header: typeof PageHeader;
611
- Body: typeof PageBody;
612
- }
613
- export interface PageProperties extends Omit<BoxProperties, "width" | "maxWidth" | "marginX"> {
614
- /**
615
- * Content to be rendered inside the page body.
616
- * @TJS-type React.ReactNode
617
- */
618
- children: ReactNode;
619
- /**
620
- * Optional parameter to define a maximum width of the page content.
621
- */
622
- maxWidth?: string;
623
- }
624
- export type PageProps = PageProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProps, "width" | "maxWidth" | "marginX">;
625
- export declare const Page: React.FC<PageProps> & PageComponents;
626
- export interface ProductUpdatesProperties extends Omit<PopoverProperties, "content" | "appearance" | "padding" | "enabledDismiss"> {
627
- /**
628
- * Title of the Popover.
629
- */
630
- title: string;
631
- /**
632
- * Content text of the Popover.
633
- */
634
- text: string;
635
- /**
636
- * Optional content for the body of the Popover.
637
- * @TJS-type React.ReactNode
638
- */
639
- bodyContent?: ReactNode;
640
- /**
641
- * Optional bottom link to dismiss the Popover. If unset, an IconButton with an X will appear on the superior right corner.
642
- * @TJS-type React.ReactNode
643
- */
644
- dismissLink?: ReactNode;
645
- }
646
- export type ProductUpdatesProps = ProductUpdatesProperties & HTMLAttributes<HTMLElement>;
647
- export declare const ProductUpdates: React.FC<ProductUpdatesProps>;
648
- export type SideModalPadding = "none" | "base";
649
- export interface SideModalProperties extends Pick<SidebarProperties, "position" | "onRemove" | "open" | "padding" | "maxWidth" | "zIndex"> {
650
- /**
651
- * Title.
652
- */
653
- title?: string;
654
- /**
655
- * Action Title
656
- * @TJS-type React.ReactNode
657
- */
658
- titleAction?: ReactNode;
659
- /**
660
- * Action Header
661
- * @TJS-type React.ReactNode
662
- */
663
- headerAction?: ReactNode;
664
- /**
665
- * Icon Header
666
- * @TJS-type React.ReactNode
667
- */
668
- headerIcon?: ReactNode;
669
- /**
670
- * Body Content
671
- * @TJS-type React.ReactNode
672
- */
673
- children?: ReactNode;
674
- /**
675
- * Header padding.
676
- */
677
- paddingHeader?: SideModalPadding;
678
- /**
679
- * Body padding.
680
- */
681
- paddingBody?: SideModalPadding;
682
- /**
683
- * Footer padding.
684
- */
685
- paddingFooter?: SideModalPadding;
686
- /**
687
- * Footer element actions.
688
- */
689
- footer?: {
690
- primaryAction: ButtonProperties;
691
- secondaryAction: ButtonProperties;
692
- };
693
- }
694
- export type SideModalProps = SideModalProperties & HTMLAttributes<HTMLElement>;
695
- export declare const SideModal: React.FC<SideModalProps>;
696
- export interface ThumbnailWithActionProperties extends BoxProperties {
697
- /**
698
- * Thumbnail component properties.
699
- */
700
- thumbnail: ThumbnailProperties;
701
- /**
702
- * Element to be rendered inside the Thumbnail.
703
- * @TJS-type React.ReactNode
704
- */
705
- children: ReactNode;
706
- /**
707
- * Optional position of the element.
708
- */
709
- contentPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
710
- }
711
- export type ThumbnailWithActionProps = ThumbnailWithActionProperties & {
712
- thumbnail: ThumbnailProps;
713
- } & Omit<HTMLAttributes<HTMLElement>, "color">;
714
- export declare const ThumbnailWithAction: React.FC<ThumbnailWithActionProps>;
715
-
716
- export {};