base on SwiftUI Package for Configurable Confetti Animation π # 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 π`.
<a href="https://brianmacdonald.github.io/Ethonate/address#0xCBa97323b4cA2fF9330827faF306065da7aA338F">
<img src="https://brianmacdonald.github.io/Ethonate/svg/eth-donate-blue.svg"/>
</a>
<!-- <a href="mailto:
[email protected]"><img src="https://img.shields.io/badge/EMAIL-SIMON-informational?style=for-the-badge&logo=minutemailer&logoColor=white"></a> <a href="https://www.linkedin.com/in/simon-bachmann-73b695151/" target="_blank"><img src="https://img.shields.io/badge/LINKEDIN-informational?style=for-the-badge&logo=linkedin&logoColor=white" ></a> <a href="https://www.paypal.com/donate?business=6H8D2EDR6LBX6&no_recurring=0&item_name=Thanks+for+supporting+open+source+contributions%21¤cy_code=CHF" target="_blank"><img src="https://img.shields.io/badge/Donate-informational?style=for-the-badge&logo=paypal&logoColor=white" ></a> -->
## π§ Navigation
- [π» Installation](#-installation)
- [Swift Package Manager](#swift-package-manager)
- [Manually](#manually)
- [𧳠Requirements](#-requirements)
- [π Usage](#-usage)
- [Parameters](#parameters)
- [Configurator Application With Live Preview](#configurator-application-with-live-preview)
- [Examples](#examples)
- [π¨βπ» Contributors](#-contributors)
- [βοΈ Author](#-author)
- [π License](#-license)
- [π¦ Projects](#-projects)
## π» Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/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...`:
```ogdl
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).
```swift
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](https://github.com/simibac/ConfettiSwiftUIDemo) 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>
```swift
.confettiCannon(counter: $counter, colors: [.red, .black], confettiSize: 20)
```
#### Repeat Configuration
<p align="center">
<img src="./Gifs/repeat.gif" width="150" />
</p>
```swift
.confettiCannon(counter: $counter, repetitions: 3, repetitionInterval: 0.7)
```
#### Firework Configuration
<p align="center">
<img src="./Gifs/explosion.gif" width="150" />
</p>
```swift
.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>
```swift
.confettiCannon(counter: $counter, confettis: [.text("β€οΈ"), .text("π"), .text("π"), .text("π§‘")])
```
#### Endless Configuration
<p align="center">
<img src="./Gifs/constant.gif" width="150" />
</p>
```swift
.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>
```swift
.confettiCannon(counter: $counter, num:1, confettis: [.text("π΅"), .text("πΆ"), .text("π·"), .text("π΄")], confettiSize: 30, repetitions: 50, repetitionInterval: 0.1)
```
<p align="center">
<img src="https://github.com/simibac/ConfettiSwiftUI/assets/15369592/c4c7c28a-c8cc-4d17-bd5c-240ce5cb4dcb" width="150" />
</p>
```swift
.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](https://github.com/simibac/ConfettiSwiftUI/blob/master/LICENSE) file for more info.
## π¦ Projects
The following projects have integrated ConfettiSwiftUI in their App.
- [Basic Code](https://basiccode.de) available on the [AppStore](https://apps.apple.com/de/app/basiccode/id1562309250)
---
- [Jump Up](#-overview)
", Assign "at most 3 tags" to the expected json: {"id":"11440","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"