Add FluentNotificationTriggerModel for easier client interactions with FluentNotification

Author: nodes11

Demos/FluentUIDemo_iOS/FluentUI.Demo/Demos/NotificationViewDemoController.swift

@@ -248,7 +248,7 @@ class NotificationViewDemoController: DemoController {
             notification.state.actionButtonTitle = "Bump"
 
             notification.state.actionButtonAction = { [weak notification] in
-                notification?.state.bump()
+                notification?.performBumpAnimation()
             }
 
             return notification

Demos/FluentUIDemo_iOS/FluentUI.Demo/Demos/NotificationViewDemoController_SwiftUI.swift

@@ -52,6 +52,7 @@ struct NotificationDemoView: View {
     @State var useCustomTheme: Bool = false
     @State var verticalOffset: CGFloat = 0.0
     @ObservedObject var fluentTheme: FluentTheme = .shared
+    private var triggerModel = FluentNotificationTriggerModel()
     let customTheme: FluentTheme = {
         let foregroundColor = UIColor(light: GlobalTokens.sharedColor(.lavender, .shade30),
                                       dark: GlobalTokens.sharedColor(.lavender, .tint40))
@@ -171,7 +172,7 @@ struct NotificationDemoView: View {
                                        showActionButtonAndDismissButton: showActionButtonAndDismissButton,
                                        defaultDismissButtonAction: dismissButtonAction,
                                        messageButtonAction: messageButtonAction,
-                                       showFromBottom: showFromBottom)
+                                       showFromBottom: showFromBottom, triggerModel: triggerModel)
                     .backgroundGradient(showBackgroundGradient ? backgroundGradient : nil)
                     .overrideTokens($overrideTokens.wrappedValue ? notificationOverrideTokens : nil)
                 }
@@ -212,7 +213,7 @@ struct NotificationDemoView: View {
                                showActionButtonAndDismissButton: showActionButtonAndDismissButton,
                                messageButtonAction: messageButtonAction,
                                showFromBottom: showFromBottom,
-                               verticalOffset: verticalOffset)
+                               verticalOffset: verticalOffset, triggerModel: triggerModel)
             .backgroundGradient(showBackgroundGradient ? backgroundGradient : nil)
             .overrideTokens($overrideTokens.wrappedValue ? notificationOverrideTokens : nil)
         }
@@ -263,6 +264,9 @@ struct NotificationDemoView: View {
                 Toggle("Has Attributed Text: Large Red Papyrus Font", isOn: $hasLargeRedPapyrusFontAttribute)
                 Toggle("Set image", isOn: $showImage)
                 Toggle("Set trailing image", isOn: $showTrailingImage)
+                Button("Perform Bump") {
+                    triggerModel.shouldBump = true
+                }
             }
 
             FluentListSection("Action") {

Sources/FluentUI_iOS/Components/Notification/FluentNotification.swift

@@ -6,6 +6,7 @@
 #if canImport(FluentUI_common)
 import FluentUI_common
 #endif
+import Combine
 import SwiftUI
 
 /// Properties that can be used to customize the appearance of the `Notification`.
@@ -67,10 +68,17 @@ import SwiftUI
     ///
     /// If this property is nil, then this notification will use the background color defined by its design tokens.
     var backgroundGradient: LinearGradientInfo? { get set }
+}
 
-    /// Performs an animation emphasizing the notification.
-    /// The animation alternates between upward and downward movements with spring physics.
-    func bump()
+/// Exposes public published properties that are observed by the `FluentNotification`. Enables
+/// easy interaction with the Notification for clients.
+@objc(MSFFluentNotificationTriggerModel)
+public class FluentNotificationTriggerModel: NSObject, ObservableObject {
+    /// Triggers the bump animation for the notification.
+    ///
+    /// Set this to `true` to trigger the bump animation. The value will be
+    /// automatically reset to `false` after the animation is triggered.
+    @Published public var shouldBump: Bool = false
 }
 
 /// View that represents the Notification.
