Skip to content

Commit

Permalink
chore: add React to reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
crutchcorn committed Jun 20, 2024
1 parent 2fcee08 commit 4c87d70
Show file tree
Hide file tree
Showing 32 changed files with 395 additions and 269 deletions.
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/injectform.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV

## Source

[inject-form.ts:4](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/inject-form.ts#L4)
[inject-form.ts:4](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/inject-form.ts#L4)
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/injectstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig

## Source

[inject-store.ts:4](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/inject-store.ts#L4)
[inject-store.ts:4](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/inject-store.ts#L4)
28 changes: 14 additions & 14 deletions docs/framework/angular/reference/tanstackfield.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;

#### Source

[tanstack-field.directive.ts:62](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L62)
[tanstack-field.directive.ts:62](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L62)

***

Expand All @@ -57,7 +57,7 @@ optional asyncAlways: boolean;

#### Source

[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L50)
[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L50)

***

Expand All @@ -73,7 +73,7 @@ optional asyncDebounceMs: number;

#### Source

[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L49)
[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L49)

***

Expand All @@ -89,7 +89,7 @@ optional defaultMeta: Partial<FieldMeta>;

#### Source

[tanstack-field.directive.ts:60](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L60)
[tanstack-field.directive.ts:60](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L60)

***

Expand All @@ -105,7 +105,7 @@ optional defaultValue: NoInfer<TData>;

#### Source

[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L48)
[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L48)

***

Expand All @@ -121,7 +121,7 @@ name: TName;

#### Source

[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L44)
[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L44)

***

Expand All @@ -137,7 +137,7 @@ optional preserveValue: boolean;

#### Source

[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L51)
[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L51)

***

Expand All @@ -149,7 +149,7 @@ tanstackField: FormApi<TParentData, TFormValidator>;

#### Source

[tanstack-field.directive.ts:53](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L53)
[tanstack-field.directive.ts:53](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L53)

***

Expand All @@ -165,7 +165,7 @@ optional unmount: () => void;

#### Source

[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L78)
[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L78)

***

Expand All @@ -181,7 +181,7 @@ optional validatorAdapter: TFieldValidator;

#### Source

[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L52)
[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L52)

***

Expand All @@ -197,7 +197,7 @@ optional validators: NoInfer<FieldValidators<TParentData, TName, TFieldValidator

#### Source

[tanstack-field.directive.ts:57](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L57)
[tanstack-field.directive.ts:57](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L57)

## Methods

Expand All @@ -217,7 +217,7 @@ ngOnChanges(): void

#### Source

[tanstack-field.directive.ts:90](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L90)
[tanstack-field.directive.ts:90](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L90)

***

Expand All @@ -237,7 +237,7 @@ ngOnDestroy(): void

#### Source

[tanstack-field.directive.ts:86](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L86)
[tanstack-field.directive.ts:86](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L86)

***

Expand All @@ -257,4 +257,4 @@ ngOnInit(): void

#### Source

[tanstack-field.directive.ts:80](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/angular-form/src/tanstack-field.directive.ts#L80)
[tanstack-field.directive.ts:80](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/angular-form/src/tanstack-field.directive.ts#L80)
10 changes: 5 additions & 5 deletions docs/framework/lit/reference/tanstackformcontroller.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
#### Source
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/lit-form/src/tanstack-form-controller.ts#L93)
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/lit-form/src/tanstack-form-controller.ts#L93)
## Properties
Expand All @@ -42,7 +42,7 @@ api: FormApi<TParentData, TFormValidator>;
#### Source
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/lit-form/src/tanstack-form-controller.ts#L91)
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/lit-form/src/tanstack-form-controller.ts#L91)
## Methods
Expand Down Expand Up @@ -96,7 +96,7 @@ render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TDat
#### Source
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/lit-form/src/tanstack-form-controller.ts#L112)
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/lit-form/src/tanstack-form-controller.ts#L112)
***
Expand All @@ -116,7 +116,7 @@ hostConnected(): void
#### Source
[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/lit-form/src/tanstack-form-controller.ts#L102)
[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/lit-form/src/tanstack-form-controller.ts#L102)
***
Expand All @@ -136,4 +136,4 @@ hostDisconnected(): void
#### Source
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/15a69d908f9285338889d60e93b689d265e4136c/packages/lit-form/src/tanstack-form-controller.ts#L108)
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/lit-form/src/tanstack-form-controller.ts#L108)
23 changes: 23 additions & 0 deletions docs/framework/react/reference/createservervalidate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Function: createServerValidate()

```ts
function createServerValidate<TFormData, TFormValidator>(defaultOpts?): ValidateFormData<TFormData, TFormValidator>
```

## Type parameters

**TFormData**

**TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined`

## Parameters

**defaultOpts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>

## Returns

`ValidateFormData`\<`TFormData`, `TFormValidator`\>

## Source

[createServerValidate.ts:40](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/createServerValidate.ts#L40)
33 changes: 33 additions & 0 deletions docs/framework/react/reference/field.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Function: Field()

```ts
function Field<TParentData, TName, TFieldValidator, TFormValidator, TData>(__namedParameters): ReactNode
```

A function component that takes field options and a render function as children and returns a React component.

The `Field` component uses the `useField` hook internally to manage the field instance.

## Type parameters

**TParentData**

**TName** *extends* `string` \| `number`

**TFieldValidator** *extends* `undefined` \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined`

**TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined`

**TData** = `DeepValue`\<`TParentData`, `TName`\>

## Parameters

**\_\_namedParameters**: `FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>

## Returns

`ReactNode`

## Source

[useField.tsx:171](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/useField.tsx#L171)
39 changes: 39 additions & 0 deletions docs/framework/react/reference/fieldcomponent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Type alias: FieldComponent()\<TParentData, TFormValidator\>

```ts
type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData>({
children,
...fieldOptions
}) => NodeType;
```

A type alias representing a field component for a specific form data type.

## Type parameters

**TParentData**

**TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`

## Type parameters

**TName** *extends* `DeepKeys`\<`TParentData`\>

**TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`

**TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\>

## Parameters

**\{
children,
...fieldOptions
\}**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>

## Returns

`NodeType`

## Source

[useField.tsx:141](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/useField.tsx#L141)
18 changes: 18 additions & 0 deletions docs/framework/react/reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# @tanstack/react-form

## Type Aliases

- [FieldComponent](Type.FieldComponent.md)
- [UseField](Type.UseField.md)

## Variables

- [initialFormState](Variable.initialFormState.md)

## Functions

- [Field](Function.Field.md)
- [createServerValidate](Function.createServerValidate.md)
- [useField](Function.useField.md)
- [useForm](Function.useForm.md)
- [useTransform](Function.useTransform.md)
29 changes: 29 additions & 0 deletions docs/framework/react/reference/initialformstate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Variable: initialFormState

```ts
const initialFormState: object;
```

## Type declaration

### errorMap

```ts
errorMap: object;
```

### errorMap.onServer

```ts
onServer: undefined = undefined;
```

### errors

```ts
errors: never[] = [];
```

## Source

[createServerValidate.ts:72](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/createServerValidate.ts#L72)
35 changes: 35 additions & 0 deletions docs/framework/react/reference/usefield.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Function: useField()

```ts
function useField<TParentData, TName, TFieldValidator, TFormValidator, TData>(opts): FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>
```

A hook for managing a field in a form.

## Type parameters

**TParentData**

**TName** *extends* `string` \| `number`

**TFieldValidator** *extends* `undefined` \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined`

**TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined`

**TData** = `DeepValue`\<`TParentData`, `TName`\>

## Parameters

**opts**: `UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>

An object with field options.

## Returns

`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>

The `FieldApi` instance for the specified field.

## Source

[useField.tsx:60](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/useField.tsx#L60)
27 changes: 27 additions & 0 deletions docs/framework/react/reference/useform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Function: useForm()

```ts
function useForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormValidator>
```

A custom React Hook that returns an instance of the `FormApi` class.

This API encapsulates all the necessary functionalities related to the form. It allows you to manage form state, handle submissions, and interact with form fields

## Type parameters

**TFormData**

**TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined`

## Parameters

**opts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>

## Returns

`FormApi`\<`TFormData`, `TFormValidator`\>

## Source

[useForm.tsx:56](https://github.com/TanStack/form/blob/2fcee08730ef56cadb9b5937d06198bcc1fedcd7/packages/react-form/src/useForm.tsx#L56)
Loading

0 comments on commit 4c87d70

Please sign in to comment.