@tanstack/react-form 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/types.cjs.map +1 -1
- package/build/legacy/types.d.cts +2 -2
- package/build/legacy/types.d.ts +2 -2
- package/build/legacy/useField.cjs +5 -1
- package/build/legacy/useField.cjs.map +1 -1
- package/build/legacy/useField.d.cts +13 -11
- package/build/legacy/useField.d.ts +13 -11
- package/build/legacy/useField.js +5 -1
- package/build/legacy/useField.js.map +1 -1
- package/build/legacy/useForm.cjs +3 -1
- package/build/legacy/useForm.cjs.map +1 -1
- package/build/legacy/useForm.js +3 -1
- package/build/legacy/useForm.js.map +1 -1
- package/build/modern/types.cjs.map +1 -1
- package/build/modern/types.d.cts +2 -2
- package/build/modern/types.d.ts +2 -2
- package/build/modern/useField.cjs +5 -1
- package/build/modern/useField.cjs.map +1 -1
- package/build/modern/useField.d.cts +13 -11
- package/build/modern/useField.d.ts +13 -11
- package/build/modern/useField.js +5 -1
- package/build/modern/useField.js.map +1 -1
- package/build/modern/useForm.cjs +3 -1
- package/build/modern/useForm.cjs.map +1 -1
- package/build/modern/useForm.js +3 -1
- package/build/modern/useForm.js.map +1 -1
- package/package.json +2 -2
- package/src/tests/useField.test-d.tsx +63 -0
- package/src/types.ts +5 -4
- package/src/useField.tsx +60 -60
- package/src/useForm.tsx +3 -4
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { FieldOptions } from '@tanstack/form-core'\n\nexport type UseFieldOptions
|
|
1
|
+
{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { FieldOptions, DeepKeys } from '@tanstack/form-core'\n\nexport type UseFieldOptions<\n TData,\n TFormData,\n TName = unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = FieldOptions<TData, TFormData, TName> & {\n mode?: 'value' | 'array'\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
package/build/legacy/types.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { FieldOptions } from '@tanstack/form-core';
|
|
1
|
+
import { DeepKeys, FieldOptions } from '@tanstack/form-core';
|
|
2
2
|
|
|
3
|
-
type UseFieldOptions<TData, TFormData
|
|
3
|
+
type UseFieldOptions<TData, TFormData, TName = unknown extends TFormData ? string : DeepKeys<TFormData>> = FieldOptions<TData, TFormData, TName> & {
|
|
4
4
|
mode?: 'value' | 'array';
|
|
5
5
|
};
|
|
6
6
|
|
package/build/legacy/types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { FieldOptions } from '@tanstack/form-core';
|
|
1
|
+
import { DeepKeys, FieldOptions } from '@tanstack/form-core';
|
|
2
2
|
|
|
3
|
-
type UseFieldOptions<TData, TFormData
|
|
3
|
+
type UseFieldOptions<TData, TFormData, TName = unknown extends TFormData ? string : DeepKeys<TFormData>> = FieldOptions<TData, TFormData, TName> & {
|
|
4
4
|
mode?: 'value' | 'array';
|
|
5
5
|
};
|
|
6
6
|
|
|
@@ -43,7 +43,11 @@ function useField(opts) {
|
|
|
43
43
|
const { formApi, parentFieldName } = (0, import_formContext.useFormContext)();
|
|
44
44
|
const [fieldApi] = (0, import_react.useState)(() => {
|
|
45
45
|
const name = (typeof opts.index === "number" ? [parentFieldName, opts.index, opts.name] : [parentFieldName, opts.name]).filter((d) => d !== void 0).join(".");
|
|
46
|
-
const api = new import_form_core.FieldApi({
|
|
46
|
+
const api = new import_form_core.FieldApi({
|
|
47
|
+
...opts,
|
|
48
|
+
form: formApi,
|
|
49
|
+
name
|
|
50
|
+
});
|
|
47
51
|
api.Field = Field;
|
|
48
52
|
return api;
|
|
49
53
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n
|
|
1
|
+
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n FieldApiOptions,\n Narrow,\n} from '@tanstack/form-core'\nimport { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'\nimport { useFormContext, formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\nimport type { UseFieldOptions } from './types'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FieldApi<_TData, TFormData, Opts, TData> {\n Field: FieldComponent<TData, TFormData>\n }\n}\n\nexport type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(\n opts?: { name: Narrow<TField> } & UseFieldOptions<\n DeepValue<TFormData, TField>,\n TFormData\n >,\n) => FieldApi<DeepValue<TFormData, TField>, TFormData>\n\nexport function useField<\n TData,\n TFormData,\n TName extends unknown extends TFormData\n ? string\n : DeepKeys<TFormData> = unknown extends TFormData\n ? string\n : DeepKeys<TFormData>,\n>(\n opts: UseFieldOptions<TData, TFormData, TName>,\n): FieldApi<\n TData,\n TFormData,\n Omit<typeof opts, 'onMount'> & {\n form: FormApi<TFormData>\n }\n> {\n // Get the form API either manually or from context\n const { formApi, parentFieldName } = useFormContext()\n\n const [fieldApi] = useState(() => {\n const name = (\n typeof opts.index === 'number'\n ? [parentFieldName, opts.index, opts.name]\n : [parentFieldName, opts.name]\n )\n .filter((d) => d !== undefined)\n .join('.')\n\n const api = new FieldApi({\n ...opts,\n form: formApi,\n name: name,\n } as never)\n\n api.Field = Field as never\n\n return api\n })\n\n /**\n * fieldApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n fieldApi.update({ ...opts, form: formApi } as never)\n })\n\n useStore(\n fieldApi.store,\n opts.mode === 'array'\n ? (state: any) => {\n return [state.meta, Object.keys(state.value || []).length]\n }\n : undefined,\n )\n // Instantiates field meta and removes it when unrendered\n useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])\n\n return fieldApi as never\n}\n\ntype FieldComponentProps<\n TParentData,\n TFormData,\n TField,\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = {\n children: (\n fieldApi: FieldApi<\n TField,\n TFormData,\n FieldApiOptions<TField, TFormData, TName>\n >,\n ) => any\n} & (TParentData extends any[]\n ? {\n name?: TName\n index: number\n }\n : {\n name: TName\n index?: never\n }) &\n Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>\n\nexport type FieldComponent<TParentData, TFormData> = <\n // Type of the field\n TField,\n // Name of the field\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n>({\n children,\n ...fieldOptions\n}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any\n\nexport function Field<TData, TFormData>({\n children,\n ...fieldOptions\n}: {\n children: (fieldApi: FieldApi<TData, TFormData>) => any\n} & UseFieldOptions<TData, TFormData>) {\n const fieldApi = useField(fieldOptions as any)\n\n return (\n <formContext.Provider\n value={{ formApi: fieldApi.form, parentFieldName: fieldApi.name }}\n children={functionalUpdate(children, fieldApi as any)}\n />\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAgC;AAChC,yBAAyB;AAOzB,uBAAyD;AACzD,yBAA4C;AAC5C,0CAAsC;AAiB/B,SAAS,SASd,MAOA;AAEA,QAAM,EAAE,SAAS,gBAAgB,QAAI,mCAAe;AAEpD,QAAM,CAAC,QAAQ,QAAI,uBAAS,MAAM;AAChC,UAAM,QACJ,OAAO,KAAK,UAAU,WAClB,CAAC,iBAAiB,KAAK,OAAO,KAAK,IAAI,IACvC,CAAC,iBAAiB,KAAK,IAAI,GAE9B,OAAO,CAAC,MAAM,MAAM,MAAS,EAC7B,KAAK,GAAG;AAEX,UAAM,MAAM,IAAI,0BAAS;AAAA,MACvB,GAAG;AAAA,MACH,MAAM;AAAA,MACN;AAAA,IACF,CAAU;AAEV,QAAI,QAAQ;AAEZ,WAAO;AAAA,EACT,CAAC;AAMD,0CAAAA,SAA0B,MAAM;AAC9B,aAAS,OAAO,EAAE,GAAG,MAAM,MAAM,QAAQ,CAAU;AAAA,EACrD,CAAC;AAED;AAAA,IACE,SAAS;AAAA,IACT,KAAK,SAAS,UACV,CAAC,UAAe;AACd,aAAO,CAAC,MAAM,MAAM,OAAO,KAAK,MAAM,SAAS,CAAC,CAAC,EAAE,MAAM;AAAA,IAC3D,IACA;AAAA,EACN;AAEA,0CAAAA,SAA0B,MAAM,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC;AAE5D,SAAO;AACT;AAoCO,SAAS,MAAwB;AAAA,EACtC;AAAA,EACA,GAAG;AACL,GAEuC;AACrC,QAAM,WAAW,SAAS,YAAmB;AAE7C,SACE,6BAAAC,QAAA;AAAA,IAAC,+BAAY;AAAA,IAAZ;AAAA,MACC,OAAO,EAAE,SAAS,SAAS,MAAM,iBAAiB,SAAS,KAAK;AAAA,MAChE,cAAU,mCAAiB,UAAU,QAAe;AAAA;AAAA,EACtD;AAEJ;","names":["useIsomorphicLayoutEffect","React"]}
|
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DeepKeys, Narrow, DeepValue, FieldApi, FormApi, FieldApiOptions } from '@tanstack/form-core';
|
|
2
2
|
import { UseFieldOptions } from './types.cjs';
|
|
3
3
|
|
|
4
4
|
declare module '@tanstack/form-core' {
|
|
5
|
-
interface FieldApi<
|
|
5
|
+
interface FieldApi<_TData, TFormData, Opts, TData> {
|
|
6
6
|
Field: FieldComponent<TData, TFormData>;
|
|
7
7
|
}
|
|
8
8
|
}
|
|
9
9
|
type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(opts?: {
|
|
10
10
|
name: Narrow<TField>;
|
|
11
11
|
} & UseFieldOptions<DeepValue<TFormData, TField>, TFormData>) => FieldApi<DeepValue<TFormData, TField>, TFormData>;
|
|
12
|
-
declare function useField<TData, TFormData>(opts: UseFieldOptions<TData, TFormData>): FieldApi<TData, TFormData
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
declare function useField<TData, TFormData, TName extends unknown extends TFormData ? string : DeepKeys<TFormData> = unknown extends TFormData ? string : DeepKeys<TFormData>>(opts: UseFieldOptions<TData, TFormData, TName>): FieldApi<TData, TFormData, Omit<typeof opts, 'onMount'> & {
|
|
13
|
+
form: FormApi<TFormData>;
|
|
14
|
+
}>;
|
|
15
|
+
type FieldComponentProps<TParentData, TFormData, TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>> = {
|
|
16
|
+
children: (fieldApi: FieldApi<TField, TFormData, FieldApiOptions<TField, TFormData, TName>>) => any;
|
|
17
|
+
} & (TParentData extends any[] ? {
|
|
18
|
+
name?: TName;
|
|
18
19
|
index: number;
|
|
19
20
|
} : {
|
|
20
|
-
name:
|
|
21
|
+
name: TName;
|
|
21
22
|
index?: never;
|
|
22
|
-
})
|
|
23
|
+
}) & Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>;
|
|
24
|
+
type FieldComponent<TParentData, TFormData> = <TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>>({ children, ...fieldOptions }: FieldComponentProps<TParentData, TFormData, TField, TName>) => any;
|
|
23
25
|
declare function Field<TData, TFormData>({ children, ...fieldOptions }: {
|
|
24
26
|
children: (fieldApi: FieldApi<TData, TFormData>) => any;
|
|
25
27
|
} & UseFieldOptions<TData, TFormData>): JSX.Element;
|
|
26
28
|
|
|
27
|
-
export { Field, FieldComponent,
|
|
29
|
+
export { Field, FieldComponent, UseField, useField };
|
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DeepKeys, Narrow, DeepValue, FieldApi, FormApi, FieldApiOptions } from '@tanstack/form-core';
|
|
2
2
|
import { UseFieldOptions } from './types.js';
|
|
3
3
|
|
|
4
4
|
declare module '@tanstack/form-core' {
|
|
5
|
-
interface FieldApi<
|
|
5
|
+
interface FieldApi<_TData, TFormData, Opts, TData> {
|
|
6
6
|
Field: FieldComponent<TData, TFormData>;
|
|
7
7
|
}
|
|
8
8
|
}
|
|
9
9
|
type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(opts?: {
|
|
10
10
|
name: Narrow<TField>;
|
|
11
11
|
} & UseFieldOptions<DeepValue<TFormData, TField>, TFormData>) => FieldApi<DeepValue<TFormData, TField>, TFormData>;
|
|
12
|
-
declare function useField<TData, TFormData>(opts: UseFieldOptions<TData, TFormData>): FieldApi<TData, TFormData
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
declare function useField<TData, TFormData, TName extends unknown extends TFormData ? string : DeepKeys<TFormData> = unknown extends TFormData ? string : DeepKeys<TFormData>>(opts: UseFieldOptions<TData, TFormData, TName>): FieldApi<TData, TFormData, Omit<typeof opts, 'onMount'> & {
|
|
13
|
+
form: FormApi<TFormData>;
|
|
14
|
+
}>;
|
|
15
|
+
type FieldComponentProps<TParentData, TFormData, TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>> = {
|
|
16
|
+
children: (fieldApi: FieldApi<TField, TFormData, FieldApiOptions<TField, TFormData, TName>>) => any;
|
|
17
|
+
} & (TParentData extends any[] ? {
|
|
18
|
+
name?: TName;
|
|
18
19
|
index: number;
|
|
19
20
|
} : {
|
|
20
|
-
name:
|
|
21
|
+
name: TName;
|
|
21
22
|
index?: never;
|
|
22
|
-
})
|
|
23
|
+
}) & Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>;
|
|
24
|
+
type FieldComponent<TParentData, TFormData> = <TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>>({ children, ...fieldOptions }: FieldComponentProps<TParentData, TFormData, TField, TName>) => any;
|
|
23
25
|
declare function Field<TData, TFormData>({ children, ...fieldOptions }: {
|
|
24
26
|
children: (fieldApi: FieldApi<TData, TFormData>) => any;
|
|
25
27
|
} & UseFieldOptions<TData, TFormData>): JSX.Element;
|
|
26
28
|
|
|
27
|
-
export { Field, FieldComponent,
|
|
29
|
+
export { Field, FieldComponent, UseField, useField };
|
package/build/legacy/useField.js
CHANGED
|
@@ -8,7 +8,11 @@ function useField(opts) {
|
|
|
8
8
|
const { formApi, parentFieldName } = useFormContext();
|
|
9
9
|
const [fieldApi] = useState(() => {
|
|
10
10
|
const name = (typeof opts.index === "number" ? [parentFieldName, opts.index, opts.name] : [parentFieldName, opts.name]).filter((d) => d !== void 0).join(".");
|
|
11
|
-
const api = new FieldApi({
|
|
11
|
+
const api = new FieldApi({
|
|
12
|
+
...opts,
|
|
13
|
+
form: formApi,
|
|
14
|
+
name
|
|
15
|
+
});
|
|
12
16
|
api.Field = Field;
|
|
13
17
|
return api;
|
|
14
18
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n
|
|
1
|
+
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n FieldApiOptions,\n Narrow,\n} from '@tanstack/form-core'\nimport { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'\nimport { useFormContext, formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\nimport type { UseFieldOptions } from './types'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FieldApi<_TData, TFormData, Opts, TData> {\n Field: FieldComponent<TData, TFormData>\n }\n}\n\nexport type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(\n opts?: { name: Narrow<TField> } & UseFieldOptions<\n DeepValue<TFormData, TField>,\n TFormData\n >,\n) => FieldApi<DeepValue<TFormData, TField>, TFormData>\n\nexport function useField<\n TData,\n TFormData,\n TName extends unknown extends TFormData\n ? string\n : DeepKeys<TFormData> = unknown extends TFormData\n ? string\n : DeepKeys<TFormData>,\n>(\n opts: UseFieldOptions<TData, TFormData, TName>,\n): FieldApi<\n TData,\n TFormData,\n Omit<typeof opts, 'onMount'> & {\n form: FormApi<TFormData>\n }\n> {\n // Get the form API either manually or from context\n const { formApi, parentFieldName } = useFormContext()\n\n const [fieldApi] = useState(() => {\n const name = (\n typeof opts.index === 'number'\n ? [parentFieldName, opts.index, opts.name]\n : [parentFieldName, opts.name]\n )\n .filter((d) => d !== undefined)\n .join('.')\n\n const api = new FieldApi({\n ...opts,\n form: formApi,\n name: name,\n } as never)\n\n api.Field = Field as never\n\n return api\n })\n\n /**\n * fieldApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n fieldApi.update({ ...opts, form: formApi } as never)\n })\n\n useStore(\n fieldApi.store,\n opts.mode === 'array'\n ? (state: any) => {\n return [state.meta, Object.keys(state.value || []).length]\n }\n : undefined,\n )\n // Instantiates field meta and removes it when unrendered\n useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])\n\n return fieldApi as never\n}\n\ntype FieldComponentProps<\n TParentData,\n TFormData,\n TField,\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = {\n children: (\n fieldApi: FieldApi<\n TField,\n TFormData,\n FieldApiOptions<TField, TFormData, TName>\n >,\n ) => any\n} & (TParentData extends any[]\n ? {\n name?: TName\n index: number\n }\n : {\n name: TName\n index?: never\n }) &\n Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>\n\nexport type FieldComponent<TParentData, TFormData> = <\n // Type of the field\n TField,\n // Name of the field\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n>({\n children,\n ...fieldOptions\n}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any\n\nexport function Field<TData, TFormData>({\n children,\n ...fieldOptions\n}: {\n children: (fieldApi: FieldApi<TData, TFormData>) => any\n} & UseFieldOptions<TData, TFormData>) {\n const fieldApi = useField(fieldOptions as any)\n\n return (\n <formContext.Provider\n value={{ formApi: fieldApi.form, parentFieldName: fieldApi.name }}\n children={functionalUpdate(children, fieldApi as any)}\n />\n )\n}\n"],"mappings":";AAAA,OAAO,SAAS,gBAAgB;AAChC,SAAS,gBAAgB;AAOzB,SAAS,UAAwB,wBAAwB;AACzD,SAAS,gBAAgB,mBAAmB;AAC5C,OAAO,+BAA+B;AAiB/B,SAAS,SASd,MAOA;AAEA,QAAM,EAAE,SAAS,gBAAgB,IAAI,eAAe;AAEpD,QAAM,CAAC,QAAQ,IAAI,SAAS,MAAM;AAChC,UAAM,QACJ,OAAO,KAAK,UAAU,WAClB,CAAC,iBAAiB,KAAK,OAAO,KAAK,IAAI,IACvC,CAAC,iBAAiB,KAAK,IAAI,GAE9B,OAAO,CAAC,MAAM,MAAM,MAAS,EAC7B,KAAK,GAAG;AAEX,UAAM,MAAM,IAAI,SAAS;AAAA,MACvB,GAAG;AAAA,MACH,MAAM;AAAA,MACN;AAAA,IACF,CAAU;AAEV,QAAI,QAAQ;AAEZ,WAAO;AAAA,EACT,CAAC;AAMD,4BAA0B,MAAM;AAC9B,aAAS,OAAO,EAAE,GAAG,MAAM,MAAM,QAAQ,CAAU;AAAA,EACrD,CAAC;AAED;AAAA,IACE,SAAS;AAAA,IACT,KAAK,SAAS,UACV,CAAC,UAAe;AACd,aAAO,CAAC,MAAM,MAAM,OAAO,KAAK,MAAM,SAAS,CAAC,CAAC,EAAE,MAAM;AAAA,IAC3D,IACA;AAAA,EACN;AAEA,4BAA0B,MAAM,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC;AAE5D,SAAO;AACT;AAoCO,SAAS,MAAwB;AAAA,EACtC;AAAA,EACA,GAAG;AACL,GAEuC;AACrC,QAAM,WAAW,SAAS,YAAmB;AAE7C,SACE;AAAA,IAAC,YAAY;AAAA,IAAZ;AAAA,MACC,OAAO,EAAE,SAAS,SAAS,MAAM,iBAAiB,SAAS,KAAK;AAAA,MAChE,UAAU,iBAAiB,UAAU,QAAe;AAAA;AAAA,EACtD;AAEJ;","names":[]}
|
package/build/legacy/useForm.cjs
CHANGED
|
@@ -42,7 +42,9 @@ var import_use_isomorphic_layout_effect = __toESM(require("use-isomorphic-layout
|
|
|
42
42
|
function useForm(opts) {
|
|
43
43
|
const [formApi] = (0, import_react.useState)(() => {
|
|
44
44
|
const api = new import_form_core.FormApi(opts);
|
|
45
|
-
api.Provider = (props)
|
|
45
|
+
api.Provider = function Provider(props) {
|
|
46
|
+
return /* @__PURE__ */ import_react.default.createElement(import_formContext.formContext.Provider, { ...props, value: { formApi: api } });
|
|
47
|
+
};
|
|
46
48
|
api.Field = import_useField.Field;
|
|
47
49
|
api.useField = import_useField.useField;
|
|
48
50
|
api.useStore = (selector) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n
|
|
1
|
+
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,uBAA0C;AAE1C,yBAAyB;AACzB,mBAAgD;AAChD,sBAAoE;AACpE,yBAA4B;AAC5B,0CAAsC;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,QAAI,uBAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,yBAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,6BAAAA,QAAA,cAAC,+BAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,iBAAO,6BAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,iBAAO;AAAA,QACL,MAAM;AAAA;AAAA,YAEN,6BAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,0CAAAC,SAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":["React","useIsomorphicLayoutEffect"]}
|
package/build/legacy/useForm.js
CHANGED
|
@@ -8,7 +8,9 @@ import useIsomorphicLayoutEffect from "use-isomorphic-layout-effect";
|
|
|
8
8
|
function useForm(opts) {
|
|
9
9
|
const [formApi] = useState(() => {
|
|
10
10
|
const api = new FormApi(opts);
|
|
11
|
-
api.Provider = (props)
|
|
11
|
+
api.Provider = function Provider(props) {
|
|
12
|
+
return /* @__PURE__ */ React.createElement(formContext.Provider, { ...props, value: { formApi: api } });
|
|
13
|
+
};
|
|
12
14
|
api.Field = Field;
|
|
13
15
|
api.useField = useField;
|
|
14
16
|
api.useStore = (selector) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n
|
|
1
|
+
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";AACA,SAAS,SAAS,wBAAwB;AAE1C,SAAS,gBAAgB;AACzB,OAAO,SAAyB,gBAAgB;AAChD,SAA6C,OAAO,gBAAgB;AACpE,SAAS,mBAAmB;AAC5B,OAAO,+BAA+B;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,IAAI,SAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,QAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,oCAAC,YAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,aAAO,SAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,aAAO;AAAA,QACL,MAAM;AAAA;AAAA,QAEN,SAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,4BAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { FieldOptions } from '@tanstack/form-core'\n\nexport type UseFieldOptions
|
|
1
|
+
{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { FieldOptions, DeepKeys } from '@tanstack/form-core'\n\nexport type UseFieldOptions<\n TData,\n TFormData,\n TName = unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = FieldOptions<TData, TFormData, TName> & {\n mode?: 'value' | 'array'\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
package/build/modern/types.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { FieldOptions } from '@tanstack/form-core';
|
|
1
|
+
import { DeepKeys, FieldOptions } from '@tanstack/form-core';
|
|
2
2
|
|
|
3
|
-
type UseFieldOptions<TData, TFormData
|
|
3
|
+
type UseFieldOptions<TData, TFormData, TName = unknown extends TFormData ? string : DeepKeys<TFormData>> = FieldOptions<TData, TFormData, TName> & {
|
|
4
4
|
mode?: 'value' | 'array';
|
|
5
5
|
};
|
|
6
6
|
|
package/build/modern/types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { FieldOptions } from '@tanstack/form-core';
|
|
1
|
+
import { DeepKeys, FieldOptions } from '@tanstack/form-core';
|
|
2
2
|
|
|
3
|
-
type UseFieldOptions<TData, TFormData
|
|
3
|
+
type UseFieldOptions<TData, TFormData, TName = unknown extends TFormData ? string : DeepKeys<TFormData>> = FieldOptions<TData, TFormData, TName> & {
|
|
4
4
|
mode?: 'value' | 'array';
|
|
5
5
|
};
|
|
6
6
|
|
|
@@ -43,7 +43,11 @@ function useField(opts) {
|
|
|
43
43
|
const { formApi, parentFieldName } = (0, import_formContext.useFormContext)();
|
|
44
44
|
const [fieldApi] = (0, import_react.useState)(() => {
|
|
45
45
|
const name = (typeof opts.index === "number" ? [parentFieldName, opts.index, opts.name] : [parentFieldName, opts.name]).filter((d) => d !== void 0).join(".");
|
|
46
|
-
const api = new import_form_core.FieldApi({
|
|
46
|
+
const api = new import_form_core.FieldApi({
|
|
47
|
+
...opts,
|
|
48
|
+
form: formApi,
|
|
49
|
+
name
|
|
50
|
+
});
|
|
47
51
|
api.Field = Field;
|
|
48
52
|
return api;
|
|
49
53
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n
|
|
1
|
+
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n FieldApiOptions,\n Narrow,\n} from '@tanstack/form-core'\nimport { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'\nimport { useFormContext, formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\nimport type { UseFieldOptions } from './types'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FieldApi<_TData, TFormData, Opts, TData> {\n Field: FieldComponent<TData, TFormData>\n }\n}\n\nexport type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(\n opts?: { name: Narrow<TField> } & UseFieldOptions<\n DeepValue<TFormData, TField>,\n TFormData\n >,\n) => FieldApi<DeepValue<TFormData, TField>, TFormData>\n\nexport function useField<\n TData,\n TFormData,\n TName extends unknown extends TFormData\n ? string\n : DeepKeys<TFormData> = unknown extends TFormData\n ? string\n : DeepKeys<TFormData>,\n>(\n opts: UseFieldOptions<TData, TFormData, TName>,\n): FieldApi<\n TData,\n TFormData,\n Omit<typeof opts, 'onMount'> & {\n form: FormApi<TFormData>\n }\n> {\n // Get the form API either manually or from context\n const { formApi, parentFieldName } = useFormContext()\n\n const [fieldApi] = useState(() => {\n const name = (\n typeof opts.index === 'number'\n ? [parentFieldName, opts.index, opts.name]\n : [parentFieldName, opts.name]\n )\n .filter((d) => d !== undefined)\n .join('.')\n\n const api = new FieldApi({\n ...opts,\n form: formApi,\n name: name,\n } as never)\n\n api.Field = Field as never\n\n return api\n })\n\n /**\n * fieldApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n fieldApi.update({ ...opts, form: formApi } as never)\n })\n\n useStore(\n fieldApi.store,\n opts.mode === 'array'\n ? (state: any) => {\n return [state.meta, Object.keys(state.value || []).length]\n }\n : undefined,\n )\n // Instantiates field meta and removes it when unrendered\n useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])\n\n return fieldApi as never\n}\n\ntype FieldComponentProps<\n TParentData,\n TFormData,\n TField,\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = {\n children: (\n fieldApi: FieldApi<\n TField,\n TFormData,\n FieldApiOptions<TField, TFormData, TName>\n >,\n ) => any\n} & (TParentData extends any[]\n ? {\n name?: TName\n index: number\n }\n : {\n name: TName\n index?: never\n }) &\n Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>\n\nexport type FieldComponent<TParentData, TFormData> = <\n // Type of the field\n TField,\n // Name of the field\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n>({\n children,\n ...fieldOptions\n}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any\n\nexport function Field<TData, TFormData>({\n children,\n ...fieldOptions\n}: {\n children: (fieldApi: FieldApi<TData, TFormData>) => any\n} & UseFieldOptions<TData, TFormData>) {\n const fieldApi = useField(fieldOptions as any)\n\n return (\n <formContext.Provider\n value={{ formApi: fieldApi.form, parentFieldName: fieldApi.name }}\n children={functionalUpdate(children, fieldApi as any)}\n />\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAgC;AAChC,yBAAyB;AAOzB,uBAAyD;AACzD,yBAA4C;AAC5C,0CAAsC;AAiB/B,SAAS,SASd,MAOA;AAEA,QAAM,EAAE,SAAS,gBAAgB,QAAI,mCAAe;AAEpD,QAAM,CAAC,QAAQ,QAAI,uBAAS,MAAM;AAChC,UAAM,QACJ,OAAO,KAAK,UAAU,WAClB,CAAC,iBAAiB,KAAK,OAAO,KAAK,IAAI,IACvC,CAAC,iBAAiB,KAAK,IAAI,GAE9B,OAAO,CAAC,MAAM,MAAM,MAAS,EAC7B,KAAK,GAAG;AAEX,UAAM,MAAM,IAAI,0BAAS;AAAA,MACvB,GAAG;AAAA,MACH,MAAM;AAAA,MACN;AAAA,IACF,CAAU;AAEV,QAAI,QAAQ;AAEZ,WAAO;AAAA,EACT,CAAC;AAMD,0CAAAA,SAA0B,MAAM;AAC9B,aAAS,OAAO,EAAE,GAAG,MAAM,MAAM,QAAQ,CAAU;AAAA,EACrD,CAAC;AAED;AAAA,IACE,SAAS;AAAA,IACT,KAAK,SAAS,UACV,CAAC,UAAe;AACd,aAAO,CAAC,MAAM,MAAM,OAAO,KAAK,MAAM,SAAS,CAAC,CAAC,EAAE,MAAM;AAAA,IAC3D,IACA;AAAA,EACN;AAEA,0CAAAA,SAA0B,MAAM,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC;AAE5D,SAAO;AACT;AAoCO,SAAS,MAAwB;AAAA,EACtC;AAAA,EACA,GAAG;AACL,GAEuC;AACrC,QAAM,WAAW,SAAS,YAAmB;AAE7C,SACE,6BAAAC,QAAA;AAAA,IAAC,+BAAY;AAAA,IAAZ;AAAA,MACC,OAAO,EAAE,SAAS,SAAS,MAAM,iBAAiB,SAAS,KAAK;AAAA,MAChE,cAAU,mCAAiB,UAAU,QAAe;AAAA;AAAA,EACtD;AAEJ;","names":["useIsomorphicLayoutEffect","React"]}
|
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DeepKeys, Narrow, DeepValue, FieldApi, FormApi, FieldApiOptions } from '@tanstack/form-core';
|
|
2
2
|
import { UseFieldOptions } from './types.cjs';
|
|
3
3
|
|
|
4
4
|
declare module '@tanstack/form-core' {
|
|
5
|
-
interface FieldApi<
|
|
5
|
+
interface FieldApi<_TData, TFormData, Opts, TData> {
|
|
6
6
|
Field: FieldComponent<TData, TFormData>;
|
|
7
7
|
}
|
|
8
8
|
}
|
|
9
9
|
type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(opts?: {
|
|
10
10
|
name: Narrow<TField>;
|
|
11
11
|
} & UseFieldOptions<DeepValue<TFormData, TField>, TFormData>) => FieldApi<DeepValue<TFormData, TField>, TFormData>;
|
|
12
|
-
declare function useField<TData, TFormData>(opts: UseFieldOptions<TData, TFormData>): FieldApi<TData, TFormData
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
declare function useField<TData, TFormData, TName extends unknown extends TFormData ? string : DeepKeys<TFormData> = unknown extends TFormData ? string : DeepKeys<TFormData>>(opts: UseFieldOptions<TData, TFormData, TName>): FieldApi<TData, TFormData, Omit<typeof opts, 'onMount'> & {
|
|
13
|
+
form: FormApi<TFormData>;
|
|
14
|
+
}>;
|
|
15
|
+
type FieldComponentProps<TParentData, TFormData, TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>> = {
|
|
16
|
+
children: (fieldApi: FieldApi<TField, TFormData, FieldApiOptions<TField, TFormData, TName>>) => any;
|
|
17
|
+
} & (TParentData extends any[] ? {
|
|
18
|
+
name?: TName;
|
|
18
19
|
index: number;
|
|
19
20
|
} : {
|
|
20
|
-
name:
|
|
21
|
+
name: TName;
|
|
21
22
|
index?: never;
|
|
22
|
-
})
|
|
23
|
+
}) & Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>;
|
|
24
|
+
type FieldComponent<TParentData, TFormData> = <TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>>({ children, ...fieldOptions }: FieldComponentProps<TParentData, TFormData, TField, TName>) => any;
|
|
23
25
|
declare function Field<TData, TFormData>({ children, ...fieldOptions }: {
|
|
24
26
|
children: (fieldApi: FieldApi<TData, TFormData>) => any;
|
|
25
27
|
} & UseFieldOptions<TData, TFormData>): JSX.Element;
|
|
26
28
|
|
|
27
|
-
export { Field, FieldComponent,
|
|
29
|
+
export { Field, FieldComponent, UseField, useField };
|
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DeepKeys, Narrow, DeepValue, FieldApi, FormApi, FieldApiOptions } from '@tanstack/form-core';
|
|
2
2
|
import { UseFieldOptions } from './types.js';
|
|
3
3
|
|
|
4
4
|
declare module '@tanstack/form-core' {
|
|
5
|
-
interface FieldApi<
|
|
5
|
+
interface FieldApi<_TData, TFormData, Opts, TData> {
|
|
6
6
|
Field: FieldComponent<TData, TFormData>;
|
|
7
7
|
}
|
|
8
8
|
}
|
|
9
9
|
type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(opts?: {
|
|
10
10
|
name: Narrow<TField>;
|
|
11
11
|
} & UseFieldOptions<DeepValue<TFormData, TField>, TFormData>) => FieldApi<DeepValue<TFormData, TField>, TFormData>;
|
|
12
|
-
declare function useField<TData, TFormData>(opts: UseFieldOptions<TData, TFormData>): FieldApi<TData, TFormData
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
declare function useField<TData, TFormData, TName extends unknown extends TFormData ? string : DeepKeys<TFormData> = unknown extends TFormData ? string : DeepKeys<TFormData>>(opts: UseFieldOptions<TData, TFormData, TName>): FieldApi<TData, TFormData, Omit<typeof opts, 'onMount'> & {
|
|
13
|
+
form: FormApi<TFormData>;
|
|
14
|
+
}>;
|
|
15
|
+
type FieldComponentProps<TParentData, TFormData, TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>> = {
|
|
16
|
+
children: (fieldApi: FieldApi<TField, TFormData, FieldApiOptions<TField, TFormData, TName>>) => any;
|
|
17
|
+
} & (TParentData extends any[] ? {
|
|
18
|
+
name?: TName;
|
|
18
19
|
index: number;
|
|
19
20
|
} : {
|
|
20
|
-
name:
|
|
21
|
+
name: TName;
|
|
21
22
|
index?: never;
|
|
22
|
-
})
|
|
23
|
+
}) & Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>;
|
|
24
|
+
type FieldComponent<TParentData, TFormData> = <TField, TName extends unknown extends TFormData ? string : DeepKeys<TFormData>>({ children, ...fieldOptions }: FieldComponentProps<TParentData, TFormData, TField, TName>) => any;
|
|
23
25
|
declare function Field<TData, TFormData>({ children, ...fieldOptions }: {
|
|
24
26
|
children: (fieldApi: FieldApi<TData, TFormData>) => any;
|
|
25
27
|
} & UseFieldOptions<TData, TFormData>): JSX.Element;
|
|
26
28
|
|
|
27
|
-
export { Field, FieldComponent,
|
|
29
|
+
export { Field, FieldComponent, UseField, useField };
|
package/build/modern/useField.js
CHANGED
|
@@ -8,7 +8,11 @@ function useField(opts) {
|
|
|
8
8
|
const { formApi, parentFieldName } = useFormContext();
|
|
9
9
|
const [fieldApi] = useState(() => {
|
|
10
10
|
const name = (typeof opts.index === "number" ? [parentFieldName, opts.index, opts.name] : [parentFieldName, opts.name]).filter((d) => d !== void 0).join(".");
|
|
11
|
-
const api = new FieldApi({
|
|
11
|
+
const api = new FieldApi({
|
|
12
|
+
...opts,
|
|
13
|
+
form: formApi,
|
|
14
|
+
name
|
|
15
|
+
});
|
|
12
16
|
api.Field = Field;
|
|
13
17
|
return api;
|
|
14
18
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n
|
|
1
|
+
{"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n FieldApiOptions,\n Narrow,\n} from '@tanstack/form-core'\nimport { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'\nimport { useFormContext, formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\nimport type { UseFieldOptions } from './types'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FieldApi<_TData, TFormData, Opts, TData> {\n Field: FieldComponent<TData, TFormData>\n }\n}\n\nexport type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(\n opts?: { name: Narrow<TField> } & UseFieldOptions<\n DeepValue<TFormData, TField>,\n TFormData\n >,\n) => FieldApi<DeepValue<TFormData, TField>, TFormData>\n\nexport function useField<\n TData,\n TFormData,\n TName extends unknown extends TFormData\n ? string\n : DeepKeys<TFormData> = unknown extends TFormData\n ? string\n : DeepKeys<TFormData>,\n>(\n opts: UseFieldOptions<TData, TFormData, TName>,\n): FieldApi<\n TData,\n TFormData,\n Omit<typeof opts, 'onMount'> & {\n form: FormApi<TFormData>\n }\n> {\n // Get the form API either manually or from context\n const { formApi, parentFieldName } = useFormContext()\n\n const [fieldApi] = useState(() => {\n const name = (\n typeof opts.index === 'number'\n ? [parentFieldName, opts.index, opts.name]\n : [parentFieldName, opts.name]\n )\n .filter((d) => d !== undefined)\n .join('.')\n\n const api = new FieldApi({\n ...opts,\n form: formApi,\n name: name,\n } as never)\n\n api.Field = Field as never\n\n return api\n })\n\n /**\n * fieldApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n fieldApi.update({ ...opts, form: formApi } as never)\n })\n\n useStore(\n fieldApi.store,\n opts.mode === 'array'\n ? (state: any) => {\n return [state.meta, Object.keys(state.value || []).length]\n }\n : undefined,\n )\n // Instantiates field meta and removes it when unrendered\n useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])\n\n return fieldApi as never\n}\n\ntype FieldComponentProps<\n TParentData,\n TFormData,\n TField,\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = {\n children: (\n fieldApi: FieldApi<\n TField,\n TFormData,\n FieldApiOptions<TField, TFormData, TName>\n >,\n ) => any\n} & (TParentData extends any[]\n ? {\n name?: TName\n index: number\n }\n : {\n name: TName\n index?: never\n }) &\n Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>\n\nexport type FieldComponent<TParentData, TFormData> = <\n // Type of the field\n TField,\n // Name of the field\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n>({\n children,\n ...fieldOptions\n}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any\n\nexport function Field<TData, TFormData>({\n children,\n ...fieldOptions\n}: {\n children: (fieldApi: FieldApi<TData, TFormData>) => any\n} & UseFieldOptions<TData, TFormData>) {\n const fieldApi = useField(fieldOptions as any)\n\n return (\n <formContext.Provider\n value={{ formApi: fieldApi.form, parentFieldName: fieldApi.name }}\n children={functionalUpdate(children, fieldApi as any)}\n />\n )\n}\n"],"mappings":";AAAA,OAAO,SAAS,gBAAgB;AAChC,SAAS,gBAAgB;AAOzB,SAAS,UAAwB,wBAAwB;AACzD,SAAS,gBAAgB,mBAAmB;AAC5C,OAAO,+BAA+B;AAiB/B,SAAS,SASd,MAOA;AAEA,QAAM,EAAE,SAAS,gBAAgB,IAAI,eAAe;AAEpD,QAAM,CAAC,QAAQ,IAAI,SAAS,MAAM;AAChC,UAAM,QACJ,OAAO,KAAK,UAAU,WAClB,CAAC,iBAAiB,KAAK,OAAO,KAAK,IAAI,IACvC,CAAC,iBAAiB,KAAK,IAAI,GAE9B,OAAO,CAAC,MAAM,MAAM,MAAS,EAC7B,KAAK,GAAG;AAEX,UAAM,MAAM,IAAI,SAAS;AAAA,MACvB,GAAG;AAAA,MACH,MAAM;AAAA,MACN;AAAA,IACF,CAAU;AAEV,QAAI,QAAQ;AAEZ,WAAO;AAAA,EACT,CAAC;AAMD,4BAA0B,MAAM;AAC9B,aAAS,OAAO,EAAE,GAAG,MAAM,MAAM,QAAQ,CAAU;AAAA,EACrD,CAAC;AAED;AAAA,IACE,SAAS;AAAA,IACT,KAAK,SAAS,UACV,CAAC,UAAe;AACd,aAAO,CAAC,MAAM,MAAM,OAAO,KAAK,MAAM,SAAS,CAAC,CAAC,EAAE,MAAM;AAAA,IAC3D,IACA;AAAA,EACN;AAEA,4BAA0B,MAAM,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC;AAE5D,SAAO;AACT;AAoCO,SAAS,MAAwB;AAAA,EACtC;AAAA,EACA,GAAG;AACL,GAEuC;AACrC,QAAM,WAAW,SAAS,YAAmB;AAE7C,SACE;AAAA,IAAC,YAAY;AAAA,IAAZ;AAAA,MACC,OAAO,EAAE,SAAS,SAAS,MAAM,iBAAiB,SAAS,KAAK;AAAA,MAChE,UAAU,iBAAiB,UAAU,QAAe;AAAA;AAAA,EACtD;AAEJ;","names":[]}
|
package/build/modern/useForm.cjs
CHANGED
|
@@ -42,7 +42,9 @@ var import_use_isomorphic_layout_effect = __toESM(require("use-isomorphic-layout
|
|
|
42
42
|
function useForm(opts) {
|
|
43
43
|
const [formApi] = (0, import_react.useState)(() => {
|
|
44
44
|
const api = new import_form_core.FormApi(opts);
|
|
45
|
-
api.Provider = (props)
|
|
45
|
+
api.Provider = function Provider(props) {
|
|
46
|
+
return /* @__PURE__ */ import_react.default.createElement(import_formContext.formContext.Provider, { ...props, value: { formApi: api } });
|
|
47
|
+
};
|
|
46
48
|
api.Field = import_useField.Field;
|
|
47
49
|
api.useField = import_useField.useField;
|
|
48
50
|
api.useStore = (selector) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n
|
|
1
|
+
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,uBAA0C;AAE1C,yBAAyB;AACzB,mBAAgD;AAChD,sBAAoE;AACpE,yBAA4B;AAC5B,0CAAsC;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,QAAI,uBAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,yBAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,6BAAAA,QAAA,cAAC,+BAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,iBAAO,6BAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,iBAAO;AAAA,QACL,MAAM;AAAA;AAAA,YAEN,6BAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,0CAAAC,SAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":["React","useIsomorphicLayoutEffect"]}
|
package/build/modern/useForm.js
CHANGED
|
@@ -8,7 +8,9 @@ import useIsomorphicLayoutEffect from "use-isomorphic-layout-effect";
|
|
|
8
8
|
function useForm(opts) {
|
|
9
9
|
const [formApi] = useState(() => {
|
|
10
10
|
const api = new FormApi(opts);
|
|
11
|
-
api.Provider = (props)
|
|
11
|
+
api.Provider = function Provider(props) {
|
|
12
|
+
return /* @__PURE__ */ React.createElement(formContext.Provider, { ...props, value: { formApi: api } });
|
|
13
|
+
};
|
|
12
14
|
api.Field = Field;
|
|
13
15
|
api.useField = useField;
|
|
14
16
|
api.useStore = (selector) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n
|
|
1
|
+
{"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";AACA,SAAS,SAAS,wBAAwB;AAE1C,SAAS,gBAAgB;AACzB,OAAO,SAAyB,gBAAgB;AAChD,SAA6C,OAAO,gBAAgB;AACpE,SAAS,mBAAmB;AAC5B,OAAO,+BAA+B;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,IAAI,SAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,QAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,oCAAC,YAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,aAAO,SAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,aAAO;AAAA,QACL,MAAM;AAAA;AAAA,QAEN,SAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,4BAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/react-form",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"description": "Powerful, type-safe forms for React.",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"@tanstack/react-store": "0.1.3",
|
|
55
55
|
"@tanstack/store": "0.1.3",
|
|
56
56
|
"use-isomorphic-layout-effect": "^1.1.2",
|
|
57
|
-
"@tanstack/form-core": "0.3.
|
|
57
|
+
"@tanstack/form-core": "0.3.3"
|
|
58
58
|
},
|
|
59
59
|
"peerDependencies": {
|
|
60
60
|
"react": "^17.0.0 || ^18.0.0",
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { assertType } from 'vitest'
|
|
2
|
+
import * as React from 'react'
|
|
3
|
+
import { useForm } from '../useForm'
|
|
4
|
+
|
|
5
|
+
it('should type state.value properly', () => {
|
|
6
|
+
function Comp() {
|
|
7
|
+
const form = useForm({
|
|
8
|
+
defaultValues: {
|
|
9
|
+
firstName: 'test',
|
|
10
|
+
age: 84,
|
|
11
|
+
},
|
|
12
|
+
} as const)
|
|
13
|
+
|
|
14
|
+
return (
|
|
15
|
+
<form.Provider>
|
|
16
|
+
<form.Field
|
|
17
|
+
name="firstName"
|
|
18
|
+
children={(field) => {
|
|
19
|
+
assertType<'test'>(field.state.value)
|
|
20
|
+
}}
|
|
21
|
+
/>
|
|
22
|
+
<form.Field
|
|
23
|
+
name="age"
|
|
24
|
+
children={(field) => {
|
|
25
|
+
assertType<84>(field.state.value)
|
|
26
|
+
}}
|
|
27
|
+
/>
|
|
28
|
+
</form.Provider>
|
|
29
|
+
)
|
|
30
|
+
}
|
|
31
|
+
})
|
|
32
|
+
|
|
33
|
+
it('should type onChange properly', () => {
|
|
34
|
+
function Comp() {
|
|
35
|
+
const form = useForm({
|
|
36
|
+
defaultValues: {
|
|
37
|
+
firstName: 'test',
|
|
38
|
+
age: 84,
|
|
39
|
+
},
|
|
40
|
+
} as const)
|
|
41
|
+
|
|
42
|
+
return (
|
|
43
|
+
<form.Provider>
|
|
44
|
+
<form.Field
|
|
45
|
+
name="firstName"
|
|
46
|
+
onChange={(val) => {
|
|
47
|
+
assertType<'test'>(val)
|
|
48
|
+
return null
|
|
49
|
+
}}
|
|
50
|
+
children={(field) => null}
|
|
51
|
+
/>
|
|
52
|
+
<form.Field
|
|
53
|
+
name="age"
|
|
54
|
+
onChange={(val) => {
|
|
55
|
+
assertType<84>(val)
|
|
56
|
+
return null
|
|
57
|
+
}}
|
|
58
|
+
children={(field) => null}
|
|
59
|
+
/>
|
|
60
|
+
</form.Provider>
|
|
61
|
+
)
|
|
62
|
+
}
|
|
63
|
+
})
|
package/src/types.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import type { FieldOptions } from '@tanstack/form-core'
|
|
1
|
+
import type { FieldOptions, DeepKeys } from '@tanstack/form-core'
|
|
2
2
|
|
|
3
|
-
export type UseFieldOptions<
|
|
3
|
+
export type UseFieldOptions<
|
|
4
4
|
TData,
|
|
5
|
-
TFormData
|
|
6
|
-
|
|
5
|
+
TFormData,
|
|
6
|
+
TName = unknown extends TFormData ? string : DeepKeys<TFormData>,
|
|
7
|
+
> = FieldOptions<TData, TFormData, TName> & {
|
|
7
8
|
mode?: 'value' | 'array'
|
|
8
9
|
}
|
package/src/useField.tsx
CHANGED
|
@@ -3,17 +3,17 @@ import { useStore } from '@tanstack/react-store'
|
|
|
3
3
|
import type {
|
|
4
4
|
DeepKeys,
|
|
5
5
|
DeepValue,
|
|
6
|
-
|
|
6
|
+
FieldApiOptions,
|
|
7
7
|
Narrow,
|
|
8
8
|
} from '@tanstack/form-core'
|
|
9
|
-
import { FieldApi, functionalUpdate } from '@tanstack/form-core'
|
|
9
|
+
import { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'
|
|
10
10
|
import { useFormContext, formContext } from './formContext'
|
|
11
11
|
import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'
|
|
12
12
|
import type { UseFieldOptions } from './types'
|
|
13
13
|
|
|
14
14
|
declare module '@tanstack/form-core' {
|
|
15
15
|
// eslint-disable-next-line no-shadow
|
|
16
|
-
interface FieldApi<
|
|
16
|
+
interface FieldApi<_TData, TFormData, Opts, TData> {
|
|
17
17
|
Field: FieldComponent<TData, TFormData>
|
|
18
18
|
}
|
|
19
19
|
}
|
|
@@ -25,13 +25,27 @@ export type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(
|
|
|
25
25
|
>,
|
|
26
26
|
) => FieldApi<DeepValue<TFormData, TField>, TFormData>
|
|
27
27
|
|
|
28
|
-
export function useField<
|
|
29
|
-
|
|
30
|
-
|
|
28
|
+
export function useField<
|
|
29
|
+
TData,
|
|
30
|
+
TFormData,
|
|
31
|
+
TName extends unknown extends TFormData
|
|
32
|
+
? string
|
|
33
|
+
: DeepKeys<TFormData> = unknown extends TFormData
|
|
34
|
+
? string
|
|
35
|
+
: DeepKeys<TFormData>,
|
|
36
|
+
>(
|
|
37
|
+
opts: UseFieldOptions<TData, TFormData, TName>,
|
|
38
|
+
): FieldApi<
|
|
39
|
+
TData,
|
|
40
|
+
TFormData,
|
|
41
|
+
Omit<typeof opts, 'onMount'> & {
|
|
42
|
+
form: FormApi<TFormData>
|
|
43
|
+
}
|
|
44
|
+
> {
|
|
31
45
|
// Get the form API either manually or from context
|
|
32
46
|
const { formApi, parentFieldName } = useFormContext()
|
|
33
47
|
|
|
34
|
-
const [fieldApi] = useState
|
|
48
|
+
const [fieldApi] = useState(() => {
|
|
35
49
|
const name = (
|
|
36
50
|
typeof opts.index === 'number'
|
|
37
51
|
? [parentFieldName, opts.index, opts.name]
|
|
@@ -40,9 +54,13 @@ export function useField<TData, TFormData>(
|
|
|
40
54
|
.filter((d) => d !== undefined)
|
|
41
55
|
.join('.')
|
|
42
56
|
|
|
43
|
-
const api = new FieldApi({
|
|
57
|
+
const api = new FieldApi({
|
|
58
|
+
...opts,
|
|
59
|
+
form: formApi,
|
|
60
|
+
name: name,
|
|
61
|
+
} as never)
|
|
44
62
|
|
|
45
|
-
api.Field = Field as
|
|
63
|
+
api.Field = Field as never
|
|
46
64
|
|
|
47
65
|
return api
|
|
48
66
|
})
|
|
@@ -56,70 +74,52 @@ export function useField<TData, TFormData>(
|
|
|
56
74
|
})
|
|
57
75
|
|
|
58
76
|
useStore(
|
|
59
|
-
fieldApi.store
|
|
77
|
+
fieldApi.store,
|
|
60
78
|
opts.mode === 'array'
|
|
61
79
|
? (state: any) => {
|
|
62
80
|
return [state.meta, Object.keys(state.value || []).length]
|
|
63
81
|
}
|
|
64
82
|
: undefined,
|
|
65
83
|
)
|
|
66
|
-
|
|
67
84
|
// Instantiates field meta and removes it when unrendered
|
|
68
85
|
useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])
|
|
69
86
|
|
|
70
|
-
return fieldApi
|
|
87
|
+
return fieldApi as never
|
|
71
88
|
}
|
|
72
89
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
// : TField extends `${infer TPrefix}[${infer TIndex extends
|
|
80
|
-
// | number
|
|
81
|
-
// | 'i'}].${infer TRest}`
|
|
82
|
-
// ? DeepValue<
|
|
83
|
-
// DeepValue<TFormData, TPrefix>[TIndex extends 'i' ? number : TIndex],
|
|
84
|
-
// TRest
|
|
85
|
-
// >
|
|
86
|
-
// : TField extends `${infer TPrefix}[${infer TIndex extends number | 'i'}]`
|
|
87
|
-
// ? DeepValue<TFormData, TPrefix>[TIndex extends 'i' ? number : TIndex]
|
|
88
|
-
// : DeepValue<TFormData, TField>
|
|
89
|
-
|
|
90
|
-
export type FieldValue<TFormData, TField> = TFormData extends any[]
|
|
91
|
-
? unknown extends TField
|
|
92
|
-
? TFormData[number]
|
|
93
|
-
: DeepValue<TFormData[number], TField>
|
|
94
|
-
: DeepValue<TFormData, TField>
|
|
95
|
-
|
|
96
|
-
// type Test1 = FieldValue<{ foo: { bar: string }[] }, 'foo'>
|
|
97
|
-
// // ^?
|
|
98
|
-
// type Test2 = FieldValue<{ foo: { bar: string }[] }, 'foo[i]'>
|
|
99
|
-
// // ^?
|
|
100
|
-
// type Test3 = FieldValue<{ foo: { bar: string }[] }, 'foo[2].bar'>
|
|
101
|
-
// // ^?
|
|
102
|
-
|
|
103
|
-
export type FieldComponent<TParentData, TFormData> = <TField>({
|
|
104
|
-
children,
|
|
105
|
-
...fieldOptions
|
|
106
|
-
}: {
|
|
90
|
+
type FieldComponentProps<
|
|
91
|
+
TParentData,
|
|
92
|
+
TFormData,
|
|
93
|
+
TField,
|
|
94
|
+
TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,
|
|
95
|
+
> = {
|
|
107
96
|
children: (
|
|
108
|
-
fieldApi: FieldApi<
|
|
97
|
+
fieldApi: FieldApi<
|
|
98
|
+
TField,
|
|
99
|
+
TFormData,
|
|
100
|
+
FieldApiOptions<TField, TFormData, TName>
|
|
101
|
+
>,
|
|
109
102
|
) => any
|
|
110
|
-
} &
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
103
|
+
} & (TParentData extends any[]
|
|
104
|
+
? {
|
|
105
|
+
name?: TName
|
|
106
|
+
index: number
|
|
107
|
+
}
|
|
108
|
+
: {
|
|
109
|
+
name: TName
|
|
110
|
+
index?: never
|
|
111
|
+
}) &
|
|
112
|
+
Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>
|
|
113
|
+
|
|
114
|
+
export type FieldComponent<TParentData, TFormData> = <
|
|
115
|
+
// Type of the field
|
|
116
|
+
TField,
|
|
117
|
+
// Name of the field
|
|
118
|
+
TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,
|
|
119
|
+
>({
|
|
120
|
+
children,
|
|
121
|
+
...fieldOptions
|
|
122
|
+
}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any
|
|
123
123
|
|
|
124
124
|
export function Field<TData, TFormData>({
|
|
125
125
|
children,
|
package/src/useForm.tsx
CHANGED
|
@@ -28,10 +28,9 @@ export function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {
|
|
|
28
28
|
// @ts-ignore
|
|
29
29
|
const api = new FormApi<TData>(opts)
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
)
|
|
31
|
+
api.Provider = function Provider(props) {
|
|
32
|
+
return <formContext.Provider {...props} value={{ formApi: api }} />
|
|
33
|
+
}
|
|
35
34
|
api.Field = Field as any
|
|
36
35
|
api.useField = useField as any
|
|
37
36
|
api.useStore = (
|