[chore]: add comment describing SwiftUIScreen's background color over…

…ride (#278)
square · Mar 29, 2024 · 15d7d29 · 15d7d29
1 parent 8a9e6ef
commit 15d7d29
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/WorkflowSwiftUIExperimental/Sources/SwiftUIScreen.swift b/WorkflowSwiftUIExperimental/Sources/SwiftUIScreen.swift
@@ -129,6 +129,10 @@ private final class ModeledHostingController<Model, Content: View>: UIHostingCon
     override func viewDidLoad() {
         super.viewDidLoad()
 
+        // `UIHostingController`'s provides a system background color by default. In order to
+        // support `SwiftUIScreen`s being composed in contexts where it is composed within another
+        // view controller where a transparent background is more desirable, we set the background
+        // to clear to allow this kind of flexibility.
         view.backgroundColor = .clear
 
         setNeedsLayoutBeforeFirstLayoutIfNeeded()