IOS-9604 Added infinite interval to crouton and snackbar for the Swif… #324

idenjoe · 2023-12-04T16:37:48Z

🎟️ Jira ticket

IOS-9604 Add infinite interval to Crouton/Snackbar SwiftUI versions.

🥅 What's the goal?

Add the same behaviour as in UIKit for crouton/snackbar SwiftUI versions with the infinite time invernal.

🚧 How do we do it?

Add a new time interval enum (fiveSeconds, tenSeconds, and infinite)
Added a block to return the dismiss reason(dismiss, button or timeout)
Modified the structure of Snackbar view to fit with the new close button cases.

🧪 How can I verify this?

Launch the Snackbar SwiftUI version in the catalog and show it with different settings.

🏑 AppCenter build

…tUI versions.

dhidalgofadrique · 2023-12-05T07:29:49Z

Sources/MisticaSwiftUI/Components/Snackbar/View+Snackbar.swift

+public enum CroutonDismissInterval {
+    case fiveSeconds
+    case tenSeconds
+    case infinite
+
+    var timeInterval: TimeInterval? {
+        switch self {
+        case .fiveSeconds:
+            return 5
+        case .tenSeconds:
+            return 10
+        case .infinite:
+            return nil
+        }
+    }
+}


Maybe a more generic approach to ease adding more intervals in the future?

Suggested change

public enum CroutonDismissInterval {

case fiveSeconds

case tenSeconds

case infinite

var timeInterval: TimeInterval? {

switch self {

case .fiveSeconds:

return 5

case .tenSeconds:

return 10

case .infinite:

return nil

}

}

}

public enum CroutonDismissInterval {

case seconds(TimeInterval)

case infinite

var timeInterval: TimeInterval? {

switch self {

case .seconds(let value):

return value

case .infinite:

return nil

}

}

}

We can't do this because you let the user to add any interval and its definition does not allow this.

dhidalgofadrique · 2023-12-05T07:49:05Z

Sources/MisticaSwiftUI/Components/Snackbar/View+Snackbar.swift

+    func normalizeDismissInterval(from action: (() -> Void)?, croutonDismissInterval: CroutonDismissInterval?) -> CroutonDismissInterval {
+        switch croutonDismissInterval {
+        case .none where action != nil:
+            return .tenSeconds
+        case .fiveSeconds where action != nil:
+            return .tenSeconds
+        case .tenSeconds where action == nil:
+            return .fiveSeconds
+        case .none:
+            return .fiveSeconds
+        case .fiveSeconds:
+            return .fiveSeconds
+        case .tenSeconds:
+            return .tenSeconds
+        case .infinite:
+            return .infinite
+        }
+    }


Is this behavior specified in any document? It's confusing create a crouton with a dismiss interval of 5 seconds that dissappear after 10 seconds...

our components have a Readme so we can include it to explain this. Good idea!

I will add this behaviour to the Readme. But JFYI: https://www.figma.com/file/yCHLIfy4WMfRdlADwyL4kZ/🔸-Snackbar-Specs?type=design&node-id=1038-1306&mode=design&t=H1SNmcgaFocwgXn9-0

dhidalgofadrique · 2023-12-05T07:56:06Z

In the Mistica Catalog the crouton is being shown under the tabbar

amegias · 2023-12-05T08:02:44Z

Sources/MisticaSwiftUI/Components/Snackbar/Snackbar.swift

@@ -25,38 +25,105 @@ public enum SnackbarButtonStyle {
    case short
 }

