@pioneer-code/pioneer-charts 22.1.1 → 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 CHANGED
@@ -1,21 +1,26 @@
1
1
  # Pioneer Charts
2
2
 
3
- ## Documentation
3
+ [![CI](https://github.com/PioneerCode/pioneer-charts/actions/workflows/ci.yml/badge.svg)](https://github.com/PioneerCode/pioneer-charts/actions/workflows/ci.yml)
4
+ [![npm](https://img.shields.io/npm/v/@pioneer-code/pioneer-charts)](https://www.npmjs.com/package/@pioneer-code/pioneer-charts)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](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
- See the [docs site](https://charts.pioneercode.com) for guides, API reference, and examples.
9
+ ## Documentation
6
10
 
7
- ## Overview
11
+ Guides, the API reference, live examples, and theming instructions all live on the docs site:
8
12
 
9
- Pioneer Charts is an Angular library for building beautiful, customizable, and responsive data visualizations. It leverages [D3.js](https://d3js.org/) for rendering and supports a variety of chart types including bar, line/area, pie, and more.
13
+ **https://charts.pioneercode.com**
10
14
 
11
15
  ## Features
12
16
 
13
- - Beautiful default theme, easily customizable via SCSS.
14
- - Supports Bar, Line/Area, Pie charts, and Legends.
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
- - Automatic chart resizing as its container's size changes.
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
- ## Quick Start
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
- ### 2. Import Components
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
- Add the Pioneer Charts CSS to your global styles:
57
-
58
- ```scss
59
- @import "@pioneer-code/pioneer-charts/themes/pioneer-charts.css";
60
- ```
40
+ ## Contributing
61
41
 
62
- #### Customizing the theme
42
+ Bug reports, feature requests, and pull requests are welcome — see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the guidelines.
63
43
 
64
- Prefer a Sass build instead? Import the source directly and override any of its color variables:
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
- ```scss
67
- @use "@pioneer-code/pioneer-charts/scss/pioneer-charts" with (
68
- $gray-800: #1a1a2e, // tooltip background
69
- $white: #f4f4f8, // tooltip text
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
- See `@pioneer-code/pioneer-charts/scss/core/theme/imports.scss` for the full list of overridable variables.
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
- ```html
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)