fix: UserChange/InputProps

TanStack · Apr 27, 2023 · 5b7c6ce · 5b7c6ce
1 parent 4e7ff05
commit 5b7c6ce
Show file tree

Hide file tree

Showing 14 changed files with 43 additions and 13 deletions.
diff --git a/docs/core/comparison.md → docs/comparison.md b/docs/core/comparison.md → docs/comparison.md
diff --git a/docs/config.json b/docs/config.json
@@ -10,19 +10,19 @@
       "children": [
         {
           "label": "Overview",
-          "to": "core/overview"
+          "to": "overview"
         },
         {
           "label": "Installation",
-          "to": "core/installation"
+          "to": "installation"
         },
         {
           "label": "Comparison",
-          "to": "core/comparison"
+          "to": "comparison"
         },
         {
           "label": "TypeScript",
-          "to": "core/typescript"
+          "to": "typescript"
         }
       ]
     },
@@ -31,7 +31,7 @@
       "children": [
         {
           "label": "Important Defaults",
-          "to": "core/guides/important-defaults"
+          "to": "guides/important-defaults"
         }
       ]
     },
@@ -40,11 +40,11 @@
       "children": [
         {
           "label": "FormApi",
-          "to": "core/reference/formApi"
+          "to": "reference/formApi"
         },
         {
           "label": "FieldApi",
-          "to": "core/reference/fieldApi"
+          "to": "reference/fieldApi"
         }
       ]
     }

diff --git a/docs/react/quick-start.md → docs/framework/react/quick-start.md b/docs/react/quick-start.md → docs/framework/react/quick-start.md
diff --git a/docs/react/reference/Field.md → docs/framework/react/reference/Field.md b/docs/react/reference/Field.md → docs/framework/react/reference/Field.md
diff --git a/docs/react/reference/formApi.md → docs/framework/react/reference/formApi.md b/docs/react/reference/formApi.md → docs/framework/react/reference/formApi.md
diff --git a/docs/react/reference/useField.md → docs/framework/react/reference/useField.md b/docs/react/reference/useField.md → docs/framework/react/reference/useField.md
diff --git a/docs/react/reference/useForm.md → docs/framework/react/reference/useForm.md b/docs/react/reference/useForm.md → docs/framework/react/reference/useForm.md
diff --git a/docs/core/guides/important-defaults.md → docs/guides/important-defaults.md b/docs/core/guides/important-defaults.md → docs/guides/important-defaults.md
diff --git a/docs/core/installation.md → docs/installation.md b/docs/core/installation.md → docs/installation.md
diff --git a/docs/core/overview.md → docs/overview.md b/docs/core/overview.md → docs/overview.md
diff --git a/docs/core/reference/fieldApi.md → docs/reference/fieldApi.md b/docs/core/reference/fieldApi.md → docs/reference/fieldApi.md
@@ -110,9 +110,9 @@ A class representing the API for managing a form field.
   - Gets a subfield instance.
 - `validate(): Promise<any>`
   - Validates the field value.
-- `getChangeProps<T extends ChangeProps<any>>(props: T = {} as T): ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>`
+- `getChangeProps<T extends UserChangeProps<any>>(props: T = {} as T): ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>`
   - Gets the change and blur event handlers.
-- `getInputProps<T extends InputProps>(props: T = {} as T): InputProps & Omit<T, keyof InputProps>`
+- `getInputProps<T extends UserInputProps>(props: T = {} as T): InputProps & Omit<T, keyof InputProps>`
   - Gets the input event handlers.
 
 ### `FieldState<TData>`
@@ -124,6 +124,24 @@ An object type representing the state of a field.
 - `meta: FieldMeta`
   - The current metadata of the field.
 
+### `UserChangeProps<TData>`
+
+An object type representing the change and blur event handlers for a field.
+
+- `onChange?: (updater: Updater<TData>) => void`
+  - An optional function to further handle the change event.
+- `onBlur?: (event: any) => void`
+  - An optional function to further handle the blur event.
+
+### `UserInputProps`
+
+An object type representing the input event handlers for a field.
+
+- `onChange?: (event: any) => void`
+  - An optional function to further handle the change event.
+- `onBlur?: (event: any) => void`
+  - An optional function to further handle the blur event.
+
 ### `ChangeProps<TData>`
 
 An object type representing the change and blur event handlers for a field.

diff --git a/docs/core/reference/formApi.md → docs/reference/formApi.md b/docs/core/reference/formApi.md → docs/reference/formApi.md
diff --git a/docs/core/typescript.md → docs/typescript.md b/docs/core/typescript.md → docs/typescript.md
diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts
@@ -31,16 +31,28 @@ export type FieldMeta = {
   isValidating: boolean
 }
 
-export type ChangeProps<TData> = {
+export type UserChangeProps<TData> = {
   onChange?: (updater: Updater<TData>) => void
   onBlur?: (event: any) => void
 }
 
-export type InputProps = {
+export type UserInputProps = {
   onChange?: (event: any) => void
   onBlur?: (event: any) => void
 }
 
+export type ChangeProps<TData> = {
+  value: TData
+  onChange: (updater: Updater<TData>) => void
+  onBlur: (event: any) => void
+}
+
+export type InputProps = {
+  value: string
+  onChange: (event: any) => void
+  onBlur: (event: any) => void
+}
+
 export type FieldApiOptions<TData, TFormData> = RequiredByKey<
   FieldOptions<TData, TFormData>,
   'form'
@@ -332,7 +344,7 @@ export class FieldApi<TData, TFormData> {
     return undefined
   }
 
-  getChangeProps = <T extends ChangeProps<any>>(
+  getChangeProps = <T extends UserChangeProps<any>>(
     props: T = {} as T,
   ): ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>> => {
     return {
@@ -350,7 +362,7 @@ export class FieldApi<TData, TFormData> {
     } as ChangeProps<TData> & Omit<T, keyof ChangeProps<TData>>
   }
 
-  getInputProps = <T extends InputProps>(
+  getInputProps = <T extends UserInputProps>(
     props: T = {} as T,
   ): InputProps & Omit<T, keyof InputProps> => {
     return {