https://github.com/recordevolution/widget-doughnut
Show pies and doughnut Charts
https://github.com/recordevolution/widget-doughnut
Last synced: 2 months ago
JSON representation
Show pies and doughnut Charts
- Host: GitHub
- URL: https://github.com/recordevolution/widget-doughnut
- Owner: RecordEvolution
- Created: 2023-11-14T12:44:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-30T16:26:57.000Z (3 months ago)
- Last Synced: 2026-01-03T11:26:02.574Z (3 months ago)
- Language: TypeScript
- Size: 688 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# \
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i widget-doughnut
```
## Usage
```html
import 'widget-doughnut/widget-doughnut.js';
```
## Expected data format
The following format represents the available data :
```js
data: {
settings: {
title: string,
subTitle: string,
minDoughnut: number,
maxDoughnut: number,
style: {
needleColor: string,
sections: number,
backgroundColor: string[]
}
}
doughnutValue: Number
}
```
## Interfaces
```ts
interface InputData {
settings: Settings
doughnutValue: number
}
```
```ts
interface Settings {
title: string,
subTitle: string,
minDoughnut: number,
maxDoughnut: number,
style: Style
}
```
```ts
interface Style {
needleColor: string,
sections: number,
backgroundColor: string[]
}
```
## Style options
The following options are available for styling the doughnut graph.
The `sections` option splits the doughnut area into by default three same sized sections. Therefore three different colors can be provided to the `backgroundColor` by default.
```
interface Style {
needleColor: string,
sections: number,
backgroundColor: string[]
}
```
## Linting and formatting
To scan the project for linting and formatting errors, run
```bash
npm run lint
```
To automatically fix linting and formatting errors, run
```bash
npm run format
```
## Tooling configs
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
## Local Demo with `web-dev-server`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`