Merge pull request #1230 from Esri/df/trackPresentedFormWithPref

`FeatureFormView` - Track presented form with preferences

Author: dfeinzimer

Sources/ArcGISToolkit/Common/EquatableObject.swift

@@ -0,0 +1,24 @@
+// Copyright 2025 Esri
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// An equatable wrapper for an object.
+///
+/// Equality is determined by object identity.
+struct EquatableObject<Object: AnyObject & Sendable>: Equatable {
+    let object: Object
+    
+    static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.object === rhs.object
+    }
+}

Sources/ArcGISToolkit/Components/FeatureFormView/EmbeddedFeatureFormView.swift

@@ -16,9 +16,6 @@ import ArcGIS
 import SwiftUI
 
 struct EmbeddedFeatureFormView: View {
-    /// The environment value to access the closure to call when the presented feature form changes.
-    @Environment(\.formChangedAction) var formChangedAction
-    
     /// A Boolean value indicating whether the deprecated FeatureFormView initializer was used.
     @Environment(\.formDeprecatedInitializerWasUsed) var deprecatedInitializerWasUsed
 
@@ -83,12 +80,13 @@ struct EmbeddedFeatureFormView: View {
 #endif
         .environment(embeddedFeatureFormViewModel)
         .padding([.horizontal])
+        .preference(
+            key: PresentedFeatureFormPreferenceKey.self,
+            value: .init(object: embeddedFeatureFormViewModel.featureForm)
+        )
         .task {
             await embeddedFeatureFormViewModel.initialEvaluation()
         }
-        .onAppear {
-            formChangedAction?(embeddedFeatureFormViewModel.featureForm)
-        }
         .featureFormToolbar(embeddedFeatureFormViewModel.featureForm, isAForm: true)
     }
 }

Sources/ArcGISToolkit/Components/FeatureFormView/FeatureFormView+EnvironmentValues.swift

@@ -22,9 +22,6 @@ extension EnvironmentValues /* FeatureFormView */ {
     /// An error thrown from a call to `FeatureForm.finishEditing()`.
     @Entry var finishEditingError: Binding<(any Error)?> = .constant(nil)
 
-    /// The environment value to access the closure to call when the presented feature form changes.
-    @Entry var formChangedAction: ((FeatureForm) -> Void)?
-    
     /// A Boolean value indicating whether the deprecated FeatureFormView initializer was used.
     @Entry var formDeprecatedInitializerWasUsed = false
 

Sources/ArcGISToolkit/Components/FeatureFormView/FeatureFormView.swift

@@ -143,9 +143,10 @@ public struct FeatureFormView: View {
                             .featureFormToolbar(embeddedFeatureFormViewModel.featureForm)
                             .navigationBarTitleDisplayMode(.inline)
                             .navigationTitle(result.filter.title, subtitle: embeddedFeatureFormViewModel.title)
-                            .onAppear {
-                                formChangedAction(embeddedFeatureFormViewModel.featureForm)
-                            }
+                            .preference(
+                                key: PresentedFeatureFormPreferenceKey.self,
+                                value: .init(object: embeddedFeatureFormViewModel.featureForm)
+                            )
                         case let .utilityAssociationGroupResultView(result, embeddedFeatureFormViewModel):
                             UtilityAssociationGroupResultView(
                                 embeddedFeatureFormViewModel: embeddedFeatureFormViewModel,
@@ -154,9 +155,6 @@ public struct FeatureFormView: View {
                             .featureFormToolbar(embeddedFeatureFormViewModel.featureForm)
                             .navigationBarTitleDisplayMode(.inline)
                             .navigationTitle(result.name, subtitle: embeddedFeatureFormViewModel.title)
-                            .onAppear {
-                                formChangedAction(embeddedFeatureFormViewModel.featureForm)
-                            }
                         }
                     }
             }
@@ -261,7 +259,6 @@ public struct FeatureFormView: View {
             )
             .environment(\.editingButtonVisibility, editingButtonsVisibility)
             .environment(\.finishEditingError, $finishEditingError)
-            .environment(\.formChangedAction, formChangedAction)
             .environment(\.formDeprecatedInitializerWasUsed, deprecatedInitializerWasUsed)
             .environment(\.isPresented, isPresented)
             .environment(\.navigationIsDisabled, navigationIsDisabled)
@@ -270,6 +267,10 @@ public struct FeatureFormView: View {
             .environment(\.setAlertContinuation, setAlertContinuation)
             .environment(\.validationErrorVisibilityExternal, validationErrorVisibilityExternal)
             .environment(\.validationErrorVisibilityInternal, $validationErrorVisibilityInternal)
+            .onPreferenceChange(PresentedFeatureFormPreferenceKey.self) { wrappedFeatureForm in
+                guard let wrappedFeatureForm else { return }
+                formChangedAction(wrappedFeatureForm.object)
+            }
         }
     }
 }

Sources/ArcGISToolkit/Components/FeatureFormView/PresentedFeatureFormPreferenceKey.swift

@@ -0,0 +1,29 @@
+// Copyright 2025 Esri
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import ArcGIS
+import SwiftUI
+
+/// A preference key that specifies the feature form currently presented in the `FeatureFormView` navigation stack.
+struct PresentedFeatureFormPreferenceKey: PreferenceKey {
+    static let defaultValue: EquatableObject<FeatureForm>? = nil
+    
+    static func reduce(
+        value: inout EquatableObject<FeatureForm>?,
+        nextValue: () -> EquatableObject<FeatureForm>?
+    ) {
+        guard let nextValue = nextValue() else { return }
+        value = nextValue
+    }
+}

Sources/ArcGISToolkit/Components/Popups/EmbeddedPopupView.swift

@@ -60,7 +60,7 @@ struct EmbeddedPopupView: View {
         .frame(maxWidth: .infinity, maxHeight: .infinity)
         .background(Color(.systemBackground))
 #endif
-        .preference(key: PresentedPopupPreferenceKey.self, value: .init(popup: popup))
+        .preference(key: PresentedPopupPreferenceKey.self, value: .init(object: popup))
         .popupViewHeader(title: popup.title)
         .task(id: ObjectIdentifier(popup)) {
             // Initial evaluation for a newly assigned popup.

Sources/ArcGISToolkit/Components/Popups/PopupView.swift

@@ -91,7 +91,7 @@ public struct PopupView: View {
         .environment(\.deprecatedProperties, deprecatedProperties)
         .onPreferenceChange(PresentedPopupPreferenceKey.self) { wrappedPopup in
             guard let wrappedPopup else { return }
-            onPopupChanged?(wrappedPopup.popup)
+            onPopupChanged?(wrappedPopup.object)
         }
     }
 }
@@ -111,20 +111,9 @@ public extension PopupView {
 
 /// A preference key that specifies the popup currently presented in the `PopupView` navigation stack.
 struct PresentedPopupPreferenceKey: PreferenceKey {
-    /// A wrapper for making a popup equatable.
-    struct EquatablePopup: Equatable {
-        let popup: Popup
-        
-        static func == (lhs: Self, rhs: Self) -> Bool {
-            lhs.popup === rhs.popup
-        }
-    }
-    
-    // MARK: PreferenceKey Conformance
-    
-    static let defaultValue: EquatablePopup? = nil
+    static let defaultValue: EquatableObject<Popup>? = nil
 
-    static func reduce(value: inout EquatablePopup?, nextValue: () -> EquatablePopup?) {
+    static func reduce(value: inout EquatableObject<Popup>?, nextValue: () -> EquatableObject<Popup>?) {
         guard let nextValue = nextValue() else { return }
         value = nextValue
     }