Rewrite of validation indicator config, fixing #1

Author: Reed Es

README.md

@@ -12,12 +12,14 @@ macOS | iOS
 
 ## Features
 
-* Convenient editing of structured data in your app
+* Convenient editing (and viewing) of fielded data in your app
 * Can be used with various collection container types, such as `List`, `Table`, `LazyVStack`, etc.\*
 * Presently targeting macOS v11+ and iOS v14+\*\*
-* Optional support for operations to Add New records and Delete them
-* Optional support for both field-level validation and record-level validation
-* No View type erasure (i.e., use of `AnyView`), which can impact scalability and performance
+* Both bound (`editDetailer`) and unbound (`viewDetailer`) views available
+* Optional support for operations to add new records and delete them
+* Optional support for field-level validation, with indicators
+* Optional support for record-level validation, with alert view
+* Minimal use of View type erasure (i.e., use of `AnyView`)
 * No external dependencies!
 
 \* And also the `Tabler` table component (by the same author; see link below)
@@ -149,7 +151,9 @@ struct ContentView: View {
 
 On macOS, ctrl-click (or right-click) on a row to invoke the context menu. On iOS, swipe the row to invoke the menu.
 
-For a full implementation, see the _DetailerDemo_ project (link below). It extends the example with operations to add new records, delete records, and validate input. Among other features, it shows _Detailer_ used with `LazyVGrid` and `Table` containers.
+For a full implementation, see the _DetailerDemo_ project (link below). It extends the example with operations to add new records, delete records, and validate input. 
+
+It shows _Detailer_ used with `LazyVGrid` and `Table` containers.
 
 ## Menuing
 
@@ -195,6 +199,8 @@ By default, invalid fields will be suffixed with a warning icon, currently an "e
 
 All field-level validations must return `true` for the `Save` button to be enabled.
 
+TIP: for consistent margin spacing in layout, you can create a validation that always succeeds: `.validate(...) { _ in true }`.
+
 ### Record-level validation
 
 This can be a *heavyweight* form of validation executed when the user presses the `Save` button.

Sources/DetailerConfigBase.swift renamed to Sources/DetailerConfig.swift

@@ -18,18 +18,25 @@
 
 import SwiftUI
 
-/// Convenience alias which hides the "Image"-bound type ugliness.
-/// Can't figure out how to avoid it yet. Curiously this isn't
-/// needed for Views.
-public typealias DetailerConfig<E> = DetailerConfigBase<E, Image> where E: Identifiable
-
-public let detailerDefaultMinWidth: CGFloat = 300
-private let defaultValidateFail = "exclamationmark.triangle"
-// TODO: defaults for all the non-nil parameters
+public enum DetailerConfigDefaults {
+    
+    #if os(macOS)
+    public static let detailerDefaultMinWidth: CGFloat = 300
+    #elseif os(iOS)
+    public static let detailerDefaultMinWidth: CGFloat = 0
+    #endif
+    
+    public static let defaultValidateIndicator: (Bool) -> AnyView = { AnyView(
+        Image(systemName: "exclamationmark.triangle")
+            .font(.title2)
+            .backport.symbolRenderingMode()
+            .foregroundColor(.orange)
+            .opacity($0 ? 0 : 1)
+    )}
+}
 
-public struct DetailerConfigBase<Element, ValidateImage>
-    where Element: Identifiable,
-    ValidateImage: View
+public struct DetailerConfig<Element>
+    where Element: Identifiable
 {
     public typealias Context = DetailerContext<Element>
 
@@ -40,6 +47,7 @@ public struct DetailerConfigBase<Element, ValidateImage>
     public typealias OnCancel = (Context, Element) -> Void
     public typealias OnSave = (Context, Element) -> Void
     public typealias Titler = (Element) -> String
+    public typealias ValidateIndicator = (Bool) -> AnyView
 
     // MARK: Parameters
 
@@ -50,18 +58,18 @@ public struct DetailerConfigBase<Element, ValidateImage>
     public let onValidate: OnValidate
     public let onSave: OnSave?
     public let onCancel: OnCancel
-    public let titler: (Element) -> String
-    public let validateFail: () -> ValidateImage
+    public let titler: Titler
+    public let validateIndicator: ValidateIndicator
 
-    public init(minWidth: CGFloat = detailerDefaultMinWidth,
+    public init(minWidth: CGFloat = DetailerConfigDefaults.detailerDefaultMinWidth,
                 canEdit: CanEdit? = nil,
                 canDelete: @escaping CanDelete = { _ in true },
                 onDelete: OnDelete? = nil,
                 onValidate: @escaping OnValidate = { _, _ in [] },
                 onSave: OnSave? = nil,
                 onCancel: @escaping OnCancel = { _, _ in },
                 titler: @escaping Titler,
-                @ViewBuilder validateFail: @escaping () -> ValidateImage)
+                validateIndicator: @escaping ValidateIndicator = DetailerConfigDefaults.defaultValidateIndicator)
     {
         self.minWidth = minWidth
         self.canEdit = canEdit
@@ -71,27 +79,27 @@ public struct DetailerConfigBase<Element, ValidateImage>
         self.onSave = onSave
         self.onCancel = onCancel
         self.titler = titler
-        self.validateFail = validateFail
+        self.validateIndicator = validateIndicator
     }
+}
 
-    // omitting: validateFail
-    public init(minWidth: CGFloat = detailerDefaultMinWidth,
-                canEdit: CanEdit? = nil,
-                canDelete: @escaping CanDelete = { _ in true },
-                onDelete: OnDelete? = nil,
-                onValidate: @escaping OnValidate = { _, _ in [] },
-                onSave: OnSave? = nil,
-                onCancel: @escaping OnCancel = { _, _ in },
-                titler: @escaping Titler)
-        where ValidateImage == Image
-    {
-        self.init(canEdit: canEdit,
-                  canDelete: canDelete,
-                  onDelete: onDelete,
-                  onValidate: onValidate,
-                  onSave: onSave,
-                  onCancel: onCancel,
-                  titler: titler,
-                  validateFail: { Image(systemName: defaultValidateFail) })
+
+// Backport for .symbolRenderingMode which isn't supported in earlier versions
+struct Backport<Content: View> {
+    let content: Content
+}
+
+extension View {
+    var backport: Backport<Self> { Backport(content: self) }
+}
+
+extension Backport {
+    @ViewBuilder func symbolRenderingMode() -> some View {
+        if #available(macOS 12.0, iOS 15.0, *) {
+            self.content
+                .symbolRenderingMode(.hierarchical)
+        } else {
+            content
+        }
     }
 }

Sources/DetailerContext.swift

@@ -21,15 +21,16 @@ import SwiftUI
 public struct DetailerContext<Element>
     where Element: Identifiable
 {
+    public typealias Config = DetailerConfig<Element>
     public typealias OnValidate = (AnyKeyPath, Bool) -> Void
 
     // MARK: Parameters
 
-    public let config: DetailerConfig<Element>
+    public let config: Config
     public let onValidate: OnValidate
     public let isAdd: Bool
 
-    public init(config: DetailerConfig<Element>,
+    public init(config: Config,
                 onValidate: @escaping OnValidate,
                 isAdd: Bool)
     {

Sources/Internal/Validate.swift

@@ -31,11 +31,7 @@ struct Validate<Element, T>: View
     var test: Test
 
     var body: some View {
-        ctx.config.validateFail()
-            .backport.symbolRenderingMode() // .symbolRenderingMode(.hierarchical)
-            .font(.title2)
-            .foregroundColor(.secondary)
-            .opacity(test(value) ? 0 : 1)
+        ctx.config.validateIndicator(test(value))
             .onAppear {
                 updateSet(value)
             }
@@ -51,24 +47,3 @@ struct Validate<Element, T>: View
         }
     }
 }
-
-// Backport for .symbolRenderingMode which isn't supported in earlier versions
-
-struct Backport<Content: View> {
-    let content: Content
-}
-
-extension View {
-    var backport: Backport<Self> { Backport(content: self) }
-}
-
-extension Backport {
-    @ViewBuilder func symbolRenderingMode() -> some View {
-        if #available(macOS 12.0, iOS 15.0, *) {
-            self.content
-                .symbolRenderingMode(.hierarchical).foregroundColor(.orange)
-        } else {
-            content
-        }
-    }
-}