https://github.com/superthinking/milestone-progress-bar

Just a progress bar with milestones
https://github.com/superthinking/milestone-progress-bar

milestone milestone-progress-bar npm npm-package react-js react-native

Last synced: 29 days ago
JSON representation

Just a progress bar with milestones

• Host: GitHub
• URL: https://github.com/superthinking/milestone-progress-bar
• Owner: SuperThinking
• License: mit
• Created: 2020-09-08T13:11:21.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-09T14:52:42.000Z (about 4 years ago)
• Last Synced: 2024-10-10T06:06:36.923Z (29 days ago)
• Topics: milestone, milestone-progress-bar, npm, npm-package, react-js, react-native
• Language: TypeScript
• Homepage:
• Size: 82 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Milestone Progress Bar

![](images/ProgressBarExample.gif)

Check out this package at [NPM](https://www.npmjs.com/package/milestone-progress-bar)

How to install:

    npm install milestone-progress-bar

How to import:

    import {MilestoneProgressBar} from 'milestone-progress-bar';

An example of usage:

    

Requires 2 props:

1) `totalMilestones` : `number` : Total number of milestones to complete the progress

2) `progress` : `list of objects` (object must have `completed` and `total`)  : `completed` must match `total` for a milestone to be marked complete. Do not increment value of `completed` of an object before marking the previous object fully complete.