Skip to content

Commit

Permalink
docs(typedoc): Add frontmatter (#866)
Browse files Browse the repository at this point in the history
* docs(typedoc): Add frontmatter

* Update knip.json
  • Loading branch information
lachlancollins committed Jul 18, 2024
1 parent de062c3 commit bbf9f46
Show file tree
Hide file tree
Showing 46 changed files with 366 additions and 131 deletions.
5 changes: 5 additions & 0 deletions docs/framework/angular/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: "@tanstack/angular-form"
title: "@tanstack/angular-form"
---

# @tanstack/angular-form

## Classes
Expand Down
7 changes: 6 additions & 1 deletion docs/framework/angular/reference/injectform.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: injectForm
title: injectForm
---

# Function: injectForm()

```ts
Expand All @@ -20,4 +25,4 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV

## Defined in

[inject-form.ts:4](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/inject-form.ts#L4)
[inject-form.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/inject-form.ts#L4)
7 changes: 6 additions & 1 deletion docs/framework/angular/reference/injectstore.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: injectStore
title: injectStore
---

# Function: injectStore()

```ts
Expand All @@ -24,4 +29,4 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig

## Defined in

[inject-store.ts:4](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/inject-store.ts#L4)
[inject-store.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/inject-store.ts#L4)
31 changes: 18 additions & 13 deletions docs/framework/angular/reference/tanstackfield.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: TanStackField
title: TanStackField
---

# Class: TanStackField\<TParentData, TName, TFieldValidator, TFormValidator, TData\>

## Type Parameters
Expand Down Expand Up @@ -41,7 +46,7 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;

#### Defined in

[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L61)
[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L61)

***

Expand All @@ -59,7 +64,7 @@ If `true`, always run async validation, even if there are errors emitted during

#### Defined in

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

***

Expand All @@ -77,7 +82,7 @@ The default time to debounce async validation if there is not a more specific de

#### Defined in

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

***

Expand All @@ -95,7 +100,7 @@ An optional object with default metadata for the field.

#### Defined in

[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L59)
[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L59)

***

Expand All @@ -113,7 +118,7 @@ An optional default value for the field.

#### Defined in

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

***

Expand All @@ -131,7 +136,7 @@ The field name. The type will be `DeepKeys<TParentData>` to ensure your name is

#### Defined in

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

***

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

#### Defined in

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

***

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

#### Defined in

[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L76)
[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L76)

***

Expand All @@ -177,7 +182,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo

#### Defined in

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

***

Expand All @@ -195,7 +200,7 @@ A list of validators to pass to the field

#### Defined in

[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L56)
[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L56)

## Methods

Expand All @@ -220,7 +225,7 @@ children are checked.

#### Defined in

[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L88)
[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L88)

***

Expand All @@ -243,7 +248,7 @@ before a directive, pipe, or service instance is destroyed.

#### Defined in

[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L84)
[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L84)

***

Expand All @@ -269,4 +274,4 @@ It is invoked only once when the directive is instantiated.

#### Defined in

[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L78)
[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L78)
5 changes: 5 additions & 0 deletions docs/framework/lit/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: "@tanstack/lit-form"
title: "@tanstack/lit-form"
---

# @tanstack/lit-form

## Classes
Expand Down
15 changes: 10 additions & 5 deletions docs/framework/lit/reference/tanstackformcontroller.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: TanStackFormController
title: TanStackFormController
---

# Class: TanStackFormController\<TParentData, TFormValidator\>

## Type Parameters
Expand Down Expand Up @@ -30,7 +35,7 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
#### Defined in
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L93)
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L93)
## Properties
Expand All @@ -42,7 +47,7 @@ api: FormApi<TParentData, TFormValidator>;
#### Defined in
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L91)
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L91)
## Methods
Expand Down Expand Up @@ -96,7 +101,7 @@ render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TDat
#### Defined in
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L112)
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L112)
***
Expand All @@ -120,7 +125,7 @@ which is only called when the component is connected to the document.
#### Defined in
[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L102)
[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L102)
***
Expand All @@ -145,4 +150,4 @@ document.
#### Defined in
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L108)
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L108)
7 changes: 6 additions & 1 deletion docs/framework/react/reference/field.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: Field
title: Field
---

# Function: Field()

