Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.83 KB

README.md

File metadata and controls

76 lines (50 loc) · 2.83 KB

Burst 🎆

Burst is a Swift and simple way to make elements in your iOS app burst.

Back in the day, Facebook Paper popularized a firework burst effect using CAEmitterLayers with buttons.

This library provides a firework effect using CAEmitterLayers contained in an easy-to-use customizable component, written in Swift.

If you enjoy this library, you may also like another CAEmitterLayer project, Twinkle.

Build Status Pod Version Swift Version GitHub license

  • 5.0 - Target your Podfile to the latest release or master

Quick Start

Burst is available and recommended for installation using the Cocoa dependency manager CocoaPods. You can also simply copy the Burst.swift file into your Xcode project.

# CocoaPods
pod "Burst", "~> 0.1.2"

# Carthage
github "piemonte/Burst" ~> 0.1.2

# SwiftPM
let package = Package(
    dependencies: [
        .Package(url: "https://github.com/piemonte/Burst", majorVersion: 0)
    ]
)

Usage

The sample project provides an example of how to integrate Burst, otherwise you can follow this example.

   import Burst
// ...
    let button: BurstButton = BurstButton(frame: CGRect(x: 0, y: 0, width: 100, height: 100))
// ...

extension ViewController {

    @objc func handleButton(_ button: BurstButton) {
        button.isSelected = !button.isSelected
    }
}

Community

Resources

License

Burst is available under the MIT license, see the LICENSE file for more information.