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
Input is an object which contains field values and methods that change form state. See the selection of most important attributes:
62
65
@@ -72,10 +75,10 @@ Input is an object which contains field values and methods that change form stat
72
75
73
76
Every user interaction that updates field value in form state should also call `input.onChange` with correct value.
74
77
75
-
### Meta
78
+
####Meta
76
79
77
80
Meta is a object which contains meta information about field with given name. There is a lot of information about every field.
78
-
[Full list is here](https://github.com/final-form/react-final-form#metaactive-boolean). These are commonly used meta informations
81
+
[Full list is here](https://final-form.org/docs/react-final-form/types/FieldRenderProps#metaactive). These are commonly used meta informations
79
82
```jsx
80
83
{
81
84
error: any, // whatever your validation function returns
@@ -86,7 +89,7 @@ Meta is a object which contains meta information about field with given name. Th
86
89
}
87
90
```
88
91
89
-
## FormOptions
92
+
###FormOptions
90
93
91
94
In addition to FieldProvider, every component will also receive prop `formOptions`.
92
95
This property contains a number of useful methods and attributes that will give you additional level of control
@@ -99,7 +102,7 @@ and informations about the formState.
99
102
focus: (name) =>void, // calls onFocus event on field with given name
100
103
getFieldState: (name) => object, // returns a state of given field, state contains input and meta information of field
101
104
getRegisteredFields: () => string[], // returns an array of field names that are rendered in DOM
102
-
getState: () => object, // returns an object with whole form state. More info https://github.com/final-form/final-form#formstate
105
+
getState: () => object, // returns an object with whole form state. More info https://final-form.org/docs/final-form/types/FormState
103
106
pristine: bool, // true if the all field values is === to the initial values, false if the values are !==.
104
107
renderForm: (defaultSchema) =>void, // function that is used by form renderer to render form fields defined by defaultSchema; can be used for schema nesting
105
108
valid: bool //true if all fields have no validation or submission errors. false otherwise.
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/docs-components/form-controls.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ If you need completely customized buttons, you can pass a component to form rend
8
8
9
9
#### Form Buttons render props
10
10
11
-
Your component will receive same props as provided by react-final-form FormSpy component. For most use cases you will need just a few of these which are listed below. If you require full list please visit [react-final-form documentation](https://github.com/final-form/final-form#formstate).
11
+
Your component will receive same props as provided by react-final-form FormSpy component. For most use cases you will need just a few of these which are listed below. If you require full list please visit [react-final-form documentation](https://final-form.org/docs/final-form/types/FormState).
12
12
13
13
|Prop|Type|Description|
14
14
|----|----|-----------|
@@ -19,4 +19,4 @@ Your component will receive same props as provided by react-final-form FormSpy c
19
19
|valid|bool|`true` if neither the form nor any of its fields has a validation or submission error.|
20
20
|validating|bool|`true` true if the form is currently being validated asynchronously.|
21
21
|values|object|The current values of the form.|
22
-
|form|object|reat final form [FormApi](https://github.com/final-form/final-form#formapi).|
22
+
|form|object|react final form [FormApi](https://final-form.org/docs/final-form/types/FormApi).|
0 commit comments