From ebe6dd56d6bf2ff3a46f36cf96cedd92d22d9476 Mon Sep 17 00:00:00 2001 From: xiaoyu2er Date: Thu, 8 May 2025 23:55:18 +0000 Subject: [PATCH] docs: update documentation translations --- .../framework/react/guides/basic-concepts.md | 77 +++++++++------ docs/ar/reference/classes/fieldapi.md | 58 ++++++------ docs/ar/reference/classes/formapi.md | 72 +++++++------- docs/ar/reference/functions/evaluate.md | 34 +++++++ docs/ar/reference/index.md | 6 +- docs/ar/reference/interfaces/formstate.md | 30 ++++-- docs/ar/reference/type-aliases/anyfieldapi.md | 6 +- .../ar/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/ar/reference/type-aliases/anyformapi.md | 6 +- .../ar/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/ar/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/ar/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 81 ++++++++++------ docs/de/reference/classes/fieldapi.md | 58 ++++++------ docs/de/reference/classes/formapi.md | 72 +++++++------- docs/de/reference/functions/evaluate.md | 34 +++++++ docs/de/reference/index.md | 6 +- docs/de/reference/interfaces/formstate.md | 30 ++++-- docs/de/reference/type-aliases/anyfieldapi.md | 6 +- .../de/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/de/reference/type-aliases/anyformapi.md | 6 +- .../de/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/de/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/de/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 57 ++++++++---- docs/es/reference/classes/fieldapi.md | 58 ++++++------ docs/es/reference/classes/formapi.md | 72 +++++++------- docs/es/reference/functions/evaluate.md | 34 +++++++ docs/es/reference/index.md | 6 +- docs/es/reference/interfaces/formstate.md | 30 ++++-- docs/es/reference/type-aliases/anyfieldapi.md | 6 +- .../es/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/es/reference/type-aliases/anyformapi.md | 6 +- .../es/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/es/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/es/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 81 ++++++++++------ docs/fr/reference/classes/fieldapi.md | 58 ++++++------ docs/fr/reference/classes/formapi.md | 72 +++++++------- docs/fr/reference/functions/evaluate.md | 34 +++++++ docs/fr/reference/index.md | 6 +- docs/fr/reference/interfaces/formstate.md | 30 ++++-- docs/fr/reference/type-aliases/anyfieldapi.md | 6 +- .../fr/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/fr/reference/type-aliases/anyformapi.md | 6 +- .../fr/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/fr/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/fr/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 84 ++++++++++------- docs/ja/reference/classes/fieldapi.md | 58 ++++++------ docs/ja/reference/classes/formapi.md | 72 +++++++------- docs/ja/reference/functions/evaluate.md | 34 +++++++ docs/ja/reference/index.md | 6 +- docs/ja/reference/interfaces/formstate.md | 30 ++++-- docs/ja/reference/type-aliases/anyfieldapi.md | 6 +- .../ja/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/ja/reference/type-aliases/anyformapi.md | 6 +- .../ja/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/ja/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/ja/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 93 ++++++++++++------- docs/ru/reference/classes/fieldapi.md | 58 ++++++------ docs/ru/reference/classes/formapi.md | 72 +++++++------- docs/ru/reference/functions/evaluate.md | 34 +++++++ docs/ru/reference/index.md | 6 +- docs/ru/reference/interfaces/formstate.md | 30 ++++-- docs/ru/reference/type-aliases/anyfieldapi.md | 6 +- .../ru/reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- docs/ru/reference/type-aliases/anyformapi.md | 6 +- .../ru/reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- docs/ru/reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- docs/ru/reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 75 +++++++++------ docs/zh-hans/reference/classes/fieldapi.md | 58 ++++++------ docs/zh-hans/reference/classes/formapi.md | 72 +++++++------- docs/zh-hans/reference/functions/evaluate.md | 34 +++++++ docs/zh-hans/reference/index.md | 6 +- .../zh-hans/reference/interfaces/formstate.md | 30 ++++-- .../reference/type-aliases/anyfieldapi.md | 6 +- .../reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- .../reference/type-aliases/anyformapi.md | 6 +- .../reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- .../reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- .../reference/type-aliases/fieldstate.md | 6 +- .../framework/react/guides/basic-concepts.md | 79 ++++++++++------ docs/zh-hant/reference/classes/fieldapi.md | 58 ++++++------ docs/zh-hant/reference/classes/formapi.md | 72 +++++++------- docs/zh-hant/reference/functions/evaluate.md | 34 +++++++ docs/zh-hant/reference/index.md | 6 +- .../zh-hant/reference/interfaces/formstate.md | 30 ++++-- .../reference/type-aliases/anyfieldapi.md | 6 +- .../reference/type-aliases/anyfieldmeta.md | 6 +- .../type-aliases/anyfieldmetaderived.md | 6 +- .../reference/type-aliases/anyformapi.md | 6 +- .../reference/type-aliases/anyformstate.md | 6 +- .../type-aliases/derivedformstate.md | 12 ++- .../reference/type-aliases/fieldmeta.md | 6 +- .../type-aliases/fieldmetaderived.md | 12 ++- .../reference/type-aliases/fieldstate.md | 6 +- 120 files changed, 1742 insertions(+), 1013 deletions(-) create mode 100644 docs/ar/reference/functions/evaluate.md create mode 100644 docs/de/reference/functions/evaluate.md create mode 100644 docs/es/reference/functions/evaluate.md create mode 100644 docs/fr/reference/functions/evaluate.md create mode 100644 docs/ja/reference/functions/evaluate.md create mode 100644 docs/ru/reference/functions/evaluate.md create mode 100644 docs/zh-hans/reference/functions/evaluate.md create mode 100644 docs/zh-hant/reference/functions/evaluate.md diff --git a/docs/ar/framework/react/guides/basic-concepts.md b/docs/ar/framework/react/guides/basic-concepts.md index eb3c1a8d9..61a98fa94 100644 --- a/docs/ar/framework/react/guides/basic-concepts.md +++ b/docs/ar/framework/react/guides/basic-concepts.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-16T08:45:06.000Z' -translation-updated-at: '2025-04-30T22:06:06.532Z' +source-updated-at: '2025-05-08T07:42:29.000Z' +translation-updated-at: '2025-05-08T23:54:45.818Z' id: basic-concepts title: المفاهيم الأساسية --- @@ -9,7 +9,7 @@ title: المفاهيم الأساسية ## خيارات النموذج (Form Options) -يمكنك إنشاء خيارات للنموذج بحيث يمكن مشاركتها بين عدة نماذج باستخدام الدالة `formOptions`. +يمكنك إنشاء خيارات لنموذجك حتى يمكن مشاركتها بين عدة نماذج باستخدام دالة `formOptions`. مثال: @@ -28,19 +28,19 @@ const formOpts = formOptions({ ## نسخة النموذج (Form Instance) -نسخة النموذج (Form Instance) هي كائن يمثل نموذجًا فرديًا ويوفر طرقًا وخصائص للعمل مع النموذج. يمكنك إنشاء نسخة نموذج باستخدام الخطاف `useForm` المقدم من خيارات النموذج. يقبل الخطاف كائنًا يحتوي على دالة `onSubmit`، والتي يتم استدعاؤها عند إرسال النموذج. +نسخة النموذج (Form Instance) هي كائن يمثل نموذجًا فرديًا ويوفر طرقًا وخصائص للعمل مع النموذج. يمكنك إنشاء نسخة نموذج باستخدام الخطاف (hook) `useForm` المقدم من خيارات النموذج. يقبل الخطاف كائنًا يحتوي على دالة `onSubmit`، والتي يتم استدعاؤها عند تقديم النموذج. ```tsx const form = useForm({ ...formOpts, onSubmit: async ({ value }) => { - // افعل شيئًا ببيانات النموذج + // القيام بشيء ما ببيانات النموذج console.log(value) }, }) ``` -يمكنك أيضًا إنشاء نسخة نموذج دون استخدام `formOptions` باستخدام واجهة `useForm` المستقلة: +يمكنك أيضًا إنشاء نسخة نموذج دون استخدام `formOptions` باستخدام واجهة برمجة التطبيقات (API) المستقلة `useForm`: ```tsx interface User { @@ -53,7 +53,7 @@ const defaultUser: User = { firstName: '', lastName: '', hobbies: [] } const form = useForm({ defaultValues: defaultUser, onSubmit: async ({ value }) => { - // افعل شيئًا ببيانات النموذج + // القيام بشيء ما ببيانات النموذج console.log(value) }, }) @@ -61,7 +61,7 @@ const form = useForm({ ## الحقل (Field) -الحقل (Field) يمثل عنصر إدخال فردي في النموذج، مثل حقل نصي أو خانة اختيار. يتم إنشاء الحقول باستخدام مكون `form.Field` المقدم من نسخة النموذج. يقبل المكون خاصية `name`، والتي يجب أن تطابق مفتاحًا في القيم الافتراضية للنموذج. كما يقبل خاصية `children`، وهي دالة عرض تأخذ كائن الحقل كوسيط. +الحقل (Field) يمثل عنصر إدخال فردي في النموذج، مثل حقل نصي أو خانة اختيار. يتم إنشاء الحقول باستخدام مكون `form.Field` المقدم من نسخة النموذج. يقبل المكون خاصية `name`، والتي يجب أن تطابق مفتاحًا في القيم الافتراضية للنموذج. كما يقبل خاصية `children`، وهي دالة عرض (render prop) تأخذ كائن حقل كوسيط لها. مثال: @@ -94,7 +94,11 @@ const { } = field.state ``` -هناك ثلاث حالات للحقل يمكن أن تكون مفيدة لمعرفة كيفية تفاعل المستخدم مع الحقل: الحقل يكون _"ملموسًا" (touched)_ عندما ينقر/ينتقل إليه المستخدم، _"نقيًا" (pristine)_ حتى يغير المستخدم قيمته، و _"متسخًا" (dirty)_ بعد تغيير القيمة. يمكنك التحقق من هذه الحالات عبر العلامات `isTouched`، `isPristine` و `isDirty`، كما هو موضح أدناه. +هناك ثلاث حالات في البيانات الوصفية يمكن أن تكون مفيدة لمعرفة كيفية تفاعل المستخدم مع الحقل: + +- _"isTouched"_: بعد أن ينقر المستخدم/ينتقل إلى الحقل +- _"isPristine"_: حتى يغير المستخدم قيمة الحقل +- _"isDirty"_: بعد تغيير قيمة الحقل ```tsx const { isTouched, isPristine, isDirty } = field.state.meta @@ -102,13 +106,32 @@ const { isTouched, isPristine, isDirty } = field.state.meta ![حالات الحقل](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) -> **ملاحظة مهمة للمستخدمين القادمين من `React Hook Form`**: العلامة `isDirty` في `TanStack/form` تختلف عن العلامة بنفس الاسم في RHF. -> في RHF، `isDirty = true`، عندما تكون قيم النموذج مختلفة عن القيم الأصلية. إذا قام المستخدم بتغيير القيم في نموذج، ثم غيرها مرة أخرى لينتهي بقيم تطابق القيم الافتراضية للنموذج، فإن `isDirty` ستكون `false` في RHF، ولكن `true` في `TanStack/form`. -> القيم الافتراضية متاحة على مستوى النموذج والحقل في `TanStack/form` (`form.options.defaultValues`، `field.options.defaultValue`)، لذا يمكنك كتابة مساعد `isDefaultValue()` الخاص بك إذا كنت بحاجة إلى محاكاة سلوك RHF. +## فهم 'isDirty' في المكتبات المختلفة + +حالة `dirty` غير الدائمة (Non-Persistent) + +- **المكتبات**: React Hook Form (RHF), Formik, Final Form. +- **السلوك**: الحقل يكون 'dirty' إذا اختلفت قيمته عن القيمة الافتراضية. العودة إلى القيمة الافتراضية تجعله 'نظيفًا' مرة أخرى. + +حالة `dirty` الدائمة (Persistent) + +- **المكتبات**: Angular Form, Vue FormKit. +- **السلوك**: يبقى الحقل 'dirty' بمجرد تغييره، حتى إذا عاد إلى القيمة الافتراضية. + +لقد اخترنا نموذج حالة 'dirty' الدائمة. لدعم حالة 'dirty' غير الدائمة أيضًا، نقدم العلامة `isDefault`. تعمل هذه العلامة كعكس لحالة 'dirty' غير الدائمة. + +```tsx +const { isTouched, isPristine, isDirty, isDefaultValue } = field.state.meta + +// السطر التالي يعيد إنشاء وظيفة حالة `dirty` غير الدائمة. +const nonPersistentIsDirty = !isDefaultValue +``` + +![حالات الحقل الممتدة](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states-extended.png) -## واجهة الحقل (Field API) +## واجهة برمجة تطبيقات الحقل (Field API) -واجهة الحقل (Field API) هي كائن يتم تمريره إلى دالة العرض عند إنشاء حقل. توفر طرقًا للعمل مع حالة الحقل. +واجهة برمجة تطبيقات الحقل (Field API) هي كائن يتم تمريره إلى دالة العرض (render prop) عند إنشاء حقل. توفر طرقًا للعمل مع حالة الحقل. مثال: @@ -132,13 +155,13 @@ const { isTouched, isPristine, isDirty } = field.state.meta validators={{ onChange: ({ value }) => !value - ? 'اسم الأول مطلوب' + ? 'الاسم الأول مطلوب' : value.length < 3 - ? 'يجب أن يكون اسم الأول على الأقل 3 أحرف' + ? 'يجب أن يكون الاسم الأول على الأقل 3 أحرف' : undefined, onChangeAsync: async ({ value }) => { await new Promise((resolve) => setTimeout(resolve, 1000)) - return value.includes('error') && 'غير مسموح بـ "error" في اسم الأول' + return value.includes('error') && 'غير مسموح بكلمة "error" في الاسم الأول' }, }} children={(field) => ( @@ -197,7 +220,7 @@ function App() { ## التفاعلية (Reactivity) -توفر `@tanstack/react-form` طرقًا مختلفة للاشتراك في تغييرات حالة النموذج والحقل، أبرزها خطاف `useStore(form.store)` ومكون `form.Subscribe`. تتيح لك هذه الطرق تحسين أداء عرض النموذج عن طريق تحديث المكونات فقط عند الضرورة. +توفر `@tanstack/react-form` طرقًا مختلفة للاشتراك في تغييرات حالة النموذج والحقل، أبرزها الخطاف `useStore(form.store)` ومكون `form.Subscribe`. تتيح لك هذه الطرق تحسين أداء عرض النموذج عن طريق تحديث المكونات فقط عند الضرورة. مثال: @@ -214,21 +237,21 @@ const firstName = useStore(form.store, (state) => state.values.firstName) /> ``` -من المهم تذكر أنه بينما خاصية `selector` لخطاف `useStore` اختيارية، يوصى بشدة بتوفير واحدة، لأن حذفها سيؤدي إلى إعادة عرض غير ضرورية. +من المهم تذكر أنه بينما خاصية `selector` في الخطاف `useStore` اختيارية، يوصى بشدة بتوفير واحدة، لأن حذفها سيؤدي إلى إعادة عرض غير ضرورية. ```tsx -// استخدام صحيح +// الاستخدام الصحيح const firstName = useStore(form.store, (state) => state.values.firstName) const errors = useStore(form.store, (state) => state.errorMap) -// استخدام غير صحيح +// الاستخدام غير الصحيح const store = useStore(form.store) ``` -ملاحظة: استخدام خطاف `useField` لتحقيق التفاعلية غير موصى به لأنه مصمم لاستخدام مدروس داخل مكون `form.Field`. قد ترغب في استخدام `useStore(form.store)` بدلاً من ذلك. +ملاحظة: يُنصح بعدم استخدام الخطاف `useField` لتحقيق التفاعلية لأنه مصمم لاستخدام مدروس داخل مكون `form.Field`. قد ترغب في استخدام `useStore(form.store)` بدلاً من ذلك. ## المستمعون (Listeners) -تسمح لك `@tanstack/react-form` بالتفاعل مع محفزات محدثة و"الاستماع" إليها لتنفيذ تأثيرات جانبية. +تتيح لك `@tanstack/react-form` الاستجابة لمحفزات محددة و"الاستماع" إليها لتنفيذ تأثيرات جانبية. مثال: @@ -244,11 +267,11 @@ const store = useStore(form.store) /> ``` -يمكن العثور على مزيد من المعلومات في [المستمعون](./listeners.md) +يمكن العثور على المزيد من المعلومات في [المستمعون](./listeners.md) ## حقول المصفوفة (Array Fields) -تسمح حقول المصفوفة (Array Fields) بإدارة قائمة من القيم داخل النموذج، مثل قائمة الهوايات. يمكنك إنشاء حقل مصفوفة باستخدام مكون `form.Field` مع خاصية `mode="array"`. +تتيح لك حقول المصفوفة (Array Fields) إدارة قائمة من القيم داخل النموذج، مثل قائمة الهوايات. يمكنك إنشاء حقل مصفوفة باستخدام مكون `form.Field` مع خاصية `mode="array"`. عند العمل مع حقول المصفوفة، يمكنك استخدام طرق الحقول `pushValue`، `removeValue`، `swapValues` و `moveValue` لإضافة، إزالة، وتبديل القيم في المصفوفة. @@ -330,8 +353,8 @@ const store = useStore(form.store) ## أزرار إعادة التعيين (Reset Buttons) -عند استخدام ` ``` -Dies sind die grundlegenden Konzepte und Begriffe, die in der `@tanstack/react-form`-Bibliothek verwendet werden. Wenn Sie diese Konzepte verstehen, können Sie effektiver mit der Bibliothek arbeiten und komplexe Formulare mühelos erstellen. +Dies sind die grundlegenden Konzepte und Begriffe, die in der `@tanstack/react-form`-Bibliothek verwendet werden. Das Verständnis dieser Konzepte hilft Ihnen, effektiver mit der Bibliothek zu arbeiten und komplexe Formulare mühelos zu erstellen. diff --git a/docs/de/reference/classes/fieldapi.md b/docs/de/reference/classes/fieldapi.md index e423989a5..8b595ef24 100644 --- a/docs/de/reference/classes/fieldapi.md +++ b/docs/de/reference/classes/fieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:52:11.915Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.879Z' id: FieldApi title: FieldApi --- @@ -9,7 +9,7 @@ title: FieldApi # Class: FieldApi\ -Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859) +Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863) A class representing the API for managing a form field. @@ -67,7 +67,7 @@ the `new FieldApi` constructor. new FieldApi(opts): FieldApi ``` -Defined in: [packages/form-core/src/FieldApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L991) +Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L995) Initializes a new `FieldApi` instance. @@ -89,7 +89,7 @@ Initializes a new `FieldApi` instance. form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L903) +Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L907) A reference to the form API instance. @@ -101,7 +101,7 @@ A reference to the form API instance. name: DeepKeys; ``` -Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927) +Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) The field name. @@ -113,7 +113,7 @@ The field name. options: FieldApiOptions; ``` -Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) The field options. @@ -125,7 +125,7 @@ The field options. store: Derived>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L955) +Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L959) The field state store. @@ -137,7 +137,7 @@ The field state store. timeoutIds: object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L982) +Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L986) #### formListeners @@ -167,7 +167,7 @@ validations: Record; get state(): FieldState ``` -Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979) +Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L983) The current field state. @@ -183,7 +183,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1245) +Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1249) Gets the field information object. @@ -199,7 +199,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1213) +Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217) #### Returns @@ -213,7 +213,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStac getValue(): TData ``` -Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198) +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) Gets the current field value. @@ -233,7 +233,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1657) +Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1661) Handles the blur event. @@ -249,7 +249,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1650) +Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1654) Handles the change event. @@ -274,7 +274,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262) +Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1266) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -304,7 +304,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri mount(): () => void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) +Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1092) Mounts the field instance to the form. @@ -327,7 +327,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1306) +Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1310) Moves the value at the first specified index to the second specified index. @@ -359,7 +359,7 @@ parseValueWithSchema(schema): | StandardSchemaV1Issue[] ``` -Defined in: [packages/form-core/src/FieldApi.ts:1699](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1699) +Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1703) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -387,7 +387,7 @@ parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[]> ``` -Defined in: [packages/form-core/src/FieldApi.ts:1711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1711) +Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1715) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -414,7 +414,7 @@ The standard schema to parse this field's value with. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1250) +Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1254) Pushes a new value to the field. @@ -440,7 +440,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1288) +Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1292) Removes a value at the specified index. @@ -469,7 +469,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) +Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279) Replaces a value at the specified index. @@ -499,7 +499,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) +Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1678) Updates the field's errorMap @@ -521,7 +521,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1218](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1218) +Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222) Sets the field metadata. @@ -543,7 +543,7 @@ Sets the field metadata. setValue(updater, options?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1205) +Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209) Sets the field value and run the `change` validator. @@ -572,7 +572,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) +Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301) Swaps the values at the specified indices. @@ -602,7 +602,7 @@ Swaps the values at the specified indices. update(opts): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1141) +Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1145) Updates the field instance with new options. @@ -624,7 +624,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617) +Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621) Validates the field value. diff --git a/docs/de/reference/classes/formapi.md b/docs/de/reference/classes/formapi.md index fd0c40d68..0ba2869d1 100644 --- a/docs/de/reference/classes/formapi.md +++ b/docs/de/reference/classes/formapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:52:11.910Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.875Z' id: FormApi title: FormApi --- @@ -9,7 +9,7 @@ title: FormApi # Class: FormApi\ -Defined in: [packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L767) +Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L771) A class representing the Form API. It handles the logic and interactions with the form state. @@ -47,7 +47,7 @@ However, if you need to create a new instance manually, you can do so by calling new FormApi(opts?): FormApi ``` -Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) +Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L842) Constructs a new `FormApi` instance with the given form options. @@ -69,7 +69,7 @@ Constructs a new `FormApi` instance with the given form options. baseStore: Store>; ``` -Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L794) +Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L798) *** @@ -79,7 +79,7 @@ Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/ fieldInfo: Record, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:824](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L824) +Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L828) A record of field information for each field in the form. @@ -91,7 +91,7 @@ A record of field information for each field in the form. fieldMetaDerived: Derived, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L807) +Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L811) *** @@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:782](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L782) +Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L786) The options for the form. @@ -113,7 +113,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) +Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L812) ## Accessors @@ -125,7 +125,7 @@ Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L826) +Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830) ##### Returns @@ -139,7 +139,7 @@ Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1912) +Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938) #### Type Parameters @@ -163,7 +163,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:2148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2148) +Defined in: [packages/form-core/src/FormApi.ts:2174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2174) Returns form and field level errors @@ -214,7 +214,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1826) +Defined in: [packages/form-core/src/FormApi.ts:1852](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852) Gets the field info of the specified field. @@ -240,7 +240,7 @@ Gets the field info of the specified field. getFieldMeta(field): undefined | AnyFieldMeta ``` -Defined in: [packages/form-core/src/FormApi.ts:1817](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1817) +Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843) Gets the metadata of the specified field. @@ -266,7 +266,7 @@ Gets the metadata of the specified field. getFieldValue(field): DeepValue ``` -Defined in: [packages/form-core/src/FormApi.ts:1810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1810) +Defined in: [packages/form-core/src/FormApi.ts:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836) Gets the value of the specified field. @@ -294,7 +294,7 @@ Gets the value of the specified field. handleSubmit(): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1712) +Defined in: [packages/form-core/src/FormApi.ts:1738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -308,7 +308,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu handleSubmit(submitMeta): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1713](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1713) +Defined in: [packages/form-core/src/FormApi.ts:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -334,7 +334,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1951) +Defined in: [packages/form-core/src/FormApi.ts:1977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977) #### Type Parameters @@ -370,7 +370,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1142) +Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) #### Returns @@ -392,7 +392,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2075) +Defined in: [packages/form-core/src/FormApi.ts:2101](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101) Moves the value at the first specified index to the second specified index within an array field. @@ -435,7 +435,7 @@ parseValuesWithSchema(schema): } ``` -Defined in: [packages/form-core/src/FormApi.ts:2208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2208) +Defined in: [packages/form-core/src/FormApi.ts:2234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2234) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -469,7 +469,7 @@ parseValuesWithSchemaAsync(schema): Promise< }> ``` -Defined in: [packages/form-core/src/FormApi.ts:2220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2220) +Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -502,7 +502,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1936](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1936) +Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962) Pushes a value into an array field. @@ -539,7 +539,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) +Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035) Removes a value from an array field at the specified index. @@ -577,7 +577,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1983) +Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) Replaces a value into an array field at the specified index. @@ -615,7 +615,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1230) +Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated. @@ -648,7 +648,7 @@ Optional options to control the reset behavior. resetField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103) +Defined in: [packages/form-core/src/FormApi.ts:2129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129) Resets the field value and meta to default state @@ -674,7 +674,7 @@ Resets the field value and meta to default state resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1866](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1866) +Defined in: [packages/form-core/src/FormApi.ts:1892](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892) resets every field's meta @@ -700,7 +700,7 @@ resets every field's meta setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2124) +Defined in: [packages/form-core/src/FormApi.ts:2150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150) Updates the form's errorMap @@ -722,7 +722,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845) +Defined in: [packages/form-core/src/FormApi.ts:1871](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871) Updates the metadata of the specified field. @@ -755,7 +755,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1882](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1882) +Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) Sets the value of the specified field and optionally updates the touched state. @@ -793,7 +793,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2046) +Defined in: [packages/form-core/src/FormApi.ts:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072) Swaps the values at the specified indices within an array field. @@ -831,7 +831,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1162) +Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1188) Updates the form options and form state. @@ -853,7 +853,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) +Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1282) Validates all fields using the correct handlers for a given validation cause. @@ -878,7 +878,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1286) +Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312) Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type. @@ -912,7 +912,7 @@ Validates the children of a specified array in the form starting from a given in validateField(field, cause): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1325) +Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/de/reference/functions/evaluate.md b/docs/de/reference/functions/evaluate.md new file mode 100644 index 000000000..cd32e8a4a --- /dev/null +++ b/docs/de/reference/functions/evaluate.md @@ -0,0 +1,34 @@ +--- +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.871Z' +id: evaluate +title: evaluate +--- + + + +# Function: evaluate() + +```ts +function evaluate(objA, objB): boolean +``` + +Defined in: [packages/form-core/src/utils.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L339) + +## Type Parameters + +• **T** + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/de/reference/index.md b/docs/de/reference/index.md index e9290afe6..def7aa08f 100644 --- a/docs/de/reference/index.md +++ b/docs/de/reference/index.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-25T12:58:29.000Z' -translation-updated-at: '2025-04-30T22:41:47.307Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.831Z' id: '@tanstack/form-core' title: '@tanstack/form-core' --- @@ -84,8 +84,8 @@ title: '@tanstack/form-core' ## Functions +- [evaluate](functions/evaluate.md) - [formOptions](functions/formoptions.md) - [isGlobalFormValidationError](functions/isglobalformvalidationerror.md) - [isStandardSchemaValidator](functions/isstandardschemavalidator.md) - [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) diff --git a/docs/de/reference/interfaces/formstate.md b/docs/de/reference/interfaces/formstate.md index 267b1e5d9..2573e29c6 100644 --- a/docs/de/reference/interfaces/formstate.md +++ b/docs/de/reference/interfaces/formstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:21:10.200Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.827Z' id: FormState title: FormState --- @@ -9,7 +9,7 @@ title: FormState # Interface: FormState\ -Defined in: [packages/form-core/src/FormApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L643) +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) An object representing the current state of the form. @@ -63,7 +63,7 @@ BaseFormState._force_re_eval canSubmit: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) +Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) A boolean indicating if the form can be submitted based on its current state. @@ -125,7 +125,7 @@ DerivedFormState.errors fieldMeta: Record, AnyFieldMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) +Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644) A record of field metadata for each field in the form. @@ -173,6 +173,24 @@ DerivedFormState.isBlurred *** +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) + +A boolean indicating if all of the form's fields are the same as default values. + +#### Inherited from + +```ts +DerivedFormState.isDefaultValue +``` + +*** + ### isDirty ```ts @@ -371,7 +389,7 @@ DerivedFormState.isTouched isValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors. diff --git a/docs/de/reference/type-aliases/anyfieldapi.md b/docs/de/reference/type-aliases/anyfieldapi.md index a21ec8036..2398ac3c3 100644 --- a/docs/de/reference/type-aliases/anyfieldapi.md +++ b/docs/de/reference/type-aliases/anyfieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:21:10.170Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.867Z' id: AnyFieldApi title: AnyFieldApi --- @@ -13,6 +13,6 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L828) +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) A type representing the Field API with all generics set to `any` for convenience. diff --git a/docs/de/reference/type-aliases/anyfieldmeta.md b/docs/de/reference/type-aliases/anyfieldmeta.md index 40593baed..b48823f22 100644 --- a/docs/de/reference/type-aliases/anyfieldmeta.md +++ b/docs/de/reference/type-aliases/anyfieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:21:10.165Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.862Z' id: AnyFieldMeta title: AnyFieldMeta --- @@ -13,4 +13,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [packages/form-core/src/FieldApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L747) +Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) diff --git a/docs/de/reference/type-aliases/anyfieldmetaderived.md b/docs/de/reference/type-aliases/anyfieldmetaderived.md index dce4b7620..e2346f147 100644 --- a/docs/de/reference/type-aliases/anyfieldmetaderived.md +++ b/docs/de/reference/type-aliases/anyfieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:21:10.155Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.858Z' id: AnyFieldMetaDerived title: AnyFieldMetaDerived --- @@ -13,4 +13,4 @@ title: AnyFieldMetaDerived type AnyFieldMetaDerived = FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661) +Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L665) diff --git a/docs/de/reference/type-aliases/anyformapi.md b/docs/de/reference/type-aliases/anyformapi.md index 851bbccd1..5b184ac2d 100644 --- a/docs/de/reference/type-aliases/anyformapi.md +++ b/docs/de/reference/type-aliases/anyformapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:21:10.150Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.854Z' id: AnyFormApi title: AnyFormApi --- @@ -13,6 +13,6 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [packages/form-core/src/FormApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L747) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) A type representing the Form API with all generics set to `any` for convenience. diff --git a/docs/de/reference/type-aliases/anyformstate.md b/docs/de/reference/type-aliases/anyformstate.md index b7ad65c3a..f35231b91 100644 --- a/docs/de/reference/type-aliases/anyformstate.md +++ b/docs/de/reference/type-aliases/anyformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:21:10.146Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.850Z' id: AnyFormState title: AnyFormState --- @@ -13,4 +13,4 @@ title: AnyFormState type AnyFormState = FormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676) +Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680) diff --git a/docs/de/reference/type-aliases/derivedformstate.md b/docs/de/reference/type-aliases/derivedformstate.md index 335671c43..49a5075ad 100644 --- a/docs/de/reference/type-aliases/derivedformstate.md +++ b/docs/de/reference/type-aliases/derivedformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:47.958Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.846Z' id: DerivedFormState title: DerivedFormState --- @@ -77,6 +77,14 @@ isBlurred: boolean; A boolean indicating if any of the form fields have been blurred. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A boolean indicating if all of the form's fields are the same as default values. + ### isDirty ```ts diff --git a/docs/de/reference/type-aliases/fieldmeta.md b/docs/de/reference/type-aliases/fieldmeta.md index 512d88ea9..864ee73fb 100644 --- a/docs/de/reference/type-aliases/fieldmeta.md +++ b/docs/de/reference/type-aliases/fieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:47.885Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.842Z' id: FieldMeta title: FieldMeta --- @@ -13,7 +13,7 @@ title: FieldMeta type FieldMeta = FieldMetaBase & FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L684) +Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L688) An object type representing the metadata of a field in a form. diff --git a/docs/de/reference/type-aliases/fieldmetaderived.md b/docs/de/reference/type-aliases/fieldmetaderived.md index eac8e90ba..7160a7d6c 100644 --- a/docs/de/reference/type-aliases/fieldmetaderived.md +++ b/docs/de/reference/type-aliases/fieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:21:10.103Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.839Z' id: FieldMetaDerived title: FieldMetaDerived --- @@ -68,6 +68,14 @@ errors: ( An array of errors related to the field value. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A flag indicating whether the field's current value is the default value + ### isPristine ```ts diff --git a/docs/de/reference/type-aliases/fieldstate.md b/docs/de/reference/type-aliases/fieldstate.md index a728a0265..2f8599be9 100644 --- a/docs/de/reference/type-aliases/fieldstate.md +++ b/docs/de/reference/type-aliases/fieldstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:47.852Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:47:24.835Z' id: FieldState title: FieldState --- @@ -13,7 +13,7 @@ title: FieldState type FieldState = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) +Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) An object type representing the state of a field. diff --git a/docs/es/framework/react/guides/basic-concepts.md b/docs/es/framework/react/guides/basic-concepts.md index f9fe81fe7..01635d979 100644 --- a/docs/es/framework/react/guides/basic-concepts.md +++ b/docs/es/framework/react/guides/basic-concepts.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-16T08:45:06.000Z' -translation-updated-at: '2025-04-30T21:48:43.089Z' +source-updated-at: '2025-05-08T07:42:29.000Z' +translation-updated-at: '2025-05-08T23:47:23.997Z' id: basic-concepts title: Conceptos básicos --- @@ -11,7 +11,7 @@ Esta página introduce los conceptos básicos y la terminología utilizada en la ## Opciones del Formulario -Puede crear opciones para su formulario para que puedan compartirse entre múltiples formularios utilizando la función `formOptions`. +Puede crear opciones para su formulario para que pueda ser compartido entre múltiples formularios utilizando la función `formOptions`. Ejemplo: @@ -96,7 +96,11 @@ const { } = field.state ``` -Hay tres estados de campo que pueden ser útiles para ver cómo interactúa el usuario con un campo: un campo está _"touched"_ (tocado) cuando el usuario hace clic o tabula en él, _"pristine"_ (prístino) hasta que el usuario cambia su valor, y _"dirty"_ (modificado) después de que el valor ha sido cambiado. Puede verificar estos estados a través de las banderas `isTouched`, `isPristine` e `isDirty`, como se muestra a continuación. +Hay tres estados en los metadatos que pueden ser útiles para ver cómo interactúa el usuario con un campo: + +- _"isTouched"_, después de que el usuario hace clic o tabula en el campo +- _"isPristine"_, hasta que el usuario cambia el valor del campo +- _"isDirty"_, después de que el valor del campo ha sido cambiado ```tsx const { isTouched, isPristine, isDirty } = field.state.meta @@ -104,9 +108,28 @@ const { isTouched, isPristine, isDirty } = field.state.meta ![Estados del campo](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) -> **Nota importante para usuarios que vienen de `React Hook Form`**: la bandera `isDirty` en `TanStack/form` es diferente de la bandera con el mismo nombre en RHF. -> En RHF, `isDirty = true`, cuando los valores del formulario son diferentes de los valores originales. Si el usuario cambia los valores en un formulario y luego los cambia nuevamente para terminar con valores que coinciden con los valores predeterminados del formulario, `isDirty` será `false` en RHF, pero `true` en `TanStack/form`. -> Los valores predeterminados se exponen tanto a nivel del formulario como del campo en `TanStack/form` (`form.options.defaultValues`, `field.options.defaultValue`), por lo que puede escribir su propia función auxiliar `isDefaultValue()` si necesita emular el comportamiento de RHF. +## Entendiendo 'isDirty' en Diferentes Bibliotecas + +Estado `dirty` no persistente + +- **Bibliotecas**: React Hook Form (RHF), Formik, Final Form. +- **Comportamiento**: Un campo está 'dirty' si su valor difiere del predeterminado. Revertir al valor predeterminado lo vuelve 'clean' nuevamente. + +Estado `dirty` persistente + +- **Bibliotecas**: Angular Form, Vue FormKit. +- **Comportamiento**: Un campo permanece 'dirty' una vez cambiado, incluso si se revierte al valor predeterminado. + +Hemos elegido el modelo de estado 'dirty' persistente. Para también admitir un estado 'dirty' no persistente, introducimos la bandera `isDefault`. Esta bandera actúa como un inverso del estado 'dirty' no persistente. + +```tsx +const { isTouched, isPristine, isDirty, isDefaultValue } = field.state.meta + +// La siguiente línea recreará la funcionalidad `dirty` no persistente. +const nonPersistentIsDirty = !isDefaultValue +``` + +![Estados del campo extendidos](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states-extended.png) ## API del Campo @@ -124,7 +147,7 @@ Ejemplo: ## Validación -`@tanstack/react-form` proporciona validación tanto síncrona como asíncrona de forma predeterminada. Las funciones de validación se pueden pasar al componente `form.Field` utilizando la propiedad `validators`. +`@tanstack/react-form` proporciona validación sincrónica y asincrónica de forma predeterminada. Las funciones de validación se pueden pasar al componente `form.Field` utilizando la propiedad `validators`. Ejemplo: @@ -160,7 +183,7 @@ Ejemplo: Además de las opciones de validación personalizadas, también admitimos la especificación [Standard Schema](https://github.com/standard-schema/standard-schema). -Puede definir un esquema utilizando cualquiera de las bibliotecas que implementan la especificación y pasarlo a un validador de formulario o campo. +Puede definir un esquema utilizando cualquiera de las bibliotecas que implementen la especificación y pasarlo a un validador de formulario o campo. Las bibliotecas admitidas incluyen: @@ -199,7 +222,7 @@ function App() { ## Reactividad -`@tanstack/react-form` ofrece varias formas de suscribirse a cambios de estado del formulario y de los campos, más notablemente el hook `useStore(form.store)` y el componente `form.Subscribe`. Estos métodos le permiten optimizar el rendimiento de renderizado de su formulario actualizando solo los componentes cuando sea necesario. +`@tanstack/react-form` ofrece varias formas de suscribirse a cambios de estado del formulario y campos, más notablemente el hook `useStore(form.store)` y el componente `form.Subscribe`. Estos métodos le permiten optimizar el rendimiento de renderizado de su formulario actualizando solo los componentes cuando sea necesario. Ejemplo: @@ -246,9 +269,9 @@ Ejemplo: /> ``` -Más información se puede encontrar en [Oyentes](./listeners.md) +Puede encontrar más información en [Oyentes (Listeners)](./listeners.md) -## Campos de Arreglo +## Campos de Arreglo (Array Fields) Los campos de arreglo le permiten administrar una lista de valores dentro de un formulario, como una lista de pasatiempos. Puede crear un campo de arreglo utilizando el componente `form.Field` con la propiedad `mode="array"`. @@ -330,10 +353,10 @@ Ejemplo: /> ``` -## Botones de Reinicio +## Botones de Reinicio (Reset Buttons) -Cuando se utiliza ` ``` -Alternativamente, puede usar ` ``` -Estos son los conceptos básicos y la terminología utilizada en la biblioteca `@tanstack/react-form`. Comprender estos conceptos le ayudará a trabajar de manera más efectiva con la biblioteca y crear formularios complejos con facilidad. +Estos son los conceptos básicos y la terminología utilizados en la biblioteca `@tanstack/react-form`. Comprender estos conceptos le ayudará a trabajar de manera más efectiva con la biblioteca y crear formularios complejos con facilidad. diff --git a/docs/es/reference/classes/fieldapi.md b/docs/es/reference/classes/fieldapi.md index 6566bd4ed..2345c6317 100644 --- a/docs/es/reference/classes/fieldapi.md +++ b/docs/es/reference/classes/fieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:51:40.649Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:39.013Z' id: FieldApi title: FieldApi --- @@ -9,7 +9,7 @@ title: FieldApi # Class: FieldApi\ -Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859) +Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863) A class representing the API for managing a form field. @@ -67,7 +67,7 @@ the `new FieldApi` constructor. new FieldApi(opts): FieldApi ``` -Defined in: [packages/form-core/src/FieldApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L991) +Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L995) Initializes a new `FieldApi` instance. @@ -89,7 +89,7 @@ Initializes a new `FieldApi` instance. form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L903) +Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L907) A reference to the form API instance. @@ -101,7 +101,7 @@ A reference to the form API instance. name: DeepKeys; ``` -Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927) +Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) The field name. @@ -113,7 +113,7 @@ The field name. options: FieldApiOptions; ``` -Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) The field options. @@ -125,7 +125,7 @@ The field options. store: Derived>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L955) +Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L959) The field state store. @@ -137,7 +137,7 @@ The field state store. timeoutIds: object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L982) +Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L986) #### formListeners @@ -167,7 +167,7 @@ validations: Record; get state(): FieldState ``` -Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979) +Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L983) The current field state. @@ -183,7 +183,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1245) +Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1249) Gets the field information object. @@ -199,7 +199,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1213) +Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217) #### Returns @@ -213,7 +213,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStac getValue(): TData ``` -Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198) +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) Gets the current field value. @@ -233,7 +233,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1657) +Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1661) Handles the blur event. @@ -249,7 +249,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1650) +Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1654) Handles the change event. @@ -274,7 +274,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262) +Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1266) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -304,7 +304,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri mount(): () => void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) +Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1092) Mounts the field instance to the form. @@ -327,7 +327,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1306) +Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1310) Moves the value at the first specified index to the second specified index. @@ -359,7 +359,7 @@ parseValueWithSchema(schema): | StandardSchemaV1Issue[] ``` -Defined in: [packages/form-core/src/FieldApi.ts:1699](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1699) +Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1703) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -387,7 +387,7 @@ parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[]> ``` -Defined in: [packages/form-core/src/FieldApi.ts:1711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1711) +Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1715) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -414,7 +414,7 @@ The standard schema to parse this field's value with. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1250) +Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1254) Pushes a new value to the field. @@ -440,7 +440,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1288) +Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1292) Removes a value at the specified index. @@ -469,7 +469,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) +Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279) Replaces a value at the specified index. @@ -499,7 +499,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) +Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1678) Updates the field's errorMap @@ -521,7 +521,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1218](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1218) +Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222) Sets the field metadata. @@ -543,7 +543,7 @@ Sets the field metadata. setValue(updater, options?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1205) +Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209) Sets the field value and run the `change` validator. @@ -572,7 +572,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) +Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301) Swaps the values at the specified indices. @@ -602,7 +602,7 @@ Swaps the values at the specified indices. update(opts): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1141) +Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1145) Updates the field instance with new options. @@ -624,7 +624,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617) +Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621) Validates the field value. diff --git a/docs/es/reference/classes/formapi.md b/docs/es/reference/classes/formapi.md index 80136bfdf..07156df7f 100644 --- a/docs/es/reference/classes/formapi.md +++ b/docs/es/reference/classes/formapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:51:40.645Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:39.009Z' id: FormApi title: FormApi --- @@ -9,7 +9,7 @@ title: FormApi # Class: FormApi\ -Defined in: [packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L767) +Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L771) A class representing the Form API. It handles the logic and interactions with the form state. @@ -47,7 +47,7 @@ However, if you need to create a new instance manually, you can do so by calling new FormApi(opts?): FormApi ``` -Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) +Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L842) Constructs a new `FormApi` instance with the given form options. @@ -69,7 +69,7 @@ Constructs a new `FormApi` instance with the given form options. baseStore: Store>; ``` -Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L794) +Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L798) *** @@ -79,7 +79,7 @@ Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/ fieldInfo: Record, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:824](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L824) +Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L828) A record of field information for each field in the form. @@ -91,7 +91,7 @@ A record of field information for each field in the form. fieldMetaDerived: Derived, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L807) +Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L811) *** @@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:782](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L782) +Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L786) The options for the form. @@ -113,7 +113,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) +Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L812) ## Accessors @@ -125,7 +125,7 @@ Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L826) +Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830) ##### Returns @@ -139,7 +139,7 @@ Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1912) +Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938) #### Type Parameters @@ -163,7 +163,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:2148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2148) +Defined in: [packages/form-core/src/FormApi.ts:2174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2174) Returns form and field level errors @@ -214,7 +214,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1826) +Defined in: [packages/form-core/src/FormApi.ts:1852](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852) Gets the field info of the specified field. @@ -240,7 +240,7 @@ Gets the field info of the specified field. getFieldMeta(field): undefined | AnyFieldMeta ``` -Defined in: [packages/form-core/src/FormApi.ts:1817](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1817) +Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843) Gets the metadata of the specified field. @@ -266,7 +266,7 @@ Gets the metadata of the specified field. getFieldValue(field): DeepValue ``` -Defined in: [packages/form-core/src/FormApi.ts:1810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1810) +Defined in: [packages/form-core/src/FormApi.ts:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836) Gets the value of the specified field. @@ -294,7 +294,7 @@ Gets the value of the specified field. handleSubmit(): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1712) +Defined in: [packages/form-core/src/FormApi.ts:1738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -308,7 +308,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu handleSubmit(submitMeta): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1713](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1713) +Defined in: [packages/form-core/src/FormApi.ts:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -334,7 +334,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1951) +Defined in: [packages/form-core/src/FormApi.ts:1977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977) #### Type Parameters @@ -370,7 +370,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1142) +Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) #### Returns @@ -392,7 +392,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2075) +Defined in: [packages/form-core/src/FormApi.ts:2101](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101) Moves the value at the first specified index to the second specified index within an array field. @@ -435,7 +435,7 @@ parseValuesWithSchema(schema): } ``` -Defined in: [packages/form-core/src/FormApi.ts:2208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2208) +Defined in: [packages/form-core/src/FormApi.ts:2234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2234) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -469,7 +469,7 @@ parseValuesWithSchemaAsync(schema): Promise< }> ``` -Defined in: [packages/form-core/src/FormApi.ts:2220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2220) +Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -502,7 +502,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1936](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1936) +Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962) Pushes a value into an array field. @@ -539,7 +539,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) +Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035) Removes a value from an array field at the specified index. @@ -577,7 +577,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1983) +Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) Replaces a value into an array field at the specified index. @@ -615,7 +615,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1230) +Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated. @@ -648,7 +648,7 @@ Optional options to control the reset behavior. resetField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103) +Defined in: [packages/form-core/src/FormApi.ts:2129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129) Resets the field value and meta to default state @@ -674,7 +674,7 @@ Resets the field value and meta to default state resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1866](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1866) +Defined in: [packages/form-core/src/FormApi.ts:1892](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892) resets every field's meta @@ -700,7 +700,7 @@ resets every field's meta setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2124) +Defined in: [packages/form-core/src/FormApi.ts:2150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150) Updates the form's errorMap @@ -722,7 +722,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845) +Defined in: [packages/form-core/src/FormApi.ts:1871](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871) Updates the metadata of the specified field. @@ -755,7 +755,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1882](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1882) +Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) Sets the value of the specified field and optionally updates the touched state. @@ -793,7 +793,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2046) +Defined in: [packages/form-core/src/FormApi.ts:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072) Swaps the values at the specified indices within an array field. @@ -831,7 +831,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1162) +Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1188) Updates the form options and form state. @@ -853,7 +853,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) +Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1282) Validates all fields using the correct handlers for a given validation cause. @@ -878,7 +878,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1286) +Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312) Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type. @@ -912,7 +912,7 @@ Validates the children of a specified array in the form starting from a given in validateField(field, cause): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1325) +Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/es/reference/functions/evaluate.md b/docs/es/reference/functions/evaluate.md new file mode 100644 index 000000000..268dbde14 --- /dev/null +++ b/docs/es/reference/functions/evaluate.md @@ -0,0 +1,34 @@ +--- +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:39.005Z' +id: evaluate +title: evaluate +--- + + + +# Function: evaluate() + +```ts +function evaluate(objA, objB): boolean +``` + +Defined in: [packages/form-core/src/utils.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L339) + +## Type Parameters + +• **T** + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/es/reference/index.md b/docs/es/reference/index.md index bf032e195..7c0262fd7 100644 --- a/docs/es/reference/index.md +++ b/docs/es/reference/index.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-25T12:58:29.000Z' -translation-updated-at: '2025-04-30T22:41:41.726Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.961Z' id: '@tanstack/form-core' title: '@tanstack/form-core' --- @@ -84,8 +84,8 @@ title: '@tanstack/form-core' ## Functions +- [evaluate](functions/evaluate.md) - [formOptions](functions/formoptions.md) - [isGlobalFormValidationError](functions/isglobalformvalidationerror.md) - [isStandardSchemaValidator](functions/isstandardschemavalidator.md) - [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) diff --git a/docs/es/reference/interfaces/formstate.md b/docs/es/reference/interfaces/formstate.md index 074cf9e6f..f2f2e80cb 100644 --- a/docs/es/reference/interfaces/formstate.md +++ b/docs/es/reference/interfaces/formstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:19:27.691Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.965Z' id: FormState title: FormState --- @@ -9,7 +9,7 @@ title: FormState # Interface: FormState\ -Defined in: [packages/form-core/src/FormApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L643) +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) An object representing the current state of the form. @@ -63,7 +63,7 @@ BaseFormState._force_re_eval canSubmit: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) +Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) A boolean indicating if the form can be submitted based on its current state. @@ -125,7 +125,7 @@ DerivedFormState.errors fieldMeta: Record, AnyFieldMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) +Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644) A record of field metadata for each field in the form. @@ -173,6 +173,24 @@ DerivedFormState.isBlurred *** +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) + +A boolean indicating if all of the form's fields are the same as default values. + +#### Inherited from + +```ts +DerivedFormState.isDefaultValue +``` + +*** + ### isDirty ```ts @@ -371,7 +389,7 @@ DerivedFormState.isTouched isValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors. diff --git a/docs/es/reference/type-aliases/anyfieldapi.md b/docs/es/reference/type-aliases/anyfieldapi.md index 74ba2b71c..468bc937c 100644 --- a/docs/es/reference/type-aliases/anyfieldapi.md +++ b/docs/es/reference/type-aliases/anyfieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:19:27.661Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:39.002Z' id: AnyFieldApi title: AnyFieldApi --- @@ -13,6 +13,6 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L828) +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) A type representing the Field API with all generics set to `any` for convenience. diff --git a/docs/es/reference/type-aliases/anyfieldmeta.md b/docs/es/reference/type-aliases/anyfieldmeta.md index 80d26e87a..c9a809ab5 100644 --- a/docs/es/reference/type-aliases/anyfieldmeta.md +++ b/docs/es/reference/type-aliases/anyfieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:19:27.657Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.995Z' id: AnyFieldMeta title: AnyFieldMeta --- @@ -13,4 +13,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [packages/form-core/src/FieldApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L747) +Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) diff --git a/docs/es/reference/type-aliases/anyfieldmetaderived.md b/docs/es/reference/type-aliases/anyfieldmetaderived.md index f8c6677a0..1dafbc470 100644 --- a/docs/es/reference/type-aliases/anyfieldmetaderived.md +++ b/docs/es/reference/type-aliases/anyfieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:19:27.646Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.992Z' id: AnyFieldMetaDerived title: AnyFieldMetaDerived --- @@ -13,4 +13,4 @@ title: AnyFieldMetaDerived type AnyFieldMetaDerived = FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661) +Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L665) diff --git a/docs/es/reference/type-aliases/anyformapi.md b/docs/es/reference/type-aliases/anyformapi.md index 16224748b..dd41891c7 100644 --- a/docs/es/reference/type-aliases/anyformapi.md +++ b/docs/es/reference/type-aliases/anyformapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:19:27.642Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.988Z' id: AnyFormApi title: AnyFormApi --- @@ -13,6 +13,6 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [packages/form-core/src/FormApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L747) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) A type representing the Form API with all generics set to `any` for convenience. diff --git a/docs/es/reference/type-aliases/anyformstate.md b/docs/es/reference/type-aliases/anyformstate.md index 7937635eb..5cd594c97 100644 --- a/docs/es/reference/type-aliases/anyformstate.md +++ b/docs/es/reference/type-aliases/anyformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:19:27.638Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.984Z' id: AnyFormState title: AnyFormState --- @@ -13,4 +13,4 @@ title: AnyFormState type AnyFormState = FormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676) +Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680) diff --git a/docs/es/reference/type-aliases/derivedformstate.md b/docs/es/reference/type-aliases/derivedformstate.md index 391906ed1..f6fa3c097 100644 --- a/docs/es/reference/type-aliases/derivedformstate.md +++ b/docs/es/reference/type-aliases/derivedformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:42.409Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.980Z' id: DerivedFormState title: DerivedFormState --- @@ -77,6 +77,14 @@ isBlurred: boolean; A boolean indicating if any of the form fields have been blurred. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A boolean indicating if all of the form's fields are the same as default values. + ### isDirty ```ts diff --git a/docs/es/reference/type-aliases/fieldmeta.md b/docs/es/reference/type-aliases/fieldmeta.md index 261937053..488f4ef1f 100644 --- a/docs/es/reference/type-aliases/fieldmeta.md +++ b/docs/es/reference/type-aliases/fieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:42.286Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.977Z' id: FieldMeta title: FieldMeta --- @@ -13,7 +13,7 @@ title: FieldMeta type FieldMeta = FieldMetaBase & FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L684) +Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L688) An object type representing the metadata of a field in a form. diff --git a/docs/es/reference/type-aliases/fieldmetaderived.md b/docs/es/reference/type-aliases/fieldmetaderived.md index 1e5b44041..bccc64902 100644 --- a/docs/es/reference/type-aliases/fieldmetaderived.md +++ b/docs/es/reference/type-aliases/fieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:19:27.599Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.973Z' id: FieldMetaDerived title: FieldMetaDerived --- @@ -68,6 +68,14 @@ errors: ( An array of errors related to the field value. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A flag indicating whether the field's current value is the default value + ### isPristine ```ts diff --git a/docs/es/reference/type-aliases/fieldstate.md b/docs/es/reference/type-aliases/fieldstate.md index 980cf832b..d7d76cc20 100644 --- a/docs/es/reference/type-aliases/fieldstate.md +++ b/docs/es/reference/type-aliases/fieldstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:42.325Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:45:38.969Z' id: FieldState title: FieldState --- @@ -13,7 +13,7 @@ title: FieldState type FieldState = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) +Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) An object type representing the state of a field. diff --git a/docs/fr/framework/react/guides/basic-concepts.md b/docs/fr/framework/react/guides/basic-concepts.md index d22d5f33d..66ee12e0d 100644 --- a/docs/fr/framework/react/guides/basic-concepts.md +++ b/docs/fr/framework/react/guides/basic-concepts.md @@ -1,13 +1,13 @@ --- -source-updated-at: '2025-04-16T08:45:06.000Z' -translation-updated-at: '2025-04-30T21:36:23.772Z' +source-updated-at: '2025-05-08T07:42:29.000Z' +translation-updated-at: '2025-05-08T23:51:04.723Z' id: basic-concepts title: Concepts de base --- Cette page présente les concepts de base et la terminologie utilisés dans la bibliothèque `@tanstack/react-form`. Se familiariser avec ces concepts vous aidera à mieux comprendre et travailler avec la bibliothèque. -## Options de formulaire +## Options de formulaire (Form Options) Vous pouvez créer des options pour votre formulaire afin qu'elles puissent être partagées entre plusieurs formulaires en utilisant la fonction `formOptions`. @@ -26,9 +26,9 @@ const formOpts = formOptions({ }) ``` -## Instance de formulaire +## Instance de formulaire (Form Instance) -Une Instance de formulaire est un objet qui représente un formulaire individuel et fournit des méthodes et propriétés pour travailler avec le formulaire. Vous créez une instance de formulaire en utilisant le hook `useForm` fourni par les options de formulaire. Le hook accepte un objet avec une fonction `onSubmit`, qui est appelée lorsque le formulaire est soumis. +Une instance de formulaire (Form Instance) est un objet qui représente un formulaire individuel et fournit des méthodes et des propriétés pour travailler avec le formulaire. Vous créez une instance de formulaire en utilisant le hook `useForm` fourni par les options de formulaire. Le hook accepte un objet avec une fonction `onSubmit`, qui est appelée lorsque le formulaire est soumis. ```tsx const form = useForm({ @@ -59,9 +59,9 @@ const form = useForm({ }) ``` -## Champ +## Champ (Field) -Un Champ représente un seul élément de saisie de formulaire, comme un champ de texte ou une case à cocher. Les champs sont créés en utilisant le composant `form.Field` fourni par l'instance de formulaire. Le composant accepte une prop `name`, qui doit correspondre à une clé dans les valeurs par défaut du formulaire. Il accepte également une prop `children`, qui est une fonction de rendu qui prend un objet champ comme argument. +Un champ (Field) représente un seul élément de saisie de formulaire, comme un champ de texte ou une case à cocher. Les champs sont créés en utilisant le composant `form.Field` fourni par l'instance de formulaire. Le composant accepte une prop `name`, qui doit correspondre à une clé dans les valeurs par défaut du formulaire. Il accepte également une prop `children`, qui est une fonction de rendu (render prop) prenant un objet field comme argument. Exemple : @@ -81,9 +81,9 @@ Exemple : /> ``` -## État d'un champ +## État du champ (Field State) -Chaque champ a son propre état, qui inclut sa valeur actuelle, son statut de validation, ses messages d'erreur et d'autres métadonnées. Vous pouvez accéder à l'état d'un champ en utilisant la propriété `field.state`. +Chaque champ a son propre état (Field State), qui inclut sa valeur actuelle, son statut de validation, ses messages d'erreur et d'autres métadonnées. Vous pouvez accéder à l'état d'un champ en utilisant la propriété `field.state`. Exemple : @@ -94,21 +94,44 @@ const { } = field.state ``` -Il existe trois états de champ qui peuvent être utiles pour voir comment l'utilisateur interagit avec un champ : un champ est _"touché"_ lorsque l'utilisateur clique/tabule dessus, _"vierge"_ jusqu'à ce que l'utilisateur modifie sa valeur, et _"modifié"_ après que la valeur a été changée. Vous pouvez vérifier ces états via les indicateurs `isTouched`, `isPristine` et `isDirty`, comme vu ci-dessous. +Il existe trois états dans les métadonnées qui peuvent être utiles pour voir comment l'utilisateur interagit avec un champ : + +- _"isTouched"_, après que l'utilisateur a cliqué ou est passé sur le champ +- _"isPristine"_, jusqu'à ce que l'utilisateur modifie la valeur du champ +- _"isDirty"_, après que la valeur du champ a été modifiée ```tsx const { isTouched, isPristine, isDirty } = field.state.meta ``` -![États d'un champ](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) +![États du champ](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) + +## Comprendre 'isDirty' dans différentes bibliothèques + +État `dirty` non persistant + +- **Bibliothèques** : React Hook Form (RHF), Formik, Final Form. +- **Comportement** : Un champ est 'dirty' si sa valeur diffère de la valeur par défaut. Revenir à la valeur par défaut le rend 'clean' à nouveau. + +État `dirty` persistant + +- **Bibliothèques** : Angular Form, Vue FormKit. +- **Comportement** : Un champ reste 'dirty' une fois modifié, même s'il revient à la valeur par défaut. + +Nous avons choisi le modèle d'état 'dirty' persistant. Pour également supporter un état 'dirty' non persistant, nous introduisons le flag `isDefault`. Ce flag agit comme l'inverse de l'état 'dirty' non persistant. + +```tsx +const { isTouched, isPristine, isDirty, isDefaultValue } = field.state.meta + +// La ligne suivante recrée la fonctionnalité `dirty` non persistante. +const nonPersistentIsDirty = !isDefaultValue +``` -> **Note importante pour les utilisateurs venant de `React Hook Form`** : l'indicateur `isDirty` dans `TanStack/form` est différent de l'indicateur du même nom dans RHF. -> Dans RHF, `isDirty = true` lorsque les valeurs du formulaire sont différentes des valeurs originales. Si l'utilisateur modifie les valeurs d'un formulaire, puis les modifie à nouveau pour revenir aux valeurs par défaut du formulaire, `isDirty` sera `false` dans RHF, mais `true` dans `TanStack/form`. -> Les valeurs par défaut sont exposées à la fois au niveau du formulaire et du champ dans `TanStack/form` (`form.options.defaultValues`, `field.options.defaultValue`), vous pouvez donc écrire votre propre helper `isDefaultValue()` si vous avez besoin d'émuler le comportement de RHF. +![États du champ étendus](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states-extended.png) -## API de champ +## API de champ (Field API) -L'API de champ est un objet passé à la fonction de rendu lors de la création d'un champ. Elle fournit des méthodes pour travailler avec l'état du champ. +L'API de champ (Field API) est un objet passé à la fonction de rendu lors de la création d'un champ. Elle fournit des méthodes pour travailler avec l'état du champ. Exemple : @@ -122,7 +145,7 @@ Exemple : ## Validation -`@tanstack/react-form` fournit à la fois une validation synchrone et asynchrone prête à l'emploi. Les fonctions de validation peuvent être passées au composant `form.Field` en utilisant la prop `validators`. +`@tanstack/react-form` fournit une validation synchrone et asynchrone prête à l'emploi. Les fonctions de validation peuvent être passées au composant `form.Field` en utilisant la prop `validators`. Exemple : @@ -154,13 +177,13 @@ Exemple : /> ``` -## Validation avec des bibliothèques de schéma standard +## Validation avec les bibliothèques de schéma standard -En plus des options de validation personnalisées, nous prenons également en charge la spécification [Standard Schema](https://github.com/standard-schema/standard-schema). +En plus des options de validation personnalisées, nous supportons également la spécification [Standard Schema](https://github.com/standard-schema/standard-schema). Vous pouvez définir un schéma en utilisant n'importe quelle bibliothèque implémentant la spécification et le passer à un validateur de formulaire ou de champ. -Les bibliothèques prises en charge incluent : +Les bibliothèques supportées incluent : - [Zod](https://zod.dev/) - [Valibot](https://valibot.dev/) @@ -195,7 +218,7 @@ function App() { } ``` -## Réactivité +## Réactivité (Reactivity) `@tanstack/react-form` offre diverses façons de s'abonner aux changements d'état du formulaire et des champs, notamment le hook `useStore(form.store)` et le composant `form.Subscribe`. Ces méthodes vous permettent d'optimiser les performances de rendu de votre formulaire en ne mettant à jour les composants que lorsque nécessaire. @@ -214,7 +237,7 @@ const firstName = useStore(form.store, (state) => state.values.firstName) /> ``` -Il est important de se rappeler que bien que la prop `selector` du hook `useStore` soit optionnelle, il est fortement recommandé de la fournir, car son omission entraînera des re-rendus inutiles. +Il est important de se rappeler que bien que la prop `selector` du hook `useStore` soit optionnelle, il est fortement recommandé de la fournir, car l'omettre entraînera des re-rendus inutiles. ```tsx // Utilisation correcte @@ -226,7 +249,7 @@ const store = useStore(form.store) Remarque : L'utilisation du hook `useField` pour obtenir de la réactivité est déconseillée car il est conçu pour être utilisé avec précaution dans le composant `form.Field`. Vous devriez plutôt utiliser `useStore(form.store)`. -## Écouteurs +## Écouteurs (Listeners) `@tanstack/react-form` vous permet de réagir à des déclencheurs spécifiques et de les "écouter" pour déclencher des effets secondaires. @@ -244,11 +267,11 @@ Exemple : /> ``` -Plus d'informations peuvent être trouvées sur [Écouteurs](./listeners.md) +Plus d'informations sont disponibles sur [Écouteurs](./listeners.md) -## Champs de tableau +## Champs de tableau (Array Fields) -Les champs de tableau vous permettent de gérer une liste de valeurs dans un formulaire, comme une liste de hobbies. Vous pouvez créer un champ de tableau en utilisant le composant `form.Field` avec la prop `mode="array"`. +Les champs de tableau (Array Fields) vous permettent de gérer une liste de valeurs dans un formulaire, comme une liste de hobbies. Vous pouvez créer un champ de tableau en utilisant le composant `form.Field` avec la prop `mode="array"`. Lorsque vous travaillez avec des champs de tableau, vous pouvez utiliser les méthodes `pushValue`, `removeValue`, `swapValues` et `moveValue` des champs pour ajouter, supprimer et échanger des valeurs dans le tableau. @@ -328,9 +351,9 @@ Exemple : /> ``` -## Boutons de réinitialisation +## Boutons de réinitialisation (Reset Buttons) -Lorsque vous utilisez ` ``` -Voici les concepts de base et la terminologie utilisés dans la bibliothèque `@tanstack/react-form`. Comprendre ces concepts vous aidera à travailler plus efficacement avec la bibliothèque et à créer des formulaires complexes avec facilité. +Ce sont les concepts de base et la terminologie utilisés dans la bibliothèque `@tanstack/react-form`. Comprendre ces concepts vous aidera à travailler plus efficacement avec la bibliothèque et à créer des formulaires complexes avec facilité. diff --git a/docs/fr/reference/classes/fieldapi.md b/docs/fr/reference/classes/fieldapi.md index 965446e6c..c5a65987c 100644 --- a/docs/fr/reference/classes/fieldapi.md +++ b/docs/fr/reference/classes/fieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:52:43.224Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.410Z' id: FieldApi title: FieldApi --- @@ -9,7 +9,7 @@ title: FieldApi # Class: FieldApi\ -Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859) +Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863) A class representing the API for managing a form field. @@ -67,7 +67,7 @@ the `new FieldApi` constructor. new FieldApi(opts): FieldApi ``` -Defined in: [packages/form-core/src/FieldApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L991) +Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L995) Initializes a new `FieldApi` instance. @@ -89,7 +89,7 @@ Initializes a new `FieldApi` instance. form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L903) +Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L907) A reference to the form API instance. @@ -101,7 +101,7 @@ A reference to the form API instance. name: DeepKeys; ``` -Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927) +Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) The field name. @@ -113,7 +113,7 @@ The field name. options: FieldApiOptions; ``` -Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) The field options. @@ -125,7 +125,7 @@ The field options. store: Derived>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L955) +Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L959) The field state store. @@ -137,7 +137,7 @@ The field state store. timeoutIds: object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L982) +Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L986) #### formListeners @@ -167,7 +167,7 @@ validations: Record; get state(): FieldState ``` -Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979) +Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L983) The current field state. @@ -183,7 +183,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1245) +Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1249) Gets the field information object. @@ -199,7 +199,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1213) +Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217) #### Returns @@ -213,7 +213,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStac getValue(): TData ``` -Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198) +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) Gets the current field value. @@ -233,7 +233,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1657) +Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1661) Handles the blur event. @@ -249,7 +249,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1650) +Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1654) Handles the change event. @@ -274,7 +274,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262) +Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1266) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -304,7 +304,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri mount(): () => void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) +Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1092) Mounts the field instance to the form. @@ -327,7 +327,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1306) +Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1310) Moves the value at the first specified index to the second specified index. @@ -359,7 +359,7 @@ parseValueWithSchema(schema): | StandardSchemaV1Issue[] ``` -Defined in: [packages/form-core/src/FieldApi.ts:1699](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1699) +Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1703) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -387,7 +387,7 @@ parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[]> ``` -Defined in: [packages/form-core/src/FieldApi.ts:1711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1711) +Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1715) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -414,7 +414,7 @@ The standard schema to parse this field's value with. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1250) +Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1254) Pushes a new value to the field. @@ -440,7 +440,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1288) +Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1292) Removes a value at the specified index. @@ -469,7 +469,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) +Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279) Replaces a value at the specified index. @@ -499,7 +499,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) +Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1678) Updates the field's errorMap @@ -521,7 +521,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1218](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1218) +Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222) Sets the field metadata. @@ -543,7 +543,7 @@ Sets the field metadata. setValue(updater, options?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1205) +Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209) Sets the field value and run the `change` validator. @@ -572,7 +572,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) +Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301) Swaps the values at the specified indices. @@ -602,7 +602,7 @@ Swaps the values at the specified indices. update(opts): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1141) +Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1145) Updates the field instance with new options. @@ -624,7 +624,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617) +Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621) Validates the field value. diff --git a/docs/fr/reference/classes/formapi.md b/docs/fr/reference/classes/formapi.md index 9b387408e..b88cde13f 100644 --- a/docs/fr/reference/classes/formapi.md +++ b/docs/fr/reference/classes/formapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:52:43.220Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.406Z' id: FormApi title: FormApi --- @@ -9,7 +9,7 @@ title: FormApi # Class: FormApi\ -Defined in: [packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L767) +Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L771) A class representing the Form API. It handles the logic and interactions with the form state. @@ -47,7 +47,7 @@ However, if you need to create a new instance manually, you can do so by calling new FormApi(opts?): FormApi ``` -Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) +Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L842) Constructs a new `FormApi` instance with the given form options. @@ -69,7 +69,7 @@ Constructs a new `FormApi` instance with the given form options. baseStore: Store>; ``` -Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L794) +Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L798) *** @@ -79,7 +79,7 @@ Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/ fieldInfo: Record, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:824](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L824) +Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L828) A record of field information for each field in the form. @@ -91,7 +91,7 @@ A record of field information for each field in the form. fieldMetaDerived: Derived, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L807) +Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L811) *** @@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:782](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L782) +Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L786) The options for the form. @@ -113,7 +113,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) +Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L812) ## Accessors @@ -125,7 +125,7 @@ Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L826) +Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830) ##### Returns @@ -139,7 +139,7 @@ Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1912) +Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938) #### Type Parameters @@ -163,7 +163,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:2148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2148) +Defined in: [packages/form-core/src/FormApi.ts:2174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2174) Returns form and field level errors @@ -214,7 +214,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1826) +Defined in: [packages/form-core/src/FormApi.ts:1852](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852) Gets the field info of the specified field. @@ -240,7 +240,7 @@ Gets the field info of the specified field. getFieldMeta(field): undefined | AnyFieldMeta ``` -Defined in: [packages/form-core/src/FormApi.ts:1817](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1817) +Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843) Gets the metadata of the specified field. @@ -266,7 +266,7 @@ Gets the metadata of the specified field. getFieldValue(field): DeepValue ``` -Defined in: [packages/form-core/src/FormApi.ts:1810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1810) +Defined in: [packages/form-core/src/FormApi.ts:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836) Gets the value of the specified field. @@ -294,7 +294,7 @@ Gets the value of the specified field. handleSubmit(): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1712) +Defined in: [packages/form-core/src/FormApi.ts:1738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -308,7 +308,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu handleSubmit(submitMeta): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1713](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1713) +Defined in: [packages/form-core/src/FormApi.ts:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -334,7 +334,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1951) +Defined in: [packages/form-core/src/FormApi.ts:1977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977) #### Type Parameters @@ -370,7 +370,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1142) +Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) #### Returns @@ -392,7 +392,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2075) +Defined in: [packages/form-core/src/FormApi.ts:2101](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101) Moves the value at the first specified index to the second specified index within an array field. @@ -435,7 +435,7 @@ parseValuesWithSchema(schema): } ``` -Defined in: [packages/form-core/src/FormApi.ts:2208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2208) +Defined in: [packages/form-core/src/FormApi.ts:2234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2234) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -469,7 +469,7 @@ parseValuesWithSchemaAsync(schema): Promise< }> ``` -Defined in: [packages/form-core/src/FormApi.ts:2220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2220) +Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -502,7 +502,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1936](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1936) +Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962) Pushes a value into an array field. @@ -539,7 +539,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) +Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035) Removes a value from an array field at the specified index. @@ -577,7 +577,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1983) +Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) Replaces a value into an array field at the specified index. @@ -615,7 +615,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1230) +Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated. @@ -648,7 +648,7 @@ Optional options to control the reset behavior. resetField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103) +Defined in: [packages/form-core/src/FormApi.ts:2129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129) Resets the field value and meta to default state @@ -674,7 +674,7 @@ Resets the field value and meta to default state resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1866](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1866) +Defined in: [packages/form-core/src/FormApi.ts:1892](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892) resets every field's meta @@ -700,7 +700,7 @@ resets every field's meta setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2124) +Defined in: [packages/form-core/src/FormApi.ts:2150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150) Updates the form's errorMap @@ -722,7 +722,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845) +Defined in: [packages/form-core/src/FormApi.ts:1871](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871) Updates the metadata of the specified field. @@ -755,7 +755,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1882](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1882) +Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) Sets the value of the specified field and optionally updates the touched state. @@ -793,7 +793,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2046) +Defined in: [packages/form-core/src/FormApi.ts:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072) Swaps the values at the specified indices within an array field. @@ -831,7 +831,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1162) +Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1188) Updates the form options and form state. @@ -853,7 +853,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) +Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1282) Validates all fields using the correct handlers for a given validation cause. @@ -878,7 +878,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1286) +Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312) Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type. @@ -912,7 +912,7 @@ Validates the children of a specified array in the form starting from a given in validateField(field, cause): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1325) +Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/fr/reference/functions/evaluate.md b/docs/fr/reference/functions/evaluate.md new file mode 100644 index 000000000..df3420958 --- /dev/null +++ b/docs/fr/reference/functions/evaluate.md @@ -0,0 +1,34 @@ +--- +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.402Z' +id: evaluate +title: evaluate +--- + + + +# Function: evaluate() + +```ts +function evaluate(objA, objB): boolean +``` + +Defined in: [packages/form-core/src/utils.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L339) + +## Type Parameters + +• **T** + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/fr/reference/index.md b/docs/fr/reference/index.md index e046931a9..7720fc4ee 100644 --- a/docs/fr/reference/index.md +++ b/docs/fr/reference/index.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-25T12:58:29.000Z' -translation-updated-at: '2025-04-30T22:41:54.487Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.353Z' id: '@tanstack/form-core' title: '@tanstack/form-core' --- @@ -84,8 +84,8 @@ title: '@tanstack/form-core' ## Functions +- [evaluate](functions/evaluate.md) - [formOptions](functions/formoptions.md) - [isGlobalFormValidationError](functions/isglobalformvalidationerror.md) - [isStandardSchemaValidator](functions/isstandardschemavalidator.md) - [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) diff --git a/docs/fr/reference/interfaces/formstate.md b/docs/fr/reference/interfaces/formstate.md index 1c1487804..846133df6 100644 --- a/docs/fr/reference/interfaces/formstate.md +++ b/docs/fr/reference/interfaces/formstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:23:29.732Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.358Z' id: FormState title: FormState --- @@ -9,7 +9,7 @@ title: FormState # Interface: FormState\ -Defined in: [packages/form-core/src/FormApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L643) +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) An object representing the current state of the form. @@ -63,7 +63,7 @@ BaseFormState._force_re_eval canSubmit: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) +Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) A boolean indicating if the form can be submitted based on its current state. @@ -125,7 +125,7 @@ DerivedFormState.errors fieldMeta: Record, AnyFieldMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) +Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644) A record of field metadata for each field in the form. @@ -173,6 +173,24 @@ DerivedFormState.isBlurred *** +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) + +A boolean indicating if all of the form's fields are the same as default values. + +#### Inherited from + +```ts +DerivedFormState.isDefaultValue +``` + +*** + ### isDirty ```ts @@ -371,7 +389,7 @@ DerivedFormState.isTouched isValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors. diff --git a/docs/fr/reference/type-aliases/anyfieldapi.md b/docs/fr/reference/type-aliases/anyfieldapi.md index 66efa9194..1b89f19e4 100644 --- a/docs/fr/reference/type-aliases/anyfieldapi.md +++ b/docs/fr/reference/type-aliases/anyfieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:23:29.702Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.398Z' id: AnyFieldApi title: AnyFieldApi --- @@ -13,6 +13,6 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L828) +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) A type representing the Field API with all generics set to `any` for convenience. diff --git a/docs/fr/reference/type-aliases/anyfieldmeta.md b/docs/fr/reference/type-aliases/anyfieldmeta.md index 8d57c4a84..42f08ff54 100644 --- a/docs/fr/reference/type-aliases/anyfieldmeta.md +++ b/docs/fr/reference/type-aliases/anyfieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:23:29.698Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.392Z' id: AnyFieldMeta title: AnyFieldMeta --- @@ -13,4 +13,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [packages/form-core/src/FieldApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L747) +Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) diff --git a/docs/fr/reference/type-aliases/anyfieldmetaderived.md b/docs/fr/reference/type-aliases/anyfieldmetaderived.md index d34a7a1c1..32321c26e 100644 --- a/docs/fr/reference/type-aliases/anyfieldmetaderived.md +++ b/docs/fr/reference/type-aliases/anyfieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:23:29.688Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.388Z' id: AnyFieldMetaDerived title: AnyFieldMetaDerived --- @@ -13,4 +13,4 @@ title: AnyFieldMetaDerived type AnyFieldMetaDerived = FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661) +Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L665) diff --git a/docs/fr/reference/type-aliases/anyformapi.md b/docs/fr/reference/type-aliases/anyformapi.md index 5c347f906..fc916a7bf 100644 --- a/docs/fr/reference/type-aliases/anyformapi.md +++ b/docs/fr/reference/type-aliases/anyformapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:23:29.684Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.384Z' id: AnyFormApi title: AnyFormApi --- @@ -13,6 +13,6 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [packages/form-core/src/FormApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L747) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) A type representing the Form API with all generics set to `any` for convenience. diff --git a/docs/fr/reference/type-aliases/anyformstate.md b/docs/fr/reference/type-aliases/anyformstate.md index aa6c87405..5f21f781f 100644 --- a/docs/fr/reference/type-aliases/anyformstate.md +++ b/docs/fr/reference/type-aliases/anyformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:23:29.680Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.380Z' id: AnyFormState title: AnyFormState --- @@ -13,4 +13,4 @@ title: AnyFormState type AnyFormState = FormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676) +Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680) diff --git a/docs/fr/reference/type-aliases/derivedformstate.md b/docs/fr/reference/type-aliases/derivedformstate.md index c1ee356a2..9fd471877 100644 --- a/docs/fr/reference/type-aliases/derivedformstate.md +++ b/docs/fr/reference/type-aliases/derivedformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:55.143Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.376Z' id: DerivedFormState title: DerivedFormState --- @@ -77,6 +77,14 @@ isBlurred: boolean; A boolean indicating if any of the form fields have been blurred. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A boolean indicating if all of the form's fields are the same as default values. + ### isDirty ```ts diff --git a/docs/fr/reference/type-aliases/fieldmeta.md b/docs/fr/reference/type-aliases/fieldmeta.md index 0af6db8c8..21d7f53d3 100644 --- a/docs/fr/reference/type-aliases/fieldmeta.md +++ b/docs/fr/reference/type-aliases/fieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:55.018Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.372Z' id: FieldMeta title: FieldMeta --- @@ -13,7 +13,7 @@ title: FieldMeta type FieldMeta = FieldMetaBase & FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L684) +Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L688) An object type representing the metadata of a field in a form. diff --git a/docs/fr/reference/type-aliases/fieldmetaderived.md b/docs/fr/reference/type-aliases/fieldmetaderived.md index d40482b7b..52d97b85c 100644 --- a/docs/fr/reference/type-aliases/fieldmetaderived.md +++ b/docs/fr/reference/type-aliases/fieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:23:29.640Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.363Z' id: FieldMetaDerived title: FieldMetaDerived --- @@ -68,6 +68,14 @@ errors: ( An array of errors related to the field value. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A flag indicating whether the field's current value is the default value + ### isPristine ```ts diff --git a/docs/fr/reference/type-aliases/fieldstate.md b/docs/fr/reference/type-aliases/fieldstate.md index 53afcdbfa..6ddd53bb5 100644 --- a/docs/fr/reference/type-aliases/fieldstate.md +++ b/docs/fr/reference/type-aliases/fieldstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:55.048Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:49:16.367Z' id: FieldState title: FieldState --- @@ -13,7 +13,7 @@ title: FieldState type FieldState = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) +Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) An object type representing the state of a field. diff --git a/docs/ja/framework/react/guides/basic-concepts.md b/docs/ja/framework/react/guides/basic-concepts.md index 104d18f82..dbf9f6301 100644 --- a/docs/ja/framework/react/guides/basic-concepts.md +++ b/docs/ja/framework/react/guides/basic-concepts.md @@ -1,11 +1,11 @@ --- -source-updated-at: '2025-04-16T08:45:06.000Z' -translation-updated-at: '2025-04-30T21:26:06.581Z' +source-updated-at: '2025-05-08T07:42:29.000Z' +translation-updated-at: '2025-05-08T23:45:38.105Z' id: basic-concepts title: 基本概念 --- -このページでは、`@tanstack/react-form` ライブラリで使用される基本的な概念と用語を紹介します。これらの概念を理解することで、ライブラリをより効果的に活用できるようになります。 +このページでは、`@tanstack/react-form` ライブラリで使用される基本概念と用語を紹介します。これらの概念を理解することで、ライブラリをより効果的に活用できるようになります。 ## フォームオプション @@ -28,19 +28,19 @@ const formOpts = formOptions({ ## フォームインスタンス -フォームインスタンスは個々のフォームを表すオブジェクトで、フォームを操作するためのメソッドとプロパティを提供します。フォームインスタンスは、フォームオプションが提供する `useForm` フックを使用して作成します。このフックは、フォームが送信されたときに呼び出される `onSubmit` 関数を含むオブジェクトを受け取ります。 +フォームインスタンスは個々のフォームを表現するオブジェクトで、フォームを操作するためのメソッドやプロパティを提供します。フォームインスタンスは、フォームオプションから提供される `useForm` フックを使用して作成します。このフックは、フォームが送信されたときに呼び出される `onSubmit` 関数を含むオブジェクトを受け取ります。 ```tsx const form = useForm({ ...formOpts, onSubmit: async ({ value }) => { - // フォームデータを処理 + // フォームデータで何か処理を行う console.log(value) }, }) ``` -`formOptions` を使用せずにスタンドアロンの `useForm` API でフォームインスタンスを作成することも可能です: +`formOptions` を使用せずにスタンドアロンの `useForm` API を使用してフォームインスタンスを作成することもできます: ```tsx interface User { @@ -53,7 +53,7 @@ const defaultUser: User = { firstName: '', lastName: '', hobbies: [] } const form = useForm({ defaultValues: defaultUser, onSubmit: async ({ value }) => { - // フォームデータを処理 + // フォームデータで何か処理を行う console.log(value) }, }) @@ -61,7 +61,7 @@ const form = useForm({ ## フィールド -フィールドは、テキスト入力やチェックボックスなどの単一のフォーム入力要素を表します。フィールドは、フォームインスタンスが提供する `form.Field` コンポーネントを使用して作成します。このコンポーネントは、フォームのデフォルト値のキーと一致する `name` プロパティと、フィールドオブジェクトを引数に取るレンダープロップ関数である `children` プロパティを受け取ります。 +フィールドは、テキスト入力やチェックボックスなどの単一のフォーム入力要素を表します。フィールドは、フォームインスタンスから提供される `form.Field` コンポーネントを使用して作成します。このコンポーネントは、フォームのデフォルト値のキーと一致する `name` プロパティと、フィールドオブジェクトを引数として受け取るレンダープロップ関数である `children` プロパティを受け取ります。 例: @@ -83,7 +83,7 @@ const form = useForm({ ## フィールド状態 -各フィールドには、現在の値、検証ステータス、エラーメッセージなどのメタデータを含む独自の状態があります。フィールドの状態には `field.state` プロパティでアクセスできます。 +各フィールドには、現在の値、検証ステータス、エラーメッセージ、その他のメタデータを含む独自の状態があります。フィールドの状態には `field.state` プロパティを使用してアクセスできます。 例: @@ -94,7 +94,11 @@ const { } = field.state ``` -ユーザーがフィールドとどのようにやり取りしているかを確認するのに役立つ3つのフィールド状態があります: ユーザーがクリック/タブでフィールドに入ると「touched」、値が変更されるまでは「pristine」、値が変更されると「dirty」になります。これらの状態は、以下のように `isTouched`、`isPristine`、`isDirty` フラグで確認できます。 +ユーザーがフィールドとどのようにやり取りしているかを確認するのに役立つ、メタデータ内の3つの状態があります: + +- _"isTouched"_: ユーザーがフィールドをクリック/タップした後 +- _"isPristine"_: ユーザーがフィールドの値を変更するまで +- _"isDirty"_: フィールドの値が変更された後 ```tsx const { isTouched, isPristine, isDirty } = field.state.meta @@ -102,13 +106,32 @@ const { isTouched, isPristine, isDirty } = field.state.meta ![フィールド状態](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) -> **`React Hook Form` からの移行に関する重要な注意**: `TanStack/form` の `isDirty` フラグは、RHF の同名フラグとは異なります。 -> RHF では、フォームの値が元の値と異なる場合に `isDirty = true` になります。ユーザーがフォームの値を変更し、再度変更してフォームのデフォルト値と一致する値になった場合、RHF では `isDirty` は `false` になりますが、`TanStack/form` では `true` のままです。 -> デフォルト値は `TanStack/form` のフォームレベルとフィールドレベルで公開されています(`form.options.defaultValues`、`field.options.defaultValue`)。RHF の動作をエミュレートする必要がある場合は、独自の `isDefaultValue()` ヘルパーを記述できます。 +## 異なるライブラリにおける 'isDirty' の理解 + +非永続的な `dirty` 状態 + +- **ライブラリ**: React Hook Form (RHF), Formik, Final Form +- **動作**: フィールドの値がデフォルトと異なる場合に 'dirty' となる。デフォルト値に戻すと 'clean' に戻る + +永続的な `dirty` 状態 + +- **ライブラリ**: Angular Form, Vue FormKit +- **動作**: 一度変更されると、デフォルト値に戻しても 'dirty' のまま + +私たちは永続的な 'dirty' 状態モデルを選択しました。非永続的な 'dirty' 状態もサポートするために、`isDefault` フラグを導入しています。このフラグは非永続的な 'dirty' 状態の逆として機能します。 + +```tsx +const { isTouched, isPristine, isDirty, isDefaultValue } = field.state.meta + +// 以下の行で非永続的な `dirty` 機能を再現できます +const nonPersistentIsDirty = !isDefaultValue +``` + +![拡張されたフィールド状態](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states-extended.png) ## フィールドAPI -フィールドAPIは、フィールドを作成する際にレンダープロップ関数に渡されるオブジェクトで、フィールドの状態を操作するためのメソッドを提供します。 +フィールドAPIは、フィールドを作成するときにレンダープロップ関数に渡されるオブジェクトで、フィールドの状態を操作するためのメソッドを提供します。 例: @@ -122,7 +145,7 @@ const { isTouched, isPristine, isDirty } = field.state.meta ## バリデーション -`@tanstack/react-form` は、同期および非同期のバリデーションを標準で提供しています。バリデーション関数は `form.Field` コンポーネントの `validators` プロパティに渡すことができます。 +`@tanstack/react-form` は、同期および非同期バリデーションを標準で提供しています。バリデーション関数は、`validators` プロパティを使用して `form.Field` コンポーネントに渡すことができます。 例: @@ -138,7 +161,7 @@ const { isTouched, isPristine, isDirty } = field.state.meta : undefined, onChangeAsync: async ({ value }) => { await new Promise((resolve) => setTimeout(resolve, 1000)) - return value.includes('error') && '名に「error」を含めることはできません' + return value.includes('error') && '名に"error"を含めることはできません' }, }} children={(field) => ( @@ -154,11 +177,11 @@ const { isTouched, isPristine, isDirty } = field.state.meta /> ``` -## 標準スキーマライブラリを使用したバリデーション +## 標準スキーマライブラリによるバリデーション 手動で作成したバリデーションオプションに加えて、[Standard Schema](https://github.com/standard-schema/standard-schema) 仕様もサポートしています。 -この仕様を実装した任意のライブラリを使用してスキーマを定義し、フォームまたはフィールドのバリデータに渡すことができます。 +仕様を実装した任意のライブラリを使用してスキーマを定義し、フォームまたはフィールドバリデータに渡すことができます。 サポートされているライブラリ: @@ -170,9 +193,7 @@ const { isTouched, isPristine, isDirty } = field.state.meta import { z } from 'zod' const userSchema = z.object({ - age: z - .number() - .gte(13, 'アカウントを作成するには13歳以上である必要があります'), + age: z.number().gte(13, 'アカウント作成には13歳以上である必要があります'), }) function App() { @@ -199,7 +220,7 @@ function App() { ## リアクティビティ -`@tanstack/react-form` は、フォームとフィールドの状態変更をサブスクライブするためのさまざまな方法を提供しており、特に `useStore(form.store)` フックと `form.Subscribe` コンポーネントが注目されます。これらの方法を使用すると、必要な時だけコンポーネントを更新することで、フォームのレンダリングパフォーマンスを最適化できます。 +`@tanstack/react-form` は、フォームやフィールドの状態変化をサブスクライブするさまざまな方法を提供しており、特に `useStore(form.store)` フックと `form.Subscribe` コンポーネントが注目されます。これらの方法を使用すると、必要な時だけコンポーネントを更新することで、フォームのレンダリングパフォーマンスを最適化できます。 例: @@ -216,21 +237,21 @@ const firstName = useStore(form.store, (state) => state.values.firstName) /> ``` -`useStore` フックの `selector` プロパティはオプションですが、これを省略すると不要な再レンダリングが発生するため、強く推奨される点に注意してください。 +`useStore` フックの `selector` プロパティはオプションですが、省略すると不要な再レンダリングが発生するため、提供することを強く推奨します。 ```tsx -// 正しい使用法 +// 正しい使い方 const firstName = useStore(form.store, (state) => state.values.firstName) const errors = useStore(form.store, (state) => state.errorMap) -// 誤った使用法 +// 間違った使い方 const store = useStore(form.store) ``` -注: リアクティビティを実現するための `useField` フックの使用は推奨されません。このフックは `form.Field` コンポーネント内で慎重に使用するように設計されています。代わりに `useStore(form.store)` の使用を検討してください。 +注: リアクティビティを実現するための `useField` フックの使用は推奨されません。このフックは `form.Field` コンポーネント内で慎重に使用するように設計されています。代わりに `useStore(form.store)` を使用することを検討してください。 ## リスナー -`@tanstack/react-form` では、特定のトリガーに反応してサイドエフェクトをディスパッチする「リスナー」を設定できます。 +`@tanstack/react-form` では、特定のトリガーに反応して副作用をディスパッチする「リスナー」を設定できます。 例: @@ -250,9 +271,9 @@ const store = useStore(form.store) ## 配列フィールド -配列フィールドを使用すると、趣味のリストなど、フォーム内の値のリストを管理できます。配列フィールドは `mode="array"` プロパティを指定した `form.Field` コンポーネントを使用して作成します。 +配列フィールドを使用すると、趣味のリストなどの値のリストをフォーム内で管理できます。配列フィールドは、`mode="array"` プロパティを指定した `form.Field` コンポーネントを使用して作成します。 -配列フィールドを操作する際は、`pushValue`、`removeValue`、`swapValues`、`moveValue` メソッドを使用して、配列内の値を追加、削除、入れ替えできます。 +配列フィールドを操作する際には、`pushValue`、`removeValue`、`swapValues`、`moveValue` メソッドを使用して、配列内の値を追加、削除、交換できます。 例: @@ -332,7 +353,8 @@ const store = useStore(form.store) ## リセットボタン -` ``` -これらは `@tanstack/react-form` ライブラリで使用される基本的な概念と用語です。これらの概念を理解することで、ライブラリをより効果的に活用し、複雑なフォームを簡単に作成できるようになります。 +これらは `@tanstack/react-form` ライブラリで使用される基本概念と用語です。これらの概念を理解することで、ライブラリをより効果的に使用し、複雑なフォームを簡単に作成できるようになります。 diff --git a/docs/ja/reference/classes/fieldapi.md b/docs/ja/reference/classes/fieldapi.md index 76d9add79..b1d052994 100644 --- a/docs/ja/reference/classes/fieldapi.md +++ b/docs/ja/reference/classes/fieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:51:10.810Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.736Z' id: FieldApi title: FieldApi --- @@ -9,7 +9,7 @@ title: FieldApi # Class: FieldApi\ -Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859) +Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863) A class representing the API for managing a form field. @@ -67,7 +67,7 @@ the `new FieldApi` constructor. new FieldApi(opts): FieldApi ``` -Defined in: [packages/form-core/src/FieldApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L991) +Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L995) Initializes a new `FieldApi` instance. @@ -89,7 +89,7 @@ Initializes a new `FieldApi` instance. form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L903) +Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L907) A reference to the form API instance. @@ -101,7 +101,7 @@ A reference to the form API instance. name: DeepKeys; ``` -Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927) +Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) The field name. @@ -113,7 +113,7 @@ The field name. options: FieldApiOptions; ``` -Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) The field options. @@ -125,7 +125,7 @@ The field options. store: Derived>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L955) +Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L959) The field state store. @@ -137,7 +137,7 @@ The field state store. timeoutIds: object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L982) +Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L986) #### formListeners @@ -167,7 +167,7 @@ validations: Record; get state(): FieldState ``` -Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979) +Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L983) The current field state. @@ -183,7 +183,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1245) +Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1249) Gets the field information object. @@ -199,7 +199,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1213) +Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217) #### Returns @@ -213,7 +213,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStac getValue(): TData ``` -Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198) +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) Gets the current field value. @@ -233,7 +233,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1657) +Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1661) Handles the blur event. @@ -249,7 +249,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1650) +Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1654) Handles the change event. @@ -274,7 +274,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262) +Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1266) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -304,7 +304,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri mount(): () => void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) +Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1092) Mounts the field instance to the form. @@ -327,7 +327,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1306) +Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1310) Moves the value at the first specified index to the second specified index. @@ -359,7 +359,7 @@ parseValueWithSchema(schema): | StandardSchemaV1Issue[] ``` -Defined in: [packages/form-core/src/FieldApi.ts:1699](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1699) +Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1703) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -387,7 +387,7 @@ parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[]> ``` -Defined in: [packages/form-core/src/FieldApi.ts:1711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1711) +Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1715) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -414,7 +414,7 @@ The standard schema to parse this field's value with. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1250) +Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1254) Pushes a new value to the field. @@ -440,7 +440,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1288) +Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1292) Removes a value at the specified index. @@ -469,7 +469,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) +Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279) Replaces a value at the specified index. @@ -499,7 +499,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) +Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1678) Updates the field's errorMap @@ -521,7 +521,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1218](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1218) +Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222) Sets the field metadata. @@ -543,7 +543,7 @@ Sets the field metadata. setValue(updater, options?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1205) +Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209) Sets the field value and run the `change` validator. @@ -572,7 +572,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) +Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301) Swaps the values at the specified indices. @@ -602,7 +602,7 @@ Swaps the values at the specified indices. update(opts): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1141) +Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1145) Updates the field instance with new options. @@ -624,7 +624,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617) +Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621) Validates the field value. diff --git a/docs/ja/reference/classes/formapi.md b/docs/ja/reference/classes/formapi.md index cf21651aa..f388dc599 100644 --- a/docs/ja/reference/classes/formapi.md +++ b/docs/ja/reference/classes/formapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-05-06T20:51:58.000Z' -translation-updated-at: '2025-05-06T22:51:10.804Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.731Z' id: FormApi title: FormApi --- @@ -9,7 +9,7 @@ title: FormApi # Class: FormApi\ -Defined in: [packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L767) +Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L771) A class representing the Form API. It handles the logic and interactions with the form state. @@ -47,7 +47,7 @@ However, if you need to create a new instance manually, you can do so by calling new FormApi(opts?): FormApi ``` -Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) +Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L842) Constructs a new `FormApi` instance with the given form options. @@ -69,7 +69,7 @@ Constructs a new `FormApi` instance with the given form options. baseStore: Store>; ``` -Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L794) +Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L798) *** @@ -79,7 +79,7 @@ Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/ fieldInfo: Record, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:824](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L824) +Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L828) A record of field information for each field in the form. @@ -91,7 +91,7 @@ A record of field information for each field in the form. fieldMetaDerived: Derived, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L807) +Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L811) *** @@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:807](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:782](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L782) +Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L786) The options for the form. @@ -113,7 +113,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) +Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L812) ## Accessors @@ -125,7 +125,7 @@ Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L826) +Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830) ##### Returns @@ -139,7 +139,7 @@ Defined in: [packages/form-core/src/FormApi.ts:826](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1912) +Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938) #### Type Parameters @@ -163,7 +163,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1912](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:2148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2148) +Defined in: [packages/form-core/src/FormApi.ts:2174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2174) Returns form and field level errors @@ -214,7 +214,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1826](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1826) +Defined in: [packages/form-core/src/FormApi.ts:1852](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852) Gets the field info of the specified field. @@ -240,7 +240,7 @@ Gets the field info of the specified field. getFieldMeta(field): undefined | AnyFieldMeta ``` -Defined in: [packages/form-core/src/FormApi.ts:1817](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1817) +Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843) Gets the metadata of the specified field. @@ -266,7 +266,7 @@ Gets the metadata of the specified field. getFieldValue(field): DeepValue ``` -Defined in: [packages/form-core/src/FormApi.ts:1810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1810) +Defined in: [packages/form-core/src/FormApi.ts:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836) Gets the value of the specified field. @@ -294,7 +294,7 @@ Gets the value of the specified field. handleSubmit(): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1712) +Defined in: [packages/form-core/src/FormApi.ts:1738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -308,7 +308,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu handleSubmit(submitMeta): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1713](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1713) +Defined in: [packages/form-core/src/FormApi.ts:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -334,7 +334,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1951) +Defined in: [packages/form-core/src/FormApi.ts:1977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977) #### Type Parameters @@ -370,7 +370,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1951](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1142) +Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) #### Returns @@ -392,7 +392,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2075) +Defined in: [packages/form-core/src/FormApi.ts:2101](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101) Moves the value at the first specified index to the second specified index within an array field. @@ -435,7 +435,7 @@ parseValuesWithSchema(schema): } ``` -Defined in: [packages/form-core/src/FormApi.ts:2208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2208) +Defined in: [packages/form-core/src/FormApi.ts:2234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2234) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -469,7 +469,7 @@ parseValuesWithSchemaAsync(schema): Promise< }> ``` -Defined in: [packages/form-core/src/FormApi.ts:2220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2220) +Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -502,7 +502,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1936](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1936) +Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962) Pushes a value into an array field. @@ -539,7 +539,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) +Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035) Removes a value from an array field at the specified index. @@ -577,7 +577,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1983) +Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009) Replaces a value into an array field at the specified index. @@ -615,7 +615,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1230) +Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated. @@ -648,7 +648,7 @@ Optional options to control the reset behavior. resetField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103) +Defined in: [packages/form-core/src/FormApi.ts:2129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129) Resets the field value and meta to default state @@ -674,7 +674,7 @@ Resets the field value and meta to default state resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1866](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1866) +Defined in: [packages/form-core/src/FormApi.ts:1892](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892) resets every field's meta @@ -700,7 +700,7 @@ resets every field's meta setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2124) +Defined in: [packages/form-core/src/FormApi.ts:2150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150) Updates the form's errorMap @@ -722,7 +722,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845) +Defined in: [packages/form-core/src/FormApi.ts:1871](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871) Updates the metadata of the specified field. @@ -755,7 +755,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1882](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1882) +Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) Sets the value of the specified field and optionally updates the touched state. @@ -793,7 +793,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2046) +Defined in: [packages/form-core/src/FormApi.ts:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072) Swaps the values at the specified indices within an array field. @@ -831,7 +831,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1162) +Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1188) Updates the form options and form state. @@ -853,7 +853,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) +Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1282) Validates all fields using the correct handlers for a given validation cause. @@ -878,7 +878,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1286) +Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312) Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type. @@ -912,7 +912,7 @@ Validates the children of a specified array in the form starting from a given in validateField(field, cause): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1325) +Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/ja/reference/functions/evaluate.md b/docs/ja/reference/functions/evaluate.md new file mode 100644 index 000000000..d333efc3e --- /dev/null +++ b/docs/ja/reference/functions/evaluate.md @@ -0,0 +1,34 @@ +--- +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.726Z' +id: evaluate +title: evaluate +--- + + + +# Function: evaluate() + +```ts +function evaluate(objA, objB): boolean +``` + +Defined in: [packages/form-core/src/utils.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L339) + +## Type Parameters + +• **T** + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/ja/reference/index.md b/docs/ja/reference/index.md index 8e9aac113..354b4d568 100644 --- a/docs/ja/reference/index.md +++ b/docs/ja/reference/index.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-25T12:58:29.000Z' -translation-updated-at: '2025-04-30T22:41:35.569Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.681Z' id: '@tanstack/form-core' title: '@tanstack/form-core' --- @@ -84,8 +84,8 @@ title: '@tanstack/form-core' ## Functions +- [evaluate](functions/evaluate.md) - [formOptions](functions/formoptions.md) - [isGlobalFormValidationError](functions/isglobalformvalidationerror.md) - [isStandardSchemaValidator](functions/isstandardschemavalidator.md) - [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) diff --git a/docs/ja/reference/interfaces/formstate.md b/docs/ja/reference/interfaces/formstate.md index 8945d5518..0d121eebb 100644 --- a/docs/ja/reference/interfaces/formstate.md +++ b/docs/ja/reference/interfaces/formstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:18:21.518Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.722Z' id: FormState title: FormState --- @@ -9,7 +9,7 @@ title: FormState # Interface: FormState\ -Defined in: [packages/form-core/src/FormApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L643) +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) An object representing the current state of the form. @@ -63,7 +63,7 @@ BaseFormState._force_re_eval canSubmit: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) +Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) A boolean indicating if the form can be submitted based on its current state. @@ -125,7 +125,7 @@ DerivedFormState.errors fieldMeta: Record, AnyFieldMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) +Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644) A record of field metadata for each field in the form. @@ -173,6 +173,24 @@ DerivedFormState.isBlurred *** +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) + +A boolean indicating if all of the form's fields are the same as default values. + +#### Inherited from + +```ts +DerivedFormState.isDefaultValue +``` + +*** + ### isDirty ```ts @@ -371,7 +389,7 @@ DerivedFormState.isTouched isValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors. diff --git a/docs/ja/reference/type-aliases/anyfieldapi.md b/docs/ja/reference/type-aliases/anyfieldapi.md index 866df6312..3f20447aa 100644 --- a/docs/ja/reference/type-aliases/anyfieldapi.md +++ b/docs/ja/reference/type-aliases/anyfieldapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:18:21.677Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.716Z' id: AnyFieldApi title: AnyFieldApi --- @@ -13,6 +13,6 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L828) +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) A type representing the Field API with all generics set to `any` for convenience. diff --git a/docs/ja/reference/type-aliases/anyfieldmeta.md b/docs/ja/reference/type-aliases/anyfieldmeta.md index 2a0025155..5c9d9efab 100644 --- a/docs/ja/reference/type-aliases/anyfieldmeta.md +++ b/docs/ja/reference/type-aliases/anyfieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:18:21.670Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.712Z' id: AnyFieldMeta title: AnyFieldMeta --- @@ -13,4 +13,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [packages/form-core/src/FieldApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L747) +Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) diff --git a/docs/ja/reference/type-aliases/anyfieldmetaderived.md b/docs/ja/reference/type-aliases/anyfieldmetaderived.md index 12e2b247d..e8cb4a756 100644 --- a/docs/ja/reference/type-aliases/anyfieldmetaderived.md +++ b/docs/ja/reference/type-aliases/anyfieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:18:21.662Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.708Z' id: AnyFieldMetaDerived title: AnyFieldMetaDerived --- @@ -13,4 +13,4 @@ title: AnyFieldMetaDerived type AnyFieldMetaDerived = FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661) +Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L665) diff --git a/docs/ja/reference/type-aliases/anyformapi.md b/docs/ja/reference/type-aliases/anyformapi.md index 9388393eb..6017f7cc1 100644 --- a/docs/ja/reference/type-aliases/anyformapi.md +++ b/docs/ja/reference/type-aliases/anyformapi.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:18:21.658Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.700Z' id: AnyFormApi title: AnyFormApi --- @@ -13,6 +13,6 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [packages/form-core/src/FormApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L747) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) A type representing the Form API with all generics set to `any` for convenience. diff --git a/docs/ja/reference/type-aliases/anyformstate.md b/docs/ja/reference/type-aliases/anyformstate.md index c63abdd2b..905cfa024 100644 --- a/docs/ja/reference/type-aliases/anyformstate.md +++ b/docs/ja/reference/type-aliases/anyformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-27T15:56:02.000Z' -translation-updated-at: '2025-05-06T20:18:21.654Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.704Z' id: AnyFormState title: AnyFormState --- @@ -13,4 +13,4 @@ title: AnyFormState type AnyFormState = FormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L676) +Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680) diff --git a/docs/ja/reference/type-aliases/derivedformstate.md b/docs/ja/reference/type-aliases/derivedformstate.md index a2a009107..21eaa9d09 100644 --- a/docs/ja/reference/type-aliases/derivedformstate.md +++ b/docs/ja/reference/type-aliases/derivedformstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:36.177Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.697Z' id: DerivedFormState title: DerivedFormState --- @@ -77,6 +77,14 @@ isBlurred: boolean; A boolean indicating if any of the form fields have been blurred. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A boolean indicating if all of the form's fields are the same as default values. + ### isDirty ```ts diff --git a/docs/ja/reference/type-aliases/fieldmeta.md b/docs/ja/reference/type-aliases/fieldmeta.md index 513424dc7..908d5ca33 100644 --- a/docs/ja/reference/type-aliases/fieldmeta.md +++ b/docs/ja/reference/type-aliases/fieldmeta.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:36.064Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.693Z' id: FieldMeta title: FieldMeta --- @@ -13,7 +13,7 @@ title: FieldMeta type FieldMeta = FieldMetaBase & FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L684) +Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L688) An object type representing the metadata of a field in a form. diff --git a/docs/ja/reference/type-aliases/fieldmetaderived.md b/docs/ja/reference/type-aliases/fieldmetaderived.md index e714cf1da..b21c10ac9 100644 --- a/docs/ja/reference/type-aliases/fieldmetaderived.md +++ b/docs/ja/reference/type-aliases/fieldmetaderived.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-05-06T20:18:21.614Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.689Z' id: FieldMetaDerived title: FieldMetaDerived --- @@ -68,6 +68,14 @@ errors: ( An array of errors related to the field value. +### isDefaultValue + +```ts +isDefaultValue: boolean; +``` + +A flag indicating whether the field's current value is the default value + ### isPristine ```ts diff --git a/docs/ja/reference/type-aliases/fieldstate.md b/docs/ja/reference/type-aliases/fieldstate.md index 6e99f9113..e2d03ae70 100644 --- a/docs/ja/reference/type-aliases/fieldstate.md +++ b/docs/ja/reference/type-aliases/fieldstate.md @@ -1,6 +1,6 @@ --- -source-updated-at: '2025-04-29T10:22:55.000Z' -translation-updated-at: '2025-04-30T22:41:36.103Z' +source-updated-at: '2025-05-08T07:43:38.000Z' +translation-updated-at: '2025-05-08T23:43:49.685Z' id: FieldState title: FieldState --- @@ -13,7 +13,7 @@ title: FieldState type FieldState = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) +Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) An object type representing the state of a field. diff --git a/docs/ru/framework/react/guides/basic-concepts.md b/docs/ru/framework/react/guides/basic-concepts.md index f4b9e268a..164439e52 100644 --- a/docs/ru/framework/react/guides/basic-concepts.md +++ b/docs/ru/framework/react/guides/basic-concepts.md @@ -1,11 +1,13 @@ --- -source-updated-at: '2025-04-16T08:45:06.000Z' -translation-updated-at: '2025-04-30T22:00:19.778Z' +source-updated-at: '2025-05-08T07:42:29.000Z' +translation-updated-at: '2025-05-08T23:52:52.172Z' id: basic-concepts -title: Основные концепции +title: Основные понятия --- -Эта страница знакомит с основными концепциями и терминологией, используемыми в библиотеке `@tanstack/react-form`. Ознакомление с этими понятиями поможет вам лучше понять и эффективнее работать с библиотекой. +# Основные концепции и терминология + +На этой странице представлены основные концепции и терминология, используемые в библиотеке `@tanstack/react-form`. Ознакомление с этими понятиями поможет вам лучше понять и эффективнее работать с библиотекой. ## Настройки формы (Form Options) @@ -28,19 +30,19 @@ const formOpts = formOptions({ ## Экземпляр формы (Form Instance) -Экземпляр формы — это объект, представляющий отдельную форму и предоставляющий методы и свойства для работы с ней. Экземпляр формы создаётся с помощью хука `useForm`, предоставляемого настройками формы. Хук принимает объект с функцией `onSubmit`, которая вызывается при отправке формы. +Экземпляр формы (Form Instance) — это объект, представляющий отдельную форму и предоставляющий методы и свойства для работы с ней. Экземпляр формы создаётся с помощью хука `useForm`, который принимает объект с функцией `onSubmit`, вызываемой при отправке формы. ```tsx const form = useForm({ ...formOpts, onSubmit: async ({ value }) => { - // Обработка данных формы + // Действия с данными формы console.log(value) }, }) ``` -Вы также можете создать экземпляр формы без использования `formOptions`, воспользовавшись автономным API `useForm`: +Также можно создать экземпляр формы без использования `formOptions`, используя автономный API `useForm`: ```tsx interface User { @@ -53,7 +55,7 @@ const defaultUser: User = { firstName: '', lastName: '', hobbies: [] } const form = useForm({ defaultValues: defaultUser, onSubmit: async ({ value }) => { - // Обработка данных формы + // Действия с данными формы console.log(value) }, }) @@ -61,7 +63,7 @@ const form = useForm({ ## Поле (Field) -Поле представляет собой отдельный элемент ввода формы, например текстовое поле или чекбокс. Поля создаются с помощью компонента `form.Field`, предоставляемого экземпляром формы. Компонент принимает проп `name`, который должен соответствовать ключу в значениях формы по умолчанию. Также он принимает проп `children` — функцию рендера, которая получает объект поля в качестве аргумента. +Поле (Field) представляет собой отдельный элемент ввода формы, например, текстовое поле или чекбокс. Поля создаются с помощью компонента `form.Field`, предоставляемого экземпляром формы. Компонент принимает проп `name`, который должен соответствовать ключу в значениях формы по умолчанию, а также проп `children` — функцию рендера, принимающую объект поля в качестве аргумента. Пример: @@ -83,7 +85,7 @@ const form = useForm({ ## Состояние поля (Field State) -Каждое поле имеет собственное состояние, включающее текущее значение, статус валидации, сообщения об ошибках и другие метаданные. Доступ к состоянию поля можно получить через свойство `field.state`. +Каждое поле имеет собственное состояние (Field State), включающее текущее значение, статус валидации, сообщения об ошибках и другие метаданные. Доступ к состоянию поля можно получить через свойство `field.state`. Пример: @@ -94,7 +96,11 @@ const { } = field.state ``` -Существует три состояния поля, которые могут быть полезны для отслеживания взаимодействия пользователя с полем: поле считается _"touched"_, когда пользователь кликает/переходит в него, _"pristine"_ до изменения значения и _"dirty"_ после изменения. Эти состояния можно проверить с помощью флагов `isTouched`, `isPristine` и `isDirty`, как показано ниже. +В метаданных есть три состояния, которые могут быть полезны для отслеживания взаимодействия пользователя с полем: + +- `"isTouched"` — после того, как пользователь кликнул/перешёл в поле. +- `"isPristine"` — пока пользователь не изменил значение поля. +- `"isDirty"` — после изменения значения поля. ```tsx const { isTouched, isPristine, isDirty } = field.state.meta @@ -102,13 +108,32 @@ const { isTouched, isPristine, isDirty } = field.state.meta ![Состояния поля](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states.png) -> **Важное примечание для пользователей `React Hook Form`**: флаг `isDirty` в `TanStack/form` отличается от одноимённого флага в RHF. -> В RHF `isDirty = true`, когда значения формы отличаются от исходных. Если пользователь изменит значения формы, а затем вернёт их к значениям по умолчанию, в RHF `isDirty` будет `false`, а в `TanStack/form` — `true`. -> Значения по умолчанию доступны как на уровне формы, так и на уровне поля в `TanStack/form` (`form.options.defaultValues`, `field.options.defaultValue`), поэтому вы можете написать собственный хелпер `isDefaultValue()`, если нужно эмулировать поведение RHF. +## Понимание `isDirty` в разных библиотеках + +**Непостоянное (Non-Persistent) состояние `dirty`** + +- **Библиотеки**: React Hook Form (RHF), Formik, Final Form. +- **Поведение**: Поле считается `dirty`, если его значение отличается от значения по умолчанию. Возврат к значению по умолчанию делает его `clean`. + +**Постоянное (Persistent) состояние `dirty`** + +- **Библиотеки**: Angular Form, Vue FormKit. +- **Поведение**: Поле остаётся `dirty` после изменения, даже если вернуться к значению по умолчанию. + +Мы выбрали модель с **постоянным `dirty`**. Для поддержки непостоянного `dirty` введён флаг `isDefault`. Этот флаг действует как инверсия непостоянного `dirty`. + +```tsx +const { isTouched, isPristine, isDirty, isDefaultValue } = field.state.meta + +// Следующая строка воссоздаёт функциональность непостоянного `dirty`. +const nonPersistentIsDirty = !isDefaultValue +``` + +![Расширенные состояния поля](https://raw.githubusercontent.com/TanStack/form/main/docs/assets/field-states-extended.png) ## API поля (Field API) -API поля — это объект, передаваемый в функцию рендера при создании поля. Он предоставляет методы для работы с состоянием поля. +API поля (Field API) — это объект, передаваемый в функцию рендера при создании поля. Он предоставляет методы для работы с состоянием поля. Пример: @@ -120,9 +145,9 @@ API поля — это объект, передаваемый в функцию /> ``` -## Валидация (Validation) +## Валидация -`@tanstack/react-form` предоставляет как синхронную, так и асинхронную валидацию "из коробки". Функции валидации можно передать в компонент `form.Field` через проп `validators`. +`@tanstack/react-form` поддерживает синхронную и асинхронную валидацию "из коробки". Функции валидации можно передать в компонент `form.Field` через проп `validators`. Пример: @@ -132,9 +157,9 @@ API поля — это объект, передаваемый в функцию validators={{ onChange: ({ value }) => !value - ? 'Укажите имя' + ? 'Имя обязательно' : value.length < 3 - ? 'Имя должно содержать не менее 3 символов' + ? 'Имя должно содержать минимум 3 символа' : undefined, onChangeAsync: async ({ value }) => { await new Promise((resolve) => setTimeout(resolve, 1000)) @@ -154,11 +179,11 @@ API поля — это объект, передаваемый в функцию /> ``` -## Валидация со стандартными библиотеками схем (Validation with Standard Schema Libraries) +## Валидация с использованием стандартных библиотек схем (Standard Schema Libraries) -Помимо ручной валидации, также поддерживается спецификация [Standard Schema](https://github.com/standard-schema/standard-schema). +Помимо ручной валидации, поддерживается спецификация [Standard Schema](https://github.com/standard-schema/standard-schema). -Вы можете определить схему с помощью любой библиотеки, реализующей спецификацию, и передать её в валидатор формы или поля. +Вы можете определить схему с помощью любой библиотеки, реализующей эту спецификацию, и передать её в валидатор формы или поля. Поддерживаемые библиотеки: @@ -197,7 +222,7 @@ function App() { ## Реактивность (Reactivity) -`@tanstack/react-form` предлагает различные способы подписки на изменения состояния формы и полей, в частности хук `useStore(form.store)` и компонент `form.Subscribe`. Эти методы позволяют оптимизировать производительность рендеринга формы, обновляя компоненты только при необходимости. +`@tanstack/react-form` предлагает различные способы подписки на изменения состояния формы и полей, включая хук `useStore(form.store)` и компонент `form.Subscribe`. Эти методы позволяют оптимизировать производительность рендеринга, обновляя компоненты только при необходимости. Пример: @@ -214,7 +239,7 @@ const firstName = useStore(form.store, (state) => state.values.firstName) /> ``` -Важно помнить, что хотя проп `selector` в хуке `useStore` необязателен, настоятельно рекомендуется его указывать, так как его отсутствие приведёт к лишним перерисовкам. +Важно помнить, что хотя проп `selector` в хуке `useStore` необязателен, его использование рекомендуется, так как его отсутствие приведёт к лишним ререндерам. ```tsx // Правильное использование @@ -224,7 +249,7 @@ const errors = useStore(form.store, (state) => state.errorMap) const store = useStore(form.store) ``` -Примечание: Использование хука `useField` для реактивности не рекомендуется, так как он предназначен для осмысленного использования внутри компонента `form.Field`. Вместо него можно использовать `useStore(form.store)`. +Примечание: Использование хука `useField` для реактивности не рекомендуется, так как он предназначен для аккуратного использования внутри компонента `form.Field`. Вместо него можно использовать `useStore(form.store)`. ## Слушатели (Listeners) @@ -237,20 +262,20 @@ const store = useStore(form.store) name="country" listeners={{ onChange: ({ value }) => { - console.log(`Страна изменена на: ${value}, сброс провинции`) + console.log(`Страна изменена на: ${value}, сброс региона`) form.setFieldValue('province', '') }, }} /> ``` -Подробнее см. в [Слушатели](./listeners.md). +Подробнее: [Слушатели](./listeners.md) ## Поля-массивы (Array Fields) -Поля-массивы позволяют управлять списками значений в форме, например списком хобби. Поле-массив создаётся с помощью компонента `form.Field` с пропом `mode="array"`. +Поля-массивы (Array Fields) позволяют управлять списками значений в форме, например, списком хобби. Такое поле создаётся с помощью компонента `form.Field` с пропом `mode="array"`. -При работе с полями-массивами можно использовать методы `pushValue`, `removeValue`, `swapValues` и `moveValue` для добавления, удаления и перестановки значений в массиве. +Для работы с массивами можно использовать методы `pushValue`, `removeValue`, `swapValues` и `moveValue` для добавления, удаления и перестановки значений. Пример: @@ -263,7 +288,7 @@ const store = useStore(form.store) Хобби
{!hobbiesField.state.value.length - ? 'Хобби не указаны.' + ? 'Хобби не найдены.' : hobbiesField.state.value.map((_, i) => (
` вместе с методом `form.reset()` в TanStack Form необходимо предотвратить стандартное поведение HTML-сброса, чтобы избежать неожиданного сброса элементов формы (особенно ``) к их начальным значениям. -Пример: +Используйте `event.preventDefault()` в обработчике `onClick` кнопки: ```tsx
)} @@ -330,7 +353,7 @@ const store = useStore(form.store) ## 重設按鈕 (Reset Buttons) -當結合使用 ` ``` -或者,您可以使用 `