@nimbus-ds/patterns 1.2.0-rc.3 → 1.2.1-rc.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/CHANGELOG.md CHANGED
@@ -2,14 +2,45 @@
2
2
 
3
3
  Nimbus is an open-source Design System created by Tiendanube / Nuvesmhop’s team to empower and enhance more stories every day, with simplicity, accessibility, consistency and performance.
4
4
 
5
- ## 2023-04-12 `1.2.0`
5
+ ## 2023-04-18 `1.2.0`
6
+ ## 2023-04-18 `1.2.0`
6
7
 
7
8
  #### 🎉 New features
8
9
 
9
- - Added `Menu.ButtonAccordion` subcomponent of `Menu` component. ([#39](https://github.com/TiendaNube/nimbus-patterns/pull/39) by [@juniorconquista](https://github.com/juniorconquista))
10
- - Added `MenuButton.Accordion` subcomponent of `MenuButton` component. ([#39](https://github.com/TiendaNube/nimbus-patterns/pull/39) by [@juniorconquista](https://github.com/juniorconquista))
10
+ - Added `Menu.ButtonAccordion` subcomponent of `Menu` component. ([#44](https://github.com/TiendaNube/nimbus-patterns/pull/44) by [@juniorconquista](https://github.com/juniorconquista))
11
+ - Added `MenuButton.Accordion` subcomponent of `MenuButton` component. ([#44](https://github.com/TiendaNube/nimbus-patterns/pull/44) by [@juniorconquista](https://github.com/juniorconquista))
11
12
 
12
- ## 2022-04-11 `1.1.0`
13
+ ## 2023-04-17 `1.1.1`
14
+
15
+ #### 🎉 New features
16
+
17
+ - Added new `DataTable.Cell` subcomponent. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
18
+ - Added `bottomDivider` property to `DataList` component API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
19
+ - Added `topDivider` property to `DataList.Row` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
20
+ - Extend `DataList` properties inside `InteractiveList` component API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
21
+ - Extend `topDivider` property from `DataList.Row` subcomponent inside `InteractiveList.CheckboxItem` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
22
+ - Extend `topDivider` property from `DataList.Row` subcomponent inside `InteractiveList.RadioItem` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
23
+ - Extend `topDivider` property from `DataList.Row` subcomponent inside `InteractiveList.ToggleItem` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
24
+ - Extend `topDivider` property from `DataList.Row` subcomponent inside `InteractiveList.ButtonItem` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
25
+ - Added new `HelpLink` component. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
26
+ - Added `children` property to the `HelpLink` component API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
27
+ - Added stories documentation for `HelpLink` component. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
28
+
29
+ #### 💡 Others
30
+
31
+ - Extend `Box` properties inside `Page` component API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
32
+ - Extend `Box` properties inside `Page.Header` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
33
+ - Extend `Box` properties inside `Page.Body` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
34
+ - Extend `Box` properties inside `AppShell.Header` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
35
+ - Added `ariaLabel` property to `NavTabs.Item` subcomponent API. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
36
+ - Added `stressed` story to `CalloutCard` stories documentation. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
37
+
38
+ #### 🐛 Bug fixes
39
+
40
+ - Fixed a bug on `AppShell.Header` subcomponent where content on `rightSlot` would fall off to the left when `leftSlot` property was empty. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
41
+ - Fixed a bug on `CalloutCard` component where the icon would incorrectly stretch and warp when the text was too long. ([#45](https://github.com/TiendaNube/nimbus-patterns/pull/45) by [@juanchigallego](https://github.com/juanchigallego))
42
+
43
+ ## 2023-04-11 `1.1.0`
13
44
 
14
45
  #### 🎉 New features
15
46
 
@@ -23,7 +54,7 @@ Nimbus is an open-source Design System created by Tiendanube / Nuvesmhop’s tea
23
54
 
24
55
  - Fixed bug using Crypto library when generating unique id's for `InteractiveListItem`. ([#38](https://github.com/TiendaNube/nimbus-patterns/pull/38) by [@juniorconquista](https://github.com/juniorconquista))
25
56
 
26
- ## 2022-04-06 `1.0.0`
57
+ ## 2023-04-06 `1.0.0`
27
58
 
28
59
  #### 🎉 New features
29
60
 
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  // Generated by dts-bundle-generator v8.0.0
2
2
 
3
- import { BoxProperties, ButtonProperties, CheckboxProperties, CheckboxProps, IconButtonProperties, IconButtonProps, InputProperties, PaginationProperties, PopoverProperties, RadioProperties, SelectProperties, SidebarProperties, TableProperties, TableRowProperties, TextareaProperties, ThumbnailProperties, ThumbnailProps, ToggleProperties } from '@nimbus-ds/components';
3
+ import { BoxProperties, ButtonProperties, CheckboxProperties, CheckboxProps, IconButtonProperties, IconButtonProps, InputProperties, PaginationProperties, PopoverProperties, RadioProperties, SelectProperties, SidebarProperties, TableCellProperties, TableProperties, TableRowProperties, TextareaProperties, ThumbnailProperties, ThumbnailProps, ToggleProperties } from '@nimbus-ds/components';
4
4
  import { IconProps } from '@nimbus-ds/icons';
5
5
  import { PolymorphicForwardRefComponent } from '@nimbus-ds/typings';
6
6
  import React from 'react';
@@ -18,7 +18,7 @@ export interface AppShellHeaderProperties {
18
18
  */
19
19
  rightSlot?: ReactNode;
20
20
  }
21
- export type AppShellHeaderProps = AppShellHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
21
+ export type AppShellHeaderProps = AppShellHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProperties, "display" | "justifyContent">;
22
22
  declare const AppShellHeader: React.FC<AppShellHeaderProps>;
23
23
  export interface AppShellComponents {
24
24
  Header: typeof AppShellHeader;
@@ -79,6 +79,11 @@ export interface DataListRowProperties extends Omit<BoxProperties, "padding"> {
79
79
  * @TJS-type React.ReactNode
80
80
  */
81
81
  children: ReactNode;
82
+ /**
83
+ * Determines if the row has a top border.
84
+ * @default true
85
+ */
86
+ topDivider?: boolean;
82
87
  }
83
88
  export type DataListRowProps = DataListRowProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
84
89
  declare const DataListRow: React.FC<DataListRowProps>;
@@ -91,6 +96,11 @@ export interface DataListProperties {
91
96
  * @TJS-type React.ReactNode
92
97
  */
93
98
  children: ReactNode;
99
+ /**
100
+ * Defines whether the List has a bottom border.
101
+ * @default true
102
+ */
103
+ bottomDivider?: boolean;
94
104
  }
95
105
  export type DataListProps = DataListProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
96
106
  export declare const DataList: React.FC<DataListProps> & DataListComponents;
@@ -160,11 +170,21 @@ export type DataTableRowProps = DataTableRowProperties & {
160
170
  checkbox: CheckboxProps;
161
171
  } & TableRowProperties & HTMLAttributes<HTMLElement>;
162
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>;
163
182
  export interface DataTableComponents {
164
183
  BulkActions: typeof DataTableBulkActions;
165
184
  Header: typeof DataTableHeader;
166
185
  Footer: typeof DataTableFooter;
167
186
  Row: typeof DataTableRow;
187
+ Cell: typeof DataTableCell;
168
188
  }
169
189
  export interface DataTableProperties {
170
190
  /**
@@ -264,6 +284,15 @@ export interface FormFieldProperties {
264
284
  }
265
285
  export type FormFieldProps = FormFieldProperties & HTMLAttributes<HTMLElement>;
266
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>;
267
296
  export interface InteractiveListStructureProperties {
268
297
  /**
269
298
  * Title of the list item element. Also used to generate the ID for the interactive element.
@@ -288,13 +317,26 @@ declare const InteractiveListStructure: React.FC<InteractiveListStructureProps>;
288
317
  export type InteractiveListStructureSkeletonProperties = InteractiveListStructureProperties;
289
318
  export type InteractiveListStructureSkeletonProps = InteractiveListStructureSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
290
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">;
291
333
  export interface InteractiveListCheckboxItemProperties extends InteractiveListStructureProperties {
292
334
  /**
293
335
  * Checkbox props inherited from Nimbus components.
294
336
  */
295
337
  checkbox: CheckboxProperties;
296
338
  }
297
- export type InteractiveListCheckboxItemProps = InteractiveListCheckboxItemProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
339
+ export type InteractiveListCheckboxItemProps = InteractiveListCheckboxItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
298
340
  declare const InteractiveListCheckboxItem: React.FC<InteractiveListCheckboxItemProps>;
299
341
  export type InteractiveListCheckboxItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
300
342
  export type InteractiveListCheckboxItemSkeletonProps = InteractiveListCheckboxItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
@@ -305,7 +347,7 @@ export interface InteractiveListRadioItemProperties extends InteractiveListStruc
305
347
  */
306
348
  radio: RadioProperties;
307
349
  }
308
- export type InteractiveListRadioItemProps = InteractiveListRadioItemProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
350
+ export type InteractiveListRadioItemProps = InteractiveListRadioItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
309
351
  declare const InteractiveListRadioItem: React.FC<InteractiveListRadioItemProps>;
310
352
  export type InteractiveListRadioItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
311
353
  export type InteractiveListRadioItemSkeletonProps = InteractiveListRadioItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
@@ -316,7 +358,7 @@ export interface InteractiveListToggleItemProperties extends InteractiveListStru
316
358
  */
317
359
  toggle: ToggleProperties;
318
360
  }
319
- export type InteractiveListToggleItemProps = InteractiveListToggleItemProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
361
+ export type InteractiveListToggleItemProps = InteractiveListToggleItemProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
320
362
  declare const InteractiveListToggleItem: React.FC<InteractiveListToggleItemProps>;
321
363
  export interface InteractiveListToggleItemSkeletonProperties extends InteractiveListStructureProperties {
322
364
  /**
@@ -334,7 +376,7 @@ export interface InteractiveListButtonItemProperties extends InteractiveListStru
334
376
  }
335
377
  export type InteractiveListButtonItemProps = InteractiveListButtonItemProperties & {
336
378
  iconButton: Omit<IconButtonProps, "backgroundColor" | "borderColor" | "size" | "source">;
337
- } & Omit<HTMLAttributes<HTMLElement>, "color">;
379
+ } & Omit<HTMLAttributes<HTMLElement>, "color"> & Pick<InteractiveListRowProps, "topDivider">;
338
380
  declare const InteractiveListButtonItem: React.FC<InteractiveListButtonItemProps>;
339
381
  export type InteractiveListButtonItemSkeletonProperties = InteractiveListStructureSkeletonProperties;
340
382
  export type InteractiveListButtonItemSkeletonProps = InteractiveListButtonItemSkeletonProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
@@ -351,7 +393,7 @@ export interface InteractiveListComponents {
351
393
  RadioItem: typeof InteractiveListRadioItem;
352
394
  RadioItemSkeleton: typeof InteractiveListRadioItemSkeleton;
353
395
  }
354
- export interface InteractiveListProperties {
396
+ export interface InteractiveListProperties extends DataListProps {
355
397
  /**
356
398
  * Content of the InteractiveList
357
399
  * @TJS-type React.ReactNode
@@ -405,6 +447,10 @@ export interface MenuButtonAccordionProperties {
405
447
  * @default false
406
448
  */
407
449
  controlled?: boolean;
450
+ /**
451
+ * Sets the state of the button as active/inactive.
452
+ */
453
+ active?: boolean;
408
454
  }
409
455
  export type MenuButtonAccordionPros = MenuButtonAccordionProperties & {
410
456
  menuButton: MenuButtonProps;
@@ -511,6 +557,10 @@ export interface NavTabsItemProperties extends BoxProperties {
511
557
  * @TJS-type onClick: () => void;
512
558
  */
513
559
  onClick: () => void;
560
+ /**
561
+ * Text label used for accessibility.
562
+ */
563
+ ariaLabel: string;
514
564
  }
515
565
  export type NavTabsItemProps = NavTabsItemProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
516
566
  declare const NavTabsItem: React.FC<NavTabsItemProps>;
@@ -546,7 +596,7 @@ export interface PageHeaderProperties {
546
596
  */
547
597
  children?: ReactNode;
548
598
  }
549
- export type PageHeaderProps = PageHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
599
+ export type PageHeaderProps = PageHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProperties, "display" | "flexDirection">;
550
600
  declare const PageHeader: React.FC<PageHeaderProps>;
551
601
  export interface PageBodyProperties {
552
602
  /**
@@ -555,7 +605,7 @@ export interface PageBodyProperties {
555
605
  */
556
606
  children: ReactNode;
557
607
  }
558
- export type PageBodyProps = PageBodyProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
608
+ export type PageBodyProps = PageBodyProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & BoxProperties;
559
609
  declare const PageBody: React.FC<PageBodyProps>;
560
610
  export interface PageComponents {
561
611
  Header: typeof PageHeader;
@@ -572,7 +622,7 @@ export interface PageProperties {
572
622
  */
573
623
  maxWidth?: string;
574
624
  }
575
- export type PageProps = PageProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
625
+ export type PageProps = PageProperties & Omit<HTMLAttributes<HTMLElement>, "color"> & Omit<BoxProperties, "width" | "maxWidth" | "marginX">;
576
626
  export declare const Page: React.FC<PageProps> & PageComponents;
577
627
  export interface ProductUpdatesProperties extends Omit<PopoverProperties, "content" | "appearance" | "padding" | "enabledDismiss"> {
578
628
  /**