Add sheet like variation on swiftMessage modifier

Author: wtmoose

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 9.0.10
+
+### Features
+
+* Add a `.sheet()` like variation to the `.swiftMessage()` modifier that takes a view builder. This provides more flexibility for constructing message views.
+
+### Fixes
+
+* #535 window being accessed from background thread when dequeueNext is called
+* #534 Xcode warnings in two swift files
+* #533 How do I show a message that appears above the keyboard, when the keyboard is already visible?
+
 ## 9.0.9
 
 ### Fixes

README.md

@@ -178,8 +178,7 @@ And check out our blog post [Elegant Custom UIViewController Transitioning](http
 
 Any of the built-in SwiftMessages views can be displayed by calling the SwiftMessages APIs from within observable object, a button action closure, etc. However, SwiftMessages can also display your custom SwiftUI views.
 
-The first step is to define a type that conforms to `MessageViewConvertible`. This would typically be a struct containing the message data to display:
-
+Take the following message view and companion data model:
 
 ````swift
 struct DemoMessage: Identifiable {
@@ -189,12 +188,6 @@ struct DemoMessage: Identifiable {
     var id: String { title + body }
 }
 
-extension DemoMessage: MessageViewConvertible {
-    func asMessageView() -> DemoMessageView {
-        DemoMessageView(message: self)
-    }
-}
-
 struct DemoMessageView: View {
 
     let message: DemoMessage
@@ -212,22 +205,22 @@ struct DemoMessageView: View {
         // This makes a tab-style view where the bottom corners are rounded and
         // the view's background extends to the top edge.
         .mask(
-	        UnevenRoundedRectangle(bottomLeadingRadius: 15, bottomTrailingRadius: 15)
+            UnevenRoundedRectangle(bottomLeadingRadius: 15, bottomTrailingRadius: 15)
             // This causes the background to extend into the safe area to the screen edge.
             .edgesIgnoringSafeArea(.top)
         )
     }
 }
 ````
 
-The SwiftUI message view can be displayed just like any other UIKit message by using `MessageHostingView`:
+You can show it from a button action, view model or other similar context like:
 
 ````swift
 struct DemoView: View {
     var body: some View {
         Button("Show message") {
             let message = DemoMessage(title: "Demo", body: "SwiftUI forever!")
-            let messageView = MessageHostingView(message: message)
+            let messageView = MessageHostingView(id: message.id, content: DemoMessageView(message: message)
             SwiftMessages.show(view: messageView)
         }
     }
@@ -245,12 +238,40 @@ struct DemoView: View {
         Button("Show message") {
             message = DemoMessage(title: "Demo", body: "SwiftUI forever!")
         }
-        .swiftMessage(message: $message)
+        .swiftMessage(message: $message) { message in
+            DemoMessageView(message: message)
+        }
     }
 }
 ````
 
-This technique may be more SwiftUI-like, but it doesn't offer the full capability of SwiftMessages, such as explicitly hiding messages by their ID. It is totally reasonable to use a combination of both approaches.
+This is very similar to the `.sheet()` modifier. However, it doesn't expose all of the features of SwiftMessages, such as explicitly hiding messages by ID. It is totally reasonable to use a combination of both approaches.
+
+If your message views are purely data-driven and don't require delegates, callbacks, etc., there is a slightly simplified variation on `swiftMessage()` that doesn't require a view builder. Instead, your data model should conform to `MessageViewConvertible`.
+
+````swift
+extension DemoMessage: MessageViewConvertible {
+    func asMessageView() -> DemoMessageView {
+        DemoMessageView(message: self)
+    }
+}
+````
+
+Then you can drop the view builder when calling `swiftMessage()`:
+
+````swift
+struct DemoView: View {
+
+    @State var message: DemoMessage?
+
+    var body: some View {
+        Button("Show message") {
+            message = DemoMessage(title: "Demo", body: "SwiftUI forever!")
+        }
+        .swiftMessage(message: $message)
+    }
+}
+````
 
 Try it out in the SwiftUI demo app!
 

SwiftMessages.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
     spec.name             = 'SwiftMessages'
-    spec.version          = '9.0.9'
+    spec.version          = '9.0.10'
     spec.license          = { :type => 'MIT' }
     spec.homepage         = 'https://github.com/SwiftKickMobile/SwiftMessages'
     spec.authors          = { 'Timothy Moose' => 'tim@swiftkickmobile.com' }

SwiftMessages/MessageHostingView.swift

@@ -16,17 +16,20 @@ public class MessageHostingView<Content>: BaseView, Identifiable where Content:
 
     public let id: String
 
-    public init<Message>(message: Message) where Message: MessageViewConvertible, Message.Content == Content {
-        let messageView: Content = message.asMessageView()
-        hostVC = UIHostingController(rootView: messageView)
-        id = message.id
+    public init(id: String, content: Content) {
+        hostVC = UIHostingController(rootView: content)
+        self.id = id
         super.init(frame: .zero)
         hostVC.loadViewIfNeeded()
         installContentView(hostVC.view)
         backgroundColor = .clear
         hostVC.view.backgroundColor = .clear
     }
 
+    convenience public init<Message>(message: Message) where Message: MessageViewConvertible, Message.Content == Content {
+        self.init(id: message.id, content: message.asMessageView() )
+    }
+
     // MARK: - Constants
 
     // MARK: - Variables

SwiftMessages/SwiftMessageModifier.swift

@@ -9,28 +9,56 @@ import SwiftUI
 
 @available(iOS 14.0, *)
 public extension View {
-    /// A state-based modifier for displaying a message.
+    /// A state-based modifier for displaying a message when `Message` does not conform to `MessageViewConvertible`. This variant is more flexible and
+    /// should be used if the message view can't be represented as pure data, such as if it requires a delegate, has callbacks, etc.
+    func swiftMessage<Message, MessageContent>(
+        message: Binding<Message?>,
+        config: SwiftMessages.Config? = nil,
+        swiftMessages: SwiftMessages? = nil,
+        @ViewBuilder messageContent: @escaping (Message) -> MessageContent
+    ) -> some View where Message: Equatable & Identifiable, MessageContent: View {
+        modifier(SwiftMessageModifier(message: message, config: config, swiftMessages: swiftMessages, messageContent: messageContent))
+    }
+
+    /// A state-based modifier for displaying a message when `Message` conforms to `MessageViewConvertible`. This variant should be used if the message
+    /// view can be represented as pure data. If the message requires a delegate, has callbacks, etc., consider using the variant that takes a message view builder.
     func swiftMessage<Message>(
         message: Binding<Message?>,
         config: SwiftMessages.Config? = nil,
         swiftMessages: SwiftMessages? = nil
     ) -> some View where Message: MessageViewConvertible {
-        modifier(SwiftMessageModifier(message: message, config: config, swiftMessages: swiftMessages))
+        swiftMessage(message: message, config: config, swiftMessages: swiftMessages) { content in
+            content.asMessageView()
+        }
     }
 }
 
 @available(iOS 14.0, *)
-private struct SwiftMessageModifier<Message>: ViewModifier where Message: MessageViewConvertible {
+private struct SwiftMessageModifier<Message, MessageContent>: ViewModifier where Message: Equatable & Identifiable, MessageContent: View {
+
     // MARK: - API
 
     fileprivate init(
         message: Binding<Message?>,
         config: SwiftMessages.Config? = nil,
-        swiftMessages: SwiftMessages? = nil
+        swiftMessages: SwiftMessages? = nil,
+        @ViewBuilder messageContent: @escaping (Message) -> MessageContent
     ) {
         _message = message
         self.config = config
         self.swiftMessages = swiftMessages
+        self.messageContent = messageContent
+    }
+
+    fileprivate init(
+        message: Binding<Message?>,
+        config: SwiftMessages.Config? = nil,
+        swiftMessages: SwiftMessages? = nil
+    ) where Message: MessageViewConvertible, Message.Content == MessageContent {
+        _message = message
+        self.config = config
+        self.swiftMessages = swiftMessages
+        self.messageContent = { $0.asMessageView() }
     }
 
     // MARK: - Constants
@@ -40,15 +68,16 @@ private struct SwiftMessageModifier<Message>: ViewModifier where Message: Messag
     @Binding private var message: Message?
     private let config: SwiftMessages.Config?
     private let swiftMessages: SwiftMessages?
+    @ViewBuilder private let messageContent: (Message) -> MessageContent
 
     // MARK: - Body
 
     func body(content: Content) -> some View {
         content
-            .onChange(of: message) { _ in
+            .onChange(of: message) { message in
                 if let message {
                     let show: @MainActor (SwiftMessages.Config, UIView) -> Void = swiftMessages?.show(config:view:) ?? SwiftMessages.show(config:view:)
-                    let view = MessageHostingView(message: message)
+                    let view = MessageHostingView(id: message.id, content: messageContent(message))
                     var config = config ?? swiftMessages?.defaultConfig ?? SwiftMessages.defaultConfig
                     config.eventListeners.append { event in
                         if case .didHide = event, event.id == self.message?.id {

SwiftUIDemo/SwiftUIDemo.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		22549DC02B55CFE8005E3E21 /* DemoMessageWithButtonView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 22549DBF2B55CFE8005E3E21 /* DemoMessageWithButtonView.swift */; };
 		228F7DAD2ACF17E8006C9644 /* SwiftUIDemoApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = 228F7DAC2ACF17E8006C9644 /* SwiftUIDemoApp.swift */; };
 		228F7DAF2ACF17E8006C9644 /* DemoView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 228F7DAE2ACF17E8006C9644 /* DemoView.swift */; };
 		228F7DB12ACF17E9006C9644 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 228F7DB02ACF17E9006C9644 /* Assets.xcassets */; };
@@ -49,6 +50,7 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		22549DBF2B55CFE8005E3E21 /* DemoMessageWithButtonView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DemoMessageWithButtonView.swift; sourceTree = "<group>"; };
 		228F7DA92ACF17E8006C9644 /* SwiftUIDemo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = SwiftUIDemo.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		228F7DAC2ACF17E8006C9644 /* SwiftUIDemoApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftUIDemoApp.swift; sourceTree = "<group>"; };
 		228F7DAE2ACF17E8006C9644 /* DemoView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DemoView.swift; sourceTree = "<group>"; };
@@ -102,6 +104,7 @@
 				228F7DAE2ACF17E8006C9644 /* DemoView.swift */,
 				228F7DD42ACF59E4006C9644 /* DemoMessage.swift */,
 				228F7DD62ACF5C2E006C9644 /* DemoMessageView.swift */,
+				22549DBF2B55CFE8005E3E21 /* DemoMessageWithButtonView.swift */,
 				228F7DB02ACF17E9006C9644 /* Assets.xcassets */,
 				228F7DB22ACF17E9006C9644 /* Preview Content */,
 			);
@@ -230,6 +233,7 @@
 				228F7DD72ACF5C2E006C9644 /* DemoMessageView.swift in Sources */,
 				228F7DAF2ACF17E8006C9644 /* DemoView.swift in Sources */,
 				228F7DAD2ACF17E8006C9644 /* SwiftUIDemoApp.swift in Sources */,
+				22549DC02B55CFE8005E3E21 /* DemoMessageWithButtonView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

SwiftUIDemo/SwiftUIDemo/DemoMessageView.swift

@@ -7,7 +7,7 @@
 
 import SwiftUI
 
-// A card-style message view
+// A message view with a title and message.
 struct DemoMessageView: View {
 
     // MARK: - API

SwiftUIDemo/SwiftUIDemo/DemoMessageWithButtonView.swift

@@ -0,0 +1,77 @@
+//
+//  DemoMessageWithButtonView.swift
+//  SwiftUIDemo
+//
+//  Created by Timothy Moose on 1/15/24.
+//
+
+import SwiftUI
+
+// A message view with a title, message and button.
+struct DemoMessageWithButtonView<Button>: View where Button: View {
+
+    // MARK: - API
+
+    enum Style {
+        case standard
+        case card
+        case tab
+    }
+
+    init(message: DemoMessage, style: Style, @ViewBuilder button: @escaping () -> Button) {
+        self.message = message
+        self.style = style
+        self.button = button
+    }
+
+    // MARK: - Variables
+
+    let message: DemoMessage
+    let style: Style
+    @ViewBuilder let button: () -> Button
+
+    // MARK: - Constants
+
+    // MARK: - Body
+
+    var body: some View {
+        switch style {
+        case .standard:
+            content()
+                // Mask the content and extend background into the safe area.
+                .mask {
+                    Rectangle()
+                        .edgesIgnoringSafeArea(.top)
+                }
+        case .card:
+            content()
+                // Mask the content with a rounded rectangle
+                .mask {
+                    RoundedRectangle(cornerRadius: 15)
+                }
+                // External padding around the card
+                .padding(10)
+        case .tab:
+            content()
+                // Mask the content with rounded bottom edge and extend background into the safe area.
+                .mask {
+                    UnevenRoundedRectangle(bottomLeadingRadius: 15, bottomTrailingRadius: 15)
+                        .edgesIgnoringSafeArea(.top)
+                }
+        }
+    }
+
+    @ViewBuilder private func content() -> some View {
+        VStack() {
+            Text(message.title).font(.system(size: 20, weight: .bold))
+            Text(message.body)
+            button()
+        }
+        .multilineTextAlignment(.center)
+        // Internal padding of the card
+        .padding(30)
+        // Greedy width
+        .frame(maxWidth: .infinity)
+        .background(.demoMessageBackground)
+    }
+}

SwiftUIDemo/SwiftUIDemo/DemoView.swift

@@ -10,8 +10,12 @@ import SwiftMessages
 
 struct DemoView: View {
 
+    /// Demonstrates purely data-driven message presentation.
     @State var message: DemoMessage?
 
+    /// Demonstrates message presentation with a view builder.
+    @State var messageWithButton: DemoMessage?
+
     var body: some View {
         VStack {
             Button("Show standard message") {
@@ -35,9 +39,24 @@ struct DemoView: View {
                     style: .tab
                 )
             }
+            Button("Show message with button") {
+                messageWithButton = DemoMessage(
+                    title: "Demo",
+                    body: "This message view has a button was constructed with a view builder.",
+                    style: .card
+                )
+            }
         }
         .buttonStyle(.bordered)
         .swiftMessage(message: $message)
+        .swiftMessage(message: $messageWithButton) { message in
+            DemoMessageWithButtonView(message: message, style: .card) {
+                Button("Tap Me") {
+                    print("Tap")
+                }
+                .buttonStyle(.bordered)
+            }
+        }
     }
 }