disable safeAreaRegions in SwiftUIHostingView, add tests

Author: honghaoz

ComposeUI/Project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -99,6 +99,10 @@ public class SwiftUIHostingView<ContentView: SwiftUI.View>: NSHostingView<AnyVie
     super.init(rootView: Self.makeWrappedRootView(rootView: rootView))
 
     updateCommonSettings()
+
+    if #available(macOS 13.3, *) {
+      safeAreaRegions = []
+    }
   }
 
   @available(*, unavailable)
@@ -189,6 +193,11 @@ private final class SwiftUIHostingViewController<ContentView: SwiftUI.View>: UIH
 
     // SwiftUI view jumps when scrolling to edges, fix it by disabling safe area.
     disableSafeArea()
+
+    if #available(iOS 16.4, *) {
+      // SwiftUI view moves up when keyboard is shown, fix it by disabling keyboard avoidance.
+      safeAreaRegions = []
+    }
   }
 
   override func viewDidLoad() {

ComposeUI/Sources/ComposeUI/Components/SwiftUIHostingView.swift

@@ -0,0 +1,147 @@
+//
+//  SwiftUIHostingViewTests.swift
+//  ComposéUI
+//
+//  Created by Honghao Zhang on 5/9/26.
+//  Copyright © 2024 Honghao Zhang.
+//
+//  MIT License
+//
+//  Copyright (c) 2024 Honghao Zhang (github.com/honghaoz)
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to
+//  deal in the Software without restriction, including without limitation the
+//  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+//  IN THE SOFTWARE.
+//
+
+#if canImport(AppKit)
+import AppKit
+#endif
+
+#if canImport(UIKit)
+import UIKit
+#endif
+
+import ChouTiTest
+import SwiftUI
+
+@testable import ComposeUI
+
+final class SwiftUIHostingViewTests: XCTestCase {
+
+  // MARK: - SwiftUIHostingView
+
+  func test_init_withRootView() {
+    let view = SwiftUIHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    expect(view.bounds.size) == .zero
+  }
+
+  func test_layout_appliesBoundsToContent() {
+    let view = SwiftUIHostingView(rootView: SwiftUI.Color.black)
+    view.frame = CGRect(x: 0, y: 0, width: 120, height: 80)
+
+    #if canImport(UIKit)
+    view.layoutIfNeeded()
+    let hostingControllerView = try? view.subviews.first.unwrap()
+    expect(hostingControllerView?.frame) == CGRect(x: 0, y: 0, width: 120, height: 80)
+    #endif
+
+    #if canImport(AppKit)
+    expect(view.bounds.size) == CGSize(width: 120, height: 80)
+    #endif
+  }
+
+  // MARK: - MutableSwiftUIHostingView
+
+  func test_mutable_init_emptyContent() {
+    let view = MutableSwiftUIHostingView()
+    expect("\(view.content)") == "AnyView(EmptyView())"
+  }
+
+  func test_mutable_setContent() {
+    let view = MutableSwiftUIHostingView()
+    expect("\(view.content)".contains("EmptyView")) == true
+
+    view.content = AnyView(SwiftUI.Text("Hello, World!"))
+    expect("\(view.content)".contains("Hello, World")) == true
+
+    view.content = AnyView(SwiftUI.Text("Updated"))
+    expect("\(view.content)".contains("Updated")) == true
+    expect("\(view.content)".contains("Hello, World")) == false
+  }
+
+  // MARK: - AppKit specific
+
+  #if canImport(AppKit)
+
+  func test_appKit_isUserInteractionEnabled_defaultTrue() {
+    let view = SwiftUIHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    expect(view.isUserInteractionEnabled) == true
+  }
+
+  func test_appKit_becomeFirstResponder_whenInteractionDisabled_returnsFalse() {
+    let window = TestWindow()
+    let view = SwiftUIHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    window.contentView().addSubview(view)
+
+    view.isUserInteractionEnabled = false
+    expect(view.becomeFirstResponder()) == false
+  }
+
+  func test_appKit_becomeFirstResponder_whenInteractionEnabled_delegatesToSuper() {
+    let window = TestWindow()
+    let view = SwiftUIHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    window.contentView().addSubview(view)
+
+    // when enabled, the result mirrors the underlying NSHostingView's response
+    view.isUserInteractionEnabled = true
+    let plainHostingView = NSHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    window.contentView().addSubview(plainHostingView)
+    expect(view.becomeFirstResponder()) == plainHostingView.becomeFirstResponder()
+  }
+
+  #endif
+
+  // MARK: - UIKit specific
+
+  #if canImport(UIKit)
+
+  func test_uiKit_layoutSubviews_resizesHostingControllerView() {
+    let view = SwiftUIHostingView(rootView: SwiftUI.Color.black)
+    view.frame = CGRect(x: 0, y: 0, width: 200, height: 150)
+    view.layoutIfNeeded()
+
+    let hostingControllerView = try? view.subviews.first.unwrap()
+    expect(hostingControllerView?.frame) == CGRect(x: 0, y: 0, width: 200, height: 150)
+
+    // bounds change re-applies the frame
+    view.frame = CGRect(x: 0, y: 0, width: 300, height: 250)
+    view.layoutIfNeeded()
+    expect(hostingControllerView?.frame) == CGRect(x: 0, y: 0, width: 300, height: 250)
+  }
+
+  func test_uiKit_hostingControllerView_hasClearBackground() {
+    let view = SwiftUIHostingView(rootView: SwiftUI.Text("Hello, World!"))
+    view.frame = CGRect(x: 0, y: 0, width: 100, height: 100)
+    view.layoutIfNeeded()
+
+    let hostingControllerView = try? view.subviews.first.unwrap()
+    expect(hostingControllerView?.backgroundColor) == .clear
+  }
+
+  #endif
+}