|
1 | | -# React Number Animation |
| 1 | +# @coderlzw/react-number-animation |
2 | 2 |
|
3 | | -一个用于数字动画过渡的 React 组件库,提供了两种组件:`AnimatedNumber` 和 `Statistic`。 |
| 3 | +一个用于数字动画过渡的 React 组件库,提供了两种不同的数字动画效果。 |
4 | 4 |
|
5 | 5 | ## 安装 |
6 | 6 |
|
7 | 7 | ```bash |
8 | | -npm install react-number-animation |
| 8 | +npm install @coderlzw/react-number-animation |
9 | 9 | # 或 |
10 | | -yarn add react-number-animation |
| 10 | +yarn add @coderlzw/react-number-animation |
| 11 | +# 或 |
| 12 | +pnpm add @coderlzw/react-number-animation |
11 | 13 | ``` |
12 | 14 |
|
13 | | -## 使用方法 |
| 15 | +## 组件 |
14 | 16 |
|
15 | | -### AnimatedNumber |
| 17 | +### Statistic |
| 18 | + |
| 19 | +一个带有标题、前缀和后缀的统计数字组件,支持数字格式化和平滑过渡动画。 |
| 20 | + |
| 21 | +#### 属性 |
16 | 22 |
|
17 | | -一个简单的数字动画组件,支持数字的上下滑动过渡效果。 |
| 23 | +| 属性名 | 类型 | 默认值 | 描述 | |
| 24 | +|--------|------|--------|------| |
| 25 | +| value | number | - | 要显示的数字值 | |
| 26 | +| title | React.ReactNode | - | 统计数字的标题 | |
| 27 | +| prefix | React.ReactNode | - | 数字前缀 | |
| 28 | +| suffix | React.ReactNode | - | 数字后缀 | |
| 29 | +| className | string | '' | 自定义类名 | |
| 30 | +| duration | number | 2000 | 动画持续时间(毫秒) | |
| 31 | +| decimals | number | 0 | 小数位数 | |
| 32 | +| separator | string | ',' | 千位分隔符 | |
| 33 | +| decimal | string | '.' | 小数点符号 | |
| 34 | +| useGrouping | boolean | true | 是否使用千位分组 | |
| 35 | + |
| 36 | +#### 示例 |
18 | 37 |
|
19 | 38 | ```tsx |
20 | | -import { AnimatedNumber } from 'react-number-animation'; |
| 39 | +import { Statistic } from '@coderlzw/react-number-animation'; |
21 | 40 |
|
22 | 41 | function App() { |
23 | | - const [value, setValue] = useState(0); |
24 | | - |
25 | | - return ( |
26 | | - <div> |
27 | | - <AnimatedNumber value={value} className="text-4xl" /> |
28 | | - <button onClick={() => setValue((v) => v + 1)}>增加</button> |
29 | | - <button onClick={() => setValue((v) => v - 1)}>减少</button> |
30 | | - </div> |
31 | | - ); |
| 42 | + return ( |
| 43 | + <Statistic |
| 44 | + value={1234567.89} |
| 45 | + title="总销售额" |
| 46 | + prefix="$" |
| 47 | + suffix="元" |
| 48 | + decimals={2} |
| 49 | + duration={1500} |
| 50 | + /> |
| 51 | + ); |
32 | 52 | } |
33 | 53 | ``` |
34 | 54 |
|
35 | | -### Statistic |
| 55 | +### AnimatedNumber |
| 56 | + |
| 57 | +一个纯数字动画组件,支持数字的上下滚动动画效果。 |
| 58 | + |
| 59 | +#### 属性 |
36 | 60 |
|
37 | | -一个统计数字组件,支持数字的平滑过渡动画,以及格式化选项。 |
| 61 | +| 属性名 | 类型 | 默认值 | 描述 | |
| 62 | +|--------|------|--------|------| |
| 63 | +| value | number | - | 要显示的数字值 | |
| 64 | +| className | string | '' | 自定义类名 | |
| 65 | + |
| 66 | +#### 示例 |
38 | 67 |
|
39 | 68 | ```tsx |
40 | | -import { Statistic } from 'react-number-animation'; |
| 69 | +import { AnimatedNumber } from '@coderlzw/react-number-animation'; |
41 | 70 |
|
42 | 71 | function App() { |
43 | | - return ( |
44 | | - <div> |
45 | | - {/* 基础用法 */} |
46 | | - <Statistic value={14.56} title="销售额" prefix="¥" /> |
47 | | - |
48 | | - {/* 带小数点的用法 */} |
49 | | - <Statistic value={1234.56} decimals={2} title="增长率" suffix="%" /> |
50 | | - |
51 | | - {/* 自定义格式化 */} |
52 | | - <Statistic |
53 | | - value={1234567} |
54 | | - separator=" " // 使用空格作为千位分隔符 |
55 | | - title="访问量" |
56 | | - suffix="次" |
57 | | - /> |
58 | | - |
59 | | - {/* 不使用分组 */} |
60 | | - <Statistic value={123} useGrouping={false} title="ID" /> |
61 | | - </div> |
62 | | - ); |
| 72 | + return ( |
| 73 | + <AnimatedNumber |
| 74 | + value={1234} |
| 75 | + className="custom-animation" |
| 76 | + /> |
| 77 | + ); |
63 | 78 | } |
64 | 79 | ``` |
65 | 80 |
|
66 | | -## Props |
| 81 | +## 样式 |
67 | 82 |
|
68 | | -### AnimatedNumber |
| 83 | +组件使用原生 CSS 进行样式设置,你可以通过自定义类名来覆盖默认样式。 |
69 | 84 |
|
70 | | -| 属性名 | 类型 | 默认值 | 说明 | |
71 | | -| --------- | ------ | ------ | ------------ | |
72 | | -| value | number | - | 要显示的数字 | |
73 | | -| className | string | "" | 自定义类名 | |
| 85 | +### Statistic 样式类 |
74 | 86 |
|
75 | | -### Statistic |
| 87 | +- `.statistic`: 统计组件容器 |
| 88 | +- `.statistic-title`: 标题样式 |
| 89 | +- `.statistic-content`: 内容容器 |
| 90 | +- `.statistic-prefix`: 前缀样式 |
| 91 | +- `.statistic-suffix`: 后缀样式 |
| 92 | +- `.statistic-value`: 数值样式 |
| 93 | + |
| 94 | +### AnimatedNumber 样式类 |
| 95 | + |
| 96 | +- `.animated-number`: 动画数字容器 |
| 97 | +- `.digit-container`: 单个数字容器 |
76 | 98 |
|
77 | | -| 属性名 | 类型 | 默认值 | 说明 | |
78 | | -| ----------- | --------- | ------ | -------------------- | |
79 | | -| value | number | - | 要显示的数字 | |
80 | | -| title | ReactNode | - | 标题 | |
81 | | -| prefix | ReactNode | - | 前缀 | |
82 | | -| suffix | ReactNode | - | 后缀 | |
83 | | -| className | string | "" | 自定义类名 | |
84 | | -| duration | number | 2000 | 动画持续时间(毫秒) | |
85 | | -| decimals | number | 0 | 小数位数 | |
86 | | -| separator | string | "," | 千位分隔符 | |
87 | | -| decimal | string | "." | 小数点符号 | |
88 | | -| useGrouping | boolean | true | 是否使用千位分组 | |
| 99 | +## 特性 |
| 100 | + |
| 101 | +- 🎯 高性能:使用 React.memo 优化渲染 |
| 102 | +- 🎨 可定制:支持自定义样式和动画参数 |
| 103 | +- 📦 轻量级:无额外依赖(除了 motion 库) |
| 104 | +- 🎭 平滑动画:使用 easeOutExpo 缓动函数 |
| 105 | +- 🔢 数字格式化:支持千位分隔和小数点设置 |
| 106 | + |
| 107 | +## 浏览器支持 |
| 108 | + |
| 109 | +- Chrome >= 60 |
| 110 | +- Firefox >= 60 |
| 111 | +- Safari >= 12 |
| 112 | +- Edge >= 79 |
89 | 113 |
|
90 | 114 | ## 开发 |
91 | 115 |
|
92 | 116 | ```bash |
93 | 117 | # 安装依赖 |
94 | 118 | npm install |
95 | 119 |
|
| 120 | +# 开发模式 |
| 121 | +npm run dev |
| 122 | + |
96 | 123 | # 构建 |
97 | 124 | npm run build |
98 | | - |
99 | | -# 测试 |
100 | | -npm test |
101 | 125 | ``` |
102 | 126 |
|
103 | | -## License |
| 127 | +## 许可证 |
104 | 128 |
|
105 | 129 | MIT |
0 commit comments