You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/fieldApi.md
+39-15Lines changed: 39 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: Field API
5
5
6
6
### Creating a new FieldApi Instance
7
7
8
-
> Some of these docs may be inaccurate due to an API shift in `0.11.0`. If you're interested in helping us fix these issues, please [join our Discord](https://tlinz.com/discord) and reach out in the `#form` channel.
8
+
9
9
10
10
Normally, you will not need to create a new `FieldApi` instance directly. Instead, you will use a framework hook/function like `useField` or `createField` to create a new instance for you that utilizes your frameworks reactivity model. However, if you need to create a new instance manually, you can do so by calling the `new FieldApi` constructor.
11
11
@@ -26,33 +26,57 @@ An object type representing the options for a field in a form.
26
26
```
27
27
- An optional default value for the field.
28
28
-```tsx
29
-
form?:FormApi<TFormData>
29
+
defaultMeta?:Partial<FieldMeta>
30
30
```
31
-
- An optional reference to the form API instance.
31
+
- An optional object with default metadata for the field.
0 commit comments