Skip to content

Commit

Permalink
docs(typedoc): Update output filename (#871)
Browse files Browse the repository at this point in the history
* docs(typedoc): Update output filename

* Update config.json
  • Loading branch information
lachlancollins authored Jul 19, 2024
1 parent a6313b7 commit 6fe229b
Show file tree
Hide file tree
Showing 47 changed files with 551 additions and 261 deletions.
82 changes: 41 additions & 41 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -192,40 +192,40 @@
"label": "API Reference",
"children": [
{ "label": "JavaScript Reference", "to": "reference/index" },
{ "label": "Classes / FieldApi", "to": "reference/fieldapi" },
{ "label": "Classes / FormApi", "to": "reference/formapi" },
{ "label": "Functions / formOptions", "to": "reference/formoptions" },
{ "label": "Functions / mergeForm", "to": "reference/mergeform" },
{ "label": "Classes / FieldApi", "to": "reference/FieldApi" },
{ "label": "Classes / FormApi", "to": "reference/FormApi" },
{ "label": "Functions / formOptions", "to": "reference/formOptions" },
{ "label": "Functions / mergeForm", "to": "reference/mergeForm" },
{
"label": "Interfaces / FieldApiOptions",
"to": "reference/fieldapioptions"
"to": "reference/FieldApiOptions"
},
{
"label": "Interfaces / FieldOptions",
"to": "reference/fieldoptions"
"to": "reference/FieldOptions"
},
{
"label": "Interfaces / FieldValidators",
"to": "reference/fieldvalidators"
"to": "reference/FieldValidators"
},
{ "label": "Interfaces / FormOptions", "to": "reference/formoptions" },
{ "label": "Interfaces / FormOptions", "to": "reference/FormOptions" },
{
"label": "Interfaces / FormValidators",
"to": "reference/formvalidators"
"to": "reference/FormValidators"
},
{ "label": "Types / DeepKeys", "to": "reference/deepkeys" },
{ "label": "Types / DeepValue", "to": "reference/deepvalue" },
{ "label": "Types / FieldInfo", "to": "reference/fieldinfo" },
{ "label": "Types / FieldMeta", "to": "reference/fieldmeta" },
{ "label": "Types / FieldState", "to": "reference/fieldstate" },
{ "label": "Types / FormState", "to": "reference/formstate" },
{ "label": "Types / Updater", "to": "reference/updater" },
{ "label": "Types / UpdaterFn", "to": "reference/updaterfn" },
{ "label": "Types / DeepKeys", "to": "reference/DeepKeys" },
{ "label": "Types / DeepValue", "to": "reference/DeepValue" },
{ "label": "Types / FieldInfo", "to": "reference/FieldInfo" },
{ "label": "Types / FieldMeta", "to": "reference/FieldMeta" },
{ "label": "Types / FieldState", "to": "reference/FieldState" },
{ "label": "Types / FormState", "to": "reference/FormState" },
{ "label": "Types / Updater", "to": "reference/Updater" },
{ "label": "Types / UpdaterFn", "to": "reference/UpdaterFn" },
{
"label": "Types / ValidationError",
"to": "reference/validationerror"
"to": "reference/ValidationError"
},
{ "label": "Types / ValidationMeta", "to": "reference/validationmeta" }
{ "label": "Types / ValidationMeta", "to": "reference/ValidationMeta" }
],
"frameworks": [
{
Expand All @@ -237,35 +237,35 @@
},
{
"label": "Functions / createServerValidate",
"to": "framework/react/reference/createservervalidate"
"to": "framework/react/reference/createServerValidate"
},
{
"label": "Functions / Field",
"to": "framework/react/reference/field"
"to": "framework/react/reference/Field"
},
{
"label": "Functions / useField",
"to": "framework/react/reference/usefield"
"to": "framework/react/reference/useField"
},
{
"label": "Functions / useForm",
"to": "framework/react/reference/useform"
"to": "framework/react/reference/useForm"
},
{
"label": "Functions / useTransform",
"to": "framework/react/reference/usetransform"
"to": "framework/react/reference/useTransform"
},
{
"label": "Types / FieldComponent",
"to": "framework/react/reference/fieldcomponent"
"to": "framework/react/reference/FieldComponent"
},
{
"label": "Types / UseField",
"to": "framework/react/reference/usefield"
"to": "framework/react/reference/UseField"
},
{
"label": "Variables / initialFormState",
"to": "framework/react/reference/initialformstate"
"to": "framework/react/reference/initialFormState"
}
]
},
Expand All @@ -275,23 +275,23 @@
{ "label": "Vue Reference", "to": "framework/vue/reference/index" },
{
"label": "Functions / Field",
"to": "framework/vue/reference/field"
"to": "framework/vue/reference/Field"
},
{
"label": "Functions / useField",
"to": "framework/vue/reference/usefield"
"to": "framework/vue/reference/useField"
},
{
"label": "Functions / useForm",
"to": "framework/vue/reference/useform"
"to": "framework/vue/reference/useForm"
},
{
"label": "Types / FieldComponent",
"to": "framework/vue/reference/fieldcomponent"
"to": "framework/vue/reference/FieldComponent"
},
{
"label": "Types / UseField",
"to": "framework/vue/reference/usefield"
"to": "framework/vue/reference/UseField"
}
]
},
Expand All @@ -304,23 +304,23 @@
},
{
"label": "Functions / createField",
"to": "framework/solid/reference/createfield"
"to": "framework/solid/reference/createField"
},
{
"label": "Functions / createForm",
"to": "framework/solid/reference/createform"
"to": "framework/solid/reference/createForm"
},
{
"label": "Functions / Field",
"to": "framework/solid/reference/field"
"to": "framework/solid/reference/Field"
},
{
"label": "Types / CreateField",
"to": "framework/solid/reference/createfield"
"to": "framework/solid/reference/CreateField"
},
{
"label": "Types / FieldComponent",
"to": "framework/solid/reference/fieldcomponent"
"to": "framework/solid/reference/FieldComponent"
}
]
},
Expand All @@ -330,7 +330,7 @@
{ "label": "Lit Reference", "to": "framework/lit/reference/index" },
{
"label": "Classes / TanStackFormController",
"to": "framework/lit/reference/tanstackformcontroller"
"to": "framework/lit/reference/TanStackFormController"
}
]
},
Expand All @@ -343,15 +343,15 @@
},
{
"label": "Classes / TanStackField",
"to": "framework/angular/reference/tanstackfield"
"to": "framework/angular/reference/TanStackField"
},
{
"label": "Functions / injectForm",
"to": "framework/angular/reference/injectform"
"to": "framework/angular/reference/injectForm"
},
{
"label": "Functions / injectStore",
"to": "framework/angular/reference/injectstore"
"to": "framework/angular/reference/injectStore"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ new TanStackField<TParentData, TName, TFieldValidator, TFormValidator, TData>():

#### Returns

[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
[`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>

## Properties

Expand All @@ -46,7 +46,7 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;

#### Defined in

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

***

Expand All @@ -64,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L50)
[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L50)

***

Expand All @@ -82,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L49)
[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L49)

***

Expand All @@ -100,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L59)
[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L59)

***

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

#### Defined in

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

***

Expand All @@ -136,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L44)
[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L44)

***

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

#### Defined in

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

***

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

#### Defined in

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

***

Expand All @@ -182,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L51)
[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L51)

***

Expand All @@ -200,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L56)
[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L56)

## Methods

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

#### Defined in

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

***

Expand All @@ -248,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L84)
[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L84)

***

Expand All @@ -274,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L78)
[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L78)
6 changes: 3 additions & 3 deletions docs/framework/angular/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: "@tanstack/angular-form"

## Classes

- [TanStackField](tanstackfield.md)
- [TanStackField](TanStackField.md)

## Functions

- [injectForm](injectform.md)
- [injectStore](injectstore.md)
- [injectForm](injectForm.md)
- [injectStore](injectStore.md)
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV

## Defined in

[inject-form.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/inject-form.ts#L4)
[inject-form.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-form.ts#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig

## Defined in

[inject-store.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/inject-store.ts#L4)
[inject-store.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-store.ts#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
#### Returns
[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormValidator`\>
[`TanStackFormController`](TanStackFormController.md)\<`TParentData`, `TFormValidator`\>
#### Defined in
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L93)
[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L93)
## Properties
Expand All @@ -47,7 +47,7 @@ api: FormApi<TParentData, TFormValidator>;
#### Defined in
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L91)
[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L91)
## Methods
Expand Down Expand Up @@ -101,7 +101,7 @@ render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TDat
#### Defined in
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L112)
[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L112)
***
Expand All @@ -125,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L102)
[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L102)
***
Expand All @@ -150,4 +150,4 @@ document.
#### Defined in
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L108)
[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L108)
2 changes: 1 addition & 1 deletion docs/framework/lit/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: "@tanstack/lit-form"

## Classes

- [TanStackFormController](tanstackformcontroller.md)
- [TanStackFormController](TanStackFormController.md)
Original file line number Diff line number Diff line change
Expand Up @@ -35,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/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useField.tsx#L163)
[useField.tsx:163](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L163)
Loading

0 comments on commit 6fe229b

Please sign in to comment.