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.
If you like the project, don't forget to put star 🌟.
Donate to:
- ETH address: 0x5d1d84d7d03016c505720e05f689cc49d77ebcb2
or
- Solana: 6gDFAxgXeoYDmHRDRmGSs88zM69EiBqxjUy4o8GeyjAP
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 Confetti_SwiftUI into your Xcode project using Xcode 12, specify it in File > Swift Packages > Add Package Dependency...:
https://github.com/afern247/Confetti_SwiftUI.git, :branch="main"
If you prefer not to use any of dependency managers, you can integrate Confetti_SwiftUI into your project manually. Put Sources/Confetti_SwiftUI folder in your Xcode project. Make sure to enable Copy items if needed and Create groups.
- iOS 17.0+ | macOS 14+ | tvOS 17+ | watchOS 10+
- Swift 6.0+
First, add import Confetti_SwiftUI on every swift file you would like to use it. Define a integer as a state variable which is responsible for triggering the animation. Any change to that variable will span a new animation (increment and decrement).
import SwiftUI
import Confetti_SwiftUI
struct ContentView: View {
@State private var counter: Int = 0
var body: some View {
Button("🎉") {
counter += 1
}
.confettiCannon(counter: $counter)
}
}| parameter | type | description | default |
|---|---|---|---|
| counter | Binding | 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 |
.confettiCannon(counter: $counter, colors: [.red, .black], confettiSize: 20)
.confettiCannon(counter: $counter, repetitions: 3, repetitionInterval: 0.7)
.confettiCannon(counter: $counter, num: 50, openingAngle: Angle(degrees: 0), closingAngle: Angle(degrees: 360), radius: 200)
.confettiCannon(counter: $counter, confettis: [.text("❤️"), .text("💙"), .text("💚"), .text("🧡")])
.confettiCannon(counter: $counter, num:1, confettis: [.text("💩")], confettiSize: 20, repetitions: 100, repetitionInterval: 0.1)
.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)All issue reports, feature requests, pull requests and GitHub stars are welcomed and much appreciated.
Arturo Fernandez Marco
Confetti_SwiftUI is available under the MIT license. See the LICENSE file for more info.
The following projects have integrated Confetti_SwiftUI in their App.
- Road2Crypto available on the AppStore