@@ -116,7 +124,9 @@ public struct FluentNotification: View, TokenizedControlView {
                 defaultDismissButtonAction: (() -> Void)? = nil,
                 messageButtonAction: (() -> Void)? = nil,
                 showFromBottom: Bool = true,
-                verticalOffset: CGFloat = 0.0) {
+                verticalOffset: CGFloat = 0.0,
+                triggerModel: FluentNotificationTriggerModel = FluentNotificationTriggerModel(),
+                onDismiss: (() -> Void)? = nil) {
         let state = MSFNotificationStateImpl(style: style,
                                              message: message,
                                              attributedMessage: attributedMessage,
@@ -133,9 +143,11 @@ public struct FluentNotification: View, TokenizedControlView {
                                              messageButtonAction: messageButtonAction,
                                              showFromBottom: showFromBottom,
                                              verticalOffset: verticalOffset)
+        state.onDismiss = onDismiss
         self.state = state
         self.shouldSelfPresent = shouldSelfPresent
         self.isFlexibleWidthToast = isFlexibleWidthToast && style.isToast
+        self.triggerModel = triggerModel
 
         self.tokenSet = NotificationTokenSet(style: { state.style })
 
@@ -328,9 +340,9 @@ public struct FluentNotification: View, TokenizedControlView {
                 .glassBackgroundEffect(in: RoundedRectangle(cornerRadius: tokenSet[.cornerRadius].float))
 #endif // os(visionOS)
                 .offset(y: -bumpVerticalOffset)
-                .onChange(of: state.shouldPerformBump) { _, shouldBump in
+                .onChange(of: triggerModel.shouldBump) { _, shouldBump in
                     if shouldBump {
-                        state.shouldPerformBump = false
+                        triggerModel.shouldBump = false
                         performBumpAnimated()
                     }
                 }
@@ -390,6 +402,7 @@ public struct FluentNotification: View, TokenizedControlView {
 
     @Environment(\.fluentTheme) var fluentTheme: FluentTheme
     @ObservedObject var state: MSFNotificationStateImpl
+    @ObservedObject var triggerModel: FluentNotificationTriggerModel
 
     /// The `dismissButtonAction` will be non-nil for the following cases:
     /// - The `state.actionButtonAction` is set but there is no custom title or trailing image. The `actionButtonAction`
@@ -522,9 +535,6 @@ class MSFNotificationStateImpl: ControlState, MSFNotificationState {
     /// Style to draw the control.
     @Published var style: MSFNotificationStyle
 
-    /// Controls whether the bump animation should start
-    @Published internal var shouldPerformBump: Bool = false
-
     @objc convenience init(style: MSFNotificationStyle) {
         self.init(style: style,
                   message: nil,
@@ -578,10 +588,4 @@ class MSFNotificationStateImpl: ControlState, MSFNotificationState {
 
         super.init()
     }
-
-    @objc func bump() {
-        if !shouldPerformBump {
-            shouldPerformBump = true
-        }
-    }
 }

Sources/FluentUI_iOS/Components/Notification/MSFNotification.swift

@@ -26,8 +26,10 @@ import UIKit
     @objc public init(style: MSFNotificationStyle,
                       isFlexibleWidthToast: Bool = false) {
         self.isFlexibleWidthToast = isFlexibleWidthToast && style.isToast
+        self.triggerModel = FluentNotificationTriggerModel()
         notification = FluentNotification(style: style,
-                                          shouldSelfPresent: false)
+                                          shouldSelfPresent: false,
+                                          triggerModel: triggerModel)
         super.init(AnyView(notification), safeAreaRegions: [])
         let defaultDismissAction = { [weak self] in
             guard let strongSelf = self else {
@@ -211,6 +213,11 @@ import UIKit
         }
     }
 
+    /// Triggers the bump animation for the notification
+    @objc public func performBumpAnimation() {
+        triggerModel.shouldBump = true
+    }
+
     // MARK: - Private variables
     private static var currentToast: MSFNotification? {
         didSet {
@@ -224,5 +231,6 @@ import UIKit
     private var constraintWhenHidden: NSLayoutConstraint!
     private var constraintWhenShown: NSLayoutConstraint!
     private var notification: FluentNotification!
+    private var triggerModel: FluentNotificationTriggerModel
     private var isHiding: Bool = false
 }