Skip to content

Commit 1106ea1

Browse files
graphierosgraphieros
committed
Update docs
1 parent 5f034c7 commit 1106ea1

File tree

2 files changed

+33
-28
lines changed

2 files changed

+33
-28
lines changed

‎README.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
# vue-data-ui
1010

1111
![npm](https://img.shields.io/npm/v/vue-data-ui)
12-
![Static Badge](https://img.shields.io/badge/components-54-blue)
13-
[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/4526-shield.svg)](https://madewithvuejs.com/p/vue-data-ui/shield-link)
12+
![Static Badge](https://img.shields.io/badge/components-55-blue)
1413
![GitHub issues](https://img.shields.io/github/issues/graphieros/vue-data-ui)
1514
[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
15+
[![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/4526-shield.svg)](https://madewithvuejs.com/p/vue-data-ui/shield-link)
1616
![npm](https://img.shields.io/npm/dt/vue-data-ui)
1717

1818
[Interactive documentation](https://vue-data-ui.graphieros.com/)
@@ -73,6 +73,7 @@ Available components
7373
- [VueUiTableHeatmap](https://vue-data-ui.graphieros.com/docs#vue-ui-table-heatmap)
7474
- [VueUiTableSparkline](https://vue-data-ui.graphieros.com/docs#vue-ui-table-sparkline)
7575
- [VueUiTable](https://vue-data-ui.graphieros.com/docs#vue-ui-table)
76+
- [VueUiCarouselTable](https://vue-data-ui.graphieros.com/docs#vue-ui-carousel-table)
7677

7778
## Rating
7879

@@ -353,14 +354,14 @@ From the dataset you pass into the props, this component will produce the most a
353354

354355
### Mini charts
355356

356-
| Name | dataset type | config type | emits / exposed methods | slots | custom tooltip | themes |
357-
| --------------------- | ---------------------------------- | --------------------------- | ----------------------- | -------------------------- | -------------- | ------ |
358-
| `VueUiSparkline` | `VueUiSparklineDatasetItem[]` | `VueUiSparklineConfig` | `@selectDatapoint` | `#svg`, `#before` | ❌ | ✅ |
359-
| `VueUiSparkbar` | `VueUiSparkbarDatasetItem[]` | `VueUiSparkbarConfig` | `@selectDatapoint` | `#data-label`, `#title` | ❌ | ✅ |
360-
| `VueUiSparkStackbar` | `VueUiSparkStackbarDatasetItem[]` | `VueUiSparkStackbarConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
361-
| `VueUiSparkHistogram` | `VueUiSparkHistogramDatasetItem[]` | `VueUiSparkHistogramConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
362-
| `VueUiSparkGauge` | `VueUiSparkGaugeDataset` | `VueUiSparkGaugeConfig` | ❌ | ❌ | ❌ | ✅ |
363-
| `VueUiSparkTrend` | `number[]` | `VueUiSparkTrendConfig` | ❌ | ❌ | ❌ | ✅ |
357+
| Name | dataset type | config type | emits / exposed methods | slots | custom tooltip | themes |
358+
| --------------------- | ---------------------------------- | --------------------------- | ----------------------- | ----------------------- | -------------- | ------ |
359+
| `VueUiSparkline` | `VueUiSparklineDatasetItem[]` | `VueUiSparklineConfig` | `@selectDatapoint` | `#svg`, `#before` | ❌ | ✅ |
360+
| `VueUiSparkbar` | `VueUiSparkbarDatasetItem[]` | `VueUiSparkbarConfig` | `@selectDatapoint` | `#data-label`, `#title` | ❌ | ✅ |
361+
| `VueUiSparkStackbar` | `VueUiSparkStackbarDatasetItem[]` | `VueUiSparkStackbarConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
362+
| `VueUiSparkHistogram` | `VueUiSparkHistogramDatasetItem[]` | `VueUiSparkHistogramConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
363+
| `VueUiSparkGauge` | `VueUiSparkGaugeDataset` | `VueUiSparkGaugeConfig` | ❌ | ❌ | ❌ | ✅ |
364+
| `VueUiSparkTrend` | `number[]` | `VueUiSparkTrendConfig` | ❌ | ❌ | ❌ | ✅ |
364365

365366
### Charts
366367

@@ -404,11 +405,12 @@ From the dataset you pass into the props, this component will produce the most a
404405

405406
### Data tables
406407

407-
| Name | dataset type | config type | emits / exposed methods | slots | themes |
408-
| --------------------- | ---------------------------------- | --------------------------- | --------------------------------------------- | --------------------------------------------------------------- | ------ |
409-
| `VueUiTable` | `VueUiTableDataset` | `VueUiTableConfig` | ❌ | ❌ | ❌ |
410-
| `VueUiTableHeatmap` | `VueUiTableHeatmapDatasetItem[]` | `VueUiTableHeatmapConfig` | `generatePdf`, `generateCsv`, `generateImage` | `#caption`, `#rowTitle`, `#cell`, `#sum`, `#average`, `#median` | ✅ |
411-
| `VueUiTableSparkline` | `VueUiTableSparklineDatasetItem[]` | `VueUiTableSparklineConfig` | `generatePdf`, `generateCsv`, `generateImage` | ❌ | ✅ |
408+
| Name | dataset type | config type | emits / exposed methods | slots | themes |
409+
| --------------------- | ---------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------ |
410+
| `VueUiTable` | `VueUiTableDataset` | `VueUiTableConfig` | ❌ | ❌ | ❌ |
411+
| `VueUiTableHeatmap` | `VueUiTableHeatmapDatasetItem[]` | `VueUiTableHeatmapConfig` | `generatePdf`, `generateCsv`, `generateImage` | `#caption`, `#rowTitle`, `#cell`, `#sum`, `#average`, `#median` | ✅ |
412+
| `VueUiTableSparkline` | `VueUiTableSparklineDatasetItem[]` | `VueUiTableSparklineConfig` | `generatePdf`, `generateCsv`, `generateImage` | ❌ | ✅ |
413+
| `VueUiCarouselTable` | `VueUiCarouselTableDataset` | `VueUiCarouselTableConfig` | `generatePdf`, `generateImage`, `generateCsv`, `toggleAnimation`, `pauseAnimation`, `resumeAnimation` | `#caption`, `#th`, `#td` | ❌ |
412414

413415
### Rating
414416

@@ -497,6 +499,7 @@ User options actions available per chart:
497499
| VueUi3dBar | optionPdf, optionImg, optionCsv, optionTable, optionFullscreen |
498500
| VueUiAgePyramid | optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen |
499501
| VueUiCandlestick | optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen |
502+
| VueUiCarouselTable | optionPdf, optionImg, optionCsv, optionAnimation, optionFullscreen |
500503
| VueUiChestnut | optionPdf, optionImg, optionCsv, optionTable, optionFullscreen |
501504
| VueUiDonut | optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen |
502505
| VueUiDonutEvolution | optionPdf, optionImg, optionCsv, optionTable, optionFullscreen |
@@ -581,6 +584,7 @@ However the folowing charts can be made fully responsive, making them better to
581584
| VueUi3dBar | - |
582585
| VueUiAgePyramid | ✅ |
583586
| VueUiCandlestick | ✅ |
587+
| VueUiCarouselTable | - |
584588
| VueUiChestnut | - |
585589
| VueUiDonut | ✅ |
586590
| VueUiDonutEvolution | - |

‎documentation/installation.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,14 @@ From the dataset you pass into the props, this component will produce the most a
129129

130130
### Mini charts
131131

132-
| Name | dataset type | config type | emits / exposed methods | slots | custom tooltip | themes |
133-
| --------------------- | ---------------------------------- | --------------------------- | ----------------------- | --------------------------- | -------------- | ------ |
134-
| `VueUiSparkline` | `VueUiSparklineDatasetItem[]` | `VueUiSparklineConfig` | `@selectDatapoint` | `#svg`, `#before` | ❌ | ✅ |
135-
| `VueUiSparkbar` | `VueUiSparkbarDatasetItem[]` | `VueUiSparkbarConfig` | `@selectDatapoint` | `#data-label`, `#title` | ❌ | ✅ |
136-
| `VueUiSparkStackbar` | `VueUiSparkStackbarDatasetItem[]` | `VueUiSparkStackbarConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
137-
| `VueUiSparkHistogram` | `VueUiSparkHistogramDatasetItem[]` | `VueUiSparkHistogramConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
138-
| `VueUiSparkGauge` | `VueUiSparkGaugeDataset` | `VueUiSparkGaugeConfig` | ❌ | ❌ | ❌ | ✅ |
139-
| `VueUiSparkTrend` | `number[]` | `VueUiSparkTrendConfig` | ❌ | ❌ | ❌ | ✅ |
132+
| Name | dataset type | config type | emits / exposed methods | slots | custom tooltip | themes |
133+
| --------------------- | ---------------------------------- | --------------------------- | ----------------------- | ----------------------- | -------------- | ------ |
134+
| `VueUiSparkline` | `VueUiSparklineDatasetItem[]` | `VueUiSparklineConfig` | `@selectDatapoint` | `#svg`, `#before` | ❌ | ✅ |
135+
| `VueUiSparkbar` | `VueUiSparkbarDatasetItem[]` | `VueUiSparkbarConfig` | `@selectDatapoint` | `#data-label`, `#title` | ❌ | ✅ |
136+
| `VueUiSparkStackbar` | `VueUiSparkStackbarDatasetItem[]` | `VueUiSparkStackbarConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
137+
| `VueUiSparkHistogram` | `VueUiSparkHistogramDatasetItem[]` | `VueUiSparkHistogramConfig` | `@selectDatapoint` | ❌ | ❌ | ✅ |
138+
| `VueUiSparkGauge` | `VueUiSparkGaugeDataset` | `VueUiSparkGaugeConfig` | ❌ | ❌ | ❌ | ✅ |
139+
| `VueUiSparkTrend` | `number[]` | `VueUiSparkTrendConfig` | ❌ | ❌ | ❌ | ✅ |
140140

141141
### Charts
142142

@@ -180,11 +180,12 @@ From the dataset you pass into the props, this component will produce the most a
180180

181181
### Data tables
182182

183-
| Name | dataset type | config type | emits / exposed methods | slots |
184-
| --------------------- | ---------------------------------- | --------------------------- | --------------------------------------------- | --------------------------------------------------------------- |
185-
| `VueUiTable` | `VueUiTableDataset` | `VueUiTableConfig` | ❌ | ❌ |
186-
| `VueUiTableHeatmap` | `VueUiTableHeatmapDatasetItem[]` | `VueUiTableHeatmapConfig` | `generatePdf`, `generateCsv`, `generateImage` | `#caption`, `#rowTitle`, `#cell`, `#sum`, `#average`, `#median` |
187-
| `VueUiTableSparkline` | `VueUiTableSparklineDatasetItem[]` | `VueUiTableSparklineConfig` | `generatePdf`, `generateCsv`, `generateImage` | ❌ |
183+
| Name | dataset type | config type | emits / exposed methods | slots |
184+
| --------------------- | ---------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --- |
185+
| `VueUiTable` | `VueUiTableDataset` | `VueUiTableConfig` | ❌ | ❌ |
186+
| `VueUiTableHeatmap` | `VueUiTableHeatmapDatasetItem[]` | `VueUiTableHeatmapConfig` | `generatePdf`, `generateCsv`, `generateImage` | `#caption`, `#rowTitle`, `#cell`, `#sum`, `#average`, `#median` |
187+
| `VueUiTableSparkline` | `VueUiTableSparklineDatasetItem[]` | `VueUiTableSparklineConfig` | `generatePdf`, `generateCsv`, `generateImage` | ❌ |
188+
| `VueUiCarouselTable` | `VueUiCarouselTableDataset` | `VueUiCarouselTableConfig` | `generatePdf`, `generateImage`, `generateCsv`, `toggleAnimation`, `pauseAnimation`, `resumeAnimation` | `#caption`, `#th`, `#td` | ❌ |
188189

189190
### Rating
190191

0 commit comments

Comments
 (0)