Skip to content

Commit 7b34289

Browse files
committed
Added docs for hideField props.
1 parent da6cb1d commit 7b34289

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

packages/react-renderer-demo/src/docs-components/component-api.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ import ExampleLink from './component-api/exampleLink';
33

44
### Components API
55

6+
### Common props for all form fields
7+
8+
There is very short list of that can be applied to every form field
9+
10+
|Prop|Type|Description|
11+
|----|:--:|----------:|
12+
|name|string|Unique field identifier. Value of this field will be under same key|
13+
|component|string|Component identifier from formFieldsMapper. Rendered component is chosen by this value|
14+
|hideField|boolean|Equivalent to html attribute `hidden`. Hides the field but it remains in DOM. Note that the field is still impacted by the form state. Validation will still apply on hidden field but the error message will not be displayed.|
15+
616
Each mapper provided in `react-forms` provides a default API for standard components. Standard components are:
717
<br />
818

0 commit comments

Comments
 (0)