Skip to content

Commit 1efc465

Browse files
rvsiarvsia
committed
Update readme
- add missing mappers to the list of mappers - add links for components - fix some typos
1 parent 1959042 commit 1efc465

File tree

11 files changed

+203
-152
lines changed

11 files changed

+203
-152
lines changed

‎README.md‎

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Data Driven Forms is a React library used for rendering and managing forms with
4141
- [BlueprintJS Mapper](#blueprintjs-mapper)
4242
- [Semantic UI Mapper](#semantic-ui-mapper)
4343
- [Ant Design Mapper](#ant-design-mapper)
44+
- [Carbon Mapper](#carbon-mapper)
4445
- [Usage](#usage)
4546
- [Custom mapper](#custom-mapper)
4647
- [Basic provided components](#basic-provided-components)
@@ -130,6 +131,16 @@ $ npm install @data-driven-forms/ant-component-mapper -S
130131
$ yarn add @data-driven-forms/ant-component-mapper
131132
```
132133

134+
#### [Carbon Mapper](https://data-driven-forms.org/mappers/carbon-component-mapper)
135+
136+
```console
137+
$ npm install @data-driven-forms/carbon-component-mapper -S
138+
```
139+
140+
```console
141+
$ yarn add @data-driven-forms/carbon-component-mapper
142+
```
143+
133144
Component libraries in mappers are external dependencies. Make sure to install them and their styles in your bundles.
134145

135146
### Usage
@@ -201,20 +212,21 @@ Mappers can be also generated by using `yarn generate-template` [command](https:
201212

202213
Data Driven Forms supports all kinds of component, basic set is consisted of:
203214

204-
- Text input
205-
- Text area
206-
- Checkbox (Multiple checkboxes)
207-
- Select (dropdown)
208-
- Dual list select
209-
- Field array
210-
- Switch
211-
- Radio buttons
212-
- Date picker
213-
- Time picker
214-
- Tabs
215-
- Slider
216-
- Sub-form
217-
- Wizard
215+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=mui)
216+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=mui)
217+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=mui) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=mui))
218+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=mui)
219+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=mui)
220+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=mui)
221+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=mui)
222+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=mui)
223+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=mui)
224+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=mui)
225+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=mui)
226+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=mui)
227+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=mui)
228+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=mui)
229+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=mui)
218230

219231
Any other components can be added to mapper and renderer with the form renderer. Existing components can be also overriden.
220232

@@ -231,6 +243,7 @@ Please use our [documentation site](https://data-driven-forms.org/). In case of
231243
- [Ant Design documentation](https://ant.design/)
232244
- [Semantic UI React](https://react.semantic-ui.com/)
233245
- [BlueprintJS](https://blueprintjs.com/)
246+
- [IBM Carbon](https://www.carbondesignsystem.com/)
234247
- NPM
235248
- [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
236249
- [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
@@ -239,8 +252,7 @@ Please use our [documentation site](https://data-driven-forms.org/). In case of
239252
- [Ant Design Mapper](https://www.npmjs.com/package/@data-driven-forms/ant-component-mapper)
240253
- [Semantic UI Mapper](https://www.npmjs.com/package/@data-driven-forms/suir-component-mapper)
241254
- [BlueprintJS Mapper](https://www.npmjs.com/package/@data-driven-forms/blueprint-component-mapper)
242-
- Examples of schemas (PatternFly 3)
243-
- [ManageIQ Form Components](https://github.com/ManageIQ/manageiq-ui-classic/tree/master/app/javascript/components)
255+
- [Carbon Mapper](https://www.npmjs.com/package/@data-driven-forms/carbon-component-mapper)
244256

245257
### Development setup
246258

‎packages/ant-component-mapper/README.md‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Material-UI component mapper for [Data Driven Forms](https://github.com/data-dri
2525

2626
### Installation
2727

28-
You neet to add React Form Renderer
28+
You need to add React Form Renderer
2929

3030
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
3131

@@ -81,18 +81,21 @@ const Form = () => (
8181

8282
Data Driven Forms supports all kinds of component, basic set is consisted of:
8383

84-
- Text input
85-
- Text area
86-
- Checkbox (Multiple checkboxes)
87-
- Select (dropdown)
88-
- Switch
89-
- Radio buttons
90-
- Date picker
91-
- Time picker
92-
- Tabs
93-
- Sub-form
94-
- Wizard
95-
- Plain-text
84+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=ant)
85+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=ant)
86+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=ant) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=ant))
87+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=ant)
88+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=ant)
89+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=ant)
90+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=ant)
91+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=ant)
92+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=ant)
93+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=ant)
94+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=ant)
95+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=ant)
96+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=ant)
97+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=ant)
98+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=ant)
9699

97100
### Useful links
98101

‎packages/blueprint-component-mapper/README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Blueprint component mapper for [Data Driven Forms](https://github.com/data-drive
2525

2626
### Installation
2727

28-
You neet to add React Form Renderer
28+
You need to add React Form Renderer
2929

3030
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
3131

@@ -79,20 +79,21 @@ const Form = () => (
7979

8080
Data Driven Forms supports all kinds of component, basic set is consisted of:
8181

82-
- Text input
83-
- Text area
84-
- Checkbox (Multiple checkboxes)
85-
- Select (dropdown)
86-
- Dual list select
87-
- Field array
88-
- Switch
89-
- Radio buttons
90-
- Date picker
91-
- Time picker
92-
- Tabs
93-
- Slider
94-
- Sub-form
95-
- Wizard
82+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=blueprint)
83+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=blueprint)
84+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=blueprint) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=blueprint))
85+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=blueprint)
86+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=blueprint)
87+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=blueprint)
88+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=blueprint)
89+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=blueprint)
90+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=blueprint)
91+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=blueprint)
92+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=blueprint)
93+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=blueprint)
94+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=blueprint)
95+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=blueprint)
96+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=blueprint)
9697

9798
### Useful links
9899

‎packages/carbon-component-mapper/README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Carbon component mapper for [Data Driven Forms](https://github.com/data-driven-f
2525

2626
### Installation
2727

28-
You neet to add React Form Renderer
28+
You need to add React Form Renderer
2929

3030
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
3131

@@ -79,20 +79,21 @@ const Form = () => (
7979

8080
Data Driven Forms supports all kinds of component, basic set is consisted of:
8181

82-
- Text input
83-
- Text area
84-
- Checkbox (Multiple checkboxes)
85-
- Select (dropdown)
86-
- Dual list select
87-
- Field array
88-
- Switch
89-
- Radio buttons
90-
- Date picker
91-
- Time picker
92-
- Tabs
93-
- Slider
94-
- Sub-form
95-
- Wizard
82+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=carbon)
83+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=carbon)
84+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=carbon) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=carbon))
85+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=carbon)
86+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=carbon)
87+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=carbon)
88+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=carbon)
89+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=carbon)
90+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=carbon)
91+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=carbon)
92+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=carbon)
93+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=carbon)
94+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=carbon)
95+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=carbon)
96+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=carbon)
9697

9798
### Useful links
9899

‎packages/mui-component-mapper/README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Material-UI component mapper for [Data Driven Forms](https://github.com/data-dri
2828

2929
### Installation
3030

31-
You neet to add React Form Renderer
31+
You need to add React Form Renderer
3232

3333
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
3434

@@ -82,20 +82,21 @@ const Form = () => (
8282

8383
Data Driven Forms supports all kinds of component, basic set is consisted of:
8484

85-
- Text input
86-
- Text area
87-
- Checkbox (Multiple checkboxes)
88-
- Select (dropdown)
89-
- Dual list select
90-
- Field array
91-
- Switch
92-
- Radio buttons
93-
- Date picker
94-
- Time picker
95-
- Tabs
96-
- Slider
97-
- Sub-form
98-
- Wizard
85+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=mui)
86+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=mui)
87+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=mui) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=mui))
88+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=mui)
89+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=mui)
90+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=mui)
91+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=mui)
92+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=mui)
93+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=mui)
94+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=mui)
95+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=mui)
96+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=mui)
97+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=mui)
98+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=mui)
99+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=mui)
99100

100101
### Useful links
101102

‎packages/parsers/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Parsers for [Data Driven Forms](https://github.com/data-driven-forms/react-forms
88

99
:book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
1010

11-
Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
12-
1311
**Table of Contents**
1412

1513
- [Installation](#installation)

‎packages/pf3-component-mapper/README.md‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Patternfly 3 component mapper for [Data Driven Forms](https://github.com/data-dr
2525

2626
### Installation
2727

28-
You neet to add React Form Renderer
28+
You need to add React Form Renderer
2929

3030
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
3131

@@ -79,18 +79,21 @@ const Form = () => (
7979

8080
Data Driven Forms supports all kinds of component, basic set is consisted of:
8181

82-
- Text input
83-
- Text area
84-
- Checkbox (Multiple checkboxes)
85-
- Select (dropdown)
86-
- Switch
87-
- Radio buttons
88-
- Date picker
89-
- Time picker
90-
- Tabs
91-
- Slider
92-
- Sub-form
93-
- Wizard
82+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=pf3)
83+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=pf3)
84+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=pf3) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=pf3))
85+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=pf3)
86+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=pf3)
87+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=pf3)
88+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=pf3)
89+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=pf3)
90+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=pf3)
91+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=pf3)
92+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=pf3)
93+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=pf3)
94+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=pf3)
95+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=pf3)
96+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=pf3)
9497

9598
### Useful links
9699

‎packages/pf4-component-mapper/README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Patternfly 4 component mapper for [Data Driven Forms](https://github.com/data-dr
2525

2626
### Installation
2727

28-
You neet to add React Form Renderer
28+
You need to add React Form Renderer
2929

3030

3131
#### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
@@ -80,20 +80,21 @@ const Form = () => (
8080

8181
Data Driven Forms supports all kinds of component, basic set is consisted of:
8282

83-
- Text input
84-
- Text area
85-
- Checkbox (Multiple checkboxes)
86-
- Select (dropdown)
87-
- Dual list select
88-
- Field array
89-
- Switch
90-
- Radio buttons
91-
- Date picker
92-
- Time picker
93-
- Tabs
94-
- Slider
95-
- Sub-form
96-
- Wizard
83+
- [Text input](https://data-driven-forms.org/mappers/text-field?mapper=pf4)
84+
- [Text area](https://data-driven-forms.org/mappers/textarea?mapper=pf4)
85+
- [Checkbox](https://data-driven-forms.org/mappers/checkbox?mapper=pf4) ([Multiple checkboxes](https://data-driven-forms.org/mappers/checkbox-multiple?mapper=pf4))
86+
- [Select (dropdown)](https://data-driven-forms.org/mappers/select?mapper=pf4)
87+
- [Dual list select](https://data-driven-forms.org/mappers/dual-list-select?mapper=pf4)
88+
- [Field array](https://data-driven-forms.org/mappers/field-array?mapper=pf4)
89+
- [Switch](https://data-driven-forms.org/mappers/switch?mapper=pf4)
90+
- [Radio buttons](https://data-driven-forms.org/mappers/radio?mapper=pf4)
91+
- [Date picker](https://data-driven-forms.org/mappers/date-picker?mapper=pf4)
92+
- [Time picker](https://data-driven-forms.org/mappers/time-picker?mapper=pf4)
93+
- [Tabs](https://data-driven-forms.org/mappers/tabs?mapper=pf4)
94+
- [Slider](https://data-driven-forms.org/mappers/slider?mapper=pf4)
95+
- [Sub-form](https://data-driven-forms.org/mappers/sub-form?mapper=pf4)
96+
- [Plain text](https://data-driven-forms.org/mappers/plain-text?mapper=pf4)
97+
- [Wizard](https://data-driven-forms.org/mappers/wizard?mapper=pf4)
9798

9899
### Useful links
99100

0 commit comments

Comments
 (0)