-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9ca47fd
commit a0dba08
Showing
1 changed file
with
111 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,131 @@ | ||
| # ConfettiKit | ||
|  | ||
|
|
||
| # ConfettiKit🎉 | ||
|
|
||
| [](https://travis-ci.org/gokulnair2001/ConfettiKit) | ||
| [](https://cocoapods.org/pods/ConfettiKit) | ||
| [](https://cocoapods.org/pods/ConfettiKit) | ||
| [](https://cocoapods.org/pods/ConfettiKit) | ||
|
|
||
| ## Example | ||
| ## 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 💻 | ||
|
|
||
| To run the example project, clone the repo, and run `pod install` from the Example directory first. | ||
| * 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 | ||
| ## Requirements ❕ | ||
|
|
||
| ## Installation | ||
| * Device running on iOS/iPadOS 12.1+ versions 📱. | ||
| * Swift 5.4+ 💻 | ||
|
|
||
| ConfettiKit is available through [CocoaPods](https://cocoapods.org). To install | ||
| it, simply add the following line to your Podfile: | ||
| ## Installation 🌏 | ||
|
|
||
| ConfettiKit is available through [CocoaPods](https://cocoapods.org). | ||
| To install it, simply add the following line to your Podfile: | ||
|
|
||
| ```ruby | ||
| pod 'ConfettiKit' | ||
| ``` | ||
| ## Don't want to use CocoaPods❗️ | ||
| <details> | ||
| <summary> | ||
| I have a solution 👀 | ||
| </summary> | ||
|
|
||
| * Add this [Confetti.swift file](https://github.com/Loafjet/Loafjet/tree/master/Source) into your project.</br> | ||
| * Now you are ready to use ConfettiKit 🚀.</br> | ||
| * Remaining steps are same 😁.</br> | ||
| * Do read the documentation till the end to know more about ConfettiKit 💪🏼 </br> | ||
|
|
||
| </details> | ||
|
|
||
| ## 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 🎚 | ||
|
|
||
| <table> | ||
| <tr><td> | ||
|
|
||
| | 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 | | ||
|
|
||
| </td><td> | ||
|
|
||
| | Parameter | Definition | | ||
| | --- | --- | | ||
| | 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 | | ||
|
|
||
| </td></tr> </table> | ||
|
|
||
| ## Result 💯 | ||
| | Customization 1 | Customization 2 | Customization 3 | | ||
| |-- | -- | -- | | ||
| <img src="https://user-images.githubusercontent.com/56252259/125240695-1070bf00-e308-11eb-9091-bba322642216.gif" width="250" height="550"/> | <img src="https://user-images.githubusercontent.com/56252259/125241249-d5bb5680-e308-11eb-96d2-00425b13896a.gif" width="250" height="550"/> | <img src="https://user-images.githubusercontent.com/56252259/125241369-f97e9c80-e308-11eb-83a4-a1627c9949f8.gif" width="250" height="550"/> | ||
|
|
||
| ## How to Stop Confetti ? ❌ | ||
| * To stop confetti just write this one line of code | ||
| ```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. | ||
| <img src="https://user-images.githubusercontent.com/56252259/125242393-3f883000-e30a-11eb-9412-11f1e7c297d8.png" width="250" height="120"/> | ||
|
|
||
| 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. | ||
|
|
||
| ## Project Admin 👨🏻💻 | ||
|
|
||
| ## Author | ||
| [](https://github.com/Loafjet/Loafjet) [](https://github.com/gokulnair2001/) | ||
|
|
||
| | <a href="https://gokulnair2001.wixsite.com/mysite"><img src="https://user-images.githubusercontent.com/56252259/115108478-482ccc80-9f8e-11eb-94a0-430db46a432f.png" width=150px height=160px /></a> | | ||
| | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | ||
| | **[Gokul Nair](https://www.linkedin.com/in/gokul-r-nair/)** | | ||
| | <a href="https://www.instagram.com/_gokul_r_nair_/"><img src="https://user-images.githubusercontent.com/56252259/114969025-24d22680-9e95-11eb-848d-b20e73269c4c.png" width="32px" height="32px"></a> <a href="https://twitter.com/GokulNair2303"><img src="https://user-images.githubusercontent.com/56252259/114967867-d6bc2380-9e92-11eb-8f89-c437f39a45de.png" width="32px" height="32px"></a> <a href="https://www.linkedin.com/in/gokul-r-nair/"><img src="https://user-images.githubusercontent.com/56252259/114967871-d7ed5080-9e92-11eb-8781-cd7cf9bb52db.png" width="32px" height="32px"></a> | | ||
|
|
||
| gokulnair2001, gokulnair.2001@gmail.com | ||
|
|
||
| ## License | ||
|
|
||
| ConfettiKit is available under the MIT license. See the LICENSE file 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)🥰 | ||
|
|
||
| [<img width="200" alt="BMC logo+wordmark - Black" src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png">](https://www.buymeacoffee.com/gokulnair) | ||
|
|
||
| OR | ||
|
|
||
| **Drop a star ⭐ if you find this project interesting!** | ||
|
|
||
| <p align="center" width="100%"> | ||
| Made with ❤️ in 🇮🇳 By Gokul Nair | ||
| </p> |