FormBuilder

THIS PROJECT IS WORK IN PROGRESS. ALL THE API IS CONSIDERED UNSTABLE. EVERYTHING CAN BE CHANGED. NEW FEATURES/BUG FIXES CAN TAKE A LONG TIME TO IMPLEMENT.

This component allows to build Data Driven Forms forms via DnD feature.

Table of contents

• FormBuilder
• Installation
• Development
  • Requirements
  • Install with yarn
  • Start the playground
  • Lint
  • Tests
  • Build
• Usage
• Props
  • render or children
  • componentMapper
  • builderMapper
    • FieldLayout
    • PropertiesEditor
    • FormContainer
    • BUILDER_FIELD
    • BuilderColumn
    • PropertyGroup
    • DragHandle
    • EmptyTarget
  • componentProperties
    • attributes
      • propertyName
      • label
      • component
    • disableValidators
    • disableInitialValue
    • Example
  • pickerMapper
  • propertiesMapper
  • mode
  • schema
  • schemaTemplate
  • cloneWhileDragging
  • debug
  • openEditor
  • disabledAdd
  • disableDrag
• Mappers
  • Material UI
    • Version 5
  • PatternFly 4
  • Example

Installation

npm install --save @data-driven-forms/form-builder

or

yarn add @data-driven-forms/form-builder

Development

Requirements

• UNIX like system (Linux, MacOS)
• Node 12+

Install with yarn

yarn

Start the playground

yarn start

Running on http://localhost:8080/

Lint

yarn lint

For automatic fix: yarn lint --fix

Tests

yarn test

For watching changes: yarn test --watchAll

Build

yarn build

To clean built files: yarn clean-build. This is also done automatically before build.

Usage

Import form builder:

import FormBuilder from '@data-driven-forms/form-builder/form-builder';

and render the component with following props:

Props

render or children

({ ComponentPicker, PropertiesEditor, DropTarget, isValid, getSchema, children }) => React.Element

Use children or a render function to render the whole editor.

componentMapper

object

Data Driven Forms component mapper. See here.

builderMapper

object

A set of components that creates the form builder.

import { builderComponentTypes } from '../src/constants';


const builderMapper = {
    FieldLayout,
    PropertiesEditor,
    FormContainer,
    [builderComponentTypes.BUILDER_FIELD]: builderField,
    BuilderColumn,
    PropertyGroup,
    DragHandle,
    EmptyTarget
}

FieldLayout

({ children, disableDrag, dragging, selected }) => React.Element

A wrapper around a single field = BUILDER_FORM + DragHandle.

PropertiesEditor

({ propertiesChildren, validationChildren, addValidator, avaiableValidators, handleClose, handleDelete, hasPropertyError }) => React.Element

An editor.

FormContainer

({ children, isDraggingOver }) => React.Element

A wrapper around the form in the form column.

BUILDER_FIELD

({ innerProps: { hideField, snapshot }, Component, propertyName, fieldId, propertyValidation, hasPropertyError, ...props }) => React.Element

A wrapper around the field.

BuilderColumn

({ children, isDraggingOver }) => React.Element

A column.

PropertyGroup

({ className, children, title, handleDelete }) => React.Element

A wrapper around a single property group in the properties editor > validation.

DragHandle

({ dragHandleProps, hasPropertyError, disableDrag }) => React.Element

A drag handle. Is passed as a child to FieldLayout.

EmptyTarget

() => React.Element

EmptyTarget is shown when there are no fields created.

componentProperties

object

A mapper of editable properties for each component. A property is a object with following attributes:

attributes

Editable attributes of the component.

propertyName

string

Corresponds to an attribute in the schema.

label

string

A label shown for the property in the editor.

component

string

A component corresponding to a key in properties mapper.

disableValidators

Disables validator selection in PropertiesEditor.

Automatically disabled in fields that are not registered in the form state.

disableInitialValue

Disables initial value field in PropertiesEditor.

Automatically disabled in fields that are not registered in the form state.

Example

const LABEL = {
    propertyName: 'label',
    label: 'Label',
    component: 'input'
}

const componentProperties = {
    [componentTypes.TEXT_FIELD]: {
        attributes: [LABEL, IS_REQUIRED]
    },
    [componentTypes.PLAIN_TEXT]: {
        attributes: [LABEL],
        disableValidators: true,
        disableInitialValue: true
    }
}

pickerMapper

object

A mapper of components available in the editor.

const pickerMapper = {
    [componentTypes.TEXT_FIELD]: ({ component }) => <div>{component}</div>
}

propertiesMapper

object

A mapper of components available in component properties.

const propertiesMapper = {
    input: ({ label, value, fieldId, innerProps: { propertyValidation }, ...rest }) => <input {...rest} />
}

mode

one of 'subset' | 'default' optional

If 'subset', options will be only editable to certain degree. See schemaTemplate.

schema

object optional

A Data Driven Forms schema. See here.

schemaTemplate

object optional

An original schema from which a subset is created. If not specified, editable boundaries will be created from the schema.

cloneWhileDragging

boolean optional

Components from the components list are being cloned when dragged.

debug

boolean optional

Turns on debug mode. Will show current field as a JSON object.

openEditor

boolean optional

Opens the first field on mount.

disabledAdd

boolean optional

Disables adding new fields.

disableDrag

boolean optional

Disables dragging.

Mappers

Form builder contains two mappers of components: PatternFly 4 and Material UI versions.

Material UI

import {
  pickerMapper,
  propertiesMapper,
  builderMapper,
  BuilderTemplate,
  fieldProperties
} from '@data-driven-forms/form-builder/mui-builder-mappers';

Version 5

MUI-BUILDER is using MUI of version 5. To use version 4 (@material-ui/core), please use the builder of version 0.0.12-rc1.

PatternFly 4

import {
  pickerMapper,
  propertiesMapper,
  builderMapper,
  BuilderTemplate,
  fieldProperties
} from '@data-driven-forms/form-builder/pf4-builder-mappers';

Example

render={({ isValid, getSchema, ...props }) => (
  <BuilderTemplate {...props} className={classes.builderWrapper}>
    <CodeEditor value={JSON.stringify(getSchema(), null, 2)} />
  </BuilderTemplate>
)}