Docs: Defining FormObject validator with FormGroupOptions (#86)

infinum · Jan 15, 2025 · c4601eb · c4601eb
1 parent 4ce1ba7
commit c4601eb
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docusaurus/docs/guides/validating-forms.md b/docusaurus/docs/guides/validating-forms.md
@@ -29,3 +29,16 @@ Validator object will be used only for `Attribute` and `HasMany` relationships.
 ## Defining FormObject validator with `FormGroupOptions`
 
 To validate a `FormStore` instance as a whole, a validator can be provided via `formGroupOptions` on `FormObject`.
+
+This can be used for validating the `BelongsTo` relationships.
+
+```ts title="user.form-object.ts"
+import { Validators } from '@angular/forms';
+...
+public formGroupOptions: FormGroupOptions = {
+  validator: (form: FormStore) => {
+    ...
+  },
+};
+...
+```
diff --git a/docusaurus/versioned_docs/version-9.0.0/guides/validating-forms.md b/docusaurus/versioned_docs/version-9.0.0/guides/validating-forms.md
@@ -29,3 +29,16 @@ Validator object will be used only for `Attribute` and `HasMany` relationships.
 ## Defining FormObject validator with `FormGroupOptions`
 
 To validate a `FormStore` instance as a whole, a validator can be provided via `formGroupOptions` on `FormObject`.
+
+This can be used for validating the `BelongsTo` relationships.
+
+```ts title="user.form-object.ts"
+import { Validators } from '@angular/forms';
+...
+public formGroupOptions: FormGroupOptions = {
+  validator: (form: FormStore) => {
+    ...
+  },
+};
+...
+```