Add dismissaibleIn and non-animated disappear

f3dm76 · f3dm76 · commit ee0a4c6fc87f · 2025-04-08T16:47:34.000+07:00
diff --git a/README.md b/README.md
@@ -275,10 +275,11 @@ scroll parameters:
 `headerView` - a view on top which won't be a part of the scroll (if you need one)
 
 `position` - topLeading, top, topTrailing, leading, center, trailing, bottomLeading, bottom, bottomTrailing 
-`appearFrom` - `topSlide, bottomSlide, leftSlide, rightSlide, centerScale`: determines the direction of appearing animation. If left empty it copies `position` parameter: so appears from .top edge, if `position` is set to .top
+`appearFrom` - `topSlide, bottomSlide, leftSlide, rightSlide, centerScale, none`: determines the direction of appearing animation. If left empty it copies `position` parameter: so appears from .top edge, if `position` is set to .top. `.none` means no animation
 `disappearTo` - same as `appearFrom`, but for disappearing animation. If left empty it copies `appearFrom`.
 `animation` - custom animation for popup sliding onto screen  
 `autohideIn` - time after which popup should disappear    
+`dismissibleIn(Double?, Binding<Bool>?)` - only allow dismiss after this time passes (forbids closeOnTap, closeOnTapOutside, and drag). Pass a boolean binding if you'd like to track current status     
 `dragToDismiss` - true by default: enable/disable drag to dismiss (upwards for .top popup types, downwards for .bottom and default type)    
 `closeOnTap` - true by default: enable/disable closing on tap on popup     
 `closeOnTapOutside` - false by default: enable/disable closing on tap on outside of popup     
diff --git a/Sources/PopupView/FullscreenPopup.swift b/Sources/PopupView/FullscreenPopup.swift
@@ -29,6 +29,13 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
     /// If nil - never hides on its own
     var autohideIn: Double?
 
+    /// Only allow dismiss by any means after this time passes
+    var dismissibleIn: Double?
+
+    /// Becomes true when `dismissibleIn` times finishes
+    /// Makes no sense if `dismissibleIn` is nil
+    var dismissEnabled: Binding<Bool>
+
     /// Should close on tap outside - default is `false`
     var closeOnTapOutside: Bool
 
@@ -79,7 +86,10 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
     private var itemRef: ClassReference<Binding<Item?>>?
 
     /// holder for autohiding dispatch work (to be able to cancel it when needed)
-    @State private var dispatchWorkHolder = DispatchWorkHolder()
+    @State private var autohidingWorkHolder = DispatchWorkHolder()
+
+    /// holder for `dismissibleIn` dispatch work (to be able to cancel it when needed)
+    @State private var dismissibleInWorkHolder = DispatchWorkHolder()
 
     // MARK: - Autohide With Dragging
     /// If user "grabbed" the popup to drag it around, put off the autohiding until he lifts his finger up
@@ -90,6 +100,10 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
     /// if autohide time was set up, shows that timer has come to an end already
     @State private var timeToHide = false
 
+    // MARK: - dismissibleIn
+
+    private var dismissEnabledRef: ClassReference<Binding<Bool>>?
+
     // MARK: - Internal
 
     /// Set dismiss source to pass to dismiss callback
@@ -111,6 +125,8 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
 
         self.params = params
         self.autohideIn = params.autohideIn
+        self.dismissibleIn = params.dismissibleIn
+        self.dismissEnabled = params.dismissEnabled
         self.closeOnTapOutside = params.closeOnTapOutside
         self.backgroundColor = params.backgroundColor
         self.backgroundView = params.backgroundView
@@ -127,6 +143,7 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
 
         self.isPresentedRef = ClassReference(self.$isPresented)
         self.itemRef = ClassReference(self.$item)
+        self.dismissEnabledRef = ClassReference(self.dismissEnabled)
     }
 
     public func body(content: Content) -> some View {
@@ -217,7 +234,8 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
                 dismissSource: $dismissSource,
                 backgroundColor: backgroundColor,
                 backgroundView: backgroundView,
-                closeOnTapOutside: closeOnTapOutside
+                closeOnTapOutside: closeOnTapOutside,
+                dismissEnabled: dismissEnabled
             )
             .modifier(getModifier())
         }
