JavaScript
Switch branches/tags
Nothing to show
Latest commit 2051a44 Jul 11, 2017 @rofrischmann committed on GitHub Merge pull request #21 from newyork-anthonyng/feature/an/fixTypoInReadMe
Fix typo in README.md
Permalink
Failed to load latest commit information.
docs update docs Jun 23, 2017
examples update docs Jun 20, 2017
modules #19 Jun 26, 2017
reference 1.1.7 release Jun 26, 2017
types initial push Jun 9, 2017
.babelrc initial push Jun 8, 2017
.codeclimate.yml initial push Jun 8, 2017
.eslintignore initial push Jun 9, 2017
.eslintrc initial push Jun 9, 2017
.flowconfig initial push Jun 8, 2017
.gitignore fix tests Jun 11, 2017
.jshintrc initial push Jun 8, 2017
.travis.yml fix tests Jun 11, 2017
CNAME update docs Jun 11, 2017
Changelog.md 1.1.7 release Jun 26, 2017
LICENSE Initial commit May 19, 2017
README.md Fix typo in README.md Jul 8, 2017
SUMMARY.md update docs Jun 23, 2017
book.json initial push Jun 9, 2017
package.json 1.1.7 release Jun 26, 2017
yarn.lock updated stats Jun 15, 2017

README.md

Controlled Forms

react-controlled-form aims to simplify form management with React and Redux.
It ships functional APIs to create your very own form fields and is built with flexibility and customization in mind.

It allows you to bring your own components.
You do not have to struggle with predefined input components ever again!

TravisCI Test Coverage npm downloads npm version

Installation

yarn add react-controlled-form react react-redux redux

Controlled Forms requires react-redux to be installed in your project. Therefore, react and redux must also be installed.

Benefits

  • simple functional API
  • Redux-driven state management
  • full flexibility
  • custom form fields
  • reactive forms

The Gist

import { Form, asField, asSubmit } from 'react-controlled-form'

function InputField({
  value,
  updateField,
  isRequired,
  isValid
}) {
  // we could also do validation here and
  // update isValid in updateField respectively
  function onInput(e) {
    updateField({ value: e.target.value })
  }

  return (
    <input
      value={value}
      required={isRequired}
      disabled={!isEnabled}
      onInput={onInput}
    />
  )
}

function SubmitButton({ submitForm }) {
  return (
    <button onClick={submitForm}>
      Submit
    </button>
  )
}

const Input = asField(InputField)
const Submit = asSubmit(SubmitButton)

function onSubmit({ data }) {
  console.log("Submitted: ", data)
}

export default () => (
  <Form formId="name" onSubmit={onSubmit}>
    <Input fieldId="firstname" />
    <Input fieldId="lastname" />
    <Submit />
  </Form>
)

Documentation

Examples

License

react-controlled-form is licensed under the MIT License.
Documentation is licensed under Creative Common License.
Created with ♥ by @rofrischmann and all the great contributors.