@agions/taroviz 1.0.1 → 1.1.0

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/README.md ADDED
@@ -0,0 +1,100 @@
1
+ # @agions/taroviz
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@agions/taroviz.svg)](https://www.npmjs.com/package/@agions/taroviz)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@agions/taroviz.svg)](https://www.npmjs.com/package/@agions/taroviz)
5
+ [![GitHub](https://img.shields.io/github/license/Agions/TaroViz)](https://github.com/Agions/TaroViz/blob/main/LICENSE)
6
+
7
+ 基于 Taro 和 ECharts 的多端图表组件库完整包,支持微信小程序、支付宝小程序、百度小程序、H5等多平台。
8
+
9
+ ## 介绍
10
+
11
+ `@agions/taroviz` 是TaroViz组件库的主包,包含了所有子包的功能,提供完整的多端图表解决方案。如果您想使用TaroViz的全部功能,推荐直接安装此包。
12
+
13
+ ## 安装
14
+
15
+ ```bash
16
+ # npm
17
+ npm install @agions/taroviz
18
+
19
+ # yarn
20
+ yarn add @agions/taroviz
21
+
22
+ # pnpm
23
+ pnpm add @agions/taroviz
24
+ ```
25
+
26
+ ## 包依赖关系
27
+
28
+ 该包整合了以下子包:
29
+
30
+ - [`@agions/taroviz-core`](https://www.npmjs.com/package/@agions/taroviz-core) - 核心组件
31
+ - [`@agions/taroviz-charts`](https://www.npmjs.com/package/@agions/taroviz-charts) - 图表组件
32
+ - [`@agions/taroviz-adapters`](https://www.npmjs.com/package/@agions/taroviz-adapters) - 平台适配器
33
+ - [`@agions/taroviz-themes`](https://www.npmjs.com/package/@agions/taroviz-themes) - 主题系统
34
+ - [`@agions/taroviz-data`](https://www.npmjs.com/package/@agions/taroviz-data) - 数据处理
35
+ - [`@agions/taroviz-hooks`](https://www.npmjs.com/package/@agions/taroviz-hooks) - React Hooks
36
+
37
+ ## 使用示例
38
+
39
+ ```jsx
40
+ import React from 'react';
41
+ import { LineChart } from '@agions/taroviz';
42
+
43
+ const App = () => {
44
+ const data = {
45
+ xAxis: ['周一', '周二', '周三', '周四', '周五'],
46
+ series: [150, 230, 224, 218, 135]
47
+ };
48
+
49
+ return (
50
+ <LineChart
51
+ data={data}
52
+ width={350}
53
+ height={250}
54
+ />
55
+ );
56
+ };
57
+
58
+ export default App;
59
+ ```
60
+
61
+ ## API文档
62
+
63
+ ### 导出的组件
64
+
65
+ 以下是主要的图表组件:
66
+
67
+ - `LineChart` - 折线图
68
+ - `BarChart` - 柱状图
69
+ - `PieChart` - 饼图
70
+ - `RadarChart` - 雷达图
71
+ - `ScatterChart` - 散点图
72
+ - `HeatmapChart` - 热力图
73
+
74
+ 更多图表类型请参考完整文档。
75
+
76
+ ### 导出的工具
77
+
78
+ - `Core` - 核心API
79
+ - `Adapters` - 适配器API
80
+ - `Charts` - 图表组件API
81
+ - `Themes` - 主题系统API
82
+ - `Data` - 数据处理API
83
+ - `Hooks` - React Hooks API
84
+
85
+ ## 依赖要求
86
+
87
+ - `@tarojs/components`: >=3.4.0
88
+ - `@tarojs/taro`: >=3.4.0
89
+ - `echarts`: >=5.4.0
90
+ - `react`: >=16.13.0
91
+
92
+ ## 相关链接
93
+
94
+ - [GitHub仓库](https://github.com/Agions/TaroViz)
95
+ - [问题反馈](https://github.com/Agions/TaroViz/issues)
96
+ - [更新日志](https://github.com/Agions/TaroViz/blob/main/CHANGELOG.md)
97
+
98
+ ## 许可证
99
+
100
+ MIT © [Agions](https://github.com/Agions)