https://github.com/component/progress-notification

Progress indication in a notification (upload status etc)
https://github.com/component/progress-notification

Last synced: 13 days ago
JSON representation

Progress indication in a notification (upload status etc)

• Host: GitHub
• URL: https://github.com/component/progress-notification
• Owner: component
• Created: 2012-09-07T18:46:41.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-10-09T23:40:38.000Z (about 11 years ago)
• Last Synced: 2024-05-08T17:07:21.325Z (8 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 7
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# ProgressNotification

  Progress notification component with a clean slate to build off of.

  ![progress notification component](http://f.cl.ly/items/0R0k131Q41452x1D303u/Screen%20Shot%202012-09-07%20at%2011.30.02%20AM.png)

## Installation

```

$ component install component/progress-notification

```

## Features

  - all the features of [notification](http://github.com/component/notification)

## Example

```js

var notify = require('progress-notification');

var progress = notify('Uploading maru.png');

var n = 0;

setInterval(function(){

  progress.update(n++);

}, 50);

```

## API

### notify(msg)

  Notify with the given `msg` and no title.

### notify(title, msg)

  Notify with the given `msg` and `title`.

### ProgressNotification#update(n)

  Update percentage to `n`.

### ProgressNotification#size(n)

  Update progress indicator size to `n`.

## License

  MIT