ConfettiSwiftUI

1.0.1

SwiftUI Package for Configurable Confetti Animation πŸŽ‰
simibac/ConfettiSwiftUI

What's New

1.0.1

2022-05-14T13:16:25Z

What's Changed

  • One last confetti physics adjustment by @twhitt14 in #24
  • docs: ✏️ improve code snippets in README for easy copying by @MarcoEidinger in #25
  • Fix crash when app goes to background before animation is complete by @kamaal111 in #23

New Contributors

Full Changelog: 1.0.0...1.0.1

ConfettiSwiftUI

Β Β Β Β Β Β 

Customizable Confetti Animations in SwiftUI

πŸŒ„ Example

πŸ”­ 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 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.

Examples

Color and Size Configuration

.confettiCannon(counter: $counter, colors: [.red, .black], confettiSize: 20)

Repeat Configuration

.confettiCannon(counter: $counter, repetitions: 3, repetitionInterval: 0.7)

Firework Configuration

.confettiCannon(counter: $counter, num: 50, openingAngle: Angle(degrees: 0), closingAngle: Angle(degrees: 360), radius: 200)

Emoji Configuration

.confettiCannon(counter: $counter, confettis: [.text("❀️"), .text("πŸ’™"), .text("πŸ’š"), .text("🧑")])

Endless Configuration

.confettiCannon(counter: $counter, num:1, confettis: [.text("πŸ’©")], confettiSize: 20, repetitions: 100, repetitionInterval: 0.1)

Make-it-Rain Configuration

.confettiCannon(counter: $counter, num:1, confettis: [.text("πŸ’΅"), .text("πŸ’Ά"), .text("πŸ’·"), .text("πŸ’΄")], confettiSize: 30, repetitions: 50, repetitionInterval: 0.1)

πŸ‘¨β€πŸ’» 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.


Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

  • None
Last updated: Mon Jan 30 2023 23:40:24 GMT-0500 (GMT-05:00)