https://github.com/gokulnair2001/ConfettiKit
A custom framework to add Confetti🎉 on iOS/iPadOS projects.
https://github.com/gokulnair2001/ConfettiKit
confetti confetti-animation confetti-ball confetti-view popper ui-components
Last synced: 18 days ago
JSON representation
A custom framework to add Confetti🎉 on iOS/iPadOS projects.
- Host: GitHub
- URL: https://github.com/gokulnair2001/ConfettiKit
- Owner: gokulnair2001
- License: mit
- Created: 2021-07-12T08:38:01.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-09T04:30:18.000Z (almost 3 years ago)
- Last Synced: 2024-10-31T15:41:15.860Z (6 months ago)
- Topics: confetti, confetti-animation, confetti-ball, confetti-view, popper, ui-components
- Language: Swift
- Homepage:
- Size: 270 KB
- Stars: 21
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - ConfettiKit - A custom framework to add Confetti on iOS/iPadOS projects. [•](https://user-images.githubusercontent.com/56252259/126186797-01dd53e1-8861-4f4d-a44d-69b8f0bbfc1e.gif) (Content / Effects)
README
# ConfettiKit🎉
[](https://travis-ci.org/gokulnair2001/ConfettiKit)
[](https://cocoapods.org/pods/ConfettiKit)
[](https://cocoapods.org/pods/ConfettiKit)
[](https://github.com/gokulnair2001/ConfettiKit)
[](https://github.com/gokulnair2001/ConfettiKit)
## About 📒
ConfettiKit is a custom framework used to add Confetti on your iOS/iPadOS projects. The kit provides variety of customisations inorder to design a confetti which matches your project's UI. ConfettiKit makes your work of adding Confetti on your project with just one line of code.
## Playground 💻
* I've provided a demo project to showcase few examples of Confetti's which can be made. Simply clone this repo, and open `ConfettiKit.xcworkspace`.
* Run `pod install`.
* Here you can see and experiment custom Loaf styles in `Examples.swift`.
## Requirements ❕
* Device running on iOS/iPadOS 12.1+ versions 📱.
* Swift 5.4+ 💻
## Installation 🌏
ConfettiKit is available through [CocoaPods](https://cocoapods.org).
To install it, simply add the following line to your Podfile:
```ruby
pod 'ConfettiKit'
```
## No CocoaPods❗️
* Add this [Confetti.swift file](https://github.com/gokulnair2001/ConfettiKit/tree/master/Sources) into your project.
* Now you are ready to use ConfettiKit 🚀.
* Remaining steps are same 😁.
* Do read the documentation till the end to know more about ConfettiKit 💪🏼
## Usage ⚙️
1. Import Library 📚
```swift
import ConfettiKit
```
2. Generate Confetti 🎉
* Write this one line of code and add the parameters according to your specifications.
```swift
Confetti.generateConfetti(ConfettiPosition:Position, ConfettiCells:Int, ConfettiImage:[String], Colours:[UIColor], Scale:CGFloat ,BirthRate: Float, LifeTime:Float, Velocity:CGFloat, Spin:CGFloat, EmissionLongitude:CGFloat = CGFloat(Double.pi), EmissionRange:CGFloat, View: UIView)
```
### Parameters 🎛
| Parameter | Definition |
| --- | --- |
| ConfettiPosition | Position from which confetti Starts |
| ConfettiCells | Total types of confetti element |
| ConfettiImage | Image to apply on every Cells|
| Colours | Colour to apply on every Cells |
| Scale | Size of cell |
| BirthRate | Cells produced in a sec |
| LifeTime | Total existence of a cell|
| Velocity | Speed of cell |
| Spin | Rotation velocity of cell|
| EmissionLongitude | longitudinal orientation of the emission angle |
| EmissionRange | Angle(radians), defining a cone around the emission angle |
| View | View on which Confetti is to be applied |
## Result 💯
| Customization 1 | Customization 2 | Customization 3 |
|-- | -- | -- |
| 
| 
* Above given confettis are example project, you can cutomise it with your favourite confetti style.
## How to Stop Confetti ? ❌
* To stop confetti add:
```swift
Confetti.stopConfetti()
```
## Instructions 🚩
1. Images which are to be used in Confetti must be present in the ```Images.xcassets``` file.
2. Change Rendering property of every Confetti Image to ```Template Image``` from Attribute Inspector.
3. While providing ```ConfettiImage``` & ```Colours``` do remember total number of Images and colours must be same to the number of ```ConfettiCells```.
## How to Contribute 🖋
* Run the app - Steps are mentioned above.
* If you face issues in any step open a new issue.
* To fix issues: Fork this repository, make your changes and make a Pull Request.
## License
ConfettiKit is available under the MIT license. See the [LICENSE file](https://github.com/gokulnair2001/ConfettiKit/blob/master/LICENSE) for more info.
## Like the Project ?
If you like using any of my projects or like what I'm doing, please do consider backing me with appreciating my work: [Message me](https://twitter.com/GokulNair2303)🥰
[
](https://www.buymeacoffee.com/gokulnair)
OR
**Drop a star ⭐ if you find this project interesting!**
Made with ❤️ in 🇮🇳 By Gokul Nair