0.0.2 • Published 3 years ago

vue-progress-circle-svg v0.0.2

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

🎉 vue-progress-circle-svg 🎉

A simple progress circle svg component made with Vue.js 2.


👩🏻‍💻👨🏻‍💻 Installation

The module is published on npmjs.org.

# 1.
# cd your-project-folder

# 2.
npm i vue-progress-circle-svg

Usage

As component

// In a .vue file
import progressCircle from 'vue-progress-circle-svg/dist/progress-circle.esm';

export default {
  components: {
    progressCircle,
  },
};

Other usages (Coming soon!):

  • Global component + Install;
  • As a global plugin;
  • Dirctly inside your browser;

Props

AttributeTypeDefault valueAbout
valueNumber0@model The value for current progress
sizeNumber24Sets the diameter of the progress circle in pixels
startAngleNumber0Sets the starting sector angle, in radians
minValueNumber0Sets the minimum value needed to normalize the value range
maxValueNumber100Sets the maximum value needed to normalize the value range
svgClassNameString''Sets the svg root tag class name
sectorClassNameString''Sets the sector class name
sectorFillString'#5B85AA'Sets the sector fill
sectorStrokeString'none'Sets the sector stroke
sectorFillRuleString'evenodd'Sets the sector fill rule
borderClassNameString''Sets the border class name
borderFillString'none'Sets the sector fill
borderStrokeString'#414770'Sets the border stroke
svgCustomPropsObject() => {}Binds every property of the passed Object as props/attributes of the svg component
sectorCustomPropsObject() => {}Binds every property of the passed Object as props/attributes of the sector path tag
circleCustomPropsObject() => {}Binds every property of the passed Object as props/attributes of the circle tag

🐞 Issues / 📝 Discussions / 👥 Contribution

This is my first package, and a first step to the OSS world.

Feel free to open issues, make suggest stuff opening a discussion or Contribute.

Thanks for using this component 💘.


🆓 License

MIT License // Copyright (©) 2021-now Gianluca Bianco