Daltron / NotificationBanner
- понедельник, 1 мая 2017 г. в 03:12:22
Swift
The easiest way to display highly customizable in app notification banners in iOS
NotificationBanner is an extremely customizable and lightweight library that makes the task of displaying in app notification banners and drop down alerts an absolute breeze in iOS.
Basic Banners | Banners with Side Views | Status Bar Banners |
---|---|---|
NSAttributedString
support UIView
support NotificationBanner is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'NotificationBannerSwift'
Creating drop down alerts with NotificationBanner is easy. To create and show a banner, simply:
let banner = NotificationBanner(title: title, subtitle: subtitle, style: .success)
banner.show()
To create a status bar alert, simply:
let banner = StatusBarNotificationBanner(title: title, style: .success)
banner.show()
By default, each banner will automatically dismiss after 5 seconds. To dismiss programatically, simply:
banner.dismiss()
NotificationBanner has five prebuilt styles that you can choose from:
public enum BannerStyle {
case danger
case info
case none
case success
case warning
}
You can override the predefined colors that NotificationBanner uses for any style by conforming to the BannerColorsProtocol
:
public protocol BannerColorsProtocol {
func color(for style: BannerStyle) -> UIColor
}
Its as easy as creating a custom banner colors class:
class CustomBannerColors: BannerColorsProtocol {
internal override func color(for style: BannerStyle) -> UIColor {
switch style {
case .danger: // Your custom .danger color
case .info: // Your custom .info color
case .none: // Your custom .none color
case .success: // Your custom .success color
case .warning: // Your custom .warning color
}
}
}
And then passing in that class to any notification banner you create:
let banner = NotificationBanner(title: title, style: .success, colors: CustomBannerColors())
banner.show()
By default, the .info
style will be applied to the banner if no style is provided in the init method. You can set the background color of a banner at any time by simply setting the backgroundColor
.
A notification banner can have a left acessory view, a right acessory view, or both:
// Success Style Notification with Left View
let leftView = UIImageView(image: #imageLiteral(resourceName: "success"))
let banner = NotificationBanner(title: title, subtitle: subtitle, leftView: leftView, style: .success)
banner.show()
// Danger Style Notification with Right View
let rightView = UIImageView(image: #imageLiteral(resourceName: "danger"))
let banner = NotificationBanner(title: title, subtitle: subtitle, rightView: rightView, style: .danger)
banner.show()
// Info Style Notification with Left and Right Views
let leftView = UIImageView(image: #imageLiteral(resourceName: "info"))
let rightView = UIImageView(image: #imageLiteral(resourceName: "right_chevron"))
let banner = NotificationBanner(title: title, subtitle: subtitle, leftView: leftView, rightView: rightView, style: .info)
banner.show()
Each side view will be automically reisized to fit perfectly
A notification banner can also be initalized with a custom view:
let banner = NotificationBanner(customView: NorthCarolinaBannerView())
banner.show()
By default, when a banner is tapped or swiped up by a user, it will be dismissed. If you want to detect when the user taps or swipes up on a banner, simply:
banner.onTap = {
// Do something regarding the banner
}
banner.onSwipeUp = {
// Do something regarding the banner
}
By default, each notification banner is placed onto a NotificationBannerQueue
. This allows an infinite amount of banners to be de displayed without one hiding the other. By default, each notification banner is placed on the back of the queue. If you would rather place the banner in the front and show it immediately no matter how many banners are in the queue, simply state it in the show()
method:
banner.show(queuePosition: .front)
Adding a banner to the front of the queue will temporarily suspend the currently displayed banner (if there is one) and will resume it after the banner in front of it dismisses.
This is all automatically managed!
I'd love to know anything that you think NotificationBanner is missing. Open an issue and add the feature request
label to it and I'll do everything I can to accomodate that request if it is in the library's best interest.
Dalton Hinterscher, daltonhint4@gmail.com
NotificationBanner is available under the MIT license. See the LICENSE file for more info.