@faststore/components 3.0.81 → 3.0.88

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.
@@ -2,24 +2,24 @@ import React from 'react';
2
2
  import type { HTMLAttributes } from 'react';
3
3
  export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
4
4
  /**
5
- * ID to find this component in testing tools (e.g.: cypress,
5
+ * ID to find this component in testing tools (e.g., cypress,
6
6
  * testing-library, and jest).
7
7
  */
8
8
  testId?: string;
9
9
  /**
10
- * Label for the subtotal value of the order. Will only show if subtotalValue is provided.
10
+ * Label for the subtotal value of the order. It will only show if subtotalValue is provided.
11
11
  */
12
12
  subtotalLabel?: string;
13
13
  /**
14
- * Subtotal value of the order. If provided, subtotal label and value will be shown.
14
+ * Subtotal value of the order. If provided, a subtotal label and value will be shown.
15
15
  */
16
16
  subtotalValue?: string;
17
17
  /**
18
- * Label for the discount value for the order. Will only show if discountValue is provided.
18
+ * Label for the discount value for the order. It will only show if discountValue is provided.
19
19
  */
20
20
  discountLabel?: string;
21
21
  /**
22
- * Discount value for the order. If provided, discount label and value will be shown.
22
+ * Discount value for the order. If provided, a discount label and value will be shown.
23
23
  */
24
24
  discountValue?: string;
25
25
  /**
@@ -31,11 +31,11 @@ export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
31
31
  */
32
32
  totalValue?: string;
33
33
  /**
34
- * Enables to include taxes status.
34
+ * Specifies whether the displayed price should include taxes.
35
35
  */
36
36
  includeTaxes?: boolean;
37
37
  /**
38
- * Label to determine if the price is with taxes included.
38
+ * Label to determine if the price includes taxes.
39
39
  */
40
40
  includeTaxesLabel?: string;
41
41
  }
@@ -12,7 +12,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
12
12
  */
13
13
  title: string;
14
14
  /**
15
- * Props for the link from ProductCard component.
15
+ * Props for the link from the ProductCard component.
16
16
  */
17
17
  linkProps?: Partial<LinkProps<LinkElementType>>;
18
18
  /**
@@ -20,7 +20,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
20
20
  */
21
21
  price?: PriceDefinition;
22
22
  /**
23
- * Enables a outOfStock status.
23
+ * Enables an outOfStock status.
24
24
  */
25
25
  outOfStock?: boolean;
26
26
  /**
@@ -28,7 +28,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
28
28
  */
29
29
  outOfStockLabel?: string;
30
30
  /**
31
- * Specifies Rating Value of the product.
31
+ * Specifies the Rating Value of the product.
32
32
  */
33
33
  ratingValue?: number;
34
34
  /**
@@ -40,15 +40,15 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
40
40
  */
41
41
  showDiscountBadge?: boolean;
42
42
  /**
43
- * Callback function when button is clicked.
43
+ * Callback function when the button is clicked.
44
44
  */
45
45
  onButtonClick?: () => void;
46
46
  /**
47
- * Enables to include taxes status.
47
+ * Specifies whether the displayed price should include taxes.
48
48
  */
49
49
  includeTaxes?: boolean;
50
50
  /**
51
- * Label to determine if the price is with taxes included.
51
+ * Label to determine if the price includes taxes.
52
52
  */
53
53
  includeTaxesLabel?: string;
54
54
  }
@@ -2,24 +2,24 @@ import React from 'react';
2
2
  import type { HTMLAttributes } from 'react';
3
3
  export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
4
4
  /**
5
- * ID to find this component in testing tools (e.g.: cypress,
5
+ * ID to find this component in testing tools (e.g., cypress,
6
6
  * testing-library, and jest).
7
7
  */
8
8
  testId?: string;
9
9
  /**
10
- * Label for the subtotal value of the order. Will only show if subtotalValue is provided.
10
+ * Label for the subtotal value of the order. It will only show if subtotalValue is provided.
11
11
  */
12
12
  subtotalLabel?: string;
13
13
  /**
14
- * Subtotal value of the order. If provided, subtotal label and value will be shown.
14
+ * Subtotal value of the order. If provided, a subtotal label and value will be shown.
15
15
  */
16
16
  subtotalValue?: string;
17
17
  /**
18
- * Label for the discount value for the order. Will only show if discountValue is provided.
18
+ * Label for the discount value for the order. It will only show if discountValue is provided.
19
19
  */
20
20
  discountLabel?: string;
21
21
  /**
22
- * Discount value for the order. If provided, discount label and value will be shown.
22
+ * Discount value for the order. If provided, a discount label and value will be shown.
23
23
  */
24
24
  discountValue?: string;
25
25
  /**
@@ -31,11 +31,11 @@ export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
31
31
  */
32
32
  totalValue?: string;
33
33
  /**
34
- * Enables to include taxes status.
34
+ * Specifies whether the displayed price should include taxes.
35
35
  */
36
36
  includeTaxes?: boolean;
37
37
  /**
38
- * Label to determine if the price is with taxes included.
38
+ * Label to determine if the price includes taxes.
39
39
  */
40
40
  includeTaxesLabel?: string;
41
41
  }
@@ -12,7 +12,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
12
12
  */
13
13
  title: string;
14
14
  /**
15
- * Props for the link from ProductCard component.
15
+ * Props for the link from the ProductCard component.
16
16
  */
17
17
  linkProps?: Partial<LinkProps<LinkElementType>>;
18
18
  /**
@@ -20,7 +20,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
20
20
  */
21
21
  price?: PriceDefinition;
