Skip to content

Commit e3dcc62

Browse files
authored
Merge pull request #274 from data-driven-forms/added-links-docs
Added missing href tags to docs link to improve search.
2 parents cf5b39b + db4996f commit e3dcc62

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

packages/react-renderer-demo/src/app/pages/renderer/component-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ All those components provides a shared group of props:
5353
|isRequired|boolean|Is the field required?|
5454
|isDisabled|boolean|Is the field disabled?|
5555
|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 <RouterLink href="/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 <RouterLink href="/renderer/renderer-api"><Link href="/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).|
5757

5858
## Text field
5959

packages/react-renderer-demo/src/app/pages/renderer/condition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ condition: {
177177

178178
## Clearing values
179179

180-
If you need to clear values after switching fields, please see <Link href="/renderer/unmounting"><a>here</a></Link>.
180+
If you need to clear values after switching fields, please see <Link href="/renderer/unmounting"><a href="/renderer/unmounting">here</a></Link>.
181181

182182
</Grid>
183183
<Grid item xs={false} md={2}>

packages/react-renderer-demo/src/app/pages/renderer/field-array.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import ListOfContents from '../../src/helpers/list-of-contents';
1010

1111
# Field Array Provider
1212

13-
Simillarly to <RouterLink href='/renderer/field-provider'><Link>FieldProvider</Link></RouterLink> Data driven forms provide an option how to inlude <a href='https://github.com/final-form/react-final-form-arrays'>React Final Form Arrays</a> in your form.
13+
Simillarly to <RouterLink href='/renderer/field-provider'><Link href='/renderer/field-provider'>FieldProvider</Link></RouterLink> Data driven forms provide an option how to inlude <a href='https://github.com/final-form/react-final-form-arrays'>React Final Form Arrays</a> in your form.
1414

1515
<b>Please visit their documentation to learn about functionality.</b>
1616

@@ -56,7 +56,7 @@ You don't need to name the nested components, then the values are saved as an ar
5656

5757
# Validators
5858

59-
You can use user a few provided validators (you can also use your <RouterLink href='/renderer/validators'><Link>own</Link></RouterLink>.)
59+
You can use user a few provided validators (you can also use your <RouterLink href='/renderer/validators'><Link href='/renderer/validators'>own</Link></RouterLink>.)
6060

6161
```jsx
6262
MIN_ITEMS_VALIDATOR: ({threshold})

packages/react-renderer-demo/src/app/pages/renderer/field-provider.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ which adds additional methods that will help you to control your form state.
2323
# Accessing FieldProvider
2424

2525
To use Fieldprovider, you first need to register a component to your component mapper.
26-
You can read more about that in <RouterNav href="/renderer/component-mapping"><Link>Component mapping</Link></RouterNav>.
26+
You can read more about that in <RouterNav href="/renderer/component-mapping"><Link href="/renderer/component-mapping">Component mapping</Link></RouterNav>.
2727

2828
Each component will receive FieldProvider as a prop. Be aware that pre-defined component types are
2929
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 <RouterNav href="/renderer/component-api"><Link>here</Link></RouterNav>.
30+
standard form components. List of standard components is available <RouterNav href="/renderer/component-api"><Link href="/renderer/component-api">here</Link></RouterNav>.
3131

3232
# Using FieldProvider
3333

packages/react-renderer-demo/src/app/pages/renderer/initialize-mount.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Data Driven Forms provides a way how you can easily initialized a field when the
1414

1515
Just pass a `initializeOnMount` prop and set it to `true`.
1616

17-
The field will use the `initialValue` set in the schema (<RouterLink href="/renderer/component-api#formgroupwrappedcomponents"><Link>initialValue</Link></RouterLink>) or in the renderer (<RouterLink href="/renderer/renderer-api#optionalprops"><Link>initialValues</Link></RouterLink>).
17+
The field will use the `initialValue` set in the schema (<RouterLink href="/renderer/component-api#formgroupwrappedcomponents"><Link href="/renderer/component-api#formgroupwrappedcomponents">initialValue</Link></RouterLink>) or in the renderer (<RouterLink href="/renderer/renderer-api#optionalprops"><Link href="/renderer/renderer-api#optionalprops">initialValues</Link></RouterLink>).
1818

1919
`initialValue` has higher priority than a value from `initialValues`.
2020

@@ -32,13 +32,13 @@ The field will use the `initialValue` set in the schema (<RouterLink href="/rend
3232

3333
## When to use it?
3434

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 <RouterLink href="/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 <RouterLink href="/renderer/component-api#commonpropsforallformfields"><Link href="/renderer/component-api#commonpropsforallformfields">hideField</Link></RouterLink> prop.
3636

3737
<RawComponent source="initialize-mount" />
3838

3939
## Clear the value
4040

41-
If you need clear the value after unmounting, you can do it by using <RouterLink href="/renderer/unmounting"><Link>clearOnUnmount</Link></RouterLink>.
41+
If you need clear the value after unmounting, you can do it by using <RouterLink href="/renderer/unmounting"><Link href="/renderer/unmounting">clearOnUnmount</Link></RouterLink>.
4242

4343
</Grid>
4444
<Grid item xs={false} md={2}>

packages/react-renderer-demo/src/app/pages/renderer/renderer-api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Form Renderer provides a lot of customization via props.
1616

1717
|Prop|Type|Description|
1818
|----|:--:|----------:|
19-
|<RouterLink href="/renderer/component-mapping"><Link>formFieldsMapper</Link></RouterLink>|object|Defines types of form field components. Field components can change the state of the form.|
20-
|<RouterLink href="/renderer/component-mapping"><Link>layoutMapper</Link></RouterLink>|object|Defines types of layout components, which can't change the state of the form.|
19+
|<RouterLink href="/renderer/component-mapping"><Link href="/renderer/component-mapping">formFieldsMapper</Link></RouterLink>|object|Defines types of form field components. Field components can change the state of the form.|
20+
|<RouterLink href="/renderer/component-mapping"><Link href="/renderer/component-mapping">layoutMapper</Link></RouterLink>|object|Defines types of layout components, which can't change the state of the form.|
2121
|onSubmit|func|A submit callback which receives two arguments: `values` and `formApi`.|
2222
|schema|object|A schema which defines structure of the form.|
2323

@@ -28,8 +28,8 @@ Form Renderer provides a lot of customization via props.
2828
|buttonClassName|string|Class which will be given to the buttons wrapper.|{ }|
2929
|buttonsLabels|object|You can specify custom labels for all three form buttons.|`{submit: 'Submit', cancel: 'Cancel', reset: 'Reset'}`|
3030
|buttonOrder|array of strings|You can specify the order of the form buttons.|`[ 'submit', 'reset', 'cancel' ]`|
31-
|<RouterLink href="/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-
|<RouterLink href="/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+
|<RouterLink href="/renderer/form-controls"><Link href="/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+
|<RouterLink href="/renderer/unmounting"><Link href="/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|
3333
|canReset|bool|Show/hide reset button.|false|
3434
|onReset|func|A reset callback. You don't need to manually clear the form values!||
3535
|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.
4040
|showFormControls|bool|You can disable showing form buttons. Use it with wizard component which has its own buttons.|true|
4141
|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 }`|
4242
|uiSchema|object|Use when you need to use mozilla schema.|{ }|
43-
|<RouterLink href="/renderer/validators"><Link>validate</Link></RouterLink>|func|A function which receives all form values and returns an object with errors.||
43+
|<RouterLink href="/renderer/validators"><Link href="/renderer/validators">validate</Link></RouterLink>|func|A function which receives all form values and returns an object with errors.||
4444

4545
# Schema
4646

47-
The root object of the schema represents the <RouterLink href="/renderer/component-mapping#formwrapper"><Link>Form</Link></RouterLink> component, which accepts only these three props:
47+
The root object of the schema represents the <RouterLink href="/renderer/component-mapping#formwrapper"><Link href="/renderer/component-mapping#formwrapper">Form</Link></RouterLink> component, which accepts only these three props:
4848

4949
|Prop|Type|Description|
5050
|----|:--:|----------:|
51-
|label, title|node|<RouterLink href="/renderer/component-mapping#title"><Link>Title</Link></RouterLink> of the form. Optional.|
52-
|description|node|<RouterLink href="/renderer/component-mapping#description"><Link>Description</Link></RouterLink> of the form. Optional.|
53-
|fields|array of objects|<RouterLink href="/renderer/component-api"><Link>Components</Link></RouterLink> of the form. Required!|
51+
|label, title|node|<RouterLink href="/renderer/component-mapping#title"><Link href="/renderer/component-mapping#title">Title</Link></RouterLink> of the form. Optional.|
52+
|description|node|<RouterLink href="/renderer/component-mapping#description"><Link href="/renderer/component-mapping#description">Description</Link></RouterLink> of the form. Optional.|
53+
|fields|array of objects|<RouterLink href="/renderer/component-api"><Link href="/renderer/component-api">Components</Link></RouterLink> of the form. Required!|
5454

5555
## Example
5656

0 commit comments

Comments
 (0)