Skip to content

Commit 6694711

Browse files
committed
Remove formGroup from componentsApi
and add plain-text
1 parent 45ff1cc commit 6694711

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

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

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,19 @@ Each mapper provided in `react-forms` provides a default API for standard compon
2323
Standard components are:
2424
<br />
2525

26-
Wrapped in formGroup: <br/>
27-
&nbsp;&nbsp;text field <br/>
28-
&nbsp;&nbsp;text area <br/>
29-
&nbsp;&nbsp;select <br/>
30-
&nbsp;&nbsp;checkbox <br/>
31-
&nbsp;&nbsp;radio <br/>
32-
&nbsp;&nbsp;switch <br/>
33-
&nbsp;&nbsp;timepicker/datepicker <br/>
34-
<br />
35-
36-
Others: <br/>
37-
&nbsp;&nbsp;subform <br/>
38-
&nbsp;&nbsp;tab/tab item <br/>
39-
&nbsp;&nbsp;wizard <br/>
26+
|Change form state (input fields)|Others|
27+
|---------------------------------------|------|
28+
|text field|subform|
29+
|textarea|tabs/tab item|
30+
|select|wizard|
31+
|checkbox|plain text|
32+
|radio|
33+
|switch|
34+
|timepicker/datepicker|
4035

41-
# FormGroup wrapped components
36+
# Form fields components
4237

43-
Basic components are wrapped in formGroup. FormGroup provides a standard API to show labels, helper texts, errors, etc.
44-
45-
All those components provides a shared group of props:
38+
Basic components that can change the form state (inputs) share common props. These components are using [useFieldApi](/renderer/component-mapping#usefieldapi) or [FieldProvider](/renderer/component-mapping#fieldprovider) to access the form state.
4639

4740
|Prop|Type|Description|
4841
|----|:--:|----------:|
@@ -190,6 +183,15 @@ Wizard step <br/>
190183

191184
<ExampleLink to='wizard' />
192185

186+
## Plain text
187+
188+
|Prop|Type|Description|
189+
|----|:--:|----------:|
190+
|label|node/string|A text|
191+
|variant|string|A variant (depends on mappers: html tags)|
192+
193+
<ExampleLink to='plain-text' />
194+
193195
</Grid>
194196
<Grid item xs={false} md={2}>
195197
<ListOfContents file="renderer/component-api" />

0 commit comments

Comments
 (0)