🎊 Fancy confetti effects in Swift
Switch branches/tags
Clone or download
Latest commit 1429d87 Aug 23, 2018

README.md

Cheers

Version Carthage Compatible License Platform Swift

Usage

Basic

// Create the view
let cheerView = CheerView()
view.addSubview(cheerView)

// Configure
cheerView.config.particle = .confetti(allowedShapes: Particle.ConfettiShape.all)

// Start
cheerView.start()

// Stop
cheerView.stop()

Configuration

Configuration will be applied at the next start

// Use predefined confetti
cheerView.config.particle = .confetti(allowedShapes: Particle.ConfettiShape.all)

// Use texts
let string = NSAttributedString(string: "❤️", attributes: [
  NSFontAttributeName: UIFont.systemFont(ofSize: 15)
])
cheerView.config.particle = .text([string])

// Use images
let image = UIImage(named: "star")
cheerView.config.particle = .image([image])

// Change colors
cheerView.config.colors = [UIColor.red, UIColor.green]

// Customize cells
cheerView.config.customize = { cells in

}

Installation

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

pod 'Cheers'

Cheers is also available through Carthage. To install just write into your Cartfile:

github "hyperoslo/Cheers"

Cheers can also be installed manually. Just download and drop Sources folders in your project.

Author

Hyper Interaktiv AS, ios@hyper.no

Credit

Contributing

We would love you to contribute to Cheers, check the CONTRIBUTING file for more info.

License

Cheers is available under the MIT license. See the LICENSE file for more info.