22
22
  /**
23
- * Enables a outOfStock status.
23
+ * Enables an outOfStock status.
24
24
  */
25
25
  outOfStock?: boolean;
26
26
  /**
@@ -28,7 +28,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
28
28
  */
29
29
  outOfStockLabel?: string;
30
30
  /**
31
- * Specifies Rating Value of the product.
31
+ * Specifies the Rating Value of the product.
32
32
  */
33
33
  ratingValue?: number;
34
34
  /**
@@ -40,15 +40,15 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
40
40
  */
41
41
  showDiscountBadge?: boolean;
42
42
  /**
43
- * Callback function when button is clicked.
43
+ * Callback function when the button is clicked.
44
44
  */
45
45
  onButtonClick?: () => void;
46
46
  /**
47
- * Enables to include taxes status.
47
+ * Specifies whether the displayed price should include taxes.
48
48
  */
49
49
  includeTaxes?: boolean;
50
50
  /**
51
- * Label to determine if the price is with taxes included.
51
+ * Label to determine if the price includes taxes.
52
52
  */
53
53
  includeTaxesLabel?: string;
54
54
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faststore/components",
3
- "version": "3.0.81",
3
+ "version": "3.0.88",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "typings": "dist/esm/index.d.ts",
@@ -35,8 +35,8 @@
35
35
  "react-dom": "^18.2.0"
36
36
  },
37
37
  "devDependencies": {
38
- "@faststore/eslint-config": "^3.0.68",
39
- "@faststore/shared": "^3.0.68",
38
+ "@faststore/eslint-config": "^3.0.88",
39
+ "@faststore/shared": "^3.0.88",
40
40
  "@testing-library/react": "^14.3.0",
41
41
  "@types/react": "^18.2.42",
42
42
  "@types/react-dom": "^18.2.17",
@@ -49,5 +49,5 @@
49
49
  "volta": {
50
50
  "extends": "../../package.json"
51
51
  },
52
- "gitHead": "2187237703ed2610a1d47a613d0a6ea62569b85f"
52
+ "gitHead": "31a958b995b2477f5c15b0b7dd8ec522e47629d9"
53
53
  }
@@ -5,24 +5,24 @@ import { Label, List } from '../../'
5
5
 
6
6
  export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
7
7
  /**
8
- * ID to find this component in testing tools (e.g.: cypress,
8
+ * ID to find this component in testing tools (e.g., cypress,
9
9
  * testing-library, and jest).
10
10
  */
11
11
  testId?: string
12
12
  /**
13
- * Label for the subtotal value of the order. Will only show if subtotalValue is provided.
13
+ * Label for the subtotal value of the order. It will only show if subtotalValue is provided.
14
14
  */
15
15
  subtotalLabel?: string
16
16
  /**
17
- * Subtotal value of the order. If provided, subtotal label and value will be shown.
17
+ * Subtotal value of the order. If provided, a subtotal label and value will be shown.
18
18
  */
19
19
  subtotalValue?: string
20
20
  /**
21
- * Label for the discount value for the order. Will only show if discountValue is provided.
21
+ * Label for the discount value for the order. It will only show if discountValue is provided.
22
22
  */
23
23
  discountLabel?: string
24
24
  /**
25
- * Discount value for the order. If provided, discount label and value will be shown.
25
+ * Discount value for the order. If provided, a discount label and value will be shown.
26
26
  */
27
27
  discountValue?: string
28
28
  /**
@@ -34,11 +34,11 @@ export interface OrderSummaryProps extends HTMLAttributes<HTMLUListElement> {
34
34
  */
35
35
  totalValue?: string
36
36
  /**
37
- * Enables to include taxes status.
37
+ * Specifies whether the displayed price should include taxes.
38
38
  */
39
39
  includeTaxes?: boolean
40
40
  /**
41
- * Label to determine if the price is with taxes included.
41
+ * Label to determine if the price includes taxes.
42
42
  */
43
43
  includeTaxesLabel?: string
44
44
  }
@@ -26,7 +26,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
26
26
  */
27
27
  title: string
28
28
  /**
29
- * Props for the link from ProductCard component.
29
+ * Props for the link from the ProductCard component.
30
30
  */
31
31
  linkProps?: Partial<LinkProps<LinkElementType>>
32
32
  /**
@@ -34,7 +34,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
34
34
  */
35
35
  price?: PriceDefinition
36
36
  /**
37
- * Enables a outOfStock status.
37
+ * Enables an outOfStock status.
38
38
  */
39
39
  outOfStock?: boolean
40
40
  /**
@@ -42,7 +42,7 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
42
42
  */
43
43
  outOfStockLabel?: string
44
44
  /**
45
- * Specifies Rating Value of the product.
45
+ * Specifies the Rating Value of the product.
46
46
  */
47
47
  ratingValue?: number
48
48
  /**
@@ -54,15 +54,15 @@ export interface ProductCardContentProps extends HTMLAttributes<HTMLElement> {
54
54
  */
55
55
  showDiscountBadge?: boolean
56
56
  /**
57
- * Callback function when button is clicked.
57
+ * Callback function when the button is clicked.
58
58
  */
59
59
  onButtonClick?: () => void
60
60
  /**
61
- * Enables to include taxes status.
61
+ * Specifies whether the displayed price should include taxes.
62
62
  */
63
63
  includeTaxes?: boolean
64
64
  /**
65
- * Label to determine if the price is with taxes included.
65
+ * Label to determine if the price includes taxes.
66
66
  */
67
67
  includeTaxesLabel?: string
68
68
  }