feat: add onSubmit listener

TanStack · Nov 22, 2024 · 72b762b · 72b762b
1 parent ebcdf83
commit 72b762b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts
@@ -305,6 +305,13 @@ export interface FieldListeners<
     TFormValidator,
     TData
   >
+  onSubmit?: FieldListenerFn<
+    TParentData,
+    TName,
+    TFieldValidator,
+    TFormValidator,
+    TData
+  >
 }
 
 /**

diff --git a/packages/form-core/tests/FieldApi.spec.ts b/packages/form-core/tests/FieldApi.spec.ts
@@ -1003,6 +1003,30 @@ describe('field api', () => {
     expect(triggered).toStrictEqual('test')
   })
 
+  it('should run listener onSubmit', () => {
+    const form = new FormApi({
+      defaultValues: {
+        name: 'test',
+      },
+    })
+
+    let triggered!: string
+    const field = new FieldApi({
+      form,
+      name: 'name',
+      listeners: {
+        onSubmit: ({ value }) => {
+          triggered = value
+        },
+      },
+    })
+
+    field.mount()
+    form.handleSubmit()
+
+    expect(triggered).toStrictEqual('test')
+  })
+
   it('should contain multiple errors when running validation onBlur and onChange', () => {
     const form = new FormApi({
       defaultValues: {