Swiftpack.co - emrearmagan/SYBanner as Swift Package

A minimalistic looking banner library for iOS. It supports multiple customizable kinds of Banner types

Quick start

SYSimpleBanner

let banner = SYSimpleBanner("Link copied", backgroundColor: .white, direction: .top)
banner.animationDurationDisappear = 0.1
banner.show()

SYDefaultBanner:

let textBanner = SYDefaultBanner("A Banner with just a text", direction: .top, style: .none)
textBanner.animationDurationDisappear = 0.1
textBanner.show()

let styleBanner = SYDefaultBanner("A Banner with just a text", direction: .top, style: .success)
styleBanner.show(queuePosition: .front)

SYCardBanner

let banner = SYCardBanner(title: "How to use", subtitle: "Simple download Notification banner and get started with your own notifcations")
banner.addButton(SYCardBannerButton(title: "Skip ", style: .dismiss)
banner.addButton(SYCardBannerButton(title: "Get started", style: .default, handler: {
    // Do something on button press
}))

// See Banner options for more
banner.setBannerOptions([
  .showExitButton(true),
  .customView(yourCustomView()),
  .buttonAxis(.horizontal),
  .titleFont(UIFont.systemFont(ofSize: 35, weight: .medium)),
  .titleColor(.gray),
  .buttonsHeight(50),
  .customViewInsets(.init(top: 20, left: 0, bottom: 40, right: 0)),
])

banner.dismissOnSwipe = false
banner.show()

By default each banner is placed at the at the end of the queue. If your want to display the banner immediately place it at the front of the queue:

banner.show(queuePosition: .front)

By default each banner will be dismissed after a time. If you want to disable that, set autoDismiss to false and dismiss manually:

banner.dismissView()

SYBannerButton Style

Currently there are only 2 Button style options. Defaults is the default iOS Button with the default or the specified tint color.
The dismiss style dismisses the banner when pressed and does not have a tint color.

public enum Style : Int {
  case `default` = 0
  case dismiss = 1
}

Delegate

To respond to animation events, implement the SYBannerDelegate protocol in your class, e.g. a View Controller, and then set the banners delegate property:

class MyViewController: UIViewController, SYBannerDelegate {
  override func viewDidLoad() {
    let banner = SYSimpleBanner("Link copied", direction: .top)
    banner.delegate = self
    banner.show()
  }

  // Banner delegate
  func notificationBannerWillAppear(_ banner: SYBaseBanner) {
    // Do something before the banner appears
  }

  func notificationBannerDidAppear(_ banner: SYBaseBanner) {
    // Do something when the banner appeared
  }
  func notificationBannerWillDisappear(_ banner: SYBaseBanner) {
    // Do something before the banner disappears
  }

  func notificationBannerDidDisappear(_ banner: SYBaseBanner) {
    // Do something after the banner disappeared
  }
}

User interaction

To respond to animation events, implement the SYBannerDelegate protocol in your class, e.g. a View Controller, and then set the banners delegate property:

banner.onSwipe = {
    // Do something on swipe
}

banner.didTap = {
    // Do something on tap
}

Banner options

Banner Options

SYSimpleBanner, SYDefaultBanner:

SYDefaultBanner:

SYCardBanner:

Requirements

• Xcode 11
• iOS 13 or later
• Swift 5 or later

Installation

CocoaPods

You can use CocoaPods to install SYBanner by adding it to your Podfile:

pod 'SYBanner'

Installing SYBanner manually

1. Download SYBanner.zip from the last release and extract its content in your project's folder.
2. From the Xcode project, choose Add Files to ... from the File menu and add the extracted files.

Contribute

Contributions are highly appreciated! To submit one:

1. Fork
2. Commit changes to a branch in your fork
3. Push your code and make a pull request