BLTNItemManager

@objc
public final class BLTNItemManager : NSObject

An object that manages the presentation of a bulletin.

You create a bulletin manager using the init(rootItem:) initializer, where rootItem is the first bulletin item to display. An item represents the contents displayed on a single card.

The manager works like a navigation controller. You can push new items to the stack to display them, and pop existing ones to go back.

You must call the prepare method before displaying the view controller.

BLTNItemManager must only be used from the main thread.

Background

  • The background color of the bulletin card. Defaults to systemBackground on iOS 13 and white on older versions of the OS.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var backgroundColor: UIColor
    Show on GitHub

  • The style of the view covering the content. Defaults to .dimmed.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var backgroundViewStyle: BLTNBackgroundViewStyle
    Show on GitHub

Status Bar

  • The style of status bar to use with the bulltin. Defaults to .automatic.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var statusBarAppearance: BLTNStatusBarAppearance
    Show on GitHub

  • The style of status bar animation. Defaults to .fade.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var statusBarAnimation: UIStatusBarAnimation
    Show on GitHub

  • The home indicator for iPhone X should be hidden or not. Defaults to false.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var hidesHomeIndicator: Bool
    Show on GitHub

Card Presentation

  • The spacing between the edge of the screen and the edge of the card. Defaults to regular.

    Set this value before presenting the bulletin. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var edgeSpacing: BLTNSpacing
    Show on GitHub

  • The rounded corner radius of the bulletin card. Defaults to 12, and 36 on iPhone X.

    Set this value before calling prepare. Changing it after will have no effect.

    Declaration

    Swift

    @objc
public var cardCornerRadius: NSNumber?
    Show on GitHub

  • Whether swipe to dismiss should be allowed. Defaults to true.

    If you set this value to true, the user will be able to drag the card, and swipe down to dismiss it (if allowed by the current item).

    If you set this value to false, no pan gesture will be recognized, and swipe to dismiss won’t be available.

    Declaration

    Swift

    @objc
public var allowsSwipeInteraction: Bool
    Show on GitHub

  • Tells us if a bulletin is currently being shown. Defaults to false

    Declaration

    Swift

    @objc
public var isShowingBulletin: Bool { get }
    Show on GitHub

Initialization

  • Creates a bulletin manager and sets the first item to display.s

    Declaration

    Swift

    @objc
public init(rootItem: BLTNItem)

    Parameters

    rootItem

    The first item to display.
    Show on GitHub

Interacting with the Bulletin

  • Presents a view controller above the bulletin card.

    This is useful if you want to present an alert or a Safari view contoller in response to user action.

    Declaration

    Swift

    @objc(presentViewControllerAboveBulletin:animated:completion:)
public func present(_ viewController: UIViewController, animated: Bool, completion: (() -> Void)? = nil)

    Parameters

    viewController

    The view controller to present.
    animated

    Whether presentation should be animated.
    completion

    An optional completion block to run after presentation has completed. Defaults to nil.
    Show on GitHub

  • Performs an operation with the bulletin content view and returns the result.

    Use this as an opportunity to customize the behavior of the content view (e.g. add motion effects).

    You must not store a reference to the view, or modify its layout (add subviews, add contraints, …) as this could break the bulletin.

    Use this feature sparingly.

    Warning

    If you save the content view outside of the transform closure, an exception will be raised.

    Declaration

    Swift

    @discardableResult
public func withContentView<Result>(_ transform: (UIView) throws -> Result) rethrows -> Result

    Parameters

    transform

    The code to execute with the content view.
    Show on GitHub

  • Hides the contents of the stack and displays an activity indicator view.

    Use this method if you need to perform a long task or fetch some data before changing the item.

    Displaying the loading indicator does not change the height of the page or the current item. It will disable dismissal by tapping and swiping to allow the task to complete and avoid resource deallocation.

    Displaying the loading indicator does not change the height of the page or the current item.

    Declaration

    Swift

    @objc
public func displayActivityIndicator(color: UIColor? = nil)

    Parameters

    color

    The color of the activity indicator to display. Defaults to .label on iOS 13 and .black on older systems.
    Show on GitHub

  • Hides the activity indicator and displays the current item.

    You can also call one of popItem, popToRootItem and pushItem if you need to hide the activity indicator and change the current item.

    Declaration

    Swift

    @objc
public func hideActivityIndicator()
    Show on GitHub

  • Displays a new item after the current one.

    Declaration

    Swift

    @objc
public func push(item: BLTNItem)

    Parameters

    item

    The item to display.
    Show on GitHub

  • Removes the current item from the stack and displays the previous item.

    Declaration

    Swift

    @objc
public func popItem()
    Show on GitHub

  • Removes items from the stack until a specific item is found.

    Declaration

    Swift

    @objc
public func popTo(item: BLTNItem, orDismiss: Bool)

    Parameters

    item

    The item to seek.
    orDismiss

    If true, dismiss bullein if not found. Otherwise popToRootItem()
    Show on GitHub

  • Removes all the items from the stack and displays the root item.

    Declaration

    Swift

    @objc
public func popToRootItem()
    Show on GitHub

  • Displays the next item, if the next property of the current item is set.

    Warning

    If you call this method but next is nil, an exception will be raised.

    Declaration

    Swift

    @objc
public func displayNextItem()
    Show on GitHub

Presentation / Dismissal

  • Presents the bulletin above the specified view controller.

    Declaration

    Swift

    @objc(showBulletinAboveViewController:animated:completion:)
public func showBulletin(above presentingVC: UIViewController,
                                   animated: Bool = true,
                                 completion: (() -> Void)? = nil)

    Parameters

    presentingVC

    The view controller to use to present the bulletin.
    animated

    Whether to animate presentation. Defaults to true.
    completion

    An optional block to execute after presentation. Default to nil.
    Show on GitHub

  • Presents the bulletin on top of your application window.

    Declaration

    Swift

    @objc(showBulletinInApplication:animated:completion:)
public func showBulletin(in application: UIApplication,
                         animated: Bool = true,
                         completion: (() -> Void)? = nil)

    Parameters

    application

    The application in which to display the bulletin. (normally: UIApplication.shared)
    animated

    Whether to animate presentation. Defaults to true.
    completion

    An optional block to execute after presentation. Default to nil.
    Show on GitHub

  • Dismisses the bulletin and clears the current page. You will have to call prepare before presenting the bulletin again.

    This method will call the dismissalHandler block of the current item if it was set.

    Declaration

    Swift

    @objc(dismissBulletinAnimated:)
public func dismissBulletin(animated: Bool = true)

    Parameters

    animated

    Whether to animate dismissal. Defaults to true.
    Show on GitHub