Giter VIP home page Giter VIP logo

formiz's Introduction

Welcome to ๐Ÿœ Formiz

React forms with easy validation and multi steps

โš ๏ธ This is an early and alpha release of Formiz. API is subject to change. Do not use in production.

Tests Badge

๐Ÿง™โ€ Multi steps forms

Multi steps form logic available out of the box! No more pain to build perfect UX for complex forms.

โœ… Easy form validation

Create forms in React with full validation without the pain. Turn everything into a custom field with full validation!

๐Ÿ› No more logic duplication

Don't duplicate your logic between display and validation. Validation is enabled only if the field is displayed.

๐Ÿ’… Forms with your own UX

Choose how to render validations, form buttons, and navigation between steps (wizard, tabs, other). It's your choice!

โš›๏ธ Built with hooks

Use hooks & cut the complexity to create custom fields :) Use complex logic without even thinking of it.

Getting started

Looking for the documentation?

Visit formiz-react.com for full documentation and live demos.

Looking for examples?

Visit documentation for live demos.

Visit formiz-examples.netlify.com for examples with Chakra UI.

Concept

The idea behind Formiz is to allow you to build advanced forms with multiple steps, complex validations and a good UX without pain.

The main idea is to build fields as independent reusable components. Fields can be anything, not just inputs. Once you have built your fields, you can use them everywhere.

When you use a field built with Formiz, you can apply validations rules on it. Only the mounted fields will apply their validation to the current step and to the form.

// Example
<MyField
  name="email"
  type="email"
  required="Email is required"
  validations={[
    {
      rule: isEmail(),
      message: 'Not a valid email',
    }
  ]}
/>

Formiz core does not provide any styles, so you can use it with any UI library and style you want. Use it with Chakra UI, ReactStrap, Material UI or your own styles.

Contributing

Feel like contributing? That's awesome!

Follow the flowing guide to run the project locally.

Install dependencies

This project use Yarn and Lerna.

This is needed the ** the first time** you get the project to install all dependencies.

yarn

Bootstrap the repo with Lerna

This is needed the ** the first time** you get the project to link local packages together.

yarn bs

Start documentation

yarn start

Run test in dev

yarn test:dev

This can be a little hard to see test results with this command.

So instead you can go in each packages folders and run tests from here.

cd packages/core
yarn test:dev

formiz's People

Contributors

ivan-dalmet avatar yoannfleurydev avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.