AXOverlayView

final class AXOverlayView : UIView, AXStackableViewContainerDelegate

AXOverlayView

frameAnimDuration
Standard frame duration
Declaration
Swift

static let frameAnimDuration: TimeInterval
Show on GitHub
toolbar
The toolbar used to set the titleView, leftBarButtonItems, rightBarButtonItems
Declaration
Swift

let toolbar: UIToolbar
Show on GitHub
titleView
The title view displayed in the toolbar. This view is sized and centered between the leftBarButtonItems and rightBarButtonItems. This is prioritized over title.
Declaration
Swift

var titleView: AXOverlayTitleViewProtocol? { get set }
Show on GitHub
titleViewBarButtonItem
The bar button item used internally to display the titleView attribute in the toolbar.
Declaration
Swift

var titleViewBarButtonItem: UIBarButtonItem?
Show on GitHub
title
The title displayed in the toolbar. This string is centered between the leftBarButtonItems and rightBarButtonItems. Overwrites internalTitle.
Declaration
Swift

var title: String? { get set }
Show on GitHub
internalTitle
The title displayed in the toolbar. This string is centered between the leftBarButtonItems and rightBarButtonItems. This is used internally by the library to set a default title. Overwritten by title.
Declaration
Swift

var internalTitle: String? { get set }
Show on GitHub
titleTextAttributes
The title text attributes inherited by the title.
Declaration
Swift

var titleTextAttributes: [NSAttributedString.Key : Any]? { get set }
Show on GitHub
titleBarButtonItem
The bar button item used internally to display the title attribute in the toolbar.
Declaration
Swift

let titleBarButtonItem: UIBarButtonItem
Show on GitHub
leftBarButtonItem
The bar button item that appears in the top left corner of the overlay.
Declaration
Swift

var leftBarButtonItem: UIBarButtonItem? { get set }
Show on GitHub
leftBarButtonItems
The bar button items that appear in the top left corner of the overlay.
Declaration
Swift

var leftBarButtonItems: [UIBarButtonItem]? { get set }
Show on GitHub
rightBarButtonItem
The bar button item that appears in the top right corner of the overlay.
Declaration
Swift

var rightBarButtonItem: UIBarButtonItem? { get set }
Show on GitHub
rightBarButtonItems
The bar button items that appear in the top right corner of the overlay.
Declaration
Swift

var rightBarButtonItems: [UIBarButtonItem]? { get set }
Show on GitHub
captionView
The caption view to be used in the overlay.
Declaration
Swift

var captionView: AXCaptionViewProtocol { get set }
Show on GitHub
animateCaptionViewChanges
Whether or not to animate captionView changes. Defaults to true.
Declaration
Swift

var animateCaptionViewChanges: Bool { get set }
Show on GitHub
contentInset
The inset of the contents of the OverlayView. Use this property to adjust layout for things such as status bar height. For internal use only.
Declaration
Swift

var contentInset: UIEdgeInsets { get set }
Show on GitHub
topStackContainer
Container to embed all content anchored at the top of the overlayView. Add custom subviews to the top container in the order that you wish to stack them. These must be self-sizing views.
Declaration
Swift

var topStackContainer: AXStackableViewContainer!
Show on GitHub
bottomStackContainer
Container to embed all content anchored at the bottom of the overlayView. Add custom subviews to the bottom container in the order that you wish to stack them. These must be self-sizing views.
Declaration
Swift

var bottomStackContainer: AXStackableViewContainer!
Show on GitHub

Completions


                    
                    
                    performAfterShowInterfaceCompletion(_:)

PerformAfterShowInterfaceCompletion

Declaration

Swift

func performAfterShowInterfaceCompletion(_ closure: @escaping () -> Void)

Parameters


                                closure

Completion

Show on GitHub

Show / hide interface


                    
                    
                    setShowInterface(_:animated:alongside:completion:)

Show or hide interface

Declaration

Swift

func setShowInterface(_ show: Bool,
                      animated: Bool,
                      alongside closure: (() -> Void)? = nil,
                      completion: ((Bool) -> Void)? = nil)

Parameters

`show`	Whether to show
`animated`	Whether to animate
`closure`	Alongside closure
`completion`	Completion closure

Show on GitHub

AXCaptionViewProtocol


                    
                    
                    updateCaptionView(photo:)

Update caption view

Declaration

Swift

func updateCaptionView(photo: AXPhotoProtocol)

Parameters


                                photo

AXPhotoProtocol

Show on GitHub