447 lines
19 KiB
Swift
447 lines
19 KiB
Swift
//
|
|
// Created by Shin Yamamoto on 2018/09/18.
|
|
// Copyright © 2018 Shin Yamamoto. All rights reserved.
|
|
//
|
|
|
|
import UIKit
|
|
|
|
public protocol FloatingPanelControllerDelegate: class {
|
|
// if it returns nil, FloatingPanelController uses the default layout
|
|
func floatingPanel(_ vc: FloatingPanelController, layoutFor newCollection: UITraitCollection) -> FloatingPanelLayout?
|
|
|
|
// if it returns nil, FloatingPanelController uses the default behavior
|
|
func floatingPanel(_ vc: FloatingPanelController, behaviorFor newCollection: UITraitCollection) -> FloatingPanelBehavior?
|
|
|
|
func floatingPanelDidChangePosition(_ vc: FloatingPanelController) // changed the settled position in the model layer
|
|
|
|
func floatingPanelDidMove(_ vc: FloatingPanelController) // any offset changes
|
|
|
|
// called on start of dragging (may require some time and or distance to move)
|
|
func floatingPanelWillBeginDragging(_ vc: FloatingPanelController)
|
|
// called on finger up if the user dragged. velocity is in points/second.
|
|
func floatingPanelDidEndDragging(_ vc: FloatingPanelController, withVelocity velocity: CGPoint, targetPosition: FloatingPanelPosition)
|
|
func floatingPanelWillBeginDecelerating(_ vc: FloatingPanelController) // called on finger up as we are moving
|
|
func floatingPanelDidEndDecelerating(_ vc: FloatingPanelController) // called when scroll view grinds to a halt
|
|
|
|
// called on start of dragging to remove its views from a parent view controller
|
|
func floatingPanelDidEndDraggingToRemove(_ vc: FloatingPanelController, withVelocity velocity: CGPoint)
|
|
// called when its views are removed from a parent view controller
|
|
func floatingPanelDidEndRemove(_ vc: FloatingPanelController)
|
|
}
|
|
|
|
public extension FloatingPanelControllerDelegate {
|
|
func floatingPanel(_ vc: FloatingPanelController, layoutFor newCollection: UITraitCollection) -> FloatingPanelLayout? {
|
|
return nil
|
|
}
|
|
func floatingPanel(_ vc: FloatingPanelController, behaviorFor newCollection: UITraitCollection) -> FloatingPanelBehavior? {
|
|
return nil
|
|
}
|
|
func floatingPanelDidChangePosition(_ vc: FloatingPanelController) {}
|
|
func floatingPanelDidMove(_ vc: FloatingPanelController) {}
|
|
func floatingPanelWillBeginDragging(_ vc: FloatingPanelController) {}
|
|
func floatingPanelDidEndDragging(_ vc: FloatingPanelController, withVelocity velocity: CGPoint, targetPosition: FloatingPanelPosition) {}
|
|
func floatingPanelWillBeginDecelerating(_ vc: FloatingPanelController) {}
|
|
func floatingPanelDidEndDecelerating(_ vc: FloatingPanelController) {}
|
|
|
|
func floatingPanelDidEndDraggingToRemove(_ vc: FloatingPanelController, withVelocity velocity: CGPoint) {}
|
|
func floatingPanelDidEndRemove(_ vc: FloatingPanelController) {}
|
|
}
|
|
|
|
public enum FloatingPanelPosition: Int, CaseIterable {
|
|
case full
|
|
case half
|
|
case tip
|
|
case hidden
|
|
}
|
|
|
|
///
|
|
/// A container view controller to display a floating panel to present contents in parallel as a user wants.
|
|
///
|
|
public class FloatingPanelController: UIViewController, UIScrollViewDelegate, UIGestureRecognizerDelegate {
|
|
/// Constants indicating how safe area insets are added to the adjusted content inset.
|
|
public enum ContentInsetAdjustmentBehavior: Int {
|
|
case always
|
|
case never
|
|
}
|
|
|
|
/// The delegate of the floating panel controller object.
|
|
public weak var delegate: FloatingPanelControllerDelegate?
|
|
|
|
/// Returns the surface view managed by the controller object. It's the same as `self.view`.
|
|
public var surfaceView: FloatingPanelSurfaceView! {
|
|
return floatingPanel.surfaceView
|
|
}
|
|
|
|
/// Returns the backdrop view managed by the controller object.
|
|
public var backdropView: FloatingPanelBackdropView! {
|
|
return floatingPanel.backdropView
|
|
}
|
|
|
|
/// Returns the scroll view that the controller tracks.
|
|
public weak var scrollView: UIScrollView? {
|
|
return floatingPanel.scrollView
|
|
}
|
|
|
|
// The underlying gesture recognizer for pan gestures
|
|
public var panGestureRecognizer: UIPanGestureRecognizer {
|
|
return floatingPanel.panGesture
|
|
}
|
|
|
|
/// The current position of the floating panel controller's contents.
|
|
public var position: FloatingPanelPosition {
|
|
return floatingPanel.state
|
|
}
|
|
|
|
/// The layout object managed by the controller
|
|
public var layout: FloatingPanelLayout {
|
|
return floatingPanel.layoutAdapter.layout
|
|
}
|
|
|
|
/// The behavior object managed by the controller
|
|
public var behavior: FloatingPanelBehavior {
|
|
return floatingPanel.behavior
|
|
}
|
|
|
|
/// The content insets of the tracking scroll view derived from this safe area
|
|
public var adjustedContentInsets: UIEdgeInsets {
|
|
return floatingPanel.layoutAdapter.adjustedContentInsets
|
|
}
|
|
|
|
/// The behavior for determining the adjusted content offsets.
|
|
///
|
|
/// This property specifies how the content area of the tracking scroll view is modified using `adjustedContentInsets`. The default value of this property is FloatingPanelController.ContentInsetAdjustmentBehavior.always.
|
|
public var contentInsetAdjustmentBehavior: ContentInsetAdjustmentBehavior = .always
|
|
|
|
/// A Boolean value that determines whether the removal interaction is enabled.
|
|
public var isRemovalInteractionEnabled: Bool {
|
|
set { floatingPanel.isRemovalInteractionEnabled = newValue }
|
|
get { return floatingPanel.isRemovalInteractionEnabled }
|
|
}
|
|
|
|
/// The view controller responsible for the content portion of the floating panel.
|
|
public var contentViewController: UIViewController? {
|
|
set { set(contentViewController: newValue) }
|
|
get { return _contentViewController }
|
|
}
|
|
private var _contentViewController: UIViewController?
|
|
|
|
private var floatingPanel: FloatingPanel!
|
|
private var safeAreaInsetsObservation: NSKeyValueObservation?
|
|
private let modalTransition = FloatingPanelModalTransition()
|
|
|
|
required init?(coder aDecoder: NSCoder) {
|
|
super.init(coder: aDecoder)
|
|
setUp()
|
|
}
|
|
|
|
/// Initialize a newly created floating panel controller.
|
|
public init() {
|
|
super.init(nibName: nil, bundle: nil)
|
|
setUp()
|
|
}
|
|
|
|
private func setUp() {
|
|
_ = FloatingPanelController.dismissSwizzling
|
|
|
|
modalPresentationStyle = .custom
|
|
transitioningDelegate = modalTransition
|
|
|
|
floatingPanel = FloatingPanel(self,
|
|
layout: fetchLayout(for: self.traitCollection),
|
|
behavior: fetchBehavior(for: self.traitCollection))
|
|
}
|
|
|
|
// MARK:- Overrides
|
|
|
|
/// Creates the view that the controller manages.
|
|
override public func loadView() {
|
|
assert(self.storyboard == nil, "Storyboard isn't supported")
|
|
|
|
let view = FloatingPanelPassThroughView()
|
|
view.backgroundColor = .clear
|
|
|
|
self.view = view as UIView
|
|
}
|
|
|
|
public override func viewDidLoad() {
|
|
super.viewDidLoad()
|
|
floatingPanel.setUpViews(in: self)
|
|
}
|
|
|
|
public override func willTransition(to newCollection: UITraitCollection, with coordinator: UIViewControllerTransitionCoordinator) {
|
|
super.willTransition(to: newCollection, with: coordinator)
|
|
|
|
// Change layout for a new trait collection
|
|
updateLayout(for: newCollection)
|
|
floatingPanel.layoutAdapter.checkLayoutConsistance()
|
|
|
|
floatingPanel.behavior = fetchBehavior(for: newCollection)
|
|
}
|
|
|
|
public override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
|
|
super.traitCollectionDidChange(previousTraitCollection)
|
|
guard previousTraitCollection != traitCollection else { return }
|
|
|
|
self.update(safeAreaInsets: layoutInsets)
|
|
}
|
|
|
|
public override func viewDidAppear(_ animated: Bool) {
|
|
super.viewDidAppear(animated)
|
|
// Must track safeAreaInsets/{top,bottom}LayoutGuide of the `self.view`
|
|
// to update floatingPanel.safeAreaInsets`. There are 2 reasons.
|
|
// 1. This or the parent VC doesn't call viewSafeAreaInsetsDidChange() on the bottom
|
|
// inset's update expectedly.
|
|
// 2. The safe area top inset can be variable on the large title navigation bar(iOS11+).
|
|
// That's why it needs the observation to keep `adjustedContentInsets` correct.
|
|
if #available(iOS 11.0, *) {
|
|
safeAreaInsetsObservation = self.observe(\.view.safeAreaInsets) { [weak self] (vc, chaneg) in
|
|
guard let self = self else { return }
|
|
self.update(safeAreaInsets: vc.layoutInsets)
|
|
}
|
|
} else {
|
|
// KVOs for topLayoutGuide & bottomLayoutGuide are not effective.
|
|
// Instead, safeAreaInsets is updated here
|
|
self.update(safeAreaInsets: layoutInsets)
|
|
}
|
|
}
|
|
|
|
public override func viewWillDisappear(_ animated: Bool) {
|
|
super.viewWillDisappear(animated)
|
|
safeAreaInsetsObservation = nil
|
|
}
|
|
|
|
// MARK:- Privates
|
|
|
|
private func fetchLayout(for traitCollection: UITraitCollection) -> FloatingPanelLayout {
|
|
switch traitCollection.verticalSizeClass {
|
|
case .compact:
|
|
return self.delegate?.floatingPanel(self, layoutFor: traitCollection) ?? FloatingPanelDefaultLandscapeLayout()
|
|
default:
|
|
return self.delegate?.floatingPanel(self, layoutFor: traitCollection) ?? FloatingPanelDefaultLayout()
|
|
}
|
|
}
|
|
|
|
private func fetchBehavior(for traitCollection: UITraitCollection) -> FloatingPanelBehavior {
|
|
return self.delegate?.floatingPanel(self, behaviorFor: traitCollection) ?? FloatingPanelDefaultBehavior()
|
|
}
|
|
|
|
private func update(safeAreaInsets: UIEdgeInsets) {
|
|
// preserve the current content offset
|
|
let contentOffset = scrollView?.contentOffset
|
|
|
|
floatingPanel.safeAreaInsets = safeAreaInsets
|
|
|
|
scrollView?.contentOffset = contentOffset ?? .zero
|
|
|
|
switch contentInsetAdjustmentBehavior {
|
|
case .always:
|
|
scrollView?.contentInset = adjustedContentInsets
|
|
scrollView?.scrollIndicatorInsets = adjustedContentInsets
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
|
|
private func updateLayout(for traitCollection: UITraitCollection) {
|
|
floatingPanel.layoutAdapter.layout = fetchLayout(for: traitCollection)
|
|
floatingPanel.layoutAdapter.prepareLayout(in: self)
|
|
floatingPanel.layoutAdapter.activateLayout(of: floatingPanel.state)
|
|
}
|
|
|
|
// MARK: - Container view controller interface
|
|
|
|
/// Shows the surface view at the initial position defined by the current layout
|
|
public func show(animated: Bool = false, completion: (() -> Void)? = nil) {
|
|
// Must apply the current layout here
|
|
updateLayout(for: traitCollection)
|
|
move(to: floatingPanel.layoutAdapter.layout.initialPosition,
|
|
animated: animated,
|
|
completion: completion)
|
|
}
|
|
|
|
/// Hides the surface view to the hidden position
|
|
public func hide(animated: Bool = false, completion: (() -> Void)? = nil) {
|
|
move(to: .hidden,
|
|
animated: animated,
|
|
completion: completion)
|
|
}
|
|
|
|
/// Adds the view managed by the controller as a child of the specified view controller.
|
|
/// - Parameters:
|
|
/// - parent: A parent view controller object that displays FloatingPanelController's view. A container view controller object isn't applicable.
|
|
/// - belowView: Insert the surface view managed by the controller below the specified view. By default, the surface view will be added to the end of the parent list of subviews.
|
|
/// - animated: Pass true to animate the presentation; otherwise, pass false.
|
|
public func addPanel(toParent parent: UIViewController, belowView: UIView? = nil, animated: Bool = false) {
|
|
guard self.parent == nil else {
|
|
log.warning("Already added to a parent(\(parent))")
|
|
return
|
|
}
|
|
precondition((parent is UINavigationController) == false, "UINavigationController displays only one child view controller at a time.")
|
|
precondition((parent is UITabBarController) == false, "UITabBarController displays child view controllers with a radio-style selection interface")
|
|
precondition((parent is UISplitViewController) == false, "UISplitViewController manages two child view controllers in a master-detail interface")
|
|
precondition((parent is UITableViewController) == false, "UITableViewController should not be the parent because the view is a table view so that a floating panel doens't work well")
|
|
precondition((parent is UICollectionViewController) == false, "UICollectionViewController should not be the parent because the view is a collection view so that a floating panel doens't work well")
|
|
|
|
if let belowView = belowView {
|
|
parent.view.insertSubview(self.view, belowSubview: belowView)
|
|
} else {
|
|
parent.view.addSubview(self.view)
|
|
}
|
|
|
|
view.frame = parent.view.bounds // MUST
|
|
|
|
parent.addChild(self)
|
|
|
|
show(animated: true) { [weak self] in
|
|
guard let self = self else { return }
|
|
self.didMove(toParent: parent)
|
|
}
|
|
}
|
|
|
|
/// Removes the controller and the managed view from its parent view controller
|
|
/// - Parameters:
|
|
/// - animated: Pass true to animate the presentation; otherwise, pass false.
|
|
/// - completion: The block to execute after the view controller is dismissed. This block has no return value and takes no parameters. You may specify nil for this parameter.
|
|
public func removePanelFromParent(animated: Bool, completion: (() -> Void)? = nil) {
|
|
guard self.parent != nil else {
|
|
completion?()
|
|
return
|
|
}
|
|
|
|
hide(animated: animated) { [weak self] in
|
|
guard let self = self else { return }
|
|
self.willMove(toParent: nil)
|
|
self.view.removeFromSuperview()
|
|
self.removeFromParent()
|
|
completion?()
|
|
}
|
|
}
|
|
|
|
/// Moves the position to the specified position.
|
|
/// - Parameters:
|
|
/// - to: Pass a FloatingPanelPosition value to move the surface view to the position.
|
|
/// - animated: Pass true to animate the presentation; otherwise, pass false.
|
|
/// - completion: The block to execute after the view controller has finished moving. This block has no return value and takes no parameters. You may specify nil for this parameter.
|
|
public func move(to: FloatingPanelPosition, animated: Bool, completion: (() -> Void)? = nil) {
|
|
precondition(floatingPanel.layoutAdapter.vc != nil, "Use show(animated:completion)")
|
|
floatingPanel.move(to: to, animated: animated, completion: completion)
|
|
}
|
|
|
|
/// Sets the view controller responsible for the content portion of the floating panel..
|
|
public func set(contentViewController: UIViewController?) {
|
|
if let vc = _contentViewController {
|
|
vc.willMove(toParent: nil)
|
|
vc.view.removeFromSuperview()
|
|
vc.removeFromParent()
|
|
}
|
|
|
|
if let vc = contentViewController {
|
|
let surfaceView = floatingPanel.surfaceView
|
|
surfaceView.add(childView: vc.view)
|
|
addChild(vc)
|
|
vc.didMove(toParent: self)
|
|
}
|
|
|
|
_contentViewController = contentViewController
|
|
}
|
|
|
|
@available(*, unavailable, renamed: "set(contentViewController:)")
|
|
public override func show(_ vc: UIViewController, sender: Any?) {
|
|
if let target = self.parent?.targetViewController(forAction: #selector(UIViewController.show(_:sender:)), sender: sender) {
|
|
target.show(vc, sender: sender)
|
|
}
|
|
}
|
|
|
|
@available(*, unavailable, renamed: "set(contentViewController:)")
|
|
public override func showDetailViewController(_ vc: UIViewController, sender: Any?) {
|
|
if let target = self.parent?.targetViewController(forAction: #selector(UIViewController.showDetailViewController(_:sender:)), sender: sender) {
|
|
target.showDetailViewController(vc, sender: sender)
|
|
}
|
|
}
|
|
|
|
// MARK: - Scroll view tracking
|
|
|
|
/// Tracks the specified scroll view to correspond with the scroll.
|
|
///
|
|
/// - Attention:
|
|
/// The specified scroll view must be already assigned to the delegate property because the controller intermediates between the various delegate methods.
|
|
///
|
|
public func track(scrollView: UIScrollView) {
|
|
floatingPanel.scrollView = scrollView
|
|
if scrollView.delegate !== floatingPanel {
|
|
floatingPanel.userScrollViewDelegate = scrollView.delegate
|
|
scrollView.delegate = floatingPanel
|
|
}
|
|
switch contentInsetAdjustmentBehavior {
|
|
case .always:
|
|
if #available(iOS 11.0, *) {
|
|
scrollView.contentInsetAdjustmentBehavior = .never
|
|
} else {
|
|
children.forEach { (vc) in
|
|
vc.automaticallyAdjustsScrollViewInsets = false
|
|
}
|
|
}
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
|
|
// MARK: - Utilities
|
|
|
|
/// Updates the layout object from the delegate and lays out the views managed
|
|
/// by the controller immediately.
|
|
///
|
|
/// This method updates the `FloatingPanelLayout` object from the delegate and
|
|
/// then it calls `layoutIfNeeded()` of the root view to force the view
|
|
/// to update the floating panel's layout immediately. It can be called in an
|
|
/// animation block.
|
|
public func updateLayout() {
|
|
updateLayout(for: view.traitCollection)
|
|
floatingPanel.layoutAdapter.checkLayoutConsistance()
|
|
}
|
|
|
|
/// Returns the y-coordinate of the point at the origin of the surface view
|
|
public func originYOfSurface(for pos: FloatingPanelPosition) -> CGFloat {
|
|
switch pos {
|
|
case .full:
|
|
return floatingPanel.layoutAdapter.topY
|
|
case .half:
|
|
return floatingPanel.layoutAdapter.middleY
|
|
case .tip:
|
|
return floatingPanel.layoutAdapter.bottomY
|
|
case .hidden:
|
|
return floatingPanel.layoutAdapter.hiddenY
|
|
}
|
|
}
|
|
}
|
|
|
|
extension FloatingPanelController {
|
|
private static let dismissSwizzling: Any? = {
|
|
let aClass: AnyClass! = UIViewController.self //object_getClass(vc)
|
|
if let imp = class_getMethodImplementation(aClass, #selector(dismiss(animated:completion:))),
|
|
let originalAltMethod = class_getInstanceMethod(aClass, #selector(fp_original_dismiss(animated:completion:))) {
|
|
method_setImplementation(originalAltMethod, imp)
|
|
}
|
|
let originalMethod = class_getInstanceMethod(aClass, #selector(dismiss(animated:completion:)))
|
|
let swizzledMethod = class_getInstanceMethod(aClass, #selector(fp_dismiss(animated:completion:)))
|
|
if let originalMethod = originalMethod, let swizzledMethod = swizzledMethod {
|
|
// switch implementation..
|
|
method_exchangeImplementations(originalMethod, swizzledMethod)
|
|
}
|
|
return nil
|
|
}()
|
|
}
|
|
|
|
public extension UIViewController {
|
|
@objc public func fp_original_dismiss(animated flag: Bool, completion: (() -> Void)? = nil) {
|
|
// Implementation will be replaced by IMP of self.dismiss(animated:completion:)
|
|
}
|
|
@objc public func fp_dismiss(animated flag: Bool, completion: (() -> Void)? = nil) {
|
|
if let fpc = parent as? FloatingPanelController, fpc.parent != nil {
|
|
fpc.removePanelFromParent(animated: flag, completion: completion)
|
|
} else {
|
|
self.fp_original_dismiss(animated: flag, completion: completion)
|
|
}
|
|
}
|
|
}
|