Update packages readme files.

Hyperkid123 · Hyperkid123 · commit 1b29dc771064 · 2020-05-22T09:51:42.000+02:00
diff --git a/README.md b/README.md
@@ -29,8 +29,6 @@ Data Driven Forms is a React library used for rendering and managing forms with
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
-
 **Table of Contents**
 
 - [Installation](#installation)
@@ -51,7 +49,7 @@ Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
 
 ### Installation
 
-You neet to add React Form Renderer
+Add React Form Renderer
 
 #### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
 
@@ -65,39 +63,42 @@ $ yarn add @data-driven-forms/react-form-renderer
 
 Optionally you can install one of provided mappers:
 
-#### [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
+
+#### [Material-UI Mapper](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/pf3-component-mapper -S
+$ npm install @data-driven-forms/mui-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/pf3-component-mapper
+$ yarn add @data-driven-forms/mui-component-mapper
 ```
 
-#### [PatternFly 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf4-component-mapper)
+#### [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/pf4-component-mapper -S
+$ npm install @data-driven-forms/pf3-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/pf4-component-mapper
+$ yarn add @data-driven-forms/pf3-component-mapper
 ```
 
-#### [Material-UI Mapper](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper)
+#### [PatternFly 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf4-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/mui-component-mapper -S
+$ npm install @data-driven-forms/pf4-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/mui-component-mapper
+$ yarn add @data-driven-forms/pf4-component-mapper
 ```
 
+Component libraries in mappers are external dependencies. Make sure to install them in your bundles.
+
 ### Usage
 
-For using Data Driven Forms in your component you need the renderer and a component mapper, which provides formFields components and layoutFields components.
+In order to Data Driven Forms in your component you need the renderer and a component mapper, which provides component mapper and form template
 
 ```jsx
 import React from 'react';
@@ -138,6 +139,8 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
 - Sub-form
 - Wizard
 
+Any other components can be added to mapper and renderer with the form renderer. Existing components can be also overriden.
+
 ### Documentation
 
 Please use our [documentation site](https://data-driven-forms.org/). In case of any problem, you can access documentation files directly in GitHub.
diff --git a/packages/blueprint-component-mapper/README.md b/packages/blueprint-component-mapper/README.md
@@ -1,13 +1,11 @@
-[![npm version](https://badge.fury.io/js/%40data-driven-forms%2Fpf4-component-mapper.svg)](https://badge.fury.io/js/%40data-driven-forms%2Fpf4-component-mapper)
+[![npm version](https://badge.fury.io/js/%40data-driven-forms%2Fblueprint-component-mapper.svg)](https://badge.fury.io/js/%40data-driven-forms%2Fblueprint-component-mapper)
 
 [![Data Driven Form logo](images/logo.png)](https://data-driven-forms.org/)
 
 Blueprint component mapper for [Data Driven Forms](https://github.com/data-driven-forms/react-forms).
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
-
 **Table of Contents**
 
 - [Installation](#installation)
@@ -156,7 +154,7 @@ Format:
 ```
 [type]([package]): message
 
-fix(pf4): title accepts node
+fix(blueprint): title accepts node
 ```
 
 Types:
diff --git a/packages/common/README.md b/packages/common/README.md
@@ -4,30 +4,23 @@
 ￼
 This package exists to share code used by more than one data-driven-forms package, such as:
 
-* shared interfaces - propTypes
-* common mapper code - `condition` implementation
+- shared interfaces - propTypes
+- common mappers code 
+  - wizard
+  - select
+  - multiplechoice list
+  - form template
+  - dual list select
+- demo schema
+
+...and some boring config files etc.
+
 ￼
+This packages is not released but can be referenced in mapper packages. Demo packages does not have access to common package!
 
 ## Usage
 ￼
 ```
-const common = require('@data-driven-forms/common');
-
-// shared props
-function MyComponent() {...}
-
-MyComponent.propTypes = {
-  ...common.children.propTypes,
-  isMulti: PropTypes.bool.isRequired,
-};
-
-MyComponent.defaultProps = {
-  ...common.children.defaultProps,
-};
+import demoSchema from '@data-driven-forms/common/src/demoschema';
 
-// condition code
-common.condition.evaluate({
-  when: "field",
-  in: ["foo", "bar"],
-}, { field: "baz" }); // false
 ```
diff --git a/packages/mui-component-mapper/README.md b/packages/mui-component-mapper/README.md
@@ -6,7 +6,8 @@ Material-UI component mapper for [Data Driven Forms](https://github.com/data-dri
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
+[Material-IU docs](https://material-ui.com/)
+
 
 **Table of Contents**
 
diff --git a/packages/parsers/README.md b/packages/parsers/README.md
@@ -54,9 +54,11 @@ const mozillaSchema = [
   }
 ]
 
+const parsedSchema = mozilla(mozillaSchema)
+
 const Form = () => (
   <FormRenderer
-    schema={mozilla(mozillaSchema)}
+    schema={parsedSchema}
     componentMapper={componentMapper}
     FormTemplate={FormTemplate}
     onSubmit={console.log}
diff --git a/packages/pf3-component-mapper/README.md b/packages/pf3-component-mapper/README.md
@@ -6,8 +6,6 @@ Patternfly 3 component mapper for [Data Driven Forms](https://github.com/data-dr
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
-
 **Table of Contents**
 
 - [Installation](#installation)
diff --git a/packages/pf4-component-mapper/README.md b/packages/pf4-component-mapper/README.md
@@ -6,8 +6,6 @@ Patternfly 4 component mapper for [Data Driven Forms](https://github.com/data-dr
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
-
 **Table of Contents**
 
 - [Installation](#installation)
diff --git a/packages/react-form-renderer/README.md b/packages/react-form-renderer/README.md
@@ -1,9 +1,12 @@
+[![codecov](https://codecov.io/gh/data-driven-forms/react-forms/branch/master/graph/badge.svg)](https://codecov.io/gh/data-driven-forms/react-forms)
+[![CircleCI](https://circleci.com/gh/data-driven-forms/react-forms/tree/master.svg?style=svg)](https://circleci.com/gh/data-driven-forms/react-forms/tree/master)
 [![npm version](https://badge.fury.io/js/%40data-driven-forms%2Freact-form-renderer.svg)](https://badge.fury.io/js/%40data-driven-forms%2Freact-form-renderer)
 
 [![Data Driven Form logo](images/logo.png)](https://data-driven-forms.org/)
 
 Data Driven Forms is a React library used for rendering and managing forms with a lot of provided features based on [React Final Form](https://github.com/final-form/react-final-form).
 
+
 :question: Why to use Data Driven Forms? :question:
 - All forms shared the same functionality!
 - Components are controlled in one place!
@@ -26,8 +29,6 @@ Data Driven Forms is a React library used for rendering and managing forms with
 
 :book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
 
-Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
-
 **Table of Contents**
 
 - [Installation](#installation)
@@ -48,7 +49,7 @@ Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
 
 ### Installation
 
-You neet to add React Form Renderer
+Add React Form Renderer
 
 #### [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
 
@@ -62,39 +63,42 @@ $ yarn add @data-driven-forms/react-form-renderer
 
 Optionally you can install one of provided mappers:
 
-#### [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
+
+#### [Material-UI Mapper](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/pf3-component-mapper -S
+$ npm install @data-driven-forms/mui-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/pf3-component-mapper
+$ yarn add @data-driven-forms/mui-component-mapper
 ```
 
-#### [PatternFly 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf4-component-mapper)
+#### [PatternFly 3 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf3-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/pf4-component-mapper -S
+$ npm install @data-driven-forms/pf3-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/pf4-component-mapper
+$ yarn add @data-driven-forms/pf3-component-mapper
 ```
 
-#### [Material-UI Mapper](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper)
+#### [PatternFly 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/pf4-component-mapper)
 
 ```console
-$ npm install @data-driven-forms/mui-component-mapper -S
+$ npm install @data-driven-forms/pf4-component-mapper -S
 ```
 
 ```console
-$ yarn add @data-driven-forms/mui-component-mapper
+$ yarn add @data-driven-forms/pf4-component-mapper
 ```
 
+Component libraries in mappers are external dependencies. Make sure to install them in your bundles.
+
 ### Usage
 
-For using Data Driven Forms in your component you need the renderer and a component mapper, which provides formFields components and layoutFields components.
+In order to Data Driven Forms in your component you need the renderer and a component mapper, which provides component mapper and form template
 
 ```jsx
 import React from 'react';
@@ -119,6 +123,39 @@ const Form = () => (
 )
 ```
 
+#### Custom mapper
+
+You can also custom mapper for your applications
+
+```jsx
+import React from 'react';
+import FormRenderer, { componentTypes, useFieldApi } from '@data-driven-forms/react-form-renderer';
+
+const TextField = props => {
+  const {label, input, meta, ...rest} = useFieldApi(props)
+  return (
+    <div>
+      <label htmlForm={input.name}>{label}</label>
+      <input {...input} {...rest} id={input.name}/>
+      {meta.error && <p>{meta.error}</p>}
+    </div>
+  )
+}
+
+const componentMapper = {
+  [componentTypes.TEXT_FIELD]: TextField,
+  'custom-type': TextField
+}
+
+const schema = {
+  fields: [{
+    component: componentTypes.TEXT_FIELD,
+    name: 'name',
+    label: 'Your name'
+    type: 'search',
+  }]
+}
+
 ### Basic provided components
 
 Data Driven Forms supports all kinds of component, basic set is consisted of:
@@ -135,15 +172,11 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
 - Sub-form
 - Wizard
 
-### Documentation
+Any other components can be added to mapper and renderer with the form renderer. Existing components can be also overriden.
 
-Please use our [documentation site](https://data-driven-forms.org/). In case of any problem, you can access documentation files directly in GitHub:
+### Documentation
 
-- [Documentation pages](packages/react-renderer-demo/src/docs-components/)
-  - [Form renderer API](packages/react-renderer-demo/src/docs-components/renderer-api.md)
-  - [Components API](packages/react-renderer-demo/src/docs-components/component-api.md)
-  - [Components mapping](packages/react-renderer-demo/src/docs-components/component-mapping.md)
-  - [Field provider](packages/react-renderer-demo/src/docs-components/field-provider.md)
+Please use our [documentation site](https://data-driven-forms.org/). In case of any problem, you can access documentation files directly in GitHub.
 
 ### Useful links
 
@@ -212,7 +245,7 @@ Format:
 ```
 [type]([package]): message
 
-fix(renderer): title accepts node
+fix(pf3): title accepts node
 ```
 
 Types:
@@ -236,4 +269,4 @@ We welcome any community contribution. Don't be afraid to report bug or to creat
 
 ### LICENSE
 
-Apache License 2.0
+Apache License 2.0
diff --git a/packages/react-renderer-demo/README.md b/packages/react-renderer-demo/README.md
diff --git a/packages/suir-component-mapper/README.md b/packages/suir-component-mapper/README.md

Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,11 @@ const mozillaSchema = [`
`54`	`54`	`}`
`55`	`55`	`]`
`56`	`56`
	`57`	`+const parsedSchema = mozilla(mozillaSchema)`
	`58`	`+`
`57`	`59`	`const Form = () => (`
`58`	`60`	`<FormRenderer`
`59`		`- schema={mozilla(mozillaSchema)}`
	`61`	`+ schema={parsedSchema}`
`60`	`62`	`componentMapper={componentMapper}`
`61`	`63`	`FormTemplate={FormTemplate}`
`62`	`64`	`onSubmit={console.log}`