{"componentChunkName":"component---src-templates-docs-js","path":"/docs/forms.html","result":{"data":{"markdownRemark":{"html":"
\n
\n

These docs are old and won’t be updated. Go to react.dev for the new React docs.

\n

These new documentation pages teach modern React and include live examples:

\n\n
\n
\n

HTML form elements work a bit differently from other DOM elements in React, because form elements naturally keep some internal state. For example, this form in plain HTML accepts a single name:

\n
<form>\n  <label>\n    Name:\n    <input type=\"text\" name=\"name\" />\n  </label>\n  <input type=\"submit\" value=\"Submit\" />\n</form>
\n

This form has the default HTML form behavior of browsing to a new page when the user submits the form. If you want this behavior in React, it just works. But in most cases, it’s convenient to have a JavaScript function that handles the submission of the form and has access to the data that the user entered into the form. The standard way to achieve this is with a technique called “controlled components”.

\n

Controlled Components

\n

In HTML, form elements such as <input>, <textarea>, and <select> typically maintain their own state and update it based on user input. In React, mutable state is typically kept in the state property of components, and only updated with setState().

\n

We can combine the two by making the React state be the “single source of truth”. Then the React component that renders a form also controls what happens in that form on subsequent user input. An input form element whose value is controlled by React in this way is called a “controlled component”.

\n

For example, if we want to make the previous example log the name when it is submitted, we can write the form as a controlled component:

\n
class NameForm extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {value: ''};\n    this.handleChange = this.handleChange.bind(this);\n    this.handleSubmit = this.handleSubmit.bind(this);\n  }\n\n  handleChange(event) {    this.setState({value: event.target.value});  }\n  handleSubmit(event) {\n    alert('A name was submitted: ' + this.state.value);\n    event.preventDefault();\n  }\n\n  render() {\n    return (\n      <form onSubmit={this.handleSubmit}>        <label>\n          Name:\n          <input type=\"text\" value={this.state.value} onChange={this.handleChange} />        </label>\n        <input type=\"submit\" value=\"Submit\" />\n      </form>\n    );\n  }\n}
\n

Try it on CodePen

\n

Since the value attribute is set on our form element, the displayed value will always be this.state.value, making the React state the source of truth. Since handleChange runs on every keystroke to update the React state, the displayed value will update as the user types.

\n

With a controlled component, the input’s value is always driven by the React state. While this means you have to type a bit more code, you can now pass the value to other UI elements too, or reset it from other event handlers.

\n

The textarea Tag

\n

In HTML, a <textarea> element defines its text by its children:

\n
<textarea>\n  Hello there, this is some text in a text area\n</textarea>
\n

In React, a <textarea> uses a value attribute instead. This way, a form using a <textarea> can be written very similarly to a form that uses a single-line input:

\n
class EssayForm extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {      value: 'Please write an essay about your favorite DOM element.'    };\n    this.handleChange = this.handleChange.bind(this);\n    this.handleSubmit = this.handleSubmit.bind(this);\n  }\n\n  handleChange(event) {    this.setState({value: event.target.value});  }\n  handleSubmit(event) {\n    alert('An essay was submitted: ' + this.state.value);\n    event.preventDefault();\n  }\n\n  render() {\n    return (\n      <form onSubmit={this.handleSubmit}>\n        <label>\n          Essay:\n          <textarea value={this.state.value} onChange={this.handleChange} />        </label>\n        <input type=\"submit\" value=\"Submit\" />\n      </form>\n    );\n  }\n}
\n

Notice that this.state.value is initialized in the constructor, so that the text area starts off with some text in it.

\n

The select Tag

\n

In HTML, <select> creates a drop-down list. For example, this HTML creates a drop-down list of flavors:

\n
<select>\n  <option value=\"grapefruit\">Grapefruit</option>\n  <option value=\"lime\">Lime</option>\n  <option selected value=\"coconut\">Coconut</option>\n  <option value=\"mango\">Mango</option>\n</select>
\n

Note that the Coconut option is initially selected, because of the selected attribute. React, instead of using this selected attribute, uses a value attribute on the root select tag. This is more convenient in a controlled component because you only need to update it in one place. For example:

\n
class FlavorForm extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {value: 'coconut'};\n    this.handleChange = this.handleChange.bind(this);\n    this.handleSubmit = this.handleSubmit.bind(this);\n  }\n\n  handleChange(event) {    this.setState({value: event.target.value});  }\n  handleSubmit(event) {\n    alert('Your favorite flavor is: ' + this.state.value);\n    event.preventDefault();\n  }\n\n  render() {\n    return (\n      <form onSubmit={this.handleSubmit}>\n        <label>\n          Pick your favorite flavor:\n          <select value={this.state.value} onChange={this.handleChange}>            <option value=\"grapefruit\">Grapefruit</option>\n            <option value=\"lime\">Lime</option>\n            <option value=\"coconut\">Coconut</option>\n            <option value=\"mango\">Mango</option>\n          </select>\n        </label>\n        <input type=\"submit\" value=\"Submit\" />\n      </form>\n    );\n  }\n}
\n

Try it on CodePen

\n

Overall, this makes it so that <input type=\"text\">, <textarea>, and <select> all work very similarly - they all accept a value attribute that you can use to implement a controlled component.

\n
\n

Note

\n

You can pass an array into the value attribute, allowing you to select multiple options in a select tag:

\n
<select multiple={true} value={['B', 'C']}>
\n
\n

The file input Tag

\n

In HTML, an <input type=\"file\"> lets the user choose one or more files from their device storage to be uploaded to a server or manipulated by JavaScript via the File API.

\n
<input type=\"file\" />
\n

Because its value is read-only, it is an uncontrolled component in React. It is discussed together with other uncontrolled components later in the documentation.

\n

Handling Multiple Inputs

\n

When you need to handle multiple controlled input elements, you can add a name attribute to each element and let the handler function choose what to do based on the value of event.target.name.

\n

For example:

\n
class Reservation extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {\n      isGoing: true,\n      numberOfGuests: 2\n    };\n\n    this.handleInputChange = this.handleInputChange.bind(this);\n  }\n\n  handleInputChange(event) {\n    const target = event.target;\n    const value = target.type === 'checkbox' ? target.checked : target.value;\n    const name = target.name;\n    this.setState({\n      [name]: value    });\n  }\n\n  render() {\n    return (\n      <form>\n        <label>\n          Is going:\n          <input\n            name=\"isGoing\"            type=\"checkbox\"\n            checked={this.state.isGoing}\n            onChange={this.handleInputChange} />\n        </label>\n        <br />\n        <label>\n          Number of guests:\n          <input\n            name=\"numberOfGuests\"            type=\"number\"\n            value={this.state.numberOfGuests}\n            onChange={this.handleInputChange} />\n        </label>\n      </form>\n    );\n  }\n}
\n

Try it on CodePen

\n

Note how we used the ES6 computed property name syntax to update the state key corresponding to the given input name:

\n
this.setState({\n  [name]: value});
\n

It is equivalent to this ES5 code:

\n
var partialState = {};\npartialState[name] = value;this.setState(partialState);
\n

Also, since setState() automatically merges a partial state into the current state, we only needed to call it with the changed parts.

\n

Controlled Input Null Value

\n

Specifying the value prop on a controlled component prevents the user from changing the input unless you desire so. If you’ve specified a value but the input is still editable, you may have accidentally set value to undefined or null.

\n

The following code demonstrates this. (The input is locked at first but becomes editable after a short delay.)

\n
ReactDOM.createRoot(mountNode).render(<input value=\"hi\" />);\n\nsetTimeout(function() {\n  ReactDOM.createRoot(mountNode).render(<input value={null} />);\n}, 1000);
\n

Alternatives to Controlled Components

\n

It can sometimes be tedious to use controlled components, because you need to write an event handler for every way your data can change and pipe all of the input state through a React component. This can become particularly annoying when you are converting a preexisting codebase to React, or integrating a React application with a non-React library. In these situations, you might want to check out uncontrolled components, an alternative technique for implementing input forms.

\n

Fully-Fledged Solutions

\n

If you’re looking for a complete solution including validation, keeping track of the visited fields, and handling form submission, Formik is one of the popular choices. However, it is built on the same principles of controlled components and managing state — so don’t neglect to learn them.

","frontmatter":{"title":"Forms","next":"lifting-state-up.html","prev":"lists-and-keys.html"},"fields":{"path":"content/docs/forms.md","slug":"docs/forms.html"}}},"pageContext":{"slug":"docs/forms.html"}},"staticQueryHashes":[]}