Search by

kevinchappell / form-builder

kevinchappell

jQuery formBuilder

Package info

github.com/kevinchappell/formBuilder

Homepage

Language:JavaScript

pkg:composer/kevinchappell/form-builder

Fund package maintenance!

kevinchappell

lucasnetau

Statistics

Installs: 7 554

Dependents: 2

Suggesters: 0

Stars: 2 709

Open Issues: 101

v3.23.9 2026-11-17 22:35 UTC

This package is auto-updated.

Last update: 2026-11-17 22:35:19 UTC


README

npm version License: MIT

A jQuery plugin for building forms with drag and drop, plus a companion plugin to render them.

  • formBuilder is a client-side drag-and-drop form editor. Users drag fields (text, textarea, select, checkbox and radio groups, date, number, file, autocomplete, button, header, paragraph, hidden and more) onto a stage, then edit each field's label, name, options and other attributes. The form definition is exported as JSON (default) or XML formData.
  • formRender takes that formData and renders it as a working HTML form. It can also read back what a user entered (userData) or prefill values.

A common setup is formBuilder in an admin area and formRender on the public side.

formBuilder editor

Demos

Installation

npm / yarn

npm install formBuilder
# or
yarn add formBuilder

The package name is case-sensitive: formBuilder. The built files are in dist/ (form-builder.min.js, form-render.min.js).

CDN (jsDelivr)

<script src="https://cdn.jsdelivr.net/npm/formBuilder@3/dist/form-builder.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/formBuilder@3/dist/form-render.min.js"></script>

formBuilder@3 loads the latest 3.x release. For production, pin an exact version such as formBuilder@3.23.5.

Dependencies

  • jQuery (>=3.4.1), required by both plugins. The dist files use the global jQuery, so load jQuery first. If you use a bundler, expose window.jQuery before you import formBuilder.
  • jQuery UI Sortable, required by formBuilder for drag and drop. You can use the jquery-ui-sortable package or a full jQuery UI build.

CSS is injected by the scripts, so you don't need a separate stylesheet.

Quick start

formBuilder

<meta charset="utf-8">
<div id="fb-editor"></div>

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/formBuilder@3/dist/form-builder.min.js"></script>
<script>
  jQuery(($) => {
    const fbPromise = $('#fb-editor').formBuilder({
      disableFields: ['autocomplete'],
      onSave: (evt, formData) => console.log(formData),
    }).promise

    fbPromise.then((formBuilder) => {
      const json = formBuilder.actions.getData('json') // 'js' (default), 'json' or 'xml'
      console.log(json)
    })
  })
</script>

formBuilder starts up asynchronously, so actions aren't ready the moment you call .formBuilder(). Wait on the promise property, or call actions later, for example from a click handler.

formRender

<div id="fb-render"></div>

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/formBuilder@3/dist/form-render.min.js"></script>
<script>
  jQuery(($) => {
    const formData = '[{"type":"text","label":"Full Name","name":"full-name","subtype":"text"}]'
    const renderer = $('#fb-render').formRender({ formData })

    // later, read what the user entered
    console.log(renderer.userData)
  })
</script>

formData can be a JSON string or the array returned by getData(). To use XML, pass dataType: 'xml'.

Documentation

Full docs: https://formbuilder.online/docs/ · Getting started · formBuilder overview

Common formBuilder options: formData, disableFields, i18n, onSave, typeUserAttrs

Common formBuilder actions: getData, setData, addField, save, setLang

Custom fields: Controls · Control plugins

formRender: Options · userData

Translations (i18n)

Translations are handled by @draggable/i18n. The language files come from formBuilder-languages. en-US is bundled. Other locales are fetched as <location><locale>.lang, and location defaults to the relative path assets/lang/. Set the i18n option to choose a locale and where its file is loaded from:

$('#fb-editor').formBuilder({
  i18n: {
    locale: 'de-DE',
    location: 'https://cdn.jsdelivr.net/npm/formbuilder-languages@1.2.2/',
  },
})

Translators welcome!

As more people use formBuilder, it needs to be available in more languages. New languages and fixes to existing ones are always welcome. See Contributing Languages for how to help.

Browser support

The build targets the browserslist defaults query, which covers current versions of the major browsers:

Chrome Firefox Safari Opera Edge
Latest ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Internet Explorer is not supported.

Contributing

Contributions are welcome. See CONTRIBUTING.md and the development docs (contributing guide on the site).

git clone https://github.com/kevinchappell/formBuilder.git
cd formBuilder
npm ci
npm start          # local demo with Vite (alias: npm run dev)
npm test           # Vitest with coverage
npm run lint       # ESLint on ./src
npm run build      # build dist/ (form-builder + form-render, minified and unminified)
npm run build:all  # plugins, vendor, build and copy to the demo

Commit messages follow Conventional Commits and are checked by commitlint. semantic-release uses them to publish releases from master.

Support

Report bugs and request features on GitHub Issues. Include your formBuilder version, the options you used, your browser and steps to reproduce.

Related

License

MIT