Skip to content

Commit fbaaeed

Browse files
authored
Merge pull request #67 from vue-pivottable/feat/readme
Feat/readme
2 parents 8eadd57 + a78d1bd commit fbaaeed

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

README.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
`vue-pivottable` is a Vue 3-compatible pivot table component, which is a Vue wrapper of the popular [react-pivottable](https://github.com/plotly/react-pivottable). This library allows you to easily summarize, transform, and visualize large datasets in a pivot table UI.
88

9+
Looking for the Vue 2 compatible version?
10+
👉 [v0.4.67 on github](https://github.com/seungwoo321/vue-pivottable)
11+
912
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
1013

1114
<!-- [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) -->
@@ -29,12 +32,16 @@ Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://
2932

3033
## Installation
3134

35+
### NPM
36+
3237
```bash
33-
# npm install
3438
npm install vue-pivottable
39+
```
3540

36-
# npm run dev
37-
npm run dev
41+
### PNPM
42+
43+
```bash
44+
pnpm add vue-pivottable
3845
```
3946

4047
<!-- 사용법 (Quick Start)-->
@@ -62,27 +69,13 @@ import { VuePivottableUi } from 'vue-pivottable'
6269

6370
## Documentation
6471

65-
### VuePivottableUi
66-
67-
| Prop | Type | Description | Default |
68-
| ---------------- | -------- | ------------------------------------------------------- | --------- |
69-
| `data` | `Array` | The dataset array to display in the pivot table | `[]` |
70-
| `rows` | `Array` | Fields to use as rows in the pivot table | `[]` |
71-
| `cols` | `Array` | Fields to use as columns in the pivot table | `[]` |
72-
| `vals` | `Array` | Fields to aggregate | `[]` |
73-
| `aggregatorName` | `String` | Aggregation function name (e.g., "Sum", "Count") | `"Count"` |
74-
| `rendererName` | `String` | Renderer to display the data ("Table", "Heatmap", etc.) | `"Table"` |
75-
76-
You can also pass custom renderers, aggregators, and sorters.
77-
For detailed API and props usage, visit the [Wiki](https://vue-pivottable.vercel.app/).
72+
For detailed API and props usage, please visit the [Wiki](https://vue-pivottable.vercel.app/).
7873

7974
<!-- 데모 사이트 링크 (없으면 임시로 로컬에서 돌릴 수 있는 설명)-->
8075

8176
## Live Demo
8277

83-
Try out the live demo of `vue-pivottable-ui` here:
84-
85-
- [Demo on Stackblitz](https://stackblitz.com/edit/vitejs-vite-dviwcxsq?file=src%2FApp.vue)
78+
Try out the live demo of `vue-pivottable-ui` in [Stackblitz](https://stackblitz.com/edit/vitejs-vite-dviwcxsq?file=src%2FApp.vue)
8679

8780
## Development
8881

@@ -103,6 +96,10 @@ pnpm dev
10396

10497
Then open http://localhost:8080 in your browser.
10598

99+
## Inspired
100+
101+
Inspired by plotly/react-pivottable - React-based pivot table library
102+
106103
<!-- end -->
107104

108105
## Contributors ✨

0 commit comments

Comments
 (0)