Skip to content

Latest commit

 

History

History
142 lines (116 loc) · 5.9 KB

README.md

File metadata and controls

142 lines (116 loc) · 5.9 KB
Raw

percircle

CSS percentage circle built with jQuery

Demo

Maintainers Wanted!

Custom circles

<div id="custom" class="yellow big"></div> 
<div id="clock" class="purple big"></div>
<div id="custom-color" class="big"></div>
<div id="countdown" class="big"></div>

Custom

Update value dynamically

Declare your html

<div class="clearfix">
    <div id="redBecomesBlue" class="red big"></div>
</div>
<a href="javascript:void(0);" id="changeCircle">Fill Circle to 95.5</a>

Big blue circle

Handle the click in the script

$(document).ready(function(){
    $("#redBecomesBlue").percircle({percent: 25,text: "25"});
    $('#changeCircle').click(function(e){
        e.preventDefault();
        changeCircle();
    });
});

function changeCircle(){
    $("#redBecomesBlue").percircle({text:''});
    $("#redBecomesBlue").percircle({
        text: "",
        percent: 95.5,
        progressBarColor: "#1252c0"
    });
}

Usage

1. Load the module to your page

<!DOCTYPE HTML>
<html>
<head>
  <script src="../bower_components/jquery/dist/jquery.min.js"></script>
  <script type="text/javascript" src="../dist/js/percircle.js"></script>
  <link rel="stylesheet" href="../dist/css/percircle.css">
</head>
</html>

2. Define the circle objects

Big blue circle marked with a percent of 50%:

<div id="bluecircle" data-percent="17" class="big">
</div>

Big blue circle

3. Let the script get the job done

<script type="text/javascript">
    $(function(){
        $("#bluecircle").percircle();
    });
</script>

npm

Percircle is registered as an npm package and can be installed with:

npm install percircle

Bower

Percircle is also registered as a Bower package, so it can be pulled down using:

bower install percircle

Options

Option Description via configuration object via data attribute Default
Animate Whether to animate the progress bar on load (or view) { animate: "true" } data-animate="true" true
Clock Display a clock in the percircle { perclock: true} data-perclock="true" false
Countdown Display a countdown in the percircle { perdown: true} data-perdown="true" false
Countdown seconds The amount of seconds to countdown. { secs: 15 } data-secs="15" -
Countdown time up text Text to display when countdown has completed. { timeUpText: 'Complete!' } data-timeUpText="Complete!" -
Countdown reset on click Whether to reset the countdown on percircle click { reset: true } data-reset="true" false
Display text at zero Whether to display text even when the percentage is 0 { displayTextAtZero: true } n/a false
Progress bar color The colour of the progress bar { progressBarColor: '#6188ff' } data-progressBarColor="#6188ff" empty (inherit from class or css)
Text Text to display inside the percirle { percent: 65 } data-percent="65" undefined (use percent value)

Building Percircle Locally

If you'd like to run the development version, percircle uses Webpack to handle build tasks like bundling and minification. First, clone the repository, then run:

# Install the dependencies
npm install

# Launch webpack dev server, whilst watching for any js or css changes 
npm start

Contribute

Contributions are more than welcome. Please ensure that you spent some time reading our Contributor's Guidelines.

Contributors

teobais chrisahardie chris--jones tinglu tranthanhhoa ahmadajmi Sylphony yireo miller-kevin
teobais chrisahardie chris--jones tinglu tranthanhhoa ahmadajmi Sylphony yireo miller-kevin

Credits

The original project was created from Andre Firchow and as I didn't find any similar here, I uploaded it.

However, the project loaded all the css transformations, in the percircle.css file. Now, it uses jQuery to apply repeated functionality where needed.