npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@data-driven-forms/react-form-renderer

v3.23.4

Published

React Form Renderer. Data Driven Forms converts JSON form definitions into fully functional React forms.

Downloads

38,353

Readme

codecov CircleCI npm version Tweet Twitter Follow

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.

:question: Why to use Data Driven Forms? :question:

  • 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!)

:tada: Features :tada:

  • 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!
  • 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!

:book: For more information please visit the documentation. :book:

Table of Contents

Installation

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:

Material-UI Mapper

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

PatternFly 4 Mapper

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

BlueprintJS Mapper

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

Semantic UI Mapper

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

Ant Design Mapper

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

Carbon Mapper

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

Component libraries in mappers are external dependencies. Make sure to install them in your bundles.

Usage

In order to Data Driven Forms in your component you need the renderer and a component mapper, which provides component mapper and form template.

import React from 'react';
import { FormRenderer, componentTypes } from '@data-driven-forms/react-form-renderer';
import { componentMapper, FormTemplate } from '@data-driven-forms/pf4-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}
  />
)

Custom mapper

You can also use custom mapper.

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',
  }]
}

For more information, please check this page.

Mappers can be also generated by using yarn generate-template command.

Basic provided components

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

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. In case of any problem, you can access documentation files directly in GitHub.

Useful links

Development setup

Data Driven Forms is a monorepo that uses Lerna and yarn workspaces, 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?
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 can be ran from the core folder or from specific packages.

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