PresenterKit Reference
Classes Reference
The following classes are available globally.
A modal presentation controller that presents the presented view controller modally, covering the bottom half of the presenting view controller. This presentation controller displays a transparent dimmed, tappable view over the top half of the presenting view controller.
Swift
View on GitHubpublic final class HalfModalPresentationController : UIPresentationController
PresenterKit Reference
NavigationStyle Enumeration Reference
View on GitHubpublic enum NavigationStyleSpecifies the navigation style for a view controller.
Do not embed a view controller in a UINavigationController.
Swift
case noneEmbed view controller in a UINavigationController.
Swift
case withNavigation
PresenterKit Reference
PresentationType Enumeration Reference
public enum PresentationTypeDescribes the type of presentation for a view controller.
A modal presentation type with the specified navigation, presentation, and transition styles.
Swift
case modal(NavigationStyle, UIModalPresentationStyle, UIModalTransitionStyle)A popover presentation type with the specified configuration.
Swift
case popover(PopoverConfig)A push presentation type.
Swift
case pushA “show” presentation type. This is an adaptive presentation that usually corresponds to .Push.
Swift
case showA “show detail” presentation type. This is an adaptive presentation that usually corresponds to .Modal.
Swift
case showDetail(NavigationStyle)A custom presentation style that uses the specified delegate.
Swift
case custom(UIViewControllerTransitioningDelegate)No presentation type specified, use UIKit defaults. Use this when presenting system controllers, like UIAlertController.
Swift
case none
PresenterKit Reference
Enumerations Reference
The following enumerations are available globally.
PresenterKit Reference
UIBarButtonItem Extension Reference
extension UIBarButtonItemInitializes a new bar button item using the specified configuration.
Swift
public convenience init(config: DismissButtonConfig, target: AnyObject?, action: Selector)
config
|
The configuration for the item. |
target
|
The object that receives the action message. |
action
|
The action to send to target when this item is selected. |
A new bar button item instance.
PresenterKit Reference
UINavigationController Extension Reference
extension UINavigationControllerPushes the given view controller and calls the given closure upon completion.
Swift
public func push(_ viewController: UIViewController,
animated: Bool = true,
completion: (() -> Void)? = nil)
viewController
|
The view controller to push onto the stack. |
animated
|
Specify |
completion
|
The closure to be called upon completion. |
Pops the top view controller and calls the given closure upon completion.
Swift
public func pop(animated: Bool = true,
completion: (() -> Void)? = nil)
animated
|
Specify |
completion
|
The closure to be called upon completion. |
PresenterKit Reference
UIViewController Extension Reference
extension UIViewControllerWraps the receiving view controller in a navigation controller.
The receiver is set as the rootViewController of the navigation controller.
Swift
@discardableResult
public func withNavigation() -> UINavigationControllerThe navigation controller that contains the receiver as the rootViewController.
Applies the specified modal presentation style to the view controller.
Swift
@discardableResult
public func withPresentation(_ presentation: UIModalPresentationStyle) -> Self
presentation
|
A modal presentation style. |
The view controller after applying the style.
Applies the specified modal transition style to the view controller.
Swift
@discardableResult
public func withTransition(_ transition: UIModalTransitionStyle) -> Self
transition
|
A modal transition style. |
The view controller after applying the style.
Applies the specified navigation style to the view controller.
Note
If navigationStyle is .withNavigation, then calling this method is equivalent to calling withNavigation().
If navigationStyle is .none, then calling this method does nothing.
Swift
@discardableResult
public func withNavigationStyle(_ navigationStyle: NavigationStyle) -> UIViewController
navigationStyle
|
A navigation style. |
The view controller after applying the style.
Applies the specified navigation style to the view controller.
Swift
@discardableResult
public func withStyles(navigation: NavigationStyle,
presentation: UIModalPresentationStyle,
transition: UIModalTransitionStyle) -> UIViewController
navigation
|
A navigation style. |
presentation
|
A modal presentation style. |
transition
|
A modal transition style. |
The view controller after applying the style.
Presents a view controller using the specified presentation type.
Warning
The completion parameter is ignored for show and showDetail presentation types.
Swift
public func presentController(_ controller: UIViewController,
type: PresentationType,
animated: Bool = true,
completion: (() -> Void)? = nil)
viewController
|
The view controller to display over the current view controller. |
type
|
The presentation type to use. |
animated
|
Pass |
completion
|
The closure to be called. |
Dismisses the receiving view controller.
Swift
public func dismissController(animated: Bool = true, completion: (() -> Void)? = nil)
animated
|
Pass |
completion
|
The closure to be called upon completion. |
Adds a dismiss button having the provided configuration, if needed.
Note
This method does nothing if the view controller is not presented modally.
Swift
public func addDismissButtonIfNeeded(config: DismissButtonConfig = DismissButtonConfig())
config
|
The configuration to apply to the dismiss button. |
Adds a dismiss button having the provided configuration.
Note
The view controller must have a non-nil navigationItem.
Swift
public func addDismissButton(config: DismissButtonConfig = DismissButtonConfig())
config
|
The configuration to apply to the dismiss button. |
PresenterKit Reference
Extensions Reference
The following extensions are available globally.
Swift
extension UIBarButtonItemSwift
extension UINavigationControllerSwift
extension UIViewController
PresenterKit Reference
Guides Reference
The following guides are available globally.
PresenterKit Reference
Content Enumeration Reference
View on GitHubpublic enum ContentSpecifies the content (title or image) for the bar button.
Specifies a UIBarButtonSystemItem.
Swift
case systemItem(UIBarButtonItem.SystemItem)Specifies custom text for the bar button.
Swift
case text(String)Specifies a custom image for the bar button.
Swift
case image(UIImage)
PresenterKit Reference
Location Enumeration Reference
public enum LocationSpecifies a bar button’s location in a navigation bar.
PresenterKit Reference
Style Enumeration Reference
public enum StyleSpecifies a bar button’s item style.
PresenterKit Reference
DismissButtonConfig Structure Reference
public struct DismissButtonConfigA configuration for UIBarButtonItem.
Use this configuration to create dismissal/cancel buttons for modally presented view controllers.
Specifies a bar button’s location in a navigation bar.
See moreSwift
public enum LocationSpecifies a bar button’s item style.
See moreSwift
public enum StyleSpecifies the content (title or image) for the bar button.
See moreSwift
public enum ContentThe location for the bar button.
The default is .left.
Swift
public let location: LocationThe style for the bar button.
The default is .plain.
Swift
public let style: StyleThe content for the bar button.
The default is .plain.
Swift
public let content: ContentInitializes a new configuration instance.
location
|
The location for the bar button. The default is |
style
|
The style for the bar button. The default is |
content
|
The content for the bar button. The default is |
A new configuration instance.
PresenterKit Reference
Source Enumeration Reference
public enum SourceDescribes the source view from which the popover is showing.
Specifies that the popover should display from a UIBarButtonItem instance.
Swift
case barButtonItem(UIBarButtonItem)Specifies that the popover should display from a UIView instance and be anchored on the specific frame.
If the frame is nil then the provided view’s frame will be used as the anchor frame.
Swift
case view(container: UIView, frame: CGRect?)
PresenterKit Reference
PopoverConfig Structure Reference
public struct PopoverConfigA configuration for UIPopoverPresentationController.
Describes the source view from which the popover is showing.
See moreSwift
public enum SourceInitializes and returns a new PopoverConfig object.
Swift
public init(source: Source,
arrowDirection: UIPopoverArrowDirection = .any,
delegate: UIPopoverPresentationControllerDelegate? = nil)
source
|
The source for the popoever. |
arrowDirection
|
The arrow direction for the popover. The default is |
delegate
|
The delegate for the popover. The default is |
A new PopoverConfig object.
PresenterKit Reference
Structures Reference
The following structures are available globally.
A configuration for UIBarButtonItem.
Use this configuration to create dismissal/cancel buttons for modally presented view controllers.
Swift
public struct DismissButtonConfigA configuration for UIPopoverPresentationController.
Swift
public struct PopoverConfig
PresenterKit Reference
Getting Started Reference
This guide provides a brief overview for how to get started using PresenterKit.
import PresenterKit
let vc = MyViewController()
presentController(vc, type: .modal(.withNavigation, .formSheet, .coverVertical))
let vc = MyViewController()
presentController(vc, type: .push)
let vc = MyViewController()
let config = PopoverConfig(source: .barButtonItem(item), delegate: self)
presentController(vc, type: .popover(config))
dismissController()
PresenterKit Reference
PresenterKit Reference
Custom presenters and better view controller presentation for iOS
pod 'PresenterKit', '~> 6.1.0'
# develop branch
pod 'PresenterKit', :git => 'https://github.com/jessesquires/PresenterKit.git', :branch => 'develop'
Add PresenterKit to the dependencies value of your Package.swift.
dependencies: [
.package(url: "https://github.com/jessesquires/PresenterKit.git", from: "6.1.0")
]
Alternatively, you can add the package directly via Xcode.
You can read the documentation here. Generated with jazzy. Hosted by GitHub Pages.
Interested in making contributions to this project? Please review the guides below.
Also, consider sponsoring this project or buying my apps! ✌️
Created and maintained by @jesse_squires.
Released under the MIT License. See LICENSE for details.
Copyright © 2016-present Jesse Squires.
Specifies that the popover should display from a UIBarButtonItem instance.
Specifies that the popover should display from a UIView instance and be anchored on the specific frame.","parent_name":"Source"},"Structs/PopoverConfig/Source.html":{"name":"Source","abstract":"
Describes the source view from which the popover is showing.
","parent_name":"PopoverConfig"},"Structs/PopoverConfig.html#/s:12PresenterKit13PopoverConfigV6source14arrowDirection8delegateA2C6SourceO_So014UIPopoverArrowG0VSo0J30PresentationControllerDelegate_pSgtcfc":{"name":"init(source:arrowDirection:delegate:)","abstract":"Initializes and returns a new PopoverConfig object.
Specifies a UIBarButtonSystemItem.
Specifies custom text for the bar button.
","parent_name":"Content"},"Structs/DismissButtonConfig/Content.html#/s:12PresenterKit19DismissButtonConfigV7ContentO5imageyAESo7UIImageCcAEmF":{"name":"image(_:)","abstract":"Specifies a custom image for the bar button.
","parent_name":"Content"},"Structs/DismissButtonConfig/Style.html#/s:12PresenterKit19DismissButtonConfigV5StyleO4boldyA2EmF":{"name":"bold","abstract":"Use bold text, .Done style.
Use regular text, .Plain style.
The left side of the navigation bar.
","parent_name":"Location"},"Structs/DismissButtonConfig/Location.html#/s:12PresenterKit19DismissButtonConfigV8LocationO5rightyA2EmF":{"name":"right","abstract":"The right side of the navigation bar.
","parent_name":"Location"},"Structs/DismissButtonConfig/Location.html":{"name":"Location","abstract":"Specifies a bar button’s location in a navigation bar.
","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig/Style.html":{"name":"Style","abstract":"Specifies a bar button’s item style.
","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig/Content.html":{"name":"Content","abstract":"Specifies the content (title or image) for the bar button.
","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig.html#/s:12PresenterKit19DismissButtonConfigV8locationAC8LocationOvp":{"name":"location","abstract":"The location for the bar button.","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig.html#/s:12PresenterKit19DismissButtonConfigV5styleAC5StyleOvp":{"name":"style","abstract":"
The style for the bar button.","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig.html#/s:12PresenterKit19DismissButtonConfigV7contentAC7ContentOvp":{"name":"content","abstract":"
The content for the bar button.","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig.html#/s:12PresenterKit19DismissButtonConfigV8location5style7contentA2C8LocationO_AC5StyleOAC7ContentOtcfc":{"name":"init(location:style:content:)","abstract":"
Initializes a new configuration instance.
","parent_name":"DismissButtonConfig"},"Structs/DismissButtonConfig.html":{"name":"DismissButtonConfig","abstract":"A configuration for UIBarButtonItem."},"Structs/PopoverConfig.html":{"name":"PopoverConfig","abstract":"
A configuration for UIPopoverPresentationController.
Wraps the receiving view controller in a navigation controller.","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE16withPresentationyABXDSo07UIModalF5StyleVF":{"name":"withPresentation(_:)","abstract":"
Applies the specified modal presentation style to the view controller.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE14withTransitionyABXDSo07UIModalF5StyleVF":{"name":"withTransition(_:)","abstract":"Applies the specified modal transition style to the view controller.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE19withNavigationStyleyAbC0fG0OF":{"name":"withNavigationStyle(_:)","abstract":"Applies the specified navigation style to the view controller.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE10withStyles10navigation12presentation10transitionAbC15NavigationStyleO_So019UIModalPresentationK0VSo0l10TransitionK0VtF":{"name":"withStyles(navigation:presentation:transition:)","abstract":"Applies the specified navigation style to the view controller.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE07presentB0_4type8animated10completionyAB_AC16PresentationTypeOSbyycSgtF":{"name":"presentController(_:type:animated:completion:)","abstract":"Presents a view controller using the specified presentation type.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE07dismissB08animated10completionySb_yycSgtF":{"name":"dismissController(animated:completion:)","abstract":"Dismisses the receiving view controller.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE24addDismissButtonIfNeeded6configyAC0fG6ConfigV_tF":{"name":"addDismissButtonIfNeeded(config:)","abstract":"Adds a dismiss button having the provided configuration, if needed.
","parent_name":"UIViewController"},"Extensions/UIViewController.html#/s:So16UIViewControllerC12PresenterKitE16addDismissButton6configyAC0fG6ConfigV_tF":{"name":"addDismissButton(config:)","abstract":"Adds a dismiss button having the provided configuration.
","parent_name":"UIViewController"},"Extensions/UINavigationController.html#/s:So22UINavigationControllerC12PresenterKitE4push_8animated10completionySo06UIViewB0C_SbyycSgtF":{"name":"push(_:animated:completion:)","abstract":"Pushes the given view controller and calls the given closure upon completion.
","parent_name":"UINavigationController"},"Extensions/UINavigationController.html#/s:So22UINavigationControllerC12PresenterKitE3pop8animated10completionySb_yycSgtF":{"name":"pop(animated:completion:)","abstract":"Pops the top view controller and calls the given closure upon completion.
","parent_name":"UINavigationController"},"Extensions/UIBarButtonItem.html#/s:So15UIBarButtonItemC12PresenterKitE6config6target6actionAbC07DismissB6ConfigV_yXlSg10ObjectiveC8SelectorVtcfc":{"name":"init(config:target:action:)","abstract":"Initializes a new bar button item using the specified configuration.
","parent_name":"UIBarButtonItem"},"Extensions/UIBarButtonItem.html":{"name":"UIBarButtonItem"},"Extensions/UINavigationController.html":{"name":"UINavigationController"},"Extensions/UIViewController.html":{"name":"UIViewController"},"Enums/PresentationType.html#/s:12PresenterKit16PresentationTypeO5modalyAcA15NavigationStyleO_So07UIModalcG0VSo0h10TransitionG0VtcACmF":{"name":"modal(_:_:_:)","abstract":"A modal presentation type with the specified navigation, presentation, and transition styles.
","parent_name":"PresentationType"},"Enums/PresentationType.html#/s:12PresenterKit16PresentationTypeO7popoveryAcA13PopoverConfigVcACmF":{"name":"popover(_:)","abstract":"A popover presentation type with the specified configuration.
","parent_name":"PresentationType"},"Enums/PresentationType.html#/s:12PresenterKit16PresentationTypeO4pushyA2CmF":{"name":"push","abstract":"A push presentation type.
","parent_name":"PresentationType"},"Enums/PresentationType.html#/s:12PresenterKit16PresentationTypeO4showyA2CmF":{"name":"show","abstract":"A “show” presentation type. This is an adaptive presentation that usually corresponds to .Push.
A “show detail” presentation type. This is an adaptive presentation that usually corresponds to .Modal.
A custom presentation style that uses the specified delegate.
","parent_name":"PresentationType"},"Enums/PresentationType.html#/s:12PresenterKit16PresentationTypeO4noneyA2CmF":{"name":"none","abstract":"No presentation type specified, use UIKit defaults. Use this when presenting system controllers, like UIAlertController.
Do not embed a view controller in a UINavigationController.
Embed view controller in a UINavigationController.
Specifies the navigation style for a view controller.
"},"Enums/PresentationType.html":{"name":"PresentationType","abstract":"Describes the type of presentation for a view controller.
"},"Classes.html#/c:@M@PresenterKit@objc(cs)HalfModalPresentationController":{"name":"HalfModalPresentationController","abstract":"A modal presentation controller that presents the presented view controller modally,"},"getting-started.html":{"name":"Getting Started"},"Guides.html":{"name":"Guides","abstract":"
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}} ================================================ FILE: docs/undocumented.json ================================================ { "warnings": [ ], "source_directory": "/Users/jsq/GitHub/PresenterKit" } ================================================ FILE: scripts/build_docs.zsh ================================================ #!/bin/zsh # Created by Jesse Squires # https://www.jessesquires.com # # Copyright © 2020-present Jesse Squires # # Docs by jazzy # https://github.com/realm/jazzy/releases/latest # ------------------------------ # Generates documentation using jazzy and checks for installation. VERSION="0.13.6" FOUND=$(jazzy --version) LINK="https://github.com/realm/jazzy" INSTALL="gem install jazzy" PROJECT="PresenterKit" if which jazzy >/dev/null; then jazzy \ --clean \ --author "Jesse Squires" \ --author_url "https://jessesquires.com" \ --github_url "https://github.com/jessesquires/$PROJECT" \ --module "$PROJECT" \ --source-directory . \ --readme "README.md" \ --documentation "Guides/*.md" \ --output docs/ else echo " Error: Jazzy not installed! Download: $LINK Install: $INSTALL " exit 1 fi if [ "$FOUND" != "jazzy version: $VERSION" ]; then echo " Warning: incorrect Jazzy installed! Please upgrade. Expected: $VERSION Found: $FOUND Download: $LINK Install: $INSTALL " fi exit ================================================ FILE: scripts/lint.zsh ================================================ #!/bin/zsh # Created by Jesse Squires # https://www.jessesquires.com # # Copyright © 2020-present Jesse Squires # # SwiftLint # https://github.com/realm/SwiftLint/releases/latest # ------------------------------ # Runs SwiftLint and checks for installation. VERSION="0.41.0" FOUND=$(swiftlint version) LINK="https://github.com/realm/SwiftLint" INSTALL="brew install swiftlint" if which swiftlint >/dev/null; then swiftlint lint --config ./.swiftlint.yml else echo " Error: SwiftLint not installed! Download: $LINK Install: $INSTALL " fi if [ $FOUND != $VERSION ]; then echo " Warning: incorrect SwiftLint installed! Please upgrade. Expected: $VERSION Found: $FOUND Download: $LINK Install: $INSTALL " fi exit