<Form>
React Router [![Travis][build-badge]][build] [![npm package][npm-badge]][npm] [![Coveralls][coveralls-badge]][coveralls]
A <Form>
component for use with React Router which does for <form>
what react-router's <Link>
does for <a>
.
Usage
A <Form>
component renders a <form>
element with the contents you provide, hooks into the form's onSubmit
event to extract user input and transitions to the configured route with user input data in the next location's state.
let NewPost = React
For example, assuming you have the following routes, the component above would trigger the onEnter
handler for the add-post
route when the form is submitted:
<Route path="/topics/:topicId/new-post" component=NewPost/><Route path="/topics/:topicId/add-post" onEnter=handleAddPost/>
Form data is set as a body
property and the form's method
is set as a method
property in the next location's state:
{ console // 'POST' console // {comment: '...'}}
Goals
One of the key goals of this component is to make it easier to implement basic isomorphic forms in your React app.
If your onEnter
handlers send back everything needed to re-render a form which has errors (i.e. validation errors and user input), then for a little extra effort your React components can handle form submissions on both client and server:
{ let comment = nextStatelocationstatebody let topicId = nextStateparams ForumService }
Install
# For React Router 3.x npm install react-router-form # For React Router 1.x npm install react-router-form@1``` ```jsimport Form from 'react-router-form'// orconst Form = require``` Browser bundles are available, which export a global `ReactRouterForm` variable and expect to find a global ``React`` variable to work with. * [react-router-form.js] * [react-router-form.min.js] ## MIT Licensed [build-badge]: https://img.shields.io/travis/insin/react-router-form/master.png?style=flat-square[build]: https://travis-ci.org/insin/react-router-form [npm-badge]: https://img.shields.io/npm/v/react-router-form.png?style=flat-square[npm]: https://www.npmjs.org/package/react-router-form [coveralls-badge]: https://img.shields.io/coveralls/insin/react-router-form/master.png?style=flat-square[coveralls]: https://coveralls.io/github/insin/react-router-form