Merge pull request #230 from SCENEE/fix-scrollindicator

Fix the scroll indicator lock on a contentVC reset

Framework/Sources/FloatingPanel.swift

@@ -8,7 +8,7 @@ import UIKit.UIGestureRecognizerSubclass // For Xcode 9.4.1
 ///
 /// FloatingPanel presentation model
 ///
-class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate {
+class FloatingPanel: NSObject, UIGestureRecognizerDelegate {
     // MUST be a weak reference to prevent UI freeze on the presentation modally
     weak var viewcontroller: FloatingPanelController!
 
@@ -52,8 +52,6 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
     private var scrollBouncable = false
     private var scrollIndictorVisible = false
 
-    private var isScrollLocked: Bool = false
-
     // MARK: - Interface
 
     init(_ vc: FloatingPanelController, layout: FloatingPanelLayout, behavior: FloatingPanelBehavior) {
@@ -118,6 +116,8 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                 self.animator = nil
                 if self.state == self.layoutAdapter.topMostState {
                     self.unlockScrollView()
+                } else {
+                    self.lockScrollView()
                 }
                 completion?()
             }
@@ -128,6 +128,8 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
             self.updateLayout(to: to)
             if self.state == self.layoutAdapter.topMostState {
                 self.unlockScrollView()
+            } else {
+                self.lockScrollView()
             }
             completion?()
         }
@@ -863,11 +865,10 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
     private func lockScrollView() {
         guard let scrollView = scrollView else { return }
 
-        if isScrollLocked {
+        if scrollView.isLocked {
             log.debug("Already scroll locked.")
             return
         }
-        isScrollLocked = true
 
         scrollBouncable = scrollView.bounces
         scrollIndictorVisible = scrollView.showsVerticalScrollIndicator
@@ -878,9 +879,7 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
     }
 
     private func unlockScrollView() {
-        guard let scrollView = scrollView, isScrollLocked else { return }
-
-        isScrollLocked = false
+        guard let scrollView = scrollView, scrollView.isLocked else { return }
 
         scrollView.isDirectionalLockEnabled = false
         scrollView.bounces = scrollBouncable

Framework/Sources/UIExtensions.swift

@@ -107,6 +107,9 @@ extension UIScrollView {
     var contentOffsetZero: CGPoint {
         return CGPoint(x: 0.0, y: 0.0 - contentInset.top)
     }
+    var isLocked: Bool {
+        return !showsVerticalScrollIndicator && !bounces &&  isDirectionalLockEnabled
+    }
 }
 
 extension UISpringTimingParameters {

Framework/Tests/FloatingPanelTests.swift

@@ -4,6 +4,7 @@
 //
 
 import XCTest
+@testable import FloatingPanel
 
 class FloatingPanelTests: XCTestCase {
 
@@ -11,4 +12,54 @@ class FloatingPanelTests: XCTestCase {
 
     override func tearDown() {}
 
+    func test_scrolllock() {
+        let fpc = FloatingPanelController()
+        fpc.loadViewIfNeeded()
+        fpc.view.frame = CGRect(x: 0, y: 0, width: 375, height: 667)
+        let contentVC1 = UITableViewController(nibName: nil, bundle: nil)
+        XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, true)
+        XCTAssertEqual(contentVC1.tableView.bounces, true)
+
+        fpc.set(contentViewController: contentVC1)
+        fpc.track(scrollView: contentVC1.tableView)
+        fpc.show(animated: false, completion: nil) // half
+        XCTAssertEqual(fpc.position, .half)
+        XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, false)
+        XCTAssertEqual(contentVC1.tableView.bounces, false)
+
+        fpc.move(to: .full, animated: false)
+        XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, true)
+        XCTAssertEqual(contentVC1.tableView.bounces, true)
+
+        fpc.move(to: .tip, animated: false)
+        XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, false)
+        XCTAssertEqual(contentVC1.tableView.bounces, false)
+
+        let exp1 = expectation(description: "move to full with animation")
+        fpc.move(to: .full, animated: true) {
+            XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, true)
+            XCTAssertEqual(contentVC1.tableView.bounces, true)
+            exp1.fulfill()
+        }
+        wait(for: [exp1], timeout: 1.0)
+
+        let exp2 = expectation(description: "move to tip with animation")
+        fpc.move(to: .tip, animated: false) {
+            XCTAssertEqual(contentVC1.tableView.showsVerticalScrollIndicator, false)
+            XCTAssertEqual(contentVC1.tableView.bounces, false)
+            exp2.fulfill()
+        }
+        wait(for: [exp2], timeout: 1.0)
+
+        // Reset the content vc
+        let contentVC2 = UITableViewController(nibName: nil, bundle: nil)
+        XCTAssertEqual(contentVC2.tableView.showsVerticalScrollIndicator, true)
+        XCTAssertEqual(contentVC2.tableView.bounces, true)
+        fpc.set(contentViewController: contentVC2)
+        fpc.track(scrollView: contentVC2.tableView)
+        fpc.show(animated: false, completion: nil)
+        XCTAssertEqual(fpc.position, .half)
+        XCTAssertEqual(contentVC2.tableView.showsVerticalScrollIndicator, false)
+        XCTAssertEqual(contentVC2.tableView.bounces, false)
+    }
 }