-public struct Snackbar<Button: View>: View {
+public enum SnackbarDismissReason: Int, RawRepresentable {


could it be moved to MisticaCommon to avoid having the UIKit & SwiftUI representations?

amegias · 2023-12-05T08:06:09Z

Sources/MisticaSwiftUI/Components/Snackbar/Snackbar.swift

+    case button
+    case timeout
+
+    public typealias RawValue = String


weird...
what about having?

- public enum SnackbarDismissReason: Int + public enum SnackbarDismissReason: String

Then, you can assign its String directly

case dismiss = "DISMISS" case button = "BUTTON" case timeout = "TIMEOUT"

you will be able to remove var rawValue and init?(rawValue: RawValue)

I moved the reason to MisticaCommon and now we need to mark the enum as @objc (it's being used from some methods marked as @objc) so we can not use String as their type.

amegias · 2023-12-05T08:09:21Z

Sources/MisticaSwiftUI/Components/Snackbar/View+Snackbar.swift

@@ -9,23 +9,44 @@
 import Foundation
 import SwiftUI

+public enum CroutonDismissInterval {


Repeated in UIKit, could we put it in common?

amegias · 2023-12-05T08:10:39Z

Sources/MisticaSwiftUI/Components/Snackbar/View+Snackbar.swift

+    func normalizeDismissInterval(from action: (() -> Void)?, croutonDismissInterval: CroutonDismissInterval?) -> CroutonDismissInterval {
+        switch croutonDismissInterval {
+        case .none where action != nil:
+            return .tenSeconds
+        case .fiveSeconds where action != nil:
+            return .tenSeconds
+        case .tenSeconds where action == nil:
+            return .fiveSeconds
+        case .none:
+            return .fiveSeconds
+        case .fiveSeconds:
+            return .fiveSeconds
+        case .tenSeconds:
+            return .tenSeconds
+        case .infinite:
+            return .infinite
+        }
+    }


our components have a Readme so we can include it to explain this. Good idea!

amegias · 2023-12-05T08:11:33Z

Sources/MisticaSwiftUI/Components/Snackbar/View+Snackbar.swift

+    func dismiss(with reason: SnackbarDismissReason) {
+        DispatchQueue.main.async {
+            withAnimation { isVisible = false }
+            dismissHandlerBlock?(reason)
+        }
+    }


I THINK you can do:

Suggested change

func dismiss(with reason: SnackbarDismissReason) {

DispatchQueue.main.async {

withAnimation { isVisible = false }

dismissHandlerBlock?(reason)

}

}

@MainActor

func dismiss(with reason: SnackbarDismissReason) {

withAnimation { isVisible = false }

dismissHandlerBlock?(reason)

}

amegias · 2023-12-05T08:12:45Z

Tests/MisticaSwiftUITests/UI/CroutonTests.swift

+                buttonAction: {},
+                forceDismiss: true
+            )
+        assertSnapshot(


thanks for adding tests and avoiding generating several brands for this :)!!

amegias · 2023-12-05T08:14:50Z

MisticaCatalog/Source/Catalog/MisticaSwiftUI/Components/SnackbarCatalogView.swift

@@ -18,7 +18,10 @@ struct SnackbarCatalogView: View {
    @State var buttonStyles: [SnackbarButtonStyle] = [.short, .large]
    @State var presentingSnackbar = false
    @State var presentingCrouton = false
-    @State var autoDismissDelay = 3
+    @State var autoDismissDelay: CroutonDismissInterval = .fiveSeconds
+    @State var intervalStyles: [CroutonDismissInterval] = [.fiveSeconds, .tenSeconds, .infinite]


it's a constant so it shouldn't be @State.
You can simplify this removing it and:

- autoDismissDelay: intervalStyles[selectedIntervalStyleIndex], + autoDismissDelay: CroutonDismissInterval.allCases[selectedIntervalStyleIndex],

wdyt?

amegias · 2023-12-05T10:09:51Z

Is it working properly?

idenjoe · 2023-12-05T11:08:16Z

Is it working properly?

Yes. The close button only should be added when the the time interval is infinite AND the action is nil OR the action is not nil and the forceDismiss is enabled.

…erval with/without an action. Added the same config to the crouton version in UIKit.

amegias · 2023-12-12T16:57:29Z

MisticaCatalog/Source/Catalog/Mistica/Components/UICatalogCroutonViewController.swift

        switch interval {
        case .fiveSeconds:
            return "5"
        case .tenSeconds:
            return "10"
-        case .infinite:
+        case .infinity:


infinite sounds better than infinity

amegias · 2023-12-12T17:01:16Z

CHANGELOG.md

@@ -8,7 +8,7 @@

 ### BREAKING CHANGES

-* **crouton:** DismissHandlerBlock has changed and now has a CroutonControllerDismissReason as return parameter
+* **crouton:** DismissHandlerBlock has changed and now has a SnackbarDismissReason as return parameter


don't change this, it's generated automatically ;)

amegias · 2023-12-12T17:06:38Z

Should we extend this https://github.com/Telefonica/mistica-ios/blob/main/Sources/Mistica/Components/Crouton/README.md ?

Maybe something like:

Config

You can use several intervals with different features:

interval	Close	Action	...
5"	NO	NO	...
10"	Optional	Mandatory	...
...	...	...	...

amegias

SwiftUI

dhidalgofadrique · 2023-12-15T07:44:54Z

Sources/Mistica/Components/Crouton/Presentation/CroutonController.swift

-        withText text: String,
-        action: ActionConfig? = nil,
+        config: SnackbarConfig,
        style: CroutonStyle = .info,


Nice! Managing one element with all the info, instead of multiple parameters

dhidalgofadrique · 2023-12-15T07:45:02Z

MisticaCatalog/Source/Catalog/MisticaSwiftUI/Components/SnackbarCatalogView.swift

        switch interval {
        case .fiveSeconds:
            return "5"
        case .tenSeconds:
            return "10"
-        case .infinite:
+        case .infinity(_):


If parameter is not needed, then it's enough with:

case .infinity:

dhidalgofadrique

👍 SwiftUI Skills +1 😂

tuentisre · 2024-01-09T14:27:18Z

🎉 This PR is included in version 28.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

idenjoe added 2 commits December 4, 2023 17:28

IOS-9604 Added infinite interval to crouton and snackbar for the Swif…

7ccc974

…tUI versions.

IOS-9604 Fixed an error returning dismiss reason when should be timeout.

a754413

idenjoe requested review from dhidalgofadrique and amegias December 4, 2023 16:37

Run swiftformat

b2bef3d

dhidalgofadrique reviewed Dec 5, 2023

View reviewed changes

amegias reviewed Dec 5, 2023

View reviewed changes

idenjoe and others added 2 commits December 12, 2023 17:51

IOS-9604 Added a config to be deterministic when selecting a time int…

a4f0d13

…erval with/without an action. Added the same config to the crouton version in UIKit.

Run swiftformat

ffe0011

amegias reviewed Dec 12, 2023

View reviewed changes

amegias approved these changes Dec 12, 2023

View reviewed changes

dhidalgofadrique reviewed Dec 15, 2023

View reviewed changes

dhidalgofadrique approved these changes Dec 15, 2023

View reviewed changes

IOS-9604 Fixed PR comments

b3c5d69

idenjoe merged commit 74fce28 into main Dec 20, 2023
2 checks passed

idenjoe deleted the IOS-9604_Snackbar_infinite_SwiftUI branch December 20, 2023 09:16

tuentisre added the released label Jan 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IOS-9604 Added infinite interval to crouton and snackbar for the Swif… #324

IOS-9604 Added infinite interval to crouton and snackbar for the Swif… #324

idenjoe commented Dec 4, 2023 •

edited

Loading

dhidalgofadrique Dec 5, 2023

idenjoe Dec 5, 2023

dhidalgofadrique Dec 5, 2023

amegias Dec 5, 2023

idenjoe Dec 5, 2023

dhidalgofadrique commented Dec 5, 2023

amegias Dec 5, 2023

amegias Dec 5, 2023

idenjoe Dec 5, 2023

amegias Dec 5, 2023

amegias Dec 5, 2023

amegias Dec 5, 2023

amegias Dec 5, 2023

amegias Dec 5, 2023

amegias commented Dec 5, 2023

idenjoe commented Dec 5, 2023

amegias Dec 12, 2023

amegias Dec 12, 2023

amegias commented Dec 12, 2023

amegias left a comment

dhidalgofadrique Dec 15, 2023

dhidalgofadrique Dec 15, 2023

dhidalgofadrique left a comment

tuentisre commented Jan 9, 2024

IOS-9604 Added infinite interval to crouton and snackbar for the Swif… #324

IOS-9604 Added infinite interval to crouton and snackbar for the Swif… #324

Conversation

idenjoe commented Dec 4, 2023 • edited Loading

🎟️ Jira ticket

🥅 What's the goal?

🚧 How do we do it?

🧪 How can I verify this?

🏑 AppCenter build

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhidalgofadrique commented Dec 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amegias commented Dec 5, 2023

idenjoe commented Dec 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amegias commented Dec 12, 2023

Config

amegias left a comment

Choose a reason for hiding this comment

SwiftUI

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhidalgofadrique left a comment

Choose a reason for hiding this comment

tuentisre commented Jan 9, 2024

idenjoe commented Dec 4, 2023 •

edited

Loading