@@ -236,7 +254,6 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
         Popup(
             params: params,
             view: viewForItem != nil ? viewForItem! : view,
-            popupPresented: popupPresented,
             shouldShowContent: $shouldShowContent,
             showContent: showContent,
             isDragging: $isDragging,
@@ -251,6 +268,7 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
                         }
                     }
                     setupAutohide()
+                    setupdismissibleIn()
                 }
             },
             dismissCallback: { source in
@@ -270,7 +288,8 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
         } else {
             closingIsInProcess = true
             userWillDismissCallback(dismissSource ?? .binding)
-            dispatchWorkHolder.work?.cancel()
+            autohidingWorkHolder.work?.cancel()
+            dismissibleInWorkHolder.work?.cancel()
             shouldShowContent = false // this will cause currentOffset change thus triggering the sliding hiding animation
             animatableOpacity = 0
             // do the rest once the animation is finished (see onAnimationCompleted())
@@ -289,6 +308,9 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
         }
         showContent = false // unload popup body after hiding animation is done
         tempItemView = nil
+        if dismissibleIn != nil {
+            dismissEnabled.wrappedValue = false
+        }
         performWithDelay(0.01) {
             showSheet = false
         }
@@ -302,27 +324,44 @@ public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier
     func setupAutohide() {
         // if needed, dispatch autohide and cancel previous one
         if let autohideIn = autohideIn {
-            dispatchWorkHolder.work?.cancel()
+            autohidingWorkHolder.work?.cancel()
 
             // Weak reference to avoid the work item capturing the struct,
             // which would create a retain cycle with the work holder itself.
 
-            dispatchWorkHolder.work = DispatchWorkItem(block: { [weak isPresentedRef, weak itemRef] in
+            autohidingWorkHolder.work = DispatchWorkItem(block: { [weak isPresentedRef, weak itemRef] in
                 if isDragging {
                     timeToHide = true // raise this flag to hide the popup once the drag is over
                     return
                 }
                 dismissSource = .autohide
                 isPresentedRef?.value.wrappedValue = false
                 itemRef?.value.wrappedValue = nil
-                dispatchWorkHolder.work = nil
+                autohidingWorkHolder.work = nil
             })
-            if popupPresented, let work = dispatchWorkHolder.work {
+            if popupPresented, let work = autohidingWorkHolder.work {
                 DispatchQueue.main.asyncAfter(deadline: .now() + autohideIn, execute: work)
             }
         }
     }
 
+    func setupdismissibleIn() {
+        if let dismissibleIn = dismissibleIn {
+            dismissibleInWorkHolder.work?.cancel()
+
+            // Weak reference to avoid the work item capturing the struct,
+            // which would create a retain cycle with the work holder itself.
+
+            dismissibleInWorkHolder.work = DispatchWorkItem(block: { [weak dismissEnabledRef] in
+                dismissEnabledRef?.value.wrappedValue = true
+                dismissibleInWorkHolder.work = nil
+            })
+            if popupPresented, let work = dismissibleInWorkHolder.work {
+                DispatchQueue.main.asyncAfter(deadline: .now() + dismissibleIn, execute: work)
+            }
+        }
+    }
+
     func performWithDelay(_ delay: Double, block: @escaping ()->()) {
         DispatchQueue.main.asyncAfter(deadline: .now() + delay) {
             block()
diff --git a/Sources/PopupView/PopupBackgroundView.swift b/Sources/PopupView/PopupBackgroundView.swift
@@ -21,6 +21,7 @@ struct PopupBackgroundView<Item: Equatable>: View {
     var backgroundColor: Color
     var backgroundView: AnyView?
     var closeOnTapOutside: Bool
+    var dismissEnabled: Binding<Bool>
 
     var body: some View {
         Group {
@@ -35,9 +36,11 @@ struct PopupBackgroundView<Item: Equatable>: View {
             view.contentShape(Rectangle())
         }
         .addTapIfNotTV(if: closeOnTapOutside) {
-            dismissSource = .tapOutside
-            isPresented = false
-            item = nil
+            if dismissEnabled.wrappedValue {
+                dismissSource = .tapOutside
+                isPresented = false
+                item = nil
+            }
         }
         .edgesIgnoringSafeArea(.all)
         .animation(.linear(duration: 0.2), value: animatableOpacity)
diff --git a/Sources/PopupView/PopupView.swift b/Sources/PopupView/PopupView.swift
@@ -15,7 +15,6 @@ public struct Popup<PopupContent: View>: ViewModifier {
 
     init(params: Popup<PopupContent>.PopupParameters,
          view: @escaping () -> PopupContent,
-         popupPresented: Bool,
          shouldShowContent: Binding<Bool>,
          showContent: Bool,
          isDragging: Binding<Bool>,
@@ -35,11 +34,11 @@ public struct Popup<PopupContent: View>: ViewModifier {
         self.animation = params.animation
         self.dragToDismiss = params.dragToDismiss
         self.dragToDismissDistance = params.dragToDismissDistance
+        self.dismissEnabled = params.dismissEnabled
         self.closeOnTap = params.closeOnTap
 
         self.view = view
 
-        self.popupPresented = popupPresented
         self.shouldShowContent = shouldShowContent
         self.showContent = showContent
         self._isDragging = isDragging
@@ -85,6 +84,10 @@ public struct Popup<PopupContent: View>: ViewModifier {
 
     var animation: Animation
 
+    /// Becomes true when `dismissibleIn` times finishes
+    /// Makes no sense if `dismissibleIn` is nil
+    var dismissEnabled: Binding<Bool>
+
     /// Should close on tap - default is `true`
     var closeOnTap: Bool
 
@@ -94,9 +97,6 @@ public struct Popup<PopupContent: View>: ViewModifier {
     /// Minimum distance to drag to dismiss
     var dragToDismissDistance: CGFloat?
 
-    /// Variable showing changes in isPresented/item, used here to determine direction of animation (showing or hiding)
-    var popupPresented: Bool
-
     /// Trigger popup showing/hiding animations and...
     var shouldShowContent: Binding<Bool>
 
@@ -151,7 +151,10 @@ public struct Popup<PopupContent: View>: ViewModifier {
     @State private var scrollViewOffset: CGSize = .zero
 
     /// Height of scrollView content that will be displayed on the screen
-    @State var scrollViewContentHeight = 0.0
+    @State private var scrollViewContentHeight = 0.0
+
+    /// Track ScrollView's frame to check if it's ready
+    @State private var scrollViewRect: CGRect = .zero
 
     // MARK: - Position calculations
 
@@ -223,7 +226,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
         }
 
         // appearing animation
-        if popupPresented {
+        if shouldShowContent.wrappedValue {
             return hiddenOffset(calculatedAppearFrom)
         }
         // hiding animation
@@ -242,7 +245,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
             return CGPoint(x: -screenWidth, y: displayedOffsetY)
         case .rightSlide:
             return CGPoint(x: screenWidth, y: displayedOffsetY)
-        case .centerScale:
+        case .centerScale, .none:
             return CGPoint(x: displayedOffsetX, y: displayedOffsetY)
         }
     }
@@ -261,10 +264,10 @@ public struct Popup<PopupContent: View>: ViewModifier {
 
     /// The scale when the popup is hidden
     private var hiddenScale: CGFloat {
-        if popupPresented, calculatedAppearFrom == .centerScale {
+        if shouldShowContent.wrappedValue, calculatedAppearFrom == .centerScale {
             return 0
         }
-        else if !popupPresented, calculatedDisappearTo == .centerScale {
+        else if !shouldShowContent.wrappedValue, calculatedDisappearTo == .centerScale {
             return 0
         }
         return 1
@@ -389,6 +392,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
                 }
                 // no heigher than its contents
                 .frame(maxHeight: scrollViewContentHeight)
+                .frameGetter($scrollViewRect)
             }
             .introspect(.scrollView, on: .iOS(.v15, .v16, .v17, .v18)) { scrollView in
                 configure(scrollView: scrollView)
@@ -412,7 +416,9 @@ public struct Popup<PopupContent: View>: ViewModifier {
                 VStack {
                     contentView()
                         .addTapIfNotTV(if: closeOnTap) {
-                            dismissCallback(.tapInside)
+                            if dismissEnabled.wrappedValue {
+                                dismissCallback(.tapInside)
+                            }
                         }
                         .scaleEffect(actualScale) // scale is here to avoid it messing with frameGetter for sheetContentRect
                 }
@@ -445,15 +451,15 @@ public struct Popup<PopupContent: View>: ViewModifier {
                 }
 
                 .onChange(of: sheetContentRect.size) { sheetContentRect in
+                    // check if scrollView has already calculated its height, otherwise sheetContentRect is already non-zero but yet incorrect
+                    if case .scroll(_) = type, scrollViewRect.height == 0 {
+                        return
+                    }
                     positionIsCalculatedCallback()
                     if shouldShowContent.wrappedValue { // already displayed but the size has changed
                         actualCurrentOffset = targetCurrentOffset
                     }
                 }
-
-                .onChange(of: actualCurrentOffset) { actualCurrentOffset in
-                    print(actualCurrentOffset)
-                }
 #if os(iOS)
                 .onOrientationChange(isLandscape: $isLandscape) {
                     actualCurrentOffset = targetCurrentOffset
@@ -465,7 +471,9 @@ public struct Popup<PopupContent: View>: ViewModifier {
                 VStack {
                     contentView()
                         .addTapIfNotTV(if: closeOnTap) {
-                            dismissCallback(.tapInside)
+                            if dismissEnabled.wrappedValue {
+                                dismissCallback(.tapInside)
+                            }
                         }
                         .scaleEffect(actualScale) // scale is here to avoid it messing with frameGetter for sheetContentRect
                 }
@@ -559,7 +567,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
             if dragState.translation.width > 0 {
                 return CGSize(width: dragState.translation.width, height: 0)
             }
-        case .centerScale:
+        case .centerScale, .none:
             return .zero
         }
         return .zero
@@ -606,7 +614,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
             if drag.translation.width > referenceX {
                 shouldDismiss = true
             }
-        case .centerScale:
+        case .centerScale, .none:
             break
         }
 
@@ -615,7 +623,7 @@ public struct Popup<PopupContent: View>: ViewModifier {
             shouldDismiss = true
         }
 
-        if shouldDismiss {
+        if dismissEnabled.wrappedValue, shouldDismiss {
             dismissCallback(.drag)
         } else {
             withAnimation {
diff --git a/Sources/PopupView/PublicAPI.swift b/Sources/PopupView/PublicAPI.swift
@@ -104,6 +104,7 @@ extension Popup {
         case leftSlide
         case rightSlide
         case centerScale
+        case none
     }
 
     public struct PopupParameters {
@@ -120,6 +121,13 @@ extension Popup {
         /// If nil - never hides on its own
         var autohideIn: Double?
 
+        /// Only allow dismiss by any means after this time passes
+        var dismissibleIn: Double?
+
+        /// Becomes true when `dismissibleIn` times finishes
+        /// Makes no sense if `dismissibleIn` is nil
+        var dismissEnabled: Binding<Bool> = .constant(true)
+
         /// Should allow dismiss by dragging - default is `true`
         var dragToDismiss: Bool = true
 
@@ -189,6 +197,15 @@ extension Popup {
             return params
         }
 
+        public func dismissibleIn(_ dismissibleIn: Double?, _ dismissEnabled: Binding<Bool>?) -> PopupParameters {
+            var params = self
+            params.dismissibleIn = dismissibleIn
+            if let dismissEnabled = dismissEnabled {
+                params.dismissEnabled = dismissEnabled
+            }
+            return params
+        }
+
         /// Should allow dismiss by dragging - default is `true`
         public func dragToDismiss(_ dragToDismiss: Bool) -> PopupParameters {
             var params = self
