Awesome
ConfettiSwiftUI
<img src="https://img.shields.io/badge/PLATFORM-IOS%20|%20MACOS-lightgray?style=for-the-badge" /> <img src="https://img.shields.io/badge/LICENSE-MIT-lightgray?style=for-the-badge" /> <img src="https://img.shields.io/badge/MADE WITH-SWIFTUI-orange?style=for-the-badge" />
Customizable Confetti Animations in SwiftUI
<p align="center"> <img src="./Gifs/native_default_iphone.png" width="200" width="480"/> </p>🌄 Example
<p align="center"> <img src="./Gifs/default.gif" width="150" /> <img src="./Gifs/make-it-rain.gif" width="150"/> <img src="./Gifs/explosion.gif" width="150" /> <img src="./Gifs/color.gif" width="150" /> </p>🔭 Overview
This is an open-source library to use with SwiftUI. It allows you to create and customize confetti animations.
- Built with pure SwiftUI.
- Select from default confetti shapes or inject emojis as text.
- Configure the radius and angles of the explosion.
- Trigger animation with one state change multiple times.
🔨Support
If you like the project, don't forget to put star 🌟.
🧭 Navigation
💻 Installation
Swift Package Manager
The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
To integrate ConfettiSwiftUI into your Xcode project using Xcode 12, specify it in File > Swift Packages > Add Package Dependency...:
https://github.com/simibac/ConfettiSwiftUI.git, :branch="master"
Manually
If you prefer not to use any of dependency managers, you can integrate ConfettiSwiftUI into your project manually. Put Sources/ConfettiSwiftUI folder in your Xcode project. Make sure to enable Copy items if needed and Create groups.
🧳 Requirements
- iOS 14.0+ | macOS 11+
- Swift 5+
🛠 Usage
First, add import ConfettiSwiftUI on every swift file you would like to use ConfettiSwiftUI. Define a integer as a state varable which is responsible for triggering the animation. Any change to that variable will span a new animation (increment and decrement).
import ConfettiSwiftUI
import SwiftUI
struct ContentView: View {
@State private var counter: Int = 0
var body: some View {
Button("🎉") {
counter += 1
}
.confettiCannon(counter: $counter)
}
}
Parameters
| parameter | type | description | default |
|---|---|---|---|
| counter | Binding<Int> | on any change of this variable triggers the animation | 0 |
| num | Int | amount of confettis | 20 |
| confettis | [ConfettiType] | list of shapes and text | [.shape(.circle), .shape(.triangle), .shape(.square), .shape(.slimRectangle), .shape(.roundedCross)] |
| colors | [Color] | list of colors applied to the default shapes | [.blue, .red, .green, .yellow, .pink, .purple, .orange] |
| confettiSize | CGFloat | size that confettis and emojis are scaled to | 10.0 |
| rainHeight | CGFloat | vertical distance that confettis pass | 600.0 |
| fadesOut | Bool | size that confettis and emojis are scaled to | true |
| opacity | Double | maximum opacity during the animation | 1.0 |
| openingAngle | Angle | boundary that defines the opening angle in degrees | Angle.degrees(60) |
| closingAngle | Angle | boundary that defines the closing angle in degrees | Angle.degrees(120) |
| radius | CGFloat | explosion radius | 300.0 |
| repetitions | Int | number of repetitions for the explosion | 0 |
| repetitionInterval | Double | duration between the repetitions | 1.0 |
Configurator Application With Live Preview
You can use the configurator app in demo project here to make your desired animation or get inspired by one of the many examples.
<p align="center"> <img src="./Gifs/configurator.png" width="150" /> <img src="./Gifs/examples.png" width="150" /> </p>Examples
Color and Size Configuration
<p align="center"> <img src="./Gifs/color.gif" width="150" /> </p>.confettiCannon(counter: $counter, colors: [.red, .black], confettiSize: 20)
Repeat Configuration
<p align="center"> <img src="./Gifs/repeat.gif" width="150" /> </p>.confettiCannon(counter: $counter, repetitions: 3, repetitionInterval: 0.7)
Firework Configuration
<p align="center"> <img src="./Gifs/explosion.gif" width="150" /> </p>.confettiCannon(counter: $counter, num: 50, openingAngle: Angle(degrees: 0), closingAngle: Angle(degrees: 360), radius: 200)
Emoji Configuration
<p align="center"> <img src="./Gifs/heart.gif" width="150" /> </p>.confettiCannon(counter: $counter, confettis: [.text("❤️"), .text("💙"), .text("💚"), .text("🧡")])
Endless Configuration
<p align="center"> <img src="./Gifs/constant.gif" width="150" /> </p>.confettiCannon(counter: $counter, num:1, confettis: [.text("💩")], confettiSize: 20, repetitions: 100, repetitionInterval: 0.1)
Make-it-Rain Configuration
<p align="center"> <img src="./Gifs/make-it-rain.gif" width="150" /> </p>.confettiCannon(counter: $counter, num:1, confettis: [.text("💵"), .text("💶"), .text("💷"), .text("💴")], confettiSize: 30, repetitions: 50, repetitionInterval: 0.1)
.confettiCannon(counter: $counter8, confettis: [.image("arb"), .image("eth"), .image("btc"), .image("op"), .image("link"), .image("doge")], confettiSize: 20)
👨💻 Contributors
All issue reports, feature requests, pull requests and GitHub stars are welcomed and much appreciated.
✍️ Author
Simon Bachmann
📃 License
ConfettiSwiftUI is available under the MIT license. See the LICENSE file for more info.
📦 Projects
The following projects have integrated ConfettiSwiftUI in their App.
- Basic Code available on the AppStore