Effortless forms, no payload. Render-prop wrapper for FormLifecycle.
Install
$ npm install --save react-form-lifecycle
Usage
Recommended way of doing forms:
var FormLifecycle = require('react-form-lifecycle')
var filterBoolean = require('boolean-filter-obj')
var isEmail = require('is-email-maybe')
function renderForm () {
return <FormLifecycle render={({ form, lifecycle }) => {
var validationErrors = getValidationErrors(form)
return <form onSubmit={e => {
e.preventDefault()
if (Object.keys(validationErrors).length) {
return lifecycle.error()
} else
API
Props
onChange
function (form, prevForm) | optional
Called whenever the form is changed via lifecycle methods. Receives the newForm and prevForm as parameters.
onReset
function (form, prevForm) | optional
Called whenever lifecycle.reset is called
onEdit
function (form, prevForm) | optional
Called whenever lifecycle.edit is called
onSubmit
function (form, prevForm) | optional
Called whenever lifecycle.submit is called
onError
function (form, prevForm) | optional
Called whenever lifecycle.error is called
onSuccess
function (form, prevForm) | optional
Called whenever lifecycle.success is called
object | optional
These values will be passed to the new FormLifecycle object that is created when the component is instantiated.
Example: <FormLifecycle formDefaults={{ fields: {rememberMe: true} }} />
render
function() | required
<FormLifecycle render={({ form, lifecycle }) => <div />} />
Also supports child render function:
<FormLifecycle>{({ form, lifecycle }) => <div />}}</FormLifecycle>
The render prop function is called with an object containing the following:
form: An instance of FormLifecycle.
lifecycle: An object containing all FormLifecycle methods. When called, the form will be edited and re-rendered.
- Example:
lifecycle.edit({ email: 'test@email.com' }).
License
MIT © Andrew Joslin