@janbox/storefront-ui 4.0.10 → 4.0.11
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.js +2 -0
- package/dist/lib/star-rating/README.md +14 -8
- package/dist/lib/star-rating/helpers.d.ts +2 -0
- package/dist/lib/star-rating/helpers.js +14 -0
- package/dist/lib/star-rating/index.d.ts +3 -2
- package/dist/lib/star-rating/star-rating.d.ts +1 -1
- package/dist/lib/star-rating/star-rating.js +9 -17
- package/dist/lib/star-rating/types.d.ts +2 -2
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -133,6 +133,7 @@ import { getMultipleSelectProps } from "./lib/multiple-select/helpers.js";
|
|
|
133
133
|
import { getPageRange, getPaginationProps } from "./lib/pagination/helpers.js";
|
|
134
134
|
import { getPriceLabelProps } from "./lib/price-label/helpers.js";
|
|
135
135
|
import { getRadioButtonProps } from "./lib/radio-button/helpers.js";
|
|
136
|
+
import { getStarRatingProps } from "./lib/star-rating/helpers.js";
|
|
136
137
|
import { getSwiperProps } from "./lib/swiper/swiper/helpers.js";
|
|
137
138
|
import { getTabListProps } from "./lib/tabs/tab-list/helpers.js";
|
|
138
139
|
import { getTabPanelProps } from "./lib/tabs/tab-panel/helpers.js";
|
|
@@ -290,6 +291,7 @@ export {
|
|
|
290
291
|
getPaginationProps,
|
|
291
292
|
getPriceLabelProps,
|
|
292
293
|
getRadioButtonProps,
|
|
294
|
+
getStarRatingProps,
|
|
293
295
|
getSwiperProps,
|
|
294
296
|
getTabListProps,
|
|
295
297
|
getTabPanelProps,
|
|
@@ -12,10 +12,10 @@ import { StarRating } from '@janbox/storefront-ui';
|
|
|
12
12
|
|
|
13
13
|
| Prop | Type | Default | Description |
|
|
14
14
|
|------|------|---------|-------------|
|
|
15
|
-
| `rating*` | `number` | - | Giá trị rating hiện tại. Kiểm soát mức độ tô màu ngôi sao qua clip-path. Hỗ trợ giá trị thập phân (VD: 2.5). |
|
|
16
|
-
| `maxRating` | `number` | 5 | Giá trị rating tối đa. Dùng để tính phần trăm tô màu của ngôi sao. |
|
|
17
|
-
| `size` | `number` | 24 | Chiều rộng và chiều cao của SVG tính bằng pixel. ViewBox nội bộ luôn là 24x24 nên giá trị này scale output. Hỗ trợ responsive qua `sm`, `md`, `lg` (VD: `md={{ size: 32 }}`). |
|
|
18
|
-
| `color` | `
|
|
15
|
+
| `rating*` | `number` | - | Giá trị rating hiện tại (bắt buộc). Kiểm soát mức độ tô màu ngôi sao qua clip-path. Hỗ trợ giá trị thập phân (VD: 2.5). |
|
|
16
|
+
| `maxRating` | `number` | `5` | Giá trị rating tối đa. Dùng để tính phần trăm tô màu của ngôi sao. |
|
|
17
|
+
| `size` | `number` | `24` | Chiều rộng và chiều cao của SVG tính bằng pixel. ViewBox nội bộ luôn là 24x24 nên giá trị này scale output. Hỗ trợ responsive qua `sm`, `md`, `lg` (VD: `md={{ size: 32 }}`). |
|
|
18
|
+
| `color` | `string` | `var(--color-orange-600)` | Giá trị màu CSS bất kỳ dùng cho cả stroke và fill của ngôi sao. Nhận mọi CSS color (hex, rgb, `var(...)`, ...). Dùng `getColorVar('orange.600')` cho giá trị mặc định. |
|
|
19
19
|
| `sx` | `ToResponsiveProps<StyledCSS>` | - | Custom style responsive (hỗ trợ `sm`, `md`, `lg`) áp dụng lên root SVG element. |
|
|
20
20
|
| `ref` | `React.Ref<SVGSVGElement>` | - | Ref tới phần tử SVG bên dưới. |
|
|
21
21
|
|
|
@@ -42,10 +42,15 @@ import { StarRating } from '@janbox/storefront-ui';
|
|
|
42
42
|
<StarRating rating={4} size={24} md={{ size: 32 }} lg={{ size: 40 }} />
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
### Max rating tùy chỉnh và color
|
|
45
|
+
### Max rating tùy chỉnh và color tùy chỉnh
|
|
46
46
|
|
|
47
47
|
```tsx
|
|
48
|
-
|
|
48
|
+
import { getColorVar } from '@janbox/storefront-ui/theme';
|
|
49
|
+
|
|
50
|
+
<StarRating rating={7} maxRating={10} color={getColorVar('primary.600')} />
|
|
51
|
+
|
|
52
|
+
{/* Hoặc dùng CSS color trực tiếp */}
|
|
53
|
+
<StarRating rating={7} maxRating={10} color="#f59e0b" />
|
|
49
54
|
```
|
|
50
55
|
|
|
51
56
|
### Custom style responsive với `sx`
|
|
@@ -71,8 +76,9 @@ import { StarRating } from '@janbox/storefront-ui';
|
|
|
71
76
|
## Dependencies
|
|
72
77
|
|
|
73
78
|
- react (useId)
|
|
74
|
-
- @/utils (
|
|
75
|
-
- @/
|
|
79
|
+
- @/utils (mergeComponentProps)
|
|
80
|
+
- @/theme (getColorVar)
|
|
81
|
+
- @/types (PropsWithSx, ToResponsiveProps, StyledCSS)
|
|
76
82
|
- Stylesheet (../stylesheet)
|
|
77
83
|
|
|
78
84
|
## See Also
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import "lodash-es";
|
|
2
|
+
import { getColorVar } from "../../theme/palette.js";
|
|
3
|
+
import { mergeComponentProps } from "../../utils/index.js";
|
|
4
|
+
const defaultProps = {
|
|
5
|
+
color: getColorVar("orange.600"),
|
|
6
|
+
size: 24,
|
|
7
|
+
maxRating: 5
|
|
8
|
+
};
|
|
9
|
+
const getStarRatingProps = (extended) => {
|
|
10
|
+
return mergeComponentProps(defaultProps, extended);
|
|
11
|
+
};
|
|
12
|
+
export {
|
|
13
|
+
getStarRatingProps
|
|
14
|
+
};
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
export
|
|
2
|
-
export
|
|
1
|
+
export { StarRating } from './star-rating';
|
|
2
|
+
export type { StarRatingProps, StarRatingResponsiveProps } from './types';
|
|
3
|
+
export { getStarRatingProps } from './helpers';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { StarRatingProps } from './types';
|
|
2
|
-
export declare const StarRating: (
|
|
2
|
+
export declare const StarRating: (_props: StarRatingProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,21 +1,13 @@
|
|
|
1
1
|
import { jsx, jsxs } from "react/jsx-runtime";
|
|
2
2
|
import { useId } from "react";
|
|
3
|
-
import { getColorShadesByVariant } from "../../utils/index.js";
|
|
4
3
|
import { Stylesheet } from "../stylesheet/stylesheet.js";
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
maxRating =
|
|
8
|
-
size = 24,
|
|
9
|
-
sm,
|
|
10
|
-
md,
|
|
11
|
-
lg,
|
|
12
|
-
ref,
|
|
13
|
-
color = "orange",
|
|
14
|
-
sx
|
|
15
|
-
}) => {
|
|
4
|
+
import { getStarRatingProps } from "./helpers.js";
|
|
5
|
+
const StarRating = (_props) => {
|
|
6
|
+
const { rating, maxRating, size, sm, md, lg, ref, color, sx } = getStarRatingProps(_props);
|
|
16
7
|
const id = useId();
|
|
17
|
-
const percent =
|
|
18
|
-
|
|
8
|
+
const percent = (() => {
|
|
9
|
+
return maxRating ? rating / maxRating * 24 : 0;
|
|
10
|
+
})();
|
|
19
11
|
return /* @__PURE__ */ jsx(Stylesheet, { children: ({ css, cx }) => /* @__PURE__ */ jsxs(
|
|
20
12
|
"svg",
|
|
21
13
|
{
|
|
@@ -38,7 +30,7 @@ const StarRating = ({
|
|
|
38
30
|
{
|
|
39
31
|
d: "M12 2.89648L14.935 8.88948L21.5 9.85648L16.75 14.5185L17.871 21.1045L12 17.9935L6.129 21.1045L7.25 14.5185L2.5 9.85648L9.064 8.88948L12 2.89648Z",
|
|
40
32
|
fill: "white",
|
|
41
|
-
stroke:
|
|
33
|
+
stroke: color,
|
|
42
34
|
strokeWidth: "1.5",
|
|
43
35
|
strokeLinecap: "round",
|
|
44
36
|
strokeLinejoin: "round"
|
|
@@ -48,12 +40,12 @@ const StarRating = ({
|
|
|
48
40
|
"path",
|
|
49
41
|
{
|
|
50
42
|
d: "M12 2.89648L14.935 8.88948L21.5 9.85648L16.75 14.5185L17.871 21.1045L12 17.9935L6.129 21.1045L7.25 14.5185L2.5 9.85648L9.064 8.88948L12 2.89648Z",
|
|
51
|
-
fill:
|
|
43
|
+
fill: color,
|
|
52
44
|
clipPath: `url(#${id})`,
|
|
53
45
|
strokeLinecap: "round",
|
|
54
46
|
strokeLinejoin: "round",
|
|
55
47
|
strokeWidth: "1.5",
|
|
56
|
-
stroke:
|
|
48
|
+
stroke: color
|
|
57
49
|
}
|
|
58
50
|
)
|
|
59
51
|
]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { PropsWithSx, ToResponsiveProps } from '../../types';
|
|
2
2
|
import { Ref } from 'react';
|
|
3
3
|
export type StarRatingResponsiveProps = {
|
|
4
4
|
size?: number;
|
|
@@ -6,6 +6,6 @@ export type StarRatingResponsiveProps = {
|
|
|
6
6
|
export type StarRatingProps = PropsWithSx<ToResponsiveProps<StarRatingResponsiveProps> & {
|
|
7
7
|
rating: number;
|
|
8
8
|
maxRating?: number;
|
|
9
|
-
color?:
|
|
9
|
+
color?: string;
|
|
10
10
|
ref?: Ref<SVGSVGElement>;
|
|
11
11
|
}>;
|