Table of Contents
#AANotifier
##Description
AANotifier allows you to create UIView based fragments to be appear on screen at runtime. It is designed to make custom elements in UIView even from xib based views to animate on screen.
##Demonstration
AANotifier can be a custom popup view, action bar, message display banner etc.
To run the example project, clone the repo, and run pod install
from the Example directory first.
##Requirements
- iOS 8.0+
- Xcode 8.0+
- Swift 3+
Installation
AANotifier
can be installed using CocoaPods, Carthage, or manually.
##CocoaPods
AANotifier
is available through CocoaPods. To install CocoaPods, run:
$ gem install cocoapods
Then create a Podfile with the following contents:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
target '<Your Target Name>' do
pod 'AANotifier' , '1.2'
end
Finally, run the following command to install it:
$ pod install
##Carthage
To install Carthage, run (using Homebrew):
$ brew update
$ brew install carthage
Then add the following line to your Cartfile:
github "EngrAhsanAli/AANotifier" "master"
Then import the library in all files where you use it:
import AANotifier
##Manual Installation
If you prefer not to use either of the above mentioned dependency managers, you can integrate AANotifier
into your project manually by adding the files contained in the Classes folder to your project.
#Getting Started
##Define your notifier!
You can simply define your notifier with options as lazy initialization in your view controller.
Usage:
lazy var myNotifier: AANotifier = {
let notifierView = UIView.fromNib(nibName: "MyNotifier")!
let options: [AANotifierOptions] = [
.transitionA(.fromBottom, 0.9), // Show notifier animation
.transitionB(.toBottom, 0.9), // Hide notifier animation
.position(.bottom), // notifier position
.preferedHeight(50), // notifier height
.margins(H: 60, V: 40), // notifier margins
.hideOnTap, // Hides on tap
.deadline(2.0) // Deadline of notifier for dismissal
]
let notifier = AANotifier(notifierView, withOptions: options)
return notifier
}()
##Show your notifier!
You can simply show the notifier by show
method or animateNotifer
for animation options.
Usage:
// Show simply!
myNotifier.show()
// Tap listner
notifier.didTapped = {
notifier.hide()
}
##Hide your notifier!
You can simply hide the notifier by hide
method.
Usage:
// Show hide!
myNotifier.hide()
##AANotifier options
You can use following notifier options for your notifier:
Options | Types | Description |
---|---|---|
preferedHeight |
CGFloat |
AANotifier height |
transitionA |
AAViewAnimators, TimeInterval |
Animator for showing notifier |
transitionB |
AAViewAnimators, TimeInterval |
Animator for hiding notifier |
position |
AANotifierPosition |
AANotifier position |
hideOnTap |
--- |
Hides on tap if added |
margins |
(CGFloat?, CGFloat?) |
Horizontal and vertical margins respectively |
#Contributions & License
AANotifier
is available under the MIT license. See the LICENSE file for more info.
Pull requests are welcome! The best contributions will consist of substitutions or configurations for classes/methods known to block the main thread during a typical app lifecycle.
I would love to know if you are using AANotifier
in your app, send an email to Engr. Ahsan Ali