```ts
Expand Down Expand Up @@ -30,4 +35,4 @@ The `Field` component uses the `useField` hook internally to manage the field in

## Defined in

[useField.tsx:163](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useField.tsx#L163)
[useField.tsx:163](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useField.tsx#L163)
7 changes: 6 additions & 1 deletion docs/framework/react/reference/fieldcomponent.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: FieldComponent
title: FieldComponent
---

# Type Alias: FieldComponent()\<TParentData, TFormValidator\>

```ts
Expand Down Expand Up @@ -36,4 +41,4 @@ A type alias representing a field component for a specific form data type.

## Defined in

[useField.tsx:133](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useField.tsx#L133)
[useField.tsx:133](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useField.tsx#L133)
5 changes: 5 additions & 0 deletions docs/framework/react/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: "@tanstack/react-form"
title: "@tanstack/react-form"
---

# @tanstack/react-form

## Type Aliases
Expand Down
7 changes: 6 additions & 1 deletion docs/framework/react/reference/usefield.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: useField
title: useField
---

# Function: useField()

```ts
Expand Down Expand Up @@ -32,4 +37,4 @@ The `FieldApi` instance for the specified field.

## Defined in

[useField.tsx:49](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useField.tsx#L49)
[useField.tsx:49](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useField.tsx#L49)
7 changes: 6 additions & 1 deletion docs/framework/react/reference/useform.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: useForm
title: useForm
---

# Function: useForm()

```ts
Expand All @@ -24,4 +29,4 @@ This API encapsulates all the necessary functionalities related to the form. It

## Defined in

[useForm.tsx:56](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useForm.tsx#L56)
[useForm.tsx:56](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useForm.tsx#L56)
7 changes: 6 additions & 1 deletion docs/framework/react/reference/usetransform.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: useTransform
title: useTransform
---

# Function: useTransform()

```ts
Expand Down Expand Up @@ -42,4 +47,4 @@ fn: (formBase) => FormApi<TFormData, TFormValidator>;

## Defined in

[useTransform.ts:3](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useTransform.ts#L3)
[useTransform.ts:3](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useTransform.ts#L3)
7 changes: 6 additions & 1 deletion docs/framework/solid/reference/createfield.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createField
title: createField
---

# Function: createField()

```ts
Expand Down Expand Up @@ -30,4 +35,4 @@ function createField<TParentData, TName, TFieldValidator, TFormValidator, TData>

## Defined in

[createField.tsx:87](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/solid-form/src/createField.tsx#L87)
[createField.tsx:87](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createField.tsx#L87)
7 changes: 6 additions & 1 deletion docs/framework/solid/reference/createform.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: createForm
title: createForm
---

# Function: createForm()

```ts
Expand All @@ -20,4 +25,4 @@ function createForm<TParentData, TFormValidator>(opts?): FormApi<TParentData, TF

## Defined in

[createForm.tsx:29](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/solid-form/src/createForm.tsx#L29)
[createForm.tsx:29](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createForm.tsx#L29)
7 changes: 6 additions & 1 deletion docs/framework/solid/reference/field.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: Field
title: Field
---

# Function: Field()

```ts
Expand Down Expand Up @@ -26,4 +31,4 @@ function Field<TParentData, TName, TFieldValidator, TFormValidator, TData>(props

## Defined in

[createField.tsx:185](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/solid-form/src/createField.tsx#L185)
[createField.tsx:185](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createField.tsx#L185)
7 changes: 6 additions & 1 deletion docs/framework/solid/reference/fieldcomponent.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: FieldComponent
title: FieldComponent
---

# Type Alias: FieldComponent()\<TParentData, TFormValidator\>

```ts
Expand Down Expand Up @@ -34,4 +39,4 @@ type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData

## Defined in

[createField.tsx:160](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/solid-form/src/createField.tsx#L160)
[createField.tsx:160](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createField.tsx#L160)
5 changes: 5 additions & 0 deletions docs/framework/solid/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: "@tanstack/solid-form"
title: "@tanstack/solid-form"
---

# @tanstack/solid-form

## Type Aliases
Expand Down
7 changes: 6 additions & 1 deletion docs/framework/vue/reference/field.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: Field
title: Field
---

# Function: Field()

```ts
Expand Down Expand Up @@ -26,4 +31,4 @@ function Field<TParentData, TName, TFieldValidator, TFormValidator, TData>(props

## Defined in

[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/vue-form/src/useField.tsx#L162)
[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/vue-form/src/useField.tsx#L162)
Loading

0 comments on commit bbf9f46

Please sign in to comment.