@data-driven-forms/pf3-component-mapper
v2.24.0
Published
Patternfly 3 component mapper
Downloads
336
Readme
Patternfly 3 component mapper for Data Driven Forms.
:book: For more information please visit the documentation. :book:
Table of Contents
Installation
You need to add React Form Renderer
React Form Renderer
$ npm install @data-driven-forms/react-form-renderer -S
$ yarn add @data-driven-forms/react-form-renderer
PatternFly 3 Mapper
$ npm install @data-driven-forms/pf3-component-mapper -S
$ yarn add @data-driven-forms/pf3-component-mapper
Usage
For using Data Driven Forms in your component you need the renderer and a component mapper, which provides formFields components and layoutFields components.
import React from 'react';
import FormRenderer, { componentTypes } from '@data-driven-forms/react-form-renderer';
import { componentMapper, FormTemplate } from '@data-driven-forms/pf3-component-mapper';
const schema = {
fields: [{
component: componentTypes.TEXT_FIELD,
name: 'name',
label: 'Your name'
}]
}
const Form = () => (
<FormRenderer
schema={schema}
componentMapper={componentMapper}
FormTemplate={FormTemplate}
onSubmit={console.log}
/>
)
Basic provided components
Data Driven Forms supports all kinds of component, basic set is consisted of:
- Text input
- Text area
- Checkbox (Multiple checkboxes)
- Select (dropdown)
- Dual list select
- Field array
- Switch
- Radio buttons
- Date picker
- Time picker
- Tabs
- Slider
- Sub-form
- Plain text
- Wizard
Useful links
- Data Driven Forms documentation
- PatternFly 3 Design documentation
- NPM
- Examples of schemas (PatternFly 3)
Development setup
Data Driven Forms is a monorepo that uses Lerna and yarn workspaces, so you can use all its commands as well.
- Install
yarn install
- Build
yarn build
- Run a package
Each package has a small playground package/demo
, where you can test your changes.
cd packages/pf3-component-mapper
yarn start
- How to clean?
yarn lerna clean # will delete all node_modules
All packages are linked together by default, so if you run a yarn build
in a package, all other packages are updated to the latest version of that package.
Tests
Tests needed to be run from the core folder.
yarn test
yarn test packages/pf3-component-mapper
Commits
Data Driven Forms uses Semantic Release
Format:
[type]([package]): message
fix(pf3): title accepts node
Types:
feat
: a new feature, will trigger new_.X._
releasefix
: a fix, will trigger new_._.X
release
Packages:
- Please describe which package is being changed
pf3
,renderer
, ...
Please, do not use Semantic Release, if you update only the demo.
All packages are releasing together and they share the version number.
Changes to documentation
If your changes influence API or add new features, you should describe these new options in the react-renderer-demo
repository. Thanks!
Contribution
We welcome any community contribution. Don't be afraid to report bug or to create issues and pull-requests! :trophy:
LICENSE
Apache License 2.0