@density/chart-linear-progress
v0.1.0
Published
Linear Progress chart
Downloads
4
Keywords
Readme
Linear Progress
A simple linear progress bar with determinate state npm
Using this chart
This chart has a single default export. This exported function takes two arguments: a dom element, and an object full of properties. When called, this chart will render the chart inside the given DOM element. See the below example.
import linearProgress from '@density/chart-linear-progress';
// or: const linearProgress = require('@density/chart-linear-progress').default;
const element = document.getElementById('chart-container');
const props = {percentFull: 50};
// Make your chart
const updateData = linearProgress(element);
// Give it new data
updateData(props);
Properties
percentFull
(int, 0-100): How full to show the progress chart.transitionDuration
(int, default=300): Transition duration for when updating thepercentFull
.
In addition, if you'd like to render a chart in a context where the DOM is abstracted away from you, such as a React or Angular app, then check out our companion helper library.
How this chart is structured
.
├── index.js # Contains main chart code. Other javascript files may be present.
├── package.json
├── story.js # Contains a react-storyboard story. Use it to present different states of your chart in the parent project.
└── styles.scss # Contains all chart styles.