Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

vue3-radial-progress

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vue3-radial-progress

A smart and light radial progress bar component for Vue 3.

  • 1.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3.8K
increased by19.82%
Maintainers
1
Weekly downloads
 
Created
Source
Demo
MIT npm version Vulnerabilities

A smart and light radial progress bar component for Vue 3.


The original project it's only available to vue 1 and 2, so i decided rewrite it to vue 3.

Live Demo

🚚 Install

 yarn add vue3-radial-progress  // npm install --save vue3-radial-progress

🚀 Usage

Global

import { createApp } from 'vue';
import RadialProgress from "vue3-radial-progress";

// Your app instance here
const app = createApp(App); 

app.use(RadialProgress);

Local

import RadialProgress from "vue3-radial-progress";

export default {
  components: {
    RadialProgress
  },
};

📌 Examples

<template>
  <radial-progress-bar 
   :diameter="200"
   :completed-steps="completedSteps"
   :total-steps="totalSteps">
    <!-- Your inner content here -->
  </radial-progress-bar>
</template>

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

export default defineComponent({
    setup(){
      const completedSteps = ref(0);
      const totalSteps = ref(10);

      return {
            completedSteps,
            totalSteps
        }
    }
})
</script>

Props

NametypeDefaultdescription
diameternumber200Sets width/diameter of the inner stroke.
totalStepsnumber10Sets the total steps/progress to the end.
completedStepsnumber0Sets the current progress of the inner stroke.
startColorstring'#00C58E'Sets the start color of the inner stroke (gradient).
stopColorstring'#00E0A1'Sets the end color of the inner stroke (gradient).
innerStrokeColorstring'#2F495E'Sets the color of the inner stroke to be applied to the shape.
strokeWidthnumber10Sets the width of the stroke to be applied to the shape. see: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
innerStrokeWidthnumber10Sets the width of the inner stroke to be applied to the shape.
strokeLinecapstring'round'Sets the shape to be used at the end of stroked. see: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
animateSpeednumber1000Sets how long the animation should take to complete one cycle. see: https://www.w3schools.com/cssref/css3_pr_animation-duration.asp
fpsnumber60Sets the frames per seconds to update inner stroke animation.
timingFuncstring'linear'Sets how the animation progresses through the duration of each cycle. see: https://developer.mozilla.org/en-US/docs/Web/CSS/animation-timing-function
isClockwisebooleantrueSets the inner stroke direction.

Slots

NameDescription
defaultSets the default slot inner the radial progress

🔖 License

MIT

Keywords

FAQs

Package last updated on 13 Nov 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc