Skip to content

Commit 031b70e

Browse files
ci: apply automated fixes and generate docs
1 parent 2ebad6a commit 031b70e

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

docs/framework/preact/reference/interfaces/AppFormHookResult.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,21 @@ function NameField({ form }: { form: ProfileForm }) {
6060
defineAppFieldGroup: DefineFieldGroupFn<TComponents["fieldComponents"]>;
6161
```
6262

63-
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:83](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L83)
63+
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:90](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L90)
6464

6565
Defines a reusable field group whose fields expose the field components
6666
registered with `createFormHook`.
6767

6868
#### Example
6969

7070
```tsx
71+
const { defineAppFieldGroup } = createFormHook({
72+
fieldComponents: {
73+
TextField,
74+
},
75+
formComponents: {},
76+
})
77+
7178
const contactFields = defineAppFieldGroup(({ strict }) => ({
7279
name: strict<string>(),
7380
email: strict<string>(),
@@ -94,7 +101,7 @@ function ContactFields({
94101
useAppForm: UseAppFormHook<TComponents>;
95102
```
96103

97-
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:108](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L108)
104+
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:115](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L115)
98105

99106
Creates a Preact form API extended with the field and form components
100107
registered with `createFormHook`.
@@ -128,7 +135,7 @@ function ProfileForm() {
128135
useFormContext: () => PreactAppFormApi<any, any, TComponents>;
129136
```
130137

131-
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:132](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L132)
138+
Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:139](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L139)
132139

133140
Reads the current App Form API from the nearest `form.AppForm` provider.
134141

docs/framework/react/reference/type-aliases/CreateFormHookDefaultFormOptions.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,18 @@ title: CreateFormHookDefaultFormOptions
66
# Type Alias: CreateFormHookDefaultFormOptions
77

88
```ts
9-
type CreateFormHookDefaultFormOptions = Pick<FormOptions<unknown, FormValidators<unknown>, unknown>,
10-
| "formId"
11-
| "errorVisibility"
12-
| "listeners"
13-
| "serverState"
14-
| "onSubmitInvalid">;
9+
type CreateFormHookDefaultFormOptions = Pick<FormOptions<unknown, FormValidators<unknown>, unknown>, "formId" | "errorVisibility" | "listeners" | "onSubmitInvalid">;
1510
```
1611

1712
Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:43](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L43)
1813

1914
Form defaults that do not participate in form value inference.
2015

21-
This type is limited to `formId`, `errorVisibility`, `listeners`,
22-
`serverState`, and `onSubmitInvalid`. Callback contexts expose form values
23-
as `unknown`, so value-dependent behavior remains local to `useAppForm`.
24-
Options passed to `useAppForm` override these defaults, including when an
25-
option is explicitly `undefined`.
16+
This type is limited to `formId`, `errorVisibility`, `listeners`, and
17+
`onSubmitInvalid`. Callback contexts expose form values as `unknown`, so
18+
value-dependent behavior remains local to `useAppForm`. Options passed to
19+
`useAppForm` override these defaults, including when an option is explicitly
20+
`undefined`.
2621

2722
## Example
2823

0 commit comments

Comments
 (0)