https://github.com/sean-perkins/nativescript-confettiview

NativeScript Confetti View.
https://github.com/sean-perkins/nativescript-confettiview

confetti confetti-view nativescript nativescript-plugin

Last synced: about 1 month ago
JSON representation

NativeScript Confetti View.

• Host: GitHub
• URL: https://github.com/sean-perkins/nativescript-confettiview
• Owner: sean-perkins
• License: other
• Created: 2016-08-25T02:27:42.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-07-27T11:55:55.000Z (over 6 years ago)
• Last Synced: 2024-12-25T08:06:08.137Z (about 2 months ago)
• Topics: confetti, confetti-view, nativescript, nativescript-plugin
• Language: TypeScript
• Size: 2.14 MB
• Stars: 7
• Watchers: 5
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NativeScript ConfettiView Plugin

[![npm](https://img.shields.io/npm/v/nativescript-confettiview.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/nativescript-confettiview)

[![npm](https://img.shields.io/npm/dt/nativescript-confettiview.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/nativescript-confettiview)

A NativeScript plugin to create an animated confetti view on iOS and Android.

## Getting Started

* `npm install nativescript-confettiview`

* Import the `ConfettiView` into your page and start confetti!

```

import {Observable} from 'data/observable';

import {ConfettiView} from 'nativescript-confettiview';

export class HelloWorldModel extends Observable {

  private confettiView: any;

  constructor() {

    super();

    this.confettiView = new ConfettiView();

    this.confettiView.startConfetti();

  }

  public stopConfetti() {

    this.confettiView.stopConfetti();

  }

  public startConfetti() {

    this.confettiView.startConfetti();

  }

}

```

_Note_: On first run, you may see a console log regarding an incorrect local file path. Let the install finish and you will notice the `package.json` will reflect your local file path to the plugin.

### Available Functions

|Call Signature|Default|

|---|---|

|intensity(number)|0.5|

|colors(array)|UIColor[]|

|startConfetti()| |

|stopConfetti()| |

## Example

![Image](http://g.recordit.co/jT65B4NaqO.gif)

## Credits

* https://github.com/sudeepag/SAConfettiView for the original Pod

* https://github.com/NathanWalker/SAConfettiView Nathan Walker for the upgrades to the Pod and this plugin