diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md index c71a6cfbc..c1ac1504d 100644 --- a/docs/framework/react/reference/functions/field.md +++ b/docs/framework/react/reference/functions/field.md @@ -37,4 +37,4 @@ The `Field` component uses the `useField` hook internally to manage the field in ## Defined in -[useField.tsx:164](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L164) +[packages/react-form/src/useField.tsx:164](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L164) diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md index 36aa63b94..779a1954e 100644 --- a/docs/framework/react/reference/functions/usefield.md +++ b/docs/framework/react/reference/functions/usefield.md @@ -39,4 +39,4 @@ The `FieldApi` instance for the specified field. ## Defined in -[useField.tsx:50](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L50) +[packages/react-form/src/useField.tsx:50](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L50) diff --git a/docs/framework/react/reference/functions/useform.md b/docs/framework/react/reference/functions/useform.md index 98bcd4a98..b959753d4 100644 --- a/docs/framework/react/reference/functions/useform.md +++ b/docs/framework/react/reference/functions/useform.md @@ -31,4 +31,4 @@ This API encapsulates all the necessary functionalities related to the form. It ## Defined in -[useForm.tsx:67](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L67) +[packages/react-form/src/useForm.tsx:67](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L67) diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md new file mode 100644 index 000000000..966b0b77a --- /dev/null +++ b/docs/framework/react/reference/functions/usestore.md @@ -0,0 +1,36 @@ +--- +id: useStore +title: useStore +--- + +# Function: useStore() + +```ts +function useStore(store, selector?): TSelected +``` + +## Type Parameters + +• **TState** + +• **TSelected** = `NoInfer`\<`TState`\> + +• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` + +## Parameters + +### store + +`Store`\<`TState`, `TUpdater`\> + +### selector? + +(`state`) => `TSelected` + +## Returns + +`TSelected` + +## Defined in + +node\_modules/.pnpm/@tanstack+react-store@0.6.1\_react-dom@18.3.1\_react@18.3.1\_\_react@18.3.1/node\_modules/@tanstack/react-store/dist/esm/index.d.ts:7 diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md index 5d8607a1b..bc4ffb2cb 100644 --- a/docs/framework/react/reference/functions/usetransform.md +++ b/docs/framework/react/reference/functions/usetransform.md @@ -31,4 +31,4 @@ function useTransform(fn, deps): FormTransform ## Defined in -[createField.tsx:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L87) +[packages/solid-form/src/createField.tsx:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L87) diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md index 5935b4c7d..1de39fc10 100644 --- a/docs/framework/solid/reference/functions/createform.md +++ b/docs/framework/solid/reference/functions/createform.md @@ -27,4 +27,4 @@ function createForm(opts?): FormApi(props ## Defined in -[createField.tsx:185](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L185) +[packages/solid-form/src/createField.tsx:185](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L185) diff --git a/docs/framework/solid/reference/functions/usestore.md b/docs/framework/solid/reference/functions/usestore.md new file mode 100644 index 000000000..ccb30601b --- /dev/null +++ b/docs/framework/solid/reference/functions/usestore.md @@ -0,0 +1,36 @@ +--- +id: useStore +title: useStore +--- + +# Function: useStore() + +```ts +function useStore(store, selector?): Accessor +``` + +## Type Parameters + +• **TState** + +• **TSelected** = `NoInfer`\<`TState`\> + +• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` + +## Parameters + +### store + +`Store`\<`TState`, `TUpdater`\> + +### selector? + +(`state`) => `TSelected` + +## Returns + +`Accessor`\<`TSelected`\> + +## Defined in + +node\_modules/.pnpm/@tanstack+solid-store@0.6.0\_solid-js@1.9.3/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:8 diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index eafeb8042..704a66cb7 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -19,3 +19,4 @@ title: "@tanstack/solid-form" - [createField](functions/createfield.md) - [createForm](functions/createform.md) - [Field](functions/field.md) +- [useStore](functions/usestore.md) diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md index a91aa44e9..048fa225a 100644 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ b/docs/framework/solid/reference/interfaces/solidformapi.md @@ -21,7 +21,7 @@ createField: CreateField; #### Defined in -[createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) +[packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) *** @@ -33,7 +33,7 @@ Field: FieldComponent; #### Defined in -[createForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L15) +[packages/solid-form/src/createForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L15) *** @@ -65,7 +65,7 @@ Subscribe: (props) => Element; #### Defined in -[createForm.tsx:20](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L20) +[packages/solid-form/src/createForm.tsx:20](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L20) *** @@ -95,4 +95,4 @@ useStore: (selector?) => () => TSelected; #### Defined in -[createForm.tsx:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L17) +[packages/solid-form/src/createForm.tsx:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L17) diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md index 42bd1e1b5..6c74e7fb9 100644 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -39,4 +39,4 @@ type CreateField: (o ## Defined in -[createField.tsx:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L29) +[packages/solid-form/src/createField.tsx:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L29) diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md index 001a50ad1..ad43276ca 100644 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -41,4 +41,4 @@ type FieldComponent: (store, selector?): Readonly> +``` + +## Type Parameters + +• **TState** + +• **TSelected** = `NoInfer`\<`TState`\> + +• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater` + +## Parameters + +### store + +`Store`\<`TState`, `TUpdater`\> + +### selector? + +(`state`) => `TSelected` + +## Returns + +`Readonly`\<`Ref`\<`TSelected`\>\> + +## Defined in + +node\_modules/.pnpm/@tanstack+vue-store@0.6.0\_vue@3.5.12\_typescript@5.7.2\_/node\_modules/@tanstack/vue-store/dist/esm/index.d.ts:8 diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index bc817c6c4..27abe16df 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -23,3 +23,4 @@ title: "@tanstack/vue-form" - [useField](functions/usefield.md) - [useForm](functions/useform.md) +- [useStore](functions/usestore.md) diff --git a/packages/react-form/src/index.ts b/packages/react-form/src/index.ts index 8b06e6751..145bcde65 100644 --- a/packages/react-form/src/index.ts +++ b/packages/react-form/src/index.ts @@ -1,5 +1,7 @@ export * from '@tanstack/form-core' +export { useStore } from '@tanstack/react-store' + export type { ReactFormApi, ReactFormExtendedApi } from './useForm' export { useForm } from './useForm' diff --git a/packages/solid-form/src/index.tsx b/packages/solid-form/src/index.tsx index f0622af1b..dbe20bcd1 100644 --- a/packages/solid-form/src/index.tsx +++ b/packages/solid-form/src/index.tsx @@ -1,5 +1,7 @@ export * from '@tanstack/form-core' +export { useStore } from '@tanstack/solid-store' + export { createForm, type SolidFormApi } from './createForm' export type { CreateField, FieldComponent } from './createField' diff --git a/packages/vue-form/src/index.ts b/packages/vue-form/src/index.ts index e39e9c75c..50f1cbaad 100644 --- a/packages/vue-form/src/index.ts +++ b/packages/vue-form/src/index.ts @@ -1,3 +1,4 @@ export * from '@tanstack/form-core' +export { useStore } from '@tanstack/vue-store' export * from './useField' export * from './useForm'