1.1.2 • Published 3 years ago

vue-progress-circle v1.1.2

Weekly downloads
126
License
-
Repository
github
Last release
3 years ago

vue-progress-circle

npm npm

Circle progress bar component

Live demo here

Global use

  • npm install
npm install --save vue-progress-circle
  • import components
import { ProgressCircle } from 'vue-progress-circle'
  • declare use or imported components in your vue script
export default {
    components: { ProgressCircle },
    methods: ...
}
  • Use components as described below

Components

Progress circle

<progress-circle completed-steps="5" total-steps="10"></progress-circle>
<progress-circle :diameter="cp_diameter"
                 :completed-steps="cp_completedSteps"
                 :circle-color="cp_circleColor"
                 :start-color="cp_startColor"
                 :stop-color="cp_stopColor"
                 :circle-width="cp_circleWidth"
                 :animation-duration="cp_animationDuration"
                 :inner-color="cp_innerColor"
                 :inner-display="cp_innerDisplay"
                 :percent-color="cp_percentColor"
                 :total-steps="cp_totalSteps">
   <p>Total steps: {{ cp_totalSteps }}</p>
   <p>Completed steps: {{ cp_completedSteps }}</p>
</progress-circle>
PropTypeNote
completed-stepsnumberREQUIRED: number of completed steps
total-stepsnumberREQUIRED: number of total steps
diameternumber(px) diameter of circle component (default 100)
circle-colorStringinner circle color (when no progress, default black)
start-colorStringleading color for progress bar (default red)
stop-colorStringtrailing color for progress bar (default blue)
inner-colorStringColor inside the circle (default transparent)
circle-widthnumber(px) circle width (default 10)
animation-durationnumber(ms) duration of animation when progress change (default 1000)
inner-displayStringChange inner circle filling. By default or 'slot', it will use provided slot (or nothing). 'Percent' will display progress percent rounded value
percent-colorStringChange color of progress percent if displayed (see inner-display, default inherit)

BY default, this component provide a slot where you can insert any html code to be displayed inside the circle

Contribution

  • Fork the repository
  • Run npm install
  • You can run npm run dev, site is at http://localhost:8081.
  • Do your stuff
  • When you're done, run npm run build command and commit your work for a pull request.
1.1.2

3 years ago

1.1.0

7 years ago

1.0.0

7 years ago