README.md

🎊 ConfettiKit

A Swift package for shooting confetti. The implementation is heavily inspired by the blog post Recreating iMessage Confetti by Bryce Bostwick.

📦 Adding the Package

ConfettiKit is distributed using Swift Package Manager. Install ConfettiKit in a project by adding it as a dependency in your Package.swift manifest or through “Package Dependencies” in project settings.

let package = Package(
    dependencies: [
        .package(url: "[email protected]:simonbs/ConfettiKit.git", from: "1.0.0")
    ]
)

🚀 Getting Started

Start by creating an instance of ConfettiView and pass an array of UIImage's when doing so. Make sure to add the view to your view hierarchy.

final class ViewController: UIViewController {
    private let confettiView: ConfettiView = {
        let images: [UIImage] = [...]
        let this = ConfettiView(images: images)
        this.translatesAutoresizingMaskIntoConstraints = false
        return this
    }()

    override func viewDidLoad() {
        super.viewDidLoad()
        view.addSubview(confettiView)
        NSLayoutConstraint.activate([
            confettiView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
            confettiView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
            confettiView.topAnchor.constraint(equalTo: view.topAnchor),
            confettiView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
        ])
    }
}

When you want to shoot confetti, for example in response to a user interaction, call the shoot() function on the confetti view.

confettiView.shoot()

By default, ConfettiView shoots confetti from the top to the bottom, creating the effect shown below.

You may configure it to shoot confetti from the center to the left of the screen.

let images: [UIImage] = [...]
let confettiView = ConfettiView(mode: .centerToLeft, images: images)

This can be used to create the effect shown below.

👨‍💻 Contributing

ConfettiKit was specifically built to be used in my side projects, including Runestone Text Editor and Re: Toot, so its API might be limited. However, pull requests with bug fixes and new features are much appreciated. I'll be happy to review and merge them once they're ready, as long as they align with the vision of ConfettiKit and offer generally useful functionality.

Clone the repository to get started working on the project.

git clone [email protected]:simonbs/ConfettiKit.git