reactjs-form-builder

React Js Form Builder

Install

npm install --save reactjs-form-builder

|Field Types| |Attributes | |-----------|---|-------------| | Text | type: text |readOnly: true/false, placeholder: String,required: true/false,requireMessage: "Custom message for require",min: Integer, max: Integer | | Number | type: number |readOnly: true/false, placeholder: String,required: true/false,requireMessage: "Custom message for require",min: Integer, max: Integer | | Textarea | type: textarea|readOnly: true/false, placeholder: String,required: true/false,requireMessage: "Custom message for require",min: Integer, max: Integer | | Select | type: select | placeholder: String,options:[{"label":"Apple","value":"apple"},{"label":"Banana","value":"banana"}] ,required: true/false,requireMessage: "Custom message for require", multiple: true/false, autofocus: true/false | | Checkbox | type: checkbox| placeholder:String, options:[{"label":"Apple","value":"apple"},{"label":"Banana","value":"banana"}] ,required: true/false,requireMessage: "Custom message for require"| | Radio | type: radio| placeholder:String, options:[{"label":"Apple","value":"apple"},{"label":"Banana","value":"banana"}] ,required: true/false,requireMessage: "Custom message for require"|

Usage

import React from "react";
import FormBuilder from "reactjs-form-builder";

export default function Example(props) {

    const [form, setForm] = useState({
        fields: {
            name: {
                label: "Product Name",
                type: "text",
                placeholder: "Custom Placeholder",
                required: true,
                requireMessage: "This Field is Required" // To customize message if field is empty
            },
            description: {
                label: "Product Name",
                type: "textarea",
                required: true,
            },
            categories: {
                label: "Categories",
                type: "select",
                options: [
                    { 'label': "Apple", 'value': 1 },
                    { 'label': "Banana", 'value': 2 }
                ],
                placeholder: "Custom Placeholder",
                required: true,
                requireMessage: "This Field is Required"
            },
            submit: {
                type: "submit",
                label: "Create Product",
                color: 'btn-primary',
            }
        }
    })

    const submitAction = () => {
        // To get FormData
        var formData = form.getFormData();
        
        // To get value of specific field
        var name = form.fields.name.value;
        var description = form.fields.description.value;
        
        // Perform you action here
    };

    return (
        <FormBuilder
            rowDef={{sm: 6}} // optional - to make the form in row. currently only col-sm is supported
            fields={form}
            onChange={(data) => {
                setForm({ ...data })
            }}
            onSubmit={(data) => {
                setForm({ ...data })
                submitAction();
            }}
        />
    );
}

Actions

if you preform action like focusing onto field on component mount or other actions on field reference. add getAction prop in your FormBuilder Component.

return (
  <FormBuilder
    fields={form}
    getActions={(data)=>{setForm({...data})}
  />
);

getAction prop gives callback and return form state with actions. once getAction is initiated you will have actions key in your field.

Eg. to focus in field.

form.fields.yourtextfield.actions.focus();

Custom Submit Button

To use custom submit button instead of the in inbuild submit button. Use

form.submit();

this will trigger validation of form and onSubmit action.

License

MIT © adsazad