Giter VIP home page Giter VIP logo

notificationbar's Introduction

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

  • 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.