Skip to content

Commit

Permalink
ci: apply automated fixes and generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
autofix-ci[bot] authored Nov 29, 2024
1 parent 0a08f26 commit 4337b92
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/functions/usefield.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ readonly state: Readonly<Ref<FieldState<TData>, FieldState<TData>>> = fieldState

## Defined in

[useField.tsx:49](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L49)
[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L49)
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/functions/useform.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ function useForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormVali

## Defined in

[useForm.tsx:30](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L30)
[packages/vue-form/src/useForm.tsx:30](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L30)
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/interfaces/vuefieldapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Field: FieldComponent<TParentData, TFormValidator>;

#### Defined in

[useField.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L14)
[packages/vue-form/src/useField.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L14)
8 changes: 4 additions & 4 deletions docs/framework/vue/reference/interfaces/vueformapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Field: FieldComponent<TFormData, TFormValidator>;

#### Defined in

[useForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L14)
[packages/vue-form/src/useForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L14)

***

Expand Down Expand Up @@ -49,7 +49,7 @@ Subscribe: <TSelected>(props, context) => any;

#### Defined in

[useForm.tsx:19](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L19)
[packages/vue-form/src/useForm.tsx:19](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L19)

***

Expand All @@ -61,7 +61,7 @@ useField: UseField<TFormData, TFormValidator>;

#### Defined in

[useForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L15)
[packages/vue-form/src/useForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L15)

***

Expand All @@ -85,4 +85,4 @@ useStore: <TSelected>(selector?) => Readonly<Ref<TSelected, TSelected>>;

#### Defined in

[useForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L16)
[packages/vue-form/src/useForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L16)
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData

## Defined in

[useField.tsx:117](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L117)
[packages/vue-form/src/useField.tsx:117](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L117)
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/type-aliases/usefield.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ state: Readonly<Ref<FieldApi<TParentData, TName, TFieldValidator, TFormValidator

## Defined in

[useField.tsx:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L17)
[packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L17)
14 changes: 11 additions & 3 deletions docs/framework/vue/reference/variables/field.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@ id: Field
title: Field
---

# Variable: Field
# Variable: Field()

```ts
const Field: Function;
const Field: <TParentData, TName, TFieldValidator, TFormValidator, TData>(props) => CreateComponentPublicInstanceWithMixins<FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & object & object | object, object, object, object, object, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, object, false, object, object, object, object, string, object, any, ComponentProvideOptions, OptionTypesType<object, object, object, object, object, object>, object & FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & { mode?: "value" | ... 1 more ... | undefined; } & ({ ...; } | { ...; }), object, object, object, object, object>;
```

## Parameters

**props**: FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps`

## Returns

`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` & `object` \| `object`, `object`, `object`, `object`, `object`, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, `object`, `false`, `object`, `object`, `object`, `object`, `string`, `object`, `any`, `ComponentProvideOptions`, `OptionTypesType`\<`object`, `object`, `object`, `object`, `object`, `object`\>, `object` & FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}), `object`, `object`, `object`, `object`, `object`\>

## Defined in

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

0 comments on commit 4337b92

Please sign in to comment.