Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pikacode/EBBannerView

Just 1 line:Show a banner the same as iOS 9~13 Notification, or show a custom view. 只需一行代码:展示跟 iOS 系统一样的推送通知横幅,或展示一个自定义的 view。支持横屏、自动适应各种机型、自动声音/震动。
https://github.com/pikacode/EBBannerView

Last synced: about 1 month ago
JSON representation

Just 1 line:Show a banner the same as iOS 9~13 Notification, or show a custom view. 只需一行代码:展示跟 iOS 系统一样的推送通知横幅,或展示一个自定义的 view。支持横屏、自动适应各种机型、自动声音/震动。

Awesome Lists containing this project

README

        

##### Swift beta version is now available! [Swift README.md](README_Swift.md)

##### Swift beta 版本现已推出! [中文 Swift README.md](README_CHS_Swift.md)

查看中文文档 [Chinese README.md](/README_CHS.md)

Email:[email protected]

微信:pikacode

# EBBannerView

Only one line to show:

- a banner the same style as iOS Push Notifications (auto show iOS 9~13 styles up to system version)
- auto play a sound or vibrate when the banner is showing

- support swipe down gesture for a long text

And more:

- custom banner's icon/title/date/content/animation_time_interval
- custom the sound (use system sound or play a sound file)

- autosize portrait/landscape frame
- show a custom view with different frame in portrait/landscape
- custom view has different animation mode, appear from top/left/right/left/center

- NSNotification with click event and pass a value

## Screenshot

### System style:

![](screenshot/3.gif)

### Custom style:

![](screenshot/4.gif)

## Installation

### pod

target 'YourTargetName' do
pod 'EBBannerView'
end

## Usage

### System style

---

```objc
#import
```

2 ways to use:

#### 1.Show a iOS style banner with one line

up to system version,will show iOS 9~13 style,auto show app icon/name.

```objc
[EBBannerView showWithContent:@"custom content"];
```

#### 2.Customize all values include iOS style

```objc
//1.create a banner, custom all values
EBBannerView *banner = [EBBannerView bannerWithBlock:^(EBBannerViewMaker *make) {
make.style = EBBannerViewStyleiOS9;//custom system, default is current
//make.style = 9;
make.content = @"MINE eye hath played the painter and hath stelled";
//make.object = ...
//make.icon = ...
//make.title = ...
//make.soundID = ...
}];

//2.show
[banner show];
```

##### Parameters:

(if not set will use default values)

- `style`:the iOS style, default is `UIDevice.currentDevice.systemVersion.intValue`, type enum : NSInteger {9/10/11}
- `icon`:the icon, default is app icon, type UIImage
- `title`:the title, default is app name, type NSString
- `date`:the date, default is localized string @"现在" = @"now", type NSString
- `content`:the content, type NSString
- `showAnimationDuration`:the animation time(show the banner), type NSTimeInterval, default is 0.3
- `hideAnimationDuration`:the animation time(hide the banner), type NSTimeInterval, default is 0.5
- `stayDuration`:how long the banner will stay before hide, type NSTimeInterval, default is 4.0
- `swipeDownStayDuration`:how long a long text banner will stay before hide when it is expanded, default is 4.0. U can set it a large value, then the banner will not hide, until customer click it or call 'hide'
- `object`:you can set it when create, then get it when clicked by adding an observer (see below), default is `content`,type id
- `soundID`:the sound will play when the banner is showing (when the mute is turn on iPhone will vibrate), type UInt32
- it's iOS system sound id, default push notification sound "Tritone" is 1312
- More sound id to see here [iOS Predefined sounds](http://iphonedevwiki.net/index.php/AudioServices#) or here [AudioServices sounds](http://www.cocoachina.com/bbs/read.php?tid=134344)

- You can download all the system sounds [UISounds.zip](/UISounds.zip) , listen and choose one which you perfer, then check out it's `id` with the form above
- `soundName`:play a cusome sound file, type NSString
- drag the file to Xcode proj
- pass the file name and extension,e.g. `banner.soundName = @"sound.mp3"`
- `showDetailOrHideWhenClickLongText`: when click a long text banner, expand it for all height or hide it, YES = expand/NO = hide, default is YES

### Custom style

---

```objc
#import
```

2 ways to use:

#### 1.create and show immediately

```objc
UIView *view = ...;//the view want to show

[EBCustomBannerView showCustomView:view block:^(EBCustomBannerViewMaker *make) {
make.portraitFrame = ...;//frame in portrait
make.portraitMode = EBCustomViewAppearModeTop;//appear from top in portrait
make.soundID = 1312;
make.stayDuration = 3.0;
//......
}];
```

#### 2.create and show after

```objc
UIView *view = ...;//the view want to show

//1.
EBCustomBannerView *customView = [EBCustomBannerView customView:view block:^(EBCustomBannerViewMaker *make) {
make.portraitFrame = ...;
make.portraitMode = EBCustomViewAppearModeTop;
make.soundID = 1312;
make.stayDuration = 3.0;
//......
}];

//2.
[customView show];
//[customView hide];
```

##### Parameters:

- `portraitFrame`: frame in portrait,default is view.frame,type CGRect
- `landscapeFrame`: frame in landscape,default is view.frame,type CGRect
- `soundID`: (the same as `system style`'s)
- `soundName`: (the same as `system style`'s)
- `animationDuration`: (the same as `system style`'s)
- `stayDuration`: (the same as `system style`'s)
- `portraitMode`: in portrait view appears from top/bottom/left/right/center, default is top, type enum
- `landscapeMode`: in landscape view appears from top/bottom/left/right/center, default is top, type enum
- `centerModeDurations`: the animation time of view appears from center, default is @[@0.3, @0.2, @0.1], `animationDuration` is invalid for center animation

## Handle click event and pass value (system style)

- add an observer for `EBBannerViewDidClickNotification` and handle click event
- pass an object when init the banner, and get it when clicked

```soobjc
#import
{
...
EBBannerView *banner = [EBBannerView bannerWithBlock:^(EBBannerViewMaker *make) {
...
make.object = aObject;
}];
}

{
...
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(bannerViewDidClick:) name:EBBannerViewDidClickNotification object:nil];
}

-(void)bannerViewDidClick:(NSNotification*)noti{
NSLog(@"%@",noti.object);
}
```