Skip to content
This repository has been archived by the owner on Aug 25, 2020. It is now read-only.

Nevoss/form-wrapper-js

Repository files navigation

Form Wrapper JS

Form wrapper js

npm npm MIT codecov CircleCI

A lightweight library that creates forms systems in a convenient and easy way, without dependencies and magic code.

Status: BETA

The current version is in beta, most of the feature are stable, but there are may still be bugs, and api may change a little bit.

for 0.x move to 0.x branch.

🎨 Playground

💿 Installation

npm install --save form-wrapper-js@next  # for 1.x
// or
npm install --save form-wrapper-js  # for 0.x

or

yarn add form-wrapper-js@next  # for 1.x
// or
yarn add form-wrapper-js  # for 0.x

📖 Documentation

Please check out the Form Wrapper JS website.

🚀 Basic Usage

This is a quick example with VUE, please check out the website for full documentation.

<template>
  <form @submit.prevent="submit">
    <input type="text" v-model="form.email" />
    <input type="text" v-model="form.name" />
    <input type="text" v-model="form.password" />

    <button type="submit" :disabled="form.$submitting" />
  </form>
</template>

<script>
import { Form } from 'form-wrapper-js'
import axios from 'axios'

export default {
  data() {
    return {
      form: Form.create({
        email: null,
        name: null,
        password: null,
      }),
    }
  },
  methods: {
    async submit() {
      const { response } = await this.form.$submit(form =>
        axios.post('some-url', form.$values())
      )
    },
  },
}
</script>

🍻 Contribute

Code, Docs, Bug reports, Ideas - are more the welcome.

the installation is very easy, take a look at CONTRIBUTING.md file and follow the instructions.

🔒 License

The MIT License (MIT). Please see License File for more information.