React JSON Schema Form Editor¶

The React JSON Schema Form Builder is a ReactJS Component Library that allows the user to visually configure a JSON Schema encoded form by dragging, dropping, and editing card elements. An example use case for this tool could be for building an app that allows users to create and distribute their own surveys. The React JSON Schema Form Builder provides components to allow users to dynamically build such survey forms. The Form Builder is also customizable, and can incorporate novel form elements (like a special email address or file upload input), specified by the developer building the survey creation app.

This FormBuilder component is wrapped around a demo app that demonstrates how the tool can be used in conjunction with a code editor and Mozilla's React JSON schema form viewer to build a form and maintain a live, code representation of it in real time.

The Form Builder is available as an NPM package here.

View the Form Builder in action here

Quickstart¶

npm i --save @ginkgo-bioworks/react-json-schema-form-builder @mui/material @emotion/react @emotion/styled

Import the tool as a React component in your project:

Usage¶

import React, { useState } from 'react';
import { FormBuilder } from '@ginkgo-bioworks/react-json-schema-form-builder';

function Example() {
  const [schema, setSchema] = useState('{}');
  const [uischema, setUiSchema] = useState('{}');

  return (
    <FormBuilder
      schema={schema}
      uischema={uischema}
      onChange={(newSchema, newUiSchema) => {
        setSchema(newSchema);
        setUiSchema(newUiSchema);
      }}
    />
  );
}

export default Example;

For more usage examples, see the Usage documentation page

Credits¶

The Form Builder was built and is maintained by Ginkgo Bioworks, and is open sourced through the Apache 2.0 license.