Loafjet ๐
About ๐
Loafjet is a light weight Toast(Loaf) generator framework which allows the user to add customised Toasts to their projects. Loafjet comes with various types of Toast Animations as well as Toast Positions. It can be used to add gradient and plain toasts. Loafjet comes with extra features like Popup Card and Loading Indicator which can be customised according to your needs.
Our Simulation App is available on App Store, Go check it out
Now Customise Like Apple ๏ฃฟ !
Airpods Detection |
Silent |
Normal |
|
|
|
Installation ๐
Loafjet is available through CocoaPods. To install
it, simply add the following line to your Podfile:
How To Use ๐ ?
From any view controller, a Loaf can be presented by following this two steps:
1. Import Library ๐ณ
2. Call Loafjet ๐
Loaf.PlainLoaf(message: "Message goes here", position: .Bottom, animationDirection: .Bottom, loafjetView: View)
Result: ๐ฏ
Plain Default Loaf |
|
- This is the most basic Loafjet that you can make with least line of code ๐.
- Below all Loafjet types are mentioned , have a look on it ๐.
Plain Loaf
* With Default Parameters ๐
Loaf.PlainLoaf(message: String, position: loafPosition, animationDirection: loafAnimation, loafjetView: UIView)
* Without Default Parameters ๐
Loaf.PlainLoaf(message: String, position:LoafPosition, loafWidth:CGFloat , loafHeight:CGFloat, cornerRadius: CGFloat, fontStyle: String, fontSize: CGFloat, bgColor: UIColor, fontColor: UIColor, alphaValue:CGFloat, loafImage: String? , animationDirection: LoafAnimation , duration: TimeInterval, loafjetView: UIView)
Gradient Loaf
* With Default Parameters ๐
Loaf.GradientLoaf(message: String, position: LoafPosition, bgColor1: UIColor, bgColor2: UIColor, fontColor: UIColor, loafImage: String?, animationDirection: loafAnimation, loafjetView: UIView)
* Without Default Parameters ๐
Loaf.GradientLoaf(message: String, position:LoafPosition, loafWidth:CGFloat, loafHeight:CGFloat, cornerRadius: CGFloat, fontStyle: String, fontSize: CGFloat, bgColor1: UIColor, bgColor2: UIColor, fontColor: UIColor, loafImage: String?, animationDirection: LoafAnimation, duration: TimeInterval, loafjetView: UIView)
* With Default Parameters ๐
Loaf.PopupCard(message: String, position: LoafPosition, bgColor1: UIColor, bgColor2: UIColor, fontColor: UIColor, loafImage: String?, blurEffect: UIBlurEffectStyle?, loafjetView: UIView)
* Without Default Parameters ๐
Loaf.PopupCard(message: String, position:LoafPosition, loafWidth:CGFloat, loafHeight:CGFloat, cornerRadius: CGFloat, fontStyle: String, fontSize: CGFloat, bgColor1: UIColor, bgColor2: UIColor, fontColor: UIColor, loafImage: String?, duration: TimeInterval, blurEffect: UIBlurEffectStyle?, loafjetView: UIView)
Dash Board
* With Default Parameters ๐
Loaf.dashBoard(dashImage: String, dashTitle: String, dashContent: String, dashButtonTitle: String, mainView: UIView, completion: () -> ())
* Without Default Parameters ๐
Loaf.dashBoard(dashSpacing: CGFloat, dashRadius: CGFloat, dashColor: UIColor, dashImage: String, dashImageRadius: CGFloat, dashTitle: String, dashTitleColor: UIColor, dashContent: String, dashContentColor: UIColor, dashButtonTitle: String, dashButtonTitleColor: UIColor, dashButtonColor: UIColor, dashButtonRadius: CGFloat, dashButtonBorderColor: UIColor, dashButtonBorderWidth: CGFloat, dashDuration: TimeInterval, mainView: UIView, completion: () -> ())
- Available for iOS 14 and above
- Dash Board Demo Photo ๐
- Calling
Dasboard Dismissal
is required when Dash Board is usedโ.
Dash Board Dismissal ๐
Loaf.dismissDashBoard(dashBoardView: UIView)
LoafWheel
* With Default Parameters ๐
Loaf.LoafWheel(message: String, bgColor1: UIColor, bgColor2: UIColor, loafWheelView: UIView)
* Without Default Parameters ๐
Loaf.LoafWheel(message: String, loafWidth:CGFloat, loafHeight:CGFloat, cornerRadius:CGFloat, bgColor1:UIColor, bgColor2:UIColor, fontStyle: String, fontSize: CGFloat, fontColor: UIColor, duration: TimeInterval, wheelStyle: UIActivityIndicatorViewStyle, blurEffect: UIBlurEffectStyle ,loafWheelView: UIView)
- Loafwheel Demo Photo ๐
- Calling
LoafWheel Dismissal
is required when LoafWheel is used for Dynamic Processingโ.
LoafWheel Dismissal ๐
Loaf.dismissWheel(loafWheelView:UIView)
STUDIO ๐ป
- Our Simulation App is available on App Store, Go check it out!
- There app consists of a live Studio made for developers to customise their Loaf in live. The live preview allows to select the best customisation possible.
- The app also have various prebuilt Loafjets, do check it out to get a better idea๐.
- Now you can experiment in the Studio and design the best suitable loafjet for your projects.
Examples |
Studio |
Studio |
Studio |
|
|
|
|
Don't want to use CocoaPodsโ๏ธ
I have a solution ๐
- Add the Source Folder into your project.
- Now you are ready to use Loafjet ๐.
- Remaining steps are same ๐.
- Do read the documentation till the end to get a reward ๐ from Loafjet organisation.
Parameters ๐
Parameter |
Definition |
message |
Message to show on Loaf |
position |
Position of Loaf |
loafWidth |
Loaf Width |
loafHeight |
Loaf Height |
cornerRadius |
CornerRadius of Loaf |
fontStyle |
Font Style of Message |
fontSize |
Font size of Message |
bgColor |
Background Color of Loaf |
|
Parameter |
Definition |
alphaValue |
Opacity value for Loaf's background |
loafImage |
Image on Loaf |
duration |
Loaf Duration |
completion |
Closure to add actions to be performed |
animationDirection |
Loaf Animation type |
blurEffect |
Blur effect type |
wheelStyle |
Wheel Style |
loafWheelView |
View on which LoafWheel is running |
loafjetView |
View on which Loaf is presented |
|
Combination of Position and Animations ๐
- Customise your Loaf according to the below given chart ๐.
Position |
Animation |
Top |
Top |
Centre |
Left & Right |
Bottom |
Bottom |
- The above mentioned are the possible combination of position & animation which are possible.
- The remaining combinations are something which are not correct with UX prospect, so we have ignored them๐
Snapshots ๐ธ
Plain(Top) |
Plain(Bottom) |
Plain(Centre) |
Plain(Centre) |
|
|
|
|
Gradient(Top) |
Gradient(Bottom) |
Gradient(Centre) |
Gradient(Centre) |
|
|
|
|
- Above shown are few possible ways, you can customise according to your need (Customisation shown below).
Customisation ๐
- Loafjet offers you a wide variety of customisation, select a style and apply your creativity on it.
- This are some possible ways, "How Loafjet can be used ?".
Snapshots ๐ท
Do Not Disturb |
Information |
Warning |
|
|
|
Success |
Error |
Device Detection |
|
|
|
Loafjet +
Additional features
Dash Board
,Gradient Loafwheel
& Popup card
are the additional customisation which you get in Loafjet๐ฅณ.
Popup Card |
Loaf Wheel |
|
|
Dash Board
- These are some possible ways of customisation ๐ก
Loafjet Proprietary |
Alert Style |
Successful Style |
|
|
|
Dark \ Light Mode Support ๐ฆ
Dark Mode |
Light Mode |
|
|
- Dash Board is available for iOS 14 and above.
- The above shown are some possible ways, How you can customise?, do try making your own and post it in the issue section and get featuredโก๏ธ.
- What are you waiting for, write
pod Loafjet
and pod install
it .
- Done?, Now enjoy using Loafjet๐.
Portrait + Landscape Support ๐
- Loafjet is made with Landscape + Portrait support* ๐.
- Have a look on your favourite Loafjet supports ๐
Loafjet |
Portrait |
Landscape |
Plain Loaf |
โ
|
โ
|
Gradient Loaf |
โ
|
โ
|
Popup Card |
โ
|
โ
|
Dash Board |
โ
|
โ |
Loaf Wheel |
โ
|
โ
|
- Other than Dash board all the Loafjets support every type of orientation ๐.
- Dash Board Landscape support will be added soon, stay tuned ๐ป
Video Demo ๐ฅ
Top(Top) |
Bottom(Bottom) |
|
|
Centre(Right) |
Centre(Left) |
|
|
- These are some possible
Position X Animation
combination, Loafjet supports various other combinations too.
Instructions โ ๏ธ
- At a time you can only use one Loaf(Simultaneous use is allowed).
- Customise Loaf Position and Anmation according to the above given table.
- Use
.greatestFiniteMagnitude
in duration to get an infinte loader.
- To dismiss the loader use
Loaf.dismissWheel(LoafWheelView:UIView)
.
- For certain colors and blur effect particular iOS version is required, So to solve it use the below code (By default Xcode will show you both the fix).
// iOS versions will varry
if #available(iOS 10.0, *) {.
// write the code to run
}
else {
print("Error Message")
}
Or
// iOS versions will varry
@available(iOS 10.0, *)
- Test Run of few Loafjets are given, have a look on it (Running all Loafjets at a time may lead to irregular functioning!).
Note ๐ด
- Currently 'Loafjet' dont support SF Symbols, if you need it just raise an issue and I will try to add it โ๏ธ.
- The Loafimage you add must be present in the
Images.xcassets
file .
- Loafimages which you add must be of A x A Size(Else images may get cutout!).
- In the Test Run make sure you don't run all the Loafjets at a time, wait for one whole Loafjet to complete its task, then go for next.
- All the Loafjets are created with default parameters too, so notice carefully which one you are using (Functions with and without default parameters are shown โฌ๏ธ).
- You can use two or more different Loafjet type at a time, but you can't use two or more Loafjet of same type at a time.
License โ๏ธ
Loafjet is available under the MIT license. See the LICENSE file for more info.
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.
Requirements โ
- Device running on iOS/iPadOS 12.0+ versions ๐ฑ.
- Swift 5.1+ ๐ป
Additional Info
Mentors ๐ฑ
Project Admin ๐จ๐ปโ๐ป
Apps Using Loafjet๐ฑ
Dock! |
Remember Us |
LinkBoard |
|
|
|
- If your App uses LOAFJET, then let us know to get your app featured on our Website.
- Want to be a part of our Organisation ๐, then:
- Mail us at gokulnair.2001@gmail.com โ๏ธ
- Do mention the following things:
1. Reason
2. Motive
3. Skills
4. What you liked abou Loafjetโค๏ธ
- We are eager to read you messageโก๏ธ!
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๐ฅฐ
OR
Drop a star โญ if you find this project interesting!
Reward ๐
If you โค๏ธ the project then there is a gift for you:
- Gift from Loafjet Organisation
- Set the following image as your iPhone's Lock Screen wallpaper and see the magic ๐ช.
- Thank Me later by giving a โญ๏ธ to Loafjet๐ .
Made with โค๏ธ in ๐ฎ๐ณ By Gokul Nair
ยฉ Gokul Nair