0.0.3 • Published 2 years ago

radial-progress-vue3 v0.0.3

Weekly downloads
-
License
-
Repository
github
Last release
2 years ago

radial-progress-vue3

A simple, highly customizable, and easy to use radial progress bar.

npm

Features

  • can be clockwise or counter-clockwise
  • colors can be customized

Installation and usage


npm install radial-progress-vue3

You can register it globally like this:

import { createApp } from "vue";
import App from "./App.vue";
import radialProgessVue3 from "radial-progress-vue3";

const app = createApp(App);

app.component("radial-progress-vue3", radialProgessVue3);

Alternatively, you can register it locally:

<!-- your-component.vue -->

<template>
  <radial-progress-vue3
    :percent="50"
    :stroke-width="10"
    :stroke-color="'#ff0000'"
    :fill-color="'#00ff00'"
  ></radial-progress-vue3>
</template>

<script>
import { defineComponent } from "vue";

import radialProgessVue3 from "radial-progress-vue3";

export default defineComponent({
  components: {
    radialProgessVue3,
  },
});
</script>

Browser with cdn

<script src="https://unpkg.com/vue@3.0.0"></script>

<script src="https://unpkg.com/radial-progress-vue3@latest/dist/radial-progress-vue3.min.js"></script>
const { createApp } = Vue;

const App = {
  // component code
};

const app = createApp(App);

app.component("radial-progress-vue3", radialProgessVue3);
app.mount("#app");

You can customize the component by passing the following props:

Props

PropDescriptionTypeDefault
percentThis is the percentage of the progressNumber42
widthThe width & height of the viewBoxNumber80
strokeWidthThis is the width of the stroke (like a border)Number6
strokeColorThis is the color of the stroke (can be rgb, hsl, hex, rgba)String#2e5090
innerStrokeColorThis is the color of the innerStroke (can be rgb, hsl, hex, rgba)String#ffaadd
fillColorThis is the background color of the component (can be rgb, hsl, hex, rgba)String#E6E6FA
roundedStrokeThis determines if the stroke has rounded edges or flat edgesBooleanfalse
showTextThis determines whether to show the progress in a textBooleantrue
textColorColor of the text (if showText is true), (can be rgb, hsl, hex, rgba)String#222222
fontWeightfont weight of the text (if showText is true)String Or Number700
fontSizefont size of the text (if showText is true) , it is in pixelsNumber12
showPercentSymbolThis determines if % is show in the textBooleantrue
clockWiseThis determines if the progress is clockwise or counter-clockwiseBooleantrue