Navigate Class Reference

NavigationStyle
Different types of Navigation Style
See more
Declaration
Swift

public enum NavigationStyle
Show on GitHub
ToastStyle
Different types of Toast Style
See more
Declaration
Swift

public enum ToastStyle
Show on GitHub
shared
The statically shared instance of Navigate
Declaration
Swift

public static var shared: Navigate
Show on GitHub


                    
                    
                    init(controller:)

Create a Navigate object to manage navigation

Declaration

Swift

public init(controller: UINavigationController? = nil)

Parameters


                                controller

An optional UINavigationController to handle navigation (Default: nil)

Show on GitHub

Configure NavigationController

configure(controller:)
Configure the Navigate Singleton with the Root Navigation Controller
Declaration
Swift

@discardableResult public func configure(controller: UINavigationController?) -> Self
Show on GitHub


                    
                    
                    set(title:)

Set the visibleViewController’s title

Declaration

Swift

@discardableResult
public func set(title: String) -> Self

Parameters


                                title

The title of the currentViewController

Show on GitHub


                    
                    
                    setLeft(barButton:animated:)

Set the left barButton

Declaration

Swift

@discardableResult
public func setLeft(barButton: UIBarButtonItem?, animated: Bool = true) -> Self

Parameters

`barButton`	The UIBarButtonItem to be set
`animated`	Should animate setting the left UIBarButtonItem (Default: true)

Show on GitHub


                    
                    
                    setRight(barButton:animated:)

Set the right barButton

Declaration

Swift

@discardableResult
public func setRight(barButton: UIBarButtonItem?, animated: Bool = true) -> Self

Parameters

`barButton`	The UIBarButtonItem to be set
`animated`	Should animate setting the right UIBarButtonItem (Default: true)

Show on GitHub


                    
                    
                    setLeft(barButtons:animated:)

Set the left barButtons

Declaration

Swift

@discardableResult
public func setLeft(barButtons: [UIBarButtonItem]?, animated: Bool = true) -> Self

Parameters

`barButton`	The [UIBarButtonItem] to be set
`animated`	Should animate setting the left UIBarButtonItem

Show on GitHub


                    
                    
                    setRight(barButtons:animated:)

Set the right barButtons

Declaration

Swift

@discardableResult
public func setRight(barButtons: [UIBarButtonItem]?, animated: Bool = true) -> Self

Parameters

`barButton`	The [UIBarButtonItem] to be set
`animated`	Should animate setting the right UIBarButtonItem

Show on GitHub

Navigation


                    
                    
                    go(_:style:completion:)

Go to a viewController by using the configured NavigationController

Declaration

Swift

public func go(
    _ viewController: UIViewController,
    style: NavigationStyle,
    completion: (() -> Void)? = nil
)

Parameters

`viewController`	UIViewController to navigate to
`style`	Style of navigation (Default: nil)

Show on GitHub


                    
                    
                    go(from:to:style:completion:)

Go to a viewController by using another viewController

Declaration

Swift

public func go(
    from: UIViewController,
    to: UIViewController,
    style: NavigationStyle,
    completion: (() -> Void)? = nil
)

Parameters

`from`	The UIViewController that is handling the navigation
`viewController`	UIViewController to navigate to
`style`	Style of navigation (Default: nil)

Show on GitHub


                    
                    
                    back(toRoot:)

Navigate back and dismiss the visibleViewController

Declaration

Swift

public func back(toRoot: Bool = false)

Parameters


                                toRoot

Should navigate back to the rootViewController (Default: false)

Show on GitHub

dismiss()
Dismiss the visibleViewController
Declaration
Swift

public func dismiss()
Show on GitHub

Alert


                    
                    
                    alert(title:message:withActions:secondsToPersist:_:)

Show an Alert

Declaration

Swift

public func alert(
    title: String,
    message: String,
    withActions actions: [UIAlertAction] = [],
    secondsToPersist: Double?,
    _ closure: ((UIAlertController) -> Void)? = nil
)

Parameters

`title`	Title of the UIAlertController
`message`	Message of the UIAlertController
`withactions`	Array of action objects to be added to the Alert (Default: [])
`secondsToPersist`	Amount of seconds the Alert should show before dismissing itself
`closure`	A closure that is passed the UIAlertController before presenting it (Default: nil)

Show on GitHub

ActionSheet


                    
                    
                    actionSheet(title:message:withActions:_:)

Show an ActionSheet

Declaration

Swift

public func actionSheet(
    title: String,
    message: String,
    withActions actions: [UIAlertAction] = [],
    _ closure: ((UIAlertController) -> Void)? = nil
)

Parameters

`title`	Title of the UIAlertController
`message`	Message of the UIAlertController
`withactions`	Array of action objects to be added to the ActionSheet (Default: [])
`closure`	A closure that is passed the UIAlertController before presenting it (Default: nil)

Show on GitHub

Toasts & Messages


                    
                    
                    toast(style:pinToTop:secondsToPersist:animationInDuration:animationOutDuration:padding:tapHandler:_:)

Show a Toast Message

Declaration

Swift

@available(iOS 11.0, *)
public func toast(
    style: ToastStyle = .custom,
    pinToTop: Bool = true,
    secondsToPersist: Double? = nil,
    animationInDuration: Double = 0.5,
    animationOutDuration: Double = 0.5,
    padding: Float = 8,
    tapHandler: @escaping (UIView) -> Void = { $0.removeFromSuperview() },
    _ closure: @escaping () -> UIView
)

Parameters

`style`	The ToastStyle (Default: .custom)
`pinToTop`	Should the Toast pin to the top or bottom (Default: true)
`secondsToPersist`	Amount of seconds the Toast should show before dismissing itself (Default: nil)
`animationInDuration`	The amount of seconds the Toast should fade in (Default: 0.5)
`animationOutDuration`	The amount of seconds the Toast should fade out (Default: 0.5)
`padding`	The amount of spacing around the Toast (Default: 8)
`tapHandler`	What happens when the user taps on the Toast (Default: { $0.removeFromSuperview() })
`closure`	A trailing closure that accepts a view

Show on GitHub

destroyToast()
Destory the toast
Declaration
Swift

public func destroyToast()
Show on GitHub