Lifecycle logic for forms: edit, submit, error, success, pending. <1kb.
$ npm install --save form-lifecycle
var form = require('form-lifecycle')
var form = form.create()
// => {pristine: true, error: null, pending: false, success: null, fields: {}}
var form2 = form.submit(form)
// => {pristine: true, error: null, pending: true, success: null, fields: {}})
// ... And more. See below.
Every action returns a new form object, never mutating the existing one.
Creates a basic form, extended by initial
if desired.
{
pristine: true,
pending: false,
success: null,
error: null,
fields: {}
}
Also available as alias Lifecycle.reset
.
Creates a new form, extending it with optional data
. Effectively the same as create, except it follows the expected argument form of the others.
Extends fields
with newFields
.
pending
to truepristine
to trueerror
to nullsuccess
to nullfields
unchanged
pending
to falsepristine
to falseerror
to supplied error or nullsuccess
to nullfields
unchanged
pending
to falsepristine
to trueerror
to nullsuccess
to supplied data or truefields
unchanged
Run FormLifecycle methods at a path of a given object (usually your app state).
Given a string or array path, returns the same functions as above, set to run at the location determined by the path
. Instead of taking a form
as your first argument, these take an object.
The form will make changes to the object at the given path, and return the changed object.
Example:
var Form = require('form-lifecycle')
var state = {
login: {
form: Form.create()
}
}
var loginForm = Form.atObjectPath('login.form')
// Creates a new state object, with all references the same except for the path to state.login.form.
var newState = loginForm.submit(state)
var Form = require('form-lifecycle')
var initialState = {
login: {
form: Form.create()
}
}
var loginForm = Form.atObjectPath('login.form')
function myReducer (state, action) {
switch(action.type) {
case 'LOGIN': return loginForm.submit(state)
case 'LOGIN_SUCCESS': return loginForm.success(state)
case 'LOGIN_ERROR': return loginForm.error(state, action.payload)
case 'LOGIN_EDIT_FORM': return loginForm.edit(state, action.payload)
default: return state
}
}
MIT © Andrew Joslin