Compare commits

...

12 Commits

Author SHA1 Message Date
Cezary Wojcik fac5c91daa fixed conflict 2015-08-25 12:34:49 -07:00
Cezary Wojcik 5c949092f5 2.3.2 2015-08-25 12:32:49 -07:00
Cezary Wojcik cdc51f3243 Update README.md 2015-08-08 18:45:36 -07:00
Cezary Wojcik 7d1890f7c5 fixed typo in README 2015-07-12 19:15:12 -07:00
Cezary Wojcik 26d6eda4f5 updated README 2015-07-12 19:14:42 -07:00
Cezary Wojcik 9dfcc29703 2015 2015-07-11 23:13:16 -07:00
Cezary Wojcik 6d00f770ef supported interface orientations 2015-07-11 14:53:09 -07:00
Cezary Wojcik 23a64f768d 2.3.1
custom notification animation duration
2015-07-11 14:49:01 -07:00
Cezary Wojcik e3fd1677b1 CGFloat -> NSTimeInterval 2015-07-11 14:44:27 -07:00
Cezary Wojcik dfbb1ed5f6 no need for this because of PCH 2015-07-11 14:42:07 -07:00
Cezary Wojcik 71aec53e1d updated read 2015-07-11 14:38:22 -07:00
Cezary Wojcik a24706854d added one more doc comment 2015-07-11 14:35:51 -07:00
5 changed files with 209 additions and 48 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = "CWStatusBarNotification"
s.version = "2.3.0"
s.version = "2.3.2"
s.summary = "A library that creates status bar notifications."
s.description = "CWStatusBarNotification is a library allows you to present a beautiful text-based notification in the status bar."
s.homepage = "https://github.com/cezarywojcik/CWStatusBarNotification"
@@ -6,8 +6,6 @@
// Copyright (c) 2015 Cezary Wojcik. All rights reserved.
//
#import <Foundation/Foundation.h>
/**
* @brief A simple completion used for handling tapping the notification.
*/
@@ -20,6 +18,10 @@ typedef void(^CWCompletionBlock)(void);
* label.
*/
@interface ScrollLabel : UILabel
/**
* Used to find the amount of time that the label will spend scrolling.
* @return The amount of time that will be spent scrolling.
*/
- (CGFloat)scrollTime;
@end
@@ -141,10 +143,16 @@ typedef NS_ENUM(NSInteger, CWNotificationAnimationType) {
*/
@property (assign, nonatomic) BOOL multiline;
/**
* The supported interface orientations. Default value is
* @c UIInterfaceOrientationMaskAll.
* The supported interface orientations. Default value is the
* @c supportedInterfaceOrientations value of the root view controller of the
* application.
*/
@property (nonatomic) UIInterfaceOrientationMask supportedInterfaceOrientations;
/**
* The amount of time that it takes to animate the notification in or out.
* Default value is 0.25.
*/
@property (nonatomic) NSTimeInterval notificationAnimationDuration;
/**
* Determines whether the notification covers the status bar or both the status
* bar and the navigation bar. Default value is
@@ -196,7 +204,7 @@ typedef NS_ENUM(NSInteger, CWNotificationAnimationType) {
* not including the animate in and out times.
*/
- (void)displayNotificationWithMessage:(NSString *)message
forDuration:(CGFloat)duration;
forDuration:(NSTimeInterval)duration;
/**
* Displays a notification with the indicated attributed string and then
@@ -221,7 +229,7 @@ typedef NS_ENUM(NSInteger, CWNotificationAnimationType) {
*/
- (void)displayNotificationWithAttributedString:(NSAttributedString *)
attributedString
forDuration:(CGFloat)duration;
forDuration:(NSTimeInterval)duration;
/**
* Displays a notification with the indicated custom view and then performs the
@@ -245,7 +253,7 @@ typedef NS_ENUM(NSInteger, CWNotificationAnimationType) {
* not including the animate in and out times.
*/
- (void)displayNotificationWithView:(UIView *)view
forDuration:(CGFloat)duration;
forDuration:(NSTimeInterval)duration;
/**
* Dismisses the currently presented notification and then performs the
@@ -11,13 +11,11 @@
#define SYSTEM_VERSION_LESS_THAN(v) ([[[UIDevice currentDevice] systemVersion] compare:v options:NSNumericSearch] == NSOrderedAscending)
#define STATUS_BAR_ANIMATION_LENGTH 0.25f
#define FONT_SIZE 12.0f
#define PADDING 10.0f
#define SCROLL_SPEED 40.0f
#define SCROLL_DELAY 1.0f
# pragma mark - ScrollLabel
@implementation ScrollLabel
@@ -196,13 +194,18 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
self = [super init];
if (self) {
// set default
self.notificationLabelBackgroundColor = [[UIApplication sharedApplication] delegate].window.tintColor;
if ([[UIApplication sharedApplication] delegate].window != nil) {
self.notificationLabelBackgroundColor = [[UIApplication sharedApplication] delegate].window.tintColor;
} else {
self.notificationLabelBackgroundColor = [UIColor blackColor];
}
self.notificationLabelTextColor = [UIColor whiteColor];
self.notificationLabelFont = [UIFont systemFontOfSize:FONT_SIZE];
self.notificationLabelHeight = 0.0;
self.customView = nil;
self.multiline = NO;
self.supportedInterfaceOrientations = UIInterfaceOrientationMaskAll;
self.supportedInterfaceOrientations = [UIApplication sharedApplication].keyWindow.rootViewController.supportedInterfaceOrientations;
self.notificationAnimationDuration = 0.25;
self.notificationStyle = CWNotificationStyleStatusBarNotification;
self.notificationAnimationInStyle = CWNotificationAnimationStyleBottom;
self.notificationAnimationOutStyle = CWNotificationAnimationStyleBottom;
@@ -256,6 +259,27 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
return 0.0f;
}
- (CGFloat)getNavigationBarHeight
{
if (UIInterfaceOrientationIsPortrait([UIApplication sharedApplication].statusBarOrientation) ||
UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) {
return 44.0f;
}
return 30.0f;
}
- (CGFloat)getNotificationLabelHeight
{
switch (self.notificationStyle) {
case CWNotificationStyleStatusBarNotification:
return [self getStatusBarHeight];
case CWNotificationStyleNavigationBarNotification:
return [self getStatusBarHeight] + [self getNavigationBarHeight];
default:
return [self getStatusBarHeight];
}
}
- (CGRect)getNotificationLabelTopFrame
{
return CGRectMake(0, [self getStatusBarOffset] + -1*[self getNotificationLabelHeight], [self getStatusBarWidth], [self getNotificationLabelHeight]);
@@ -281,27 +305,6 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
return CGRectMake(0, [self getStatusBarOffset], [self getStatusBarWidth], [self getNotificationLabelHeight]);
}
- (CGFloat)getNavigationBarHeight
{
if (UIInterfaceOrientationIsPortrait([UIApplication sharedApplication].statusBarOrientation) ||
UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad) {
return 44.0f;
}
return 30.0f;
}
- (CGFloat)getNotificationLabelHeight
{
switch (self.notificationStyle) {
case CWNotificationStyleStatusBarNotification:
return [self getStatusBarHeight];
case CWNotificationStyleNavigationBarNotification:
return [self getStatusBarHeight] + [self getNavigationBarHeight];
default:
return [self getStatusBarHeight];
}
}
# pragma mark - screen orientation change
- (void)updateStatusBarFrame
@@ -361,7 +364,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
[view setTranslatesAutoresizingMaskIntoConstraints:NO];
[self.customView addSubview:view];
// Setup Auto Layout constaints so that the custom view that is added is constained to be the same
// Setup Auto Layout constaints so that the custom view that is added is consrtained to be the same
// size as its superview, whose frame will be altered
[self.customView addConstraint:[NSLayoutConstraint constraintWithItem:view attribute:NSLayoutAttributeTrailing relatedBy:NSLayoutRelationEqual toItem:self.customView attribute:NSLayoutAttributeTrailing multiplier:1.0 constant:0.0]];
[self.customView addConstraint:[NSLayoutConstraint constraintWithItem:view attribute:NSLayoutAttributeLeading relatedBy:NSLayoutRelationEqual toItem:self.customView attribute:NSLayoutAttributeLeading multiplier:1.0 constant:0.0]];
@@ -489,7 +492,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(updateStatusBarFrame) name:UIApplicationWillChangeStatusBarFrameNotification object:nil];
// animate
[UIView animateWithDuration:STATUS_BAR_ANIMATION_LENGTH animations:^{
[UIView animateWithDuration:self.notificationAnimationDuration animations:^{
[self firstFrameChange];
} completion:^(BOOL finished) {
double delayInSeconds = [self.notificationLabel scrollTime];
@@ -500,7 +503,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
}
}
- (void)displayNotificationWithMessage:(NSString *)message forDuration:(CGFloat)duration
- (void)displayNotificationWithMessage:(NSString *)message forDuration:(NSTimeInterval)duration
{
[self displayNotificationWithMessage:message completion:^{
self.dismissHandle = perform_block_after_delay(duration, ^{
@@ -515,7 +518,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
[[self notificationLabel] setAttributedText:attributedString];
}
- (void)displayNotificationWithAttributedString:(NSAttributedString *)attributedString forDuration:(CGFloat)duration
- (void)displayNotificationWithAttributedString:(NSAttributedString *)attributedString forDuration:(NSTimeInterval)duration
{
[self displayNotificationWithMessage:[attributedString string] forDuration:duration];
[[self notificationLabel] setAttributedText:attributedString];
@@ -527,7 +530,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
self.isCustomView = YES;
self.notificationIsShowing = YES;
// create UIWindow
// create window
[self createNotificationWindow];
// setup view
@@ -549,7 +552,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(updateStatusBarFrame) name:UIApplicationWillChangeStatusBarFrameNotification object:nil];
// animate
[UIView animateWithDuration:STATUS_BAR_ANIMATION_LENGTH animations:^{
[UIView animateWithDuration:self.notificationAnimationDuration animations:^{
[self firstFrameChange];
} completion:^(BOOL finished) {
[completion invoke];
@@ -557,7 +560,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
}
}
- (void)displayNotificationWithView:(UIView *)view forDuration:(CGFloat)duration
- (void)displayNotificationWithView:(UIView *)view forDuration:(NSTimeInterval)duration
{
[self displayNotificationWithView:view completion:^{
self.dismissHandle = perform_block_after_delay(duration, ^{
@@ -572,7 +575,7 @@ static void cancel_delayed_block(CWDelayedBlockHandle delayedHandle)
cancel_delayed_block(self.dismissHandle);
self.notificationIsDismissing = YES;
[self secondFrameChange];
[UIView animateWithDuration:STATUS_BAR_ANIMATION_LENGTH animations:^{
[UIView animateWithDuration:self.notificationAnimationDuration animations:^{
[self thirdFrameChange];
} completion:^(BOOL finished) {
UIView *view = self.isCustomView ? self.customView : self.notificationLabel;
+1 -1
View File
@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2014 Cezary Wojcik <http://www.cezarywojcik.com>
Copyright (c) 2015 Cezary Wojcik <http://www.cezarywojcik.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
+156 -6
View File
@@ -2,10 +2,12 @@
[![Build Status](https://travis-ci.org/cezarywojcik/CWStatusBarNotification.png?branch=master)](https://travis-ci.org/cezarywojcik/CWStatusBarNotification)
**NOTE:** You can find a `Swift` implementation of this library [in the swift branch of this repo](https://github.com/cezarywojcik/CWStatusBarNotification/tree/swift).
**NOTE:** You can find a **Swift 2.0** implementation of this library [in the swift branch of this repo](https://github.com/cezarywojcik/CWStatusBarNotification/tree/swift).
`CWStatusBarNotification` is a library that allows you to easily create text-based notifications that appear on the status bar.
You can find the documentation [here](http://cocoadocs.org/docsets/CWStatusBarNotification/).
![demo](screenshots/demo.gif)
## Requirements
@@ -18,7 +20,7 @@ Works for iPhone and iPad.
### CocoaPods
`pod 'CWStatusBarNotification', '~> 2.3.0'`
`pod 'CWStatusBarNotification', '~> 2.3.2'`
### Manual
@@ -140,17 +142,165 @@ The notifications will work in both screen orientations, however, screen rotatio
## Apps Using This Library
If you would like for your app to be featured here, [contact me](cezarywojcik.com/contact) and I would love to hear about your app!
If you would like for your app to be featured here, [contact me](http://cezarywojcik.com/contact) and I would love to hear about your app!
* [SlideShare Presentations](https://itunes.apple.com/app/id917418728)
* [Pong Ping](https://itunes.apple.com/us/app/pong-ping-social-addictive/id822887888)
=======
# CWStatusBarNotification
[![Build Status](https://travis-ci.org/cezarywojcik/CWStatusBarNotification.png?branch=master)](https://travis-ci.org/cezarywojcik/CWStatusBarNotification)
**NOTE:** You can find a **Swift 2.0** implementation of this library [in the swift branch of this repo](https://github.com/cezarywojcik/CWStatusBarNotification/tree/swift).
`CWStatusBarNotification` is a library that allows you to easily create text-based notifications that appear on the status bar.
You can find the documentation [here](http://cocoadocs.org/docsets/CWStatusBarNotification/).
![demo](screenshots/demo.gif)
## Requirements
`CWStatusBarNotification` uses ARC and requires iOS 7.0+.
Works for iPhone and iPad.
## Installation
### CocoaPods
`pod 'CWStatusBarNotification', '~> 2.3.1'`
### Manual
Copy the folder `CWStatusBarNotification` to your project.
## Usage
Firstly, you need the following import statement:
```objc
#import "CWStatusBarNotification.h"
```
Now, you need to create a `CWStatusBarNotification` object. It is recommended that you do so by attaching it as a property to a `UIViewController`.
```objc
CWStatusBarNotification *notification = [CWStatusBarNotification new];
```
After you have a `CWStatusBarNotification` object, you can simply call the `displayNotificationMessage:forDuration:` method:
```objc
[self.notification displayNotificationWithMessage:@"Hello, World!"
forDuration:1.0f];
```
If you prefer to manually choose when to display and dismiss the notification, you can do so as well:
```objc
[self.notification displayNotificationWithMessage:@"Hello" completion:nil];
// wait until you need to dismiss
[self.notification dismissNotification];
```
### Behavior on Tap
The default behavior when the notification is tapped is to dismiss it. However, you can override this behavior by setting the `onTapNotification` block to something different.
For example:
```objc
self.notification.notificationTappedBlock = ^(void) {
NSLog(@"notification tapped");
// more code here
};
```
Note that overriding this block means that the notification will no longer be dismissed when tapped. If you want the notification to still dismiss when tapped, make sure to implement the following when overriding the block:
```objc
__weak typeof(self) weakSelf = self;
self.notification.notificationTappedBlock = ^(void) {
if (!weakSelf.notificationIsDismissing) {
[weakSelf dismissNotification];
// more code here
}
};
```
## Customizing Appearance
First of all, you can customize the background color and text color using the following properties: `notificationLabelBackgroundColor` and `notificationLabelTextColor`.
Example:
```objc
notification.notificationLabelBackgroundColor = [UIColor blackColor];
notification.notificationLabelTextColor = [UIColor greenColor];
```
![custom colors](screenshots/ss1.gif)
The default value of `notificationLabelBackgroundColor` is `[[UIApplication sharedApplication] delegate].window.tintColor`.
The default value of `notification.notificationLabelTextColor` is `[UIColor whiteColor]`.
Finally, you can also choose from two styles - a notification the size of the status bar, or a notification the size of the status bar and a navigation bar. Simply change the `notificationStyle` property of the `CWStatusBarNotification` object to either `CWNotificationStyleStatusBarNotification` or `CWNotificationStyleNavigationBarNotification`.
![custom style](screenshots/ss2.gif)
The default value of `notificationStyle` is `CWNotificationStyleStatusBarNotification`.
## Customizing Animation
There are two properties that determine the animation style of the notification: `notificationAnimationInStyle` and `notificationAnimationOutStyle`. Each can take on one of four values:
* `CWNotificationAnimationStyleTop`
* `CWNotificationAnimationStyleBottom`
* `CWNotificationAnimationStyleLeft`
* `CWNotificationAnimationStyleRight`
The `notificationAnimationInStyle` describes where the notification comes from, whereas the `notificationAnimationOutStyle` describes where the notification will go.
The default value for `notificationAnimationInStyle` is `CWNotificationAnimationStyleTop`.
The default value for `notificationAnimationOutStyle` is `CWNotificationAnimationStyleTop`.
## Presenting a Custom View
As of version `2.2.0`, you can choose to present a custom view in lieu of presenting a simple message. The demo project shows a simple way in which you can make a custom NIB file and present it as the notification view using the `displayNotificationWithView:forDuration:` method:
```objc
UIView *view = [[NSBundle mainBundle] loadNibNamed:@"CustomView" owner:nil options:nil][0];
[self.notification displayNotificationWithView:view forDuration:self.sliderDuration.value];
```
You can also display the notification and choose when to dismiss it as usual:
```objc
[self.notification displayNotificationWithView:view completion:nil];
// wait until you need to dismiss
[self.notification dismissNotification];
```
### Additional Remarks
The notifications will work in both screen orientations, however, screen rotation while a notification is displayed is not yet fully supported.
## Apps Using This Library
If you would like for your app to be featured here, [contact me](http://cezarywojcik.com/contact) and I would love to hear about your app!
* [SlideShare Presentations](https://itunes.apple.com/app/id917418728)
* [Pong Ping](https://itunes.apple.com/us/app/pong-ping-social-addictive/id822887888)
* [NextMovies](https://itunes.apple.com/us/app/nextmovies-smart-movie-recommendation/id680850329)
* [Social Dummy](https://itunes.apple.com/gb/app/social-dummy-create-fake-social/id610088272)
## License
The MIT License (MIT)
Copyright (c) 2014 Cezary Wojcik <http://www.cezarywojcik.com>
Copyright (c) 2015 Cezary Wojcik <http://www.cezarywojcik.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal