Skip to content
React library for rendering forms.
JavaScript CSS Other
Branch: master
Clone or download
Hyperkid123 Merge pull request #312 from boaz0/fix_scroll_top_wizard
fix(pf4): scroll to top on switching to a different step
Latest commit 10fc6de Feb 20, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Set TRAVIS_REPO_SLUG in Circle_CI Jan 17, 2020
.github/ISSUE_TEMPLATE Add generail issue template Dec 12, 2019
__mocks__ fix(renderer): prevent double submitting by button Jan 21, 2020
config fix(pf4): scroll to top on switching to a different step Feb 20, 2020
images Add readme for core repo Sep 9, 2019
packages fix(pf4): scroll to top on switching to a different step Feb 20, 2020
scripts fix(common): fixed travis faling auth NPM token. Nov 1, 2019
.codecov.yml Updated codecov config May 10, 2019
.gitignore Added yarn lock for caching Nov 11, 2019
.gitmodules Initial commit. Apr 2, 2019
.npmrc.template
LICENSE LICENSE: symlink /LICENSE in all packages/ (Apache-2.0) Dec 18, 2019
README.md Update readmes Jan 15, 2020
babel.config.js Use tranform pluging to transform PF4 icons Jan 9, 2020
lerna.json Add rebuild for demo app to travis. Apr 24, 2019
package.json Updated wildcard-release-notes to latest Jan 17, 2020
yarn.lock Add releases page to demo Feb 11, 2020

README.md

codecov CircleCI npm version

Data Driven Form logo

Data Driven Forms is a React library used for rendering and managing forms with a lot of provided features based on React Final Form.

Why to use Data Driven Forms?

  • All forms shared the same functionality!
  • Components are controlled in one place!
  • You can easily migrate to different sets of components!
  • All functionality is provided (see below!)

🎉 Features 🎉

  • Easily readable schema, you don't need to know any HTML or JS to be able to write your own form schemas!
  • You can use your own components or use one of our provided mappers (PatternFly 3, PatternFly 4 or Material-UI!)
  • Form state managing out-of-the-box (including error states!)
  • Fully customizable (you can use your own buttons, actions, etc.)!
  • Conditional fields!
  • Custom field validation with basic set included!
  • Datatype validation!
  • Cross-field validation!
  • Asynchronous validation supported!
  • Supporting Wizard forms!
  • Supporting Final Form Field Array!
  • ... and a lot more!

📖 For more information please visit the documentation. 📖

Used by ManageIQ, Red Hat Cloud Services.

Table of Contents

Installation

You neet 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

Optionally you can install one of provided mappers:

PatternFly 3 Mapper

$ npm install @data-driven-forms/pf3-component-mapper -S
$ yarn add @data-driven-forms/pf3-component-mapper

PatternFly 4 Mapper

$ npm install @data-driven-forms/pf4-component-mapper -S
$ yarn add @data-driven-forms/pf4-component-mapper

Material-UI Mapper

$ npm install @data-driven-forms/mui-component-mapper -S
$ yarn add @data-driven-forms/mui-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 { formFieldsMapper, layoutMapper } from '@data-driven-forms/pf4-component-mapper';

const schema = {
  fields: [{
    component: componentTypes.TEXT_FIELD,
    name: 'name',
    label: 'Your name'
  }]
}

const Form = () => (
  <FormRenderer
    schema={schema}
    formFieldsMapper={formFieldsMapper}
    layoutMapper={layoutMapper}
    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)
  • Switch
  • Radio buttons
  • Date picker
  • Time picker
  • Tabs
  • Sub-form
  • Wizard

Documentation

Please use our documentation site. In case of any problem, you can access documentation files directly in GitHub:

Useful links

Development setup

Data Driven Forms is a monorepo which uses Lerna, so you can use all its commands as well.

  1. Install
yarn install
  1. Build
yarn build
  1. Run a package

Each package has a small playground package/demo, where you can test your changes.

cd packages/pf3-component-mapper
yarn start
  1. How to clean?
rm yarn.lock
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._ release
  • fix: 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 demo repository. Thanks!

Contribution

We welcome any community contribution. Don't be afraid to report bug or to create issues and pull-requests! 🏆

LICENSE

Apache License 2.0

You can’t perform that action at this time.