Merge pull request #152 from liveviewnative/registry-defaults

Add defaults to `CustomRegistry` associated types

Author: carson-katri

Sources/LiveViewNative/Coordinators/LiveViewCoordinator.swift

@@ -133,6 +133,7 @@ public class LiveViewCoordinator<R: CustomRegistry>: ObservableObject {
         if let channel {
             guard !channel.isJoined, !channel.isJoining else { return }
         }
+        internalState = .startingConnection
         do {
             try await connectLiveView()
         } catch {

Sources/LiveViewNative/CustomRegistry.swift

@@ -48,13 +48,8 @@ public protocol CustomRegistry {
     /// }
     /// ```
     ///
-    /// If your registry does not support any custom tags, you can set this type alias to the ``EmptyRegistry/None`` type:
-    /// ```swift
-    /// struct MyRegistry: CustomRegistry {
-    ///     typealias TagName = EmptyRegistry.None
-    /// }
-    /// ```
-    associatedtype TagName: RawRepresentable where TagName.RawValue == String
+    /// This will default to the ``EmptyRegistry/None`` type if you don't support any custom tags.
+    associatedtype TagName: RawRepresentable = EmptyRegistry.None where TagName.RawValue == String
     /// A type represnting the custom modifier types that this registry can handle.
     ///
     /// This type must be `RawRepresentable` and its raw values must be strings.
@@ -69,21 +64,16 @@ public protocol CustomRegistry {
     /// }
     /// ```
     ///
-    /// If your registry does not support any custom modifiers, you can set this type alias to the ``EmptyRegistry/None`` type:
-    /// ```swift
-    /// struct MyRegistry: CustomRegistry {
-    ///     typealias ModifierType = EmptyRegistry.None
-    /// }
-    /// ```
-    associatedtype ModifierType: RawRepresentable where ModifierType.RawValue == String
+    /// This will default to the ``EmptyRegistry/None`` type if you don't support any custom modifiers.
+    associatedtype ModifierType: RawRepresentable = EmptyRegistry.None where ModifierType.RawValue == String
     /// The type of view this registry returns from the `lookup` method.
     ///
     /// Generally, implementors will use an opaque return type on their ``lookup(_:element:context:)-895au`` implementations and this will be inferred automatically.
-    associatedtype CustomView: View
+    associatedtype CustomView: View = Never
     /// The type of view this registry produces for loading views.
     ///
     /// Generally, implementors will use an opaque return type on their ``loadingView(for:state:)-2uoy9`` implementations and this will be inferred automatically.
-    associatedtype LoadingView: View
+    associatedtype LoadingView: View = Never
 
     /// This method is called by LiveView Native when it needs to construct a custom view.
     ///

Sources/LiveViewNative/LiveViewNative.docc/Resources/04-01-03-modifier.swift

@@ -5,7 +5,6 @@ struct MyRegistry: CustomRegistry {
     enum TagName: String {
         case catRating = "cat-rating"
     }
-    typealias ModifierType = EmptyRegistry.None
 
     static func lookup(_ name: TagName, element: ElementNode, context: LiveContext<MyRegistry>) -> some View {
         switch name {

Sources/LiveViewNative/LiveViewNative.docc/Resources/04-01-04-view.swift renamed to Sources/LiveViewNative/LiveViewNative.docc/Resources/04-01-03-view.swift

@@ -38,16 +38,6 @@
                 @Code(name: "MyRegistry.swift", file: 04-01-02-tag.swift)
             }
 
-            @Step {
-                Then, define a type alias called `ModifierType` that is `EmptyRegistry.None`. This tells the framework that your registry doesn't support any custom modifiers.
-                
-                @Comment {
-                    project = "app"
-                    path = "LVNTutorialApp/MyRegistry.swift"
-                }
-                @Code(name: "MyRegistry.swift", file: 04-01-03-modifier.swift)
-            }
-            
             @Step {
                 In the `lookup` method, we'll construct a `CatRatingView`, passing in the `context` parameter of the lookup method. This will cause a compiler error, but don't worry; in Section 3, we'll implement the view and resolve it.
 
@@ -57,7 +47,7 @@
                     project = "app"
                     path = "LVNTutorialApp/MyRegistry.swift"
                 }
-                @Code(name: "MyRegistry.swift", file: 04-01-04-view.swift)
+                @Code(name: "MyRegistry.swift", file: 04-01-03-view.swift)
             }
 
             @Step {
@@ -78,7 +68,7 @@
                     project = "app"
                     path = "LVNTutorialApp/ContentView.swift"
                 }
-                @Code(name: "ContentView.swift", file: 04-01-05-coordinator.swift)
+                @Code(name: "ContentView.swift", file: 04-01-04-coordinator.swift)
             }
         }
     }