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: packages/react-renderer-demo/src/app/pages/renderer/component-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ All those components provides a shared group of props:
53
53
|isRequired|boolean|Is the field required?|
54
54
|isDisabled|boolean|Is the field disabled?|
55
55
|isReadOnly|boolean|Is the field readOnly?|
56
-
|initialValue|custom|There are two ways how to set initial values in the form: you can use either the <RouterLinkhref="/renderer/renderer-api"><Link>initialValues</Link></RouterLink> prop for the whole form or you can set the value in the schema for each field separately. For more information, please see [here](https://final-form.org/docs/react-final-form/types/FieldProps#initialvalue).|
56
+
|initialValue|custom|There are two ways how to set initial values in the form: you can use either the <RouterLinkhref="/renderer/renderer-api"><Linkhref="/renderer/renderer-api">initialValues</Link></RouterLink> prop for the whole form or you can set the value in the schema for each field separately. For more information, please see [here](https://final-form.org/docs/react-final-form/types/FieldProps#initialvalue).|
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/app/pages/renderer/field-array.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
@@ -10,7 +10,7 @@ import ListOfContents from '../../src/helpers/list-of-contents';
10
10
11
11
# Field Array Provider
12
12
13
-
Simillarly to <RouterLinkhref='/renderer/field-provider'><Link>FieldProvider</Link></RouterLink> Data driven forms provide an option how to inlude <ahref='https://github.com/final-form/react-final-form-arrays'>React Final Form Arrays</a> in your form.
13
+
Simillarly to <RouterLinkhref='/renderer/field-provider'><Linkhref='/renderer/field-provider'>FieldProvider</Link></RouterLink> Data driven forms provide an option how to inlude <ahref='https://github.com/final-form/react-final-form-arrays'>React Final Form Arrays</a> in your form.
14
14
15
15
<b>Please visit their documentation to learn about functionality.</b>
16
16
@@ -56,7 +56,7 @@ You don't need to name the nested components, then the values are saved as an ar
56
56
57
57
# Validators
58
58
59
-
You can use user a few provided validators (you can also use your <RouterLinkhref='/renderer/validators'><Link>own</Link></RouterLink>.)
59
+
You can use user a few provided validators (you can also use your <RouterLinkhref='/renderer/validators'><Linkhref='/renderer/validators'>own</Link></RouterLink>.)
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/app/pages/renderer/field-provider.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
@@ -23,11 +23,11 @@ which adds additional methods that will help you to control your form state.
23
23
# Accessing FieldProvider
24
24
25
25
To use Fieldprovider, you first need to register a component to your component mapper.
26
-
You can read more about that in <RouterNavhref="/renderer/component-mapping"><Link>Component mapping</Link></RouterNav>.
26
+
You can read more about that in <RouterNavhref="/renderer/component-mapping"><Linkhref="/renderer/component-mapping">Component mapping</Link></RouterNav>.
27
27
28
28
Each component will receive FieldProvider as a prop. Be aware that pre-defined component types are
29
29
automatically wrapped in FieldProvider. This is done to make it easier to create component mappers for
30
-
standard form components. List of standard components is available <RouterNavhref="/renderer/component-api"><Link>here</Link></RouterNav>.
30
+
standard form components. List of standard components is available <RouterNavhref="/renderer/component-api"><Linkhref="/renderer/component-api">here</Link></RouterNav>.
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/app/pages/renderer/initialize-mount.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Data Driven Forms provides a way how you can easily initialized a field when the
14
14
15
15
Just pass a `initializeOnMount` prop and set it to `true`.
16
16
17
-
The field will use the `initialValue` set in the schema (<RouterLinkhref="/renderer/component-api#formgroupwrappedcomponents"><Link>initialValue</Link></RouterLink>) or in the renderer (<RouterLinkhref="/renderer/renderer-api#optionalprops"><Link>initialValues</Link></RouterLink>).
17
+
The field will use the `initialValue` set in the schema (<RouterLinkhref="/renderer/component-api#formgroupwrappedcomponents"><Linkhref="/renderer/component-api#formgroupwrappedcomponents">initialValue</Link></RouterLink>) or in the renderer (<RouterLinkhref="/renderer/renderer-api#optionalprops"><Linkhref="/renderer/renderer-api#optionalprops">initialValues</Link></RouterLink>).
18
18
19
19
`initialValue` has higher priority than a value from `initialValues`.
20
20
@@ -32,13 +32,13 @@ The field will use the `initialValue` set in the schema (<RouterLink href="/rend
32
32
33
33
## When to use it?
34
34
35
-
This feature comes handy if you need change a value when an user traverses a form, which shows and hides fields, and the value is not set by the user. Very useful case is used it wizard forms, where you can set different value for the same input according the way the user went in the wizard form by using this option combined with <RouterLinkhref="/renderer/component-api#commonpropsforallformfields"><Link>hideField</Link></RouterLink> prop.
35
+
This feature comes handy if you need change a value when an user traverses a form, which shows and hides fields, and the value is not set by the user. Very useful case is used it wizard forms, where you can set different value for the same input according the way the user went in the wizard form by using this option combined with <RouterLinkhref="/renderer/component-api#commonpropsforallformfields"><Linkhref="/renderer/component-api#commonpropsforallformfields">hideField</Link></RouterLink> prop.
36
36
37
37
<RawComponentsource="initialize-mount" />
38
38
39
39
## Clear the value
40
40
41
-
If you need clear the value after unmounting, you can do it by using <RouterLinkhref="/renderer/unmounting"><Link>clearOnUnmount</Link></RouterLink>.
41
+
If you need clear the value after unmounting, you can do it by using <RouterLinkhref="/renderer/unmounting"><Linkhref="/renderer/unmounting">clearOnUnmount</Link></RouterLink>.
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/app/pages/renderer/renderer-api.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ Form Renderer provides a lot of customization via props.
16
16
17
17
|Prop|Type|Description|
18
18
|----|:--:|----------:|
19
-
|<RouterLinkhref="/renderer/component-mapping"><Link>formFieldsMapper</Link></RouterLink>|object|Defines types of form field components. Field components can change the state of the form.|
20
-
|<RouterLinkhref="/renderer/component-mapping"><Link>layoutMapper</Link></RouterLink>|object|Defines types of layout components, which can't change the state of the form.|
19
+
|<RouterLinkhref="/renderer/component-mapping"><Linkhref="/renderer/component-mapping">formFieldsMapper</Link></RouterLink>|object|Defines types of form field components. Field components can change the state of the form.|
20
+
|<RouterLinkhref="/renderer/component-mapping"><Linkhref="/renderer/component-mapping">layoutMapper</Link></RouterLink>|object|Defines types of layout components, which can't change the state of the form.|
21
21
|onSubmit|func|A submit callback which receives two arguments: `values` and `formApi`.|
22
22
|schema|object|A schema which defines structure of the form.|
23
23
@@ -28,8 +28,8 @@ Form Renderer provides a lot of customization via props.
28
28
|buttonClassName|string|Class which will be given to the buttons wrapper.|{ }|
29
29
|buttonsLabels|object|You can specify custom labels for all three form buttons.|`{submit: 'Submit', cancel: 'Cancel', reset: 'Reset'}`|
30
30
|buttonOrder|array of strings|You can specify the order of the form buttons.|`[ 'submit', 'reset', 'cancel' ]`|
31
-
|<RouterLinkhref="/renderer/form-controls"><Link>renderFormButtons</Link></RouterLink>|one of `[node, element, func]`|You can provide your own form buttons component. This component will receive all needed props.||
32
-
|<RouterLinkhref="/renderer/unmounting"><Link>clearOnUnmount</Link></RouterLink>|bool|Will clear values of unmounted components. You can also set this to specific component in the form schema.|false|
31
+
|<RouterLinkhref="/renderer/form-controls"><Linkhref="/renderer/form-controls">renderFormButtons</Link></RouterLink>|one of `[node, element, func]`|You can provide your own form buttons component. This component will receive all needed props.||
32
+
|<RouterLinkhref="/renderer/unmounting"><Linkhref="/renderer/unmounting">clearOnUnmount</Link></RouterLink>|bool|Will clear values of unmounted components. You can also set this to specific component in the form schema.|false|
33
33
|canReset|bool|Show/hide reset button.|false|
34
34
|onReset|func|A reset callback. You don't need to manually clear the form values!||
35
35
|onCancel|func|A cancel callback, which receives `values` as the first argument.||
@@ -40,17 +40,17 @@ Form Renderer provides a lot of customization via props.
40
40
|showFormControls|bool|You can disable showing form buttons. Use it with wizard component which has its own buttons.|true|
41
41
|subscription|object|You can pass your own [subscription](https://final-form.org/docs/react-final-form/types/FormProps#subscription), which will be added to default settings.|`{ pristine: true, submitting: true, valid: true }`|
42
42
|uiSchema|object|Use when you need to use mozilla schema.|{ }|
43
-
|<RouterLinkhref="/renderer/validators"><Link>validate</Link></RouterLink>|func|A function which receives all form values and returns an object with errors.||
43
+
|<RouterLinkhref="/renderer/validators"><Linkhref="/renderer/validators">validate</Link></RouterLink>|func|A function which receives all form values and returns an object with errors.||
44
44
45
45
# Schema
46
46
47
-
The root object of the schema represents the <RouterLinkhref="/renderer/component-mapping#formwrapper"><Link>Form</Link></RouterLink> component, which accepts only these three props:
47
+
The root object of the schema represents the <RouterLinkhref="/renderer/component-mapping#formwrapper"><Linkhref="/renderer/component-mapping#formwrapper">Form</Link></RouterLink> component, which accepts only these three props:
48
48
49
49
|Prop|Type|Description|
50
50
|----|:--:|----------:|
51
-
|label, title|node|<RouterLinkhref="/renderer/component-mapping#title"><Link>Title</Link></RouterLink> of the form. Optional.|
52
-
|description|node|<RouterLinkhref="/renderer/component-mapping#description"><Link>Description</Link></RouterLink> of the form. Optional.|
53
-
|fields|array of objects|<RouterLinkhref="/renderer/component-api"><Link>Components</Link></RouterLink> of the form. Required!|
51
+
|label, title|node|<RouterLinkhref="/renderer/component-mapping#title"><Linkhref="/renderer/component-mapping#title">Title</Link></RouterLink> of the form. Optional.|
52
+
|description|node|<RouterLinkhref="/renderer/component-mapping#description"><Linkhref="/renderer/component-mapping#description">Description</Link></RouterLink> of the form. Optional.|
53
+
|fields|array of objects|<RouterLinkhref="/renderer/component-api"><Linkhref="/renderer/component-api">Components</Link></RouterLink> of the form. Required!|
0 commit comments