# piecon

**Repository Path**: mirrors_defunctzombie/piecon

## Basic Information

- **Project Name**: piecon
- **Description**: A tiny javascript library for generating progress pie charts in your favicon.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-02-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Piecon

Pie charts in your favicon!

A tiny javascript library for dynamically generating progress pie charts in your favicons.

<p align="center"><img src="https://github.com/lipka/piecon/blob/master/example/screenshot.png?raw=true"></p>

[Interactive Demo](http://tryme.jitsu.com/shtylman/piecon)

## Documentation

### Basic usage

```javascript
var Piecon = require('piecon');

var count = 0;
Piecon.setOptions({fallback: 'force'});
var i = setInterval(function(){
  if (++count > 100) {
    // clears the icon
    Piecon.reset();
    clearInterval(i);
    return false;
  }

  // this is what sets the actual progress count
  Piecon.setProgress(count);
}, 250);

'check out the favicon' // =>
```

### Options

```javascript
Piecon.setOptions({
  color: '#ff0084', // Pie chart color
  background: '#bbb', // Empty pie chart color
  shadow: '#fff', // Outer ring color
  fallback: false // Toggles displaying percentage in the title bar (possible values - true, false, 'force')
});
```

### Browser Support

Piecon has been tested to work completely in the following browsers (older versions may be supported, but haven't been tested):

* Chrome 15+
* Firefox 9+
* Opera 11+

Currently the library falls back to title updates for the following browsers:

* Internet Explorer 9
* Safari 5+

## License

Licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).

## Credits

Piecon was inspired by [Tinycon](https://github.com/tommoor/tinycon).

## An Lipka project

Made by yours truly - [@lipka](https://github.com/lipka).