@zealicsolutions/web-ui 1.0.140-beta.185 → 1.0.140-beta.187

package/dist/cjs/containers/ReplicatorContainer/ReplicatorFormSetup.d.ts

@@ -14,12 +14,31 @@ export interface ReplicatorFormSetupProps {
 }
 /**
  * Sets up useFieldArray for a replicator container in form mode.
- * This component should wrap the replicator Container when the organism is a form.
  *
- * CRITICAL: useFieldArray name must include full nested path for nested replicators.
- * Example: "visits" for top-level, "visits.0.medications" for nested
+ * This component bridges the gap between the Container/Replicator system and
+ * react-hook-form's useFieldArray. It handles:
  *
- * Also registers with the ReplicatorRegistry so buttons outside the replicator
- * can control it via targetReplicatorFieldId.
+ * 1. **Field Array Registration**: Creates a useFieldArray instance for the replicator
+ *    and provides it via ReplicatorFormContext to child components.
+ *
+ * 2. **Nested Path Handling**: Builds the correct field array name for nested replicators.
+ *    Example: "visits" for top-level, "visits.0.medications" for nested.
+ *
+ * 3. **Prefill Data Integration**: When navigateToPrepopulateForm passes array data
+ *    via prefillData, this component syncs it with the field array using replace().
+ *
+ * 4. **Default Instance Creation**: For new forms without data, creates minInstances
+ *    empty objects to ensure at least one replicator item is shown.
+ *
+ * 5. **Registry Integration**: Registers with ReplicatorRegistry so external buttons
+ *    (e.g., "Add Item") can control this replicator via targetReplicatorFieldId.
+ *
+ * @usage
+ * Wrap a replicator Container in form organisms:
+ * ```tsx
+ * <ReplicatorFormSetup replicatorFieldId="visits">
+ *   <Container type="replicator" ... />
+ * </ReplicatorFormSetup>
+ * ```
  */
 export declare const ReplicatorFormSetup: FC<PropsWithChildren<ReplicatorFormSetupProps>>;