@pioneer-code/pioneer-charts 22.1.0 → 22.1.3
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 +28 -50
- package/fesm2022/pioneer-code-pioneer-charts.mjs +482 -140
- package/fesm2022/pioneer-code-pioneer-charts.mjs.map +1 -1
- package/package.json +1 -1
- package/scss/bar-chart/bar-horizontal-chart/bar-horizontal-chart.component.scss +0 -12
- package/scss/pioneer-charts.scss +10 -3
- package/scss/plot-line-area-chart/plot-line-area-chart.component.scss +0 -12
- package/themes/pioneer-charts.css +6 -3
- package/themes/pioneer-charts.min.css +1 -1
- package/types/pioneer-code-pioneer-charts.d.ts +206 -38
package/README.md
CHANGED
|
@@ -1,21 +1,26 @@
|
|
|
1
1
|
# Pioneer Charts
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/PioneerCode/pioneer-charts/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/@pioneer-code/pioneer-charts)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
Pioneer Charts is an Angular library for building beautiful, customizable, and responsive data visualizations. It leverages [D3.js](https://d3js.org/) for rendering and provides bar, line/area, and pie charts, plus a legend component.
|
|
4
8
|
|
|
5
|
-
|
|
9
|
+
## Documentation
|
|
6
10
|
|
|
7
|
-
|
|
11
|
+
Guides, the API reference, live examples, and theming instructions all live on the docs site:
|
|
8
12
|
|
|
9
|
-
|
|
13
|
+
**https://charts.pioneercode.com**
|
|
10
14
|
|
|
11
15
|
## Features
|
|
12
16
|
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
- Event emitters for user interaction.
|
|
17
|
+
- Bar (vertical and horizontal), line, area, plot, and pie charts, plus a legend.
|
|
18
|
+
- Beautiful default theme, customizable via CSS or by overriding the source Sass variables.
|
|
16
19
|
- Strongly typed configuration contracts.
|
|
20
|
+
- Outputs for user interaction (bar, slice, dot, and legend clicks).
|
|
21
|
+
- Custom tooltips via a projected template.
|
|
17
22
|
- Standalone components — no `NgModule`s required.
|
|
18
|
-
-
|
|
23
|
+
- Charts automatically re-render when their container resizes.
|
|
19
24
|
- Zoneless-compatible.
|
|
20
25
|
- Open source and actively maintained.
|
|
21
26
|
|
|
@@ -24,61 +29,34 @@ Pioneer Charts is an Angular library for building beautiful, customizable, and r
|
|
|
24
29
|
- Angular ^22.0.0
|
|
25
30
|
- D3 ^7.9.0
|
|
26
31
|
|
|
27
|
-
##
|
|
28
|
-
|
|
29
|
-
### 1. Install Pioneer Charts
|
|
32
|
+
## Installation
|
|
30
33
|
|
|
31
34
|
```bash
|
|
32
35
|
npm install --save @pioneer-code/pioneer-charts
|
|
33
36
|
```
|
|
34
37
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
Pioneer Charts components are standalone — import the ones you need directly in your component:
|
|
38
|
-
|
|
39
|
-
```typescript
|
|
40
|
-
import { PcacBarVerticalChartComponent, PcacLineChart } from '@pioneer-code/pioneer-charts';
|
|
41
|
-
|
|
42
|
-
@Component({
|
|
43
|
-
selector: 'app-dashboard',
|
|
44
|
-
imports: [
|
|
45
|
-
PcacBarVerticalChartComponent,
|
|
46
|
-
PcacLineChart,
|
|
47
|
-
// ...other components
|
|
48
|
-
],
|
|
49
|
-
templateUrl: './dashboard.component.html',
|
|
50
|
-
})
|
|
51
|
-
export class DashboardComponent { }
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### 3. Import Styles
|
|
38
|
+
Then follow the [Introduction](https://charts.pioneercode.com) on the docs site to import the components and theme into your app.
|
|
55
39
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
```scss
|
|
59
|
-
@import "@pioneer-code/pioneer-charts/themes/pioneer-charts.css";
|
|
60
|
-
```
|
|
40
|
+
## Contributing
|
|
61
41
|
|
|
62
|
-
|
|
42
|
+
Bug reports, feature requests, and pull requests are welcome — see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the guidelines.
|
|
63
43
|
|
|
64
|
-
|
|
44
|
+
This repository is an Angular workspace containing the library (`projects/pioneer-charts`) and the docs site (`projects/pioneer-charts-docs`). To work on it locally:
|
|
65
45
|
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
)
|
|
46
|
+
```bash
|
|
47
|
+
npm ci
|
|
48
|
+
npm start # serve the docs site, which consumes the library
|
|
49
|
+
npm run lint
|
|
50
|
+
npm test # library unit tests (vitest)
|
|
51
|
+
npm run build:lib # build the publishable package into dist/pioneer-charts
|
|
71
52
|
```
|
|
72
53
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
## Usage Example
|
|
54
|
+
Every push and pull request to `main` is verified by [GitHub Actions](https://github.com/PioneerCode/pioneer-charts/actions) (lint, tests, and both builds).
|
|
76
55
|
|
|
77
|
-
|
|
78
|
-
<pcac-bar-vertical-chart [config]="barVerticalChartConfig" (barClicked)="onBarClicked($event)"></pcac-bar-vertical-chart>
|
|
79
|
-
```
|
|
56
|
+
### Releasing
|
|
80
57
|
|
|
58
|
+
Releases are published to npm by the [Publish workflow](.github/workflows/publish.yml), never from a local machine. Bumping `version` in `projects/pioneer-charts/package.json` on `main` runs the full test suite and then waits for a maintainer to approve the deployment; once approved, the tested build is published to npm and a matching `v<version>` tag and GitHub Release are created.
|
|
81
59
|
|
|
82
60
|
## License
|
|
83
61
|
|
|
84
|
-
MIT © [Chad Ramos & Pioneer Code](LICENSE)
|
|
62
|
+
MIT © [Chad Ramos & Pioneer Code](LICENSE)
|