SAConfettiView

It's raining confetti! SAConfettiView is the easiest way to add fun, multi-colored confetti to your application and make users feel rewarded. Written in Swift, SAConfettiView is a subclass of UIView and is highly customizable. From various types and colors of confetti to different levels of intensity, you can make the confetti as fancy as you want.

Installation

SAConfettiView is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "SAConfettiView"

And then run:

$ pod install

Manual Installation

To manually install SAConfettiView, simply add SAConfettiView.swift to your project.

Usage

Creating a SAConfettiView is the same as creating a UIView:

let confettiView = SAConfettiView(frame: self.view.bounds)

Don't forget to add the subview!

self.view.addSubview(confettiView)

Types

Pick one of the preconfigured types of confetti with the .type property, or create your own by providing a custom image. This property defaults to the .Confetti type.

.Confetti

confettiView.type = .Confetti

.Triangle

confettiView.type = .Triangle

.Star

confettiView.type = .Star

.Diamond

confettiView.type = .Diamond

.Image

confettiView.type = .Image(UIImage(named: "smiley"))

Colors

Set the colors of the confetti with the .colors property. This property has a default value of multiple colors.

confettiView.colors = [UIColor.redColor(), UIColor.greenColor(), UIColor.blueColor()]

Intensity

The intensity refers to how many particles are generated and how quickly they fall. Set the intensity of the confetti with the .intensity property by passing in a value between 0 and 1. The default intensity is 0.5.

confettiView.intensity = 0.75

Starting

To start the confetti, use

confettiView.startConfetti()

Stopping

To stop the confetti, use

confettiView.stopConfetti()

Status

To check if the confetti is active and currently being displayed, use

confettiView.isActive()

Returns true if it is being displayed, and false if it is not.

Change Log

1.0.8

• Add isActive() method to determine if the confetti is currently active Shakarang #9

1.0.7

• Use view's width property instead of center to fix bug in UIScrollView debug29 #4

1.0.6

• Prevent error when calling .stopConfetti() before .startConfetti() ahmads #7

1.0.5

• Add Storyboard support SlaunchaMan #1

1.0.4

• Replace .Custom with .Image(UIImage) for easier customization of confetti image gmertk #2

License

Copyright (c) 2015 Sudeep Agarwal

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.