Swiftpack.co - Package - furqanmk/NotificationBar

NotificationBar

NotificationBar is a simple module that allows you to show notifications or alerts. It's simple to use yet very customizable. Just make an instance and call a method to show, that's it!

iOS 8+ Swift 4

Default Look

Installation

Cocoapods

Paste the following line to your Podfile:

pod 'NotificationBar', :git => 'https://github.com/furqanmk/NotificationBar.git'

CocoaPods release coming soon.

Manual

Drag and drop files from the Source folder.

Usage

Make an instance of NotificationBar with desired properties in the initializer and show() method. Don't forget to call the dismiss() method if you passed .loading for style in the init.

NotificationBar(over: self, text: "Here goes your message", style: .success).show()

Customizations

NotificationBarConfiguration

You can set the following properties on NotificationBar.sharedConfig which will then be applied on all NotificationBar instances thereafter:

  • duration: Duration after which auto dismissed notification bar is dismissed
  • font: The default font of the text
  • textColor: The color of the text
  • padding: Padding around the text
  • loadingColor: Default background color for .loading style
  • successColor: Default background color for .sucess style
  • errorColor: Default color for .error style

Custom NotificationBarStyle

You can provide a custom style in the initializer by providing an instance of NotificationBarStyle.VisualConfig using NotificationBarStyle.custom.

let customConfig = NotificationBarStyle.VisualConfig(backgroundColor: .gray,
                                                     isLoaderHidden: true,
                                                     dismiss: .auto)
NotificationBar(over: self, text: "Some text", style: .custom(customConfig))

NotificationBarDismiss

It's important to remember that if the dismiss property of the NotificationBar is set to .manual, the user must also call dismiss() on the NotificationBar. Style .loading has a dismiss property of .manual.

TODO

  • [x] Add Cocoapods support
  • [ ] Add Carthage support
  • [ ] Add Swift Package Manager support

Mentions

Project Details

Requirements

  • Swift 4.0
  • Xcode 7.0+
  • iOS 8.0+

Contributing

Feel free to collaborate with ideas 💭, issues ⁉️ and/or pull requests 🔃.

If you use NotificationBar in your app I'd love to hear about it and feature your animation here!

Author

Furqan Khan | @furqanmk9

Twitter Follow

License

Copyright (c) 2018 Furqan Muhammad Khan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Github

link
Stars: 29
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

0.2 - Jul 9, 2018

0.1 - Feb 22, 2018