@tanstack/form-core - npm Package Compare versions

Comparing version 0.33.0 to 0.34.0

dist/esm/FormApi.d.ts

@@ -181,3 +181,12 @@ import { Store } from '@tanstack/store';
     /**
-     * A boolean indicating if the form is currently submitting.
+     * A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called.
+     *
+     * Goes back to `false` when submission completes for one of the following reasons:
+     * - the validation step returned errors.
+     * - the `onSubmit` function has completed.
+     *
+     * Note: if you're running async operations in your `onSubmit` function make sure to await them to ensure `isSubmitting` is set to `false` only when the async operation completes.
+     *
+     * This is useful for displaying loading indicators or disabling form inputs during submission.
+     *
      */
@@ -184,0 +193,0 @@ isSubmitting: boolean;

package.json

 {
   "name": "@tanstack/form-core",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Powerful, type-safe, framework agnostic forms.",
@@ -5,0 +5,0 @@ "author": "tannerlinsley",

src/FormApi.ts

@@ -257,3 +257,12 @@ import { Store } from '@tanstack/store'
   /**
-   * A boolean indicating if the form is currently submitting.
+   * A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called.
+   *
+   * Goes back to `false` when submission completes for one of the following reasons:
+   * - the validation step returned errors.
+   * - the `onSubmit` function has completed.
+   *
+   * Note: if you're running async operations in your `onSubmit` function make sure to await them to ensure `isSubmitting` is set to `false` only when the async operation completes.
+   *
+   * This is useful for displaying loading indicators or disabling form inputs during submission.
+   *
    */
@@ -260,0 +269,0 @@ isSubmitting: boolean

No alert changes

Improved metrics

Total package byte prevSize

467223

0.58%

Lines of code

6209

0.29%

No dependency changes