lets-form

0.11.1 • Public • Published


Create React forms with simple JSON form schemas, supports Material UI / Bootstrap / AntDesign / RSuite / Mantine

Documentation  |  Try LetsForm Designer  |  Roadmap  |  Blog

About LetsForm

LetsForm is an open source tool to generate React forms with simple JSON schemas using native UI components: Material UI, AntD, RSuite, ReactBootstrap, Mantine or just React

  • forget tedious boilerplate copy and paste everytime you need to add a field. No more copy and paste from old code

  • build the form visually with LetsForm designer

  • based on the performant React Hook Form, no more unwanted re-renders even with complex forms

  • keep visual consistency of the form, with a JSON form schema all forms are rendered in the same way across all pages, with the same margins, colors, customizations and components.

  • validation out of the box with i18n and scripting support

  • multi-language (i18n) support and automatic translations of i18n tokens

  • implement dynamic forms with the language you love - JavaScript - and a simple set of instructions

  • use form features you will certainly need in every project like splitting the form in tabs, steps, collapsible groups or columns

  • easily switch form modes: editable, disabled, read only and plaintext (you will never have to write form confirmation views)

  • support for arrays, just define the fields of the array and you'll get the UI to add, remove and validate the items in the array

  • over 30 components with consistent behaviour and properties

  • full set of helpers to programmatically interact with JSON form schemas

  • toolchain to organize your forms in projects with versioning and integration with GitHub, NPM or your repository

  • leverage ready-to-use and useful form templates (like cascading drop downs of all countries and provinces in all languages or credit card with validation)

  • JSON forms can be created programmatically, for example in those use cases where a form is defined after introspection of a data scheme (database table, GraphQL schema, etc.)

Getting started

Install LetsForm

npm i lets-form -D

then try a simple JSON form schema with just one text field (or use the LetsForm Designer to create one), for example using RSuite components

import React from 'react';
import LetsForm from 'lets-form/react-rsuite5';
// or /react-antd or /react-bootstrap or /react-material-ui or /react-mantine or /react
// see https://letsform.dev/docs for more info about specific frameworks

import 'rsuite/dist/rsuite.min.css';

// copied and pasted from LetsForm Designer
const MY_FORM = {
  "$schema": "https://cdn.jsdelivr.net/npm/lets-form/schemas/react-rsuite5/form.json",
  "version": 1,
  "layout": "vertical",
  "validationMode": "onSubmit",
  "fluid": true,
  "fields": [
    {
      "component": "input-text",
      "label": "My Field",
      "name": "my_field"
    }
  ],
  "name": "Simplest example"
};

const MyView = () => {
  return (
    <LetsForm
      form={MY_FORM}
      // or onChange
      onSubmit={(values => {
        console.log('Submitting...', values);
      }}
    />
  );
}

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Coded with ❤️ in 🇮🇹

Readme

Keywords

none

Package Sidebar

Install

npm i lets-form

Weekly Downloads

88

Version

0.11.1

License

MIT

Unpacked Size

15.9 MB

Total Files

681

Last publish

Collaborators

  • guidone