{"componentChunkName":"component---src-templates-docs-js","path":"/docs/state-and-lifecycle.html","result":{"data":{"markdownRemark":{"html":"

This page introduces the concept of state and lifecycle in a React component. You can find a detailed component API reference here.

\n

Consider the ticking clock example from one of the previous sections. In Rendering Elements, we have only learned one way to update the UI. We call ReactDOM.render() to change the rendered output:

\n
function tick() {\n  const element = (\n    <div>\n      <h1>Hello, world!</h1>\n      <h2>It is {new Date().toLocaleTimeString()}.</h2>\n    </div>\n  );\n  ReactDOM.render(    element,    document.getElementById('root')  );}\n\nsetInterval(tick, 1000);
\n

Try it on CodePen

\n

In this section, we will learn how to make the Clock component truly reusable and encapsulated. It will set up its own timer and update itself every second.

\n

We can start by encapsulating how the clock looks:

\n
function Clock(props) {\n  return (\n    <div>      <h1>Hello, world!</h1>      <h2>It is {props.date.toLocaleTimeString()}.</h2>    </div>  );\n}\n\nfunction tick() {\n  ReactDOM.render(\n    <Clock date={new Date()} />,    document.getElementById('root')\n  );\n}\n\nsetInterval(tick, 1000);
\n

Try it on CodePen

\n

However, it misses a crucial requirement: the fact that the Clock sets up a timer and updates the UI every second should be an implementation detail of the Clock.

\n

Ideally we want to write this once and have the Clock update itself:

\n
ReactDOM.render(\n  <Clock />,  document.getElementById('root')\n);
\n

To implement this, we need to add “state” to the Clock component.

\n

State is similar to props, but it is private and fully controlled by the component.

\n

Converting a Function to a Class

\n

You can convert a function component like Clock to a class in five steps:

\n
    \n
  1. Create an ES6 class, with the same name, that extends React.Component.
    2. \n
  2. Add a single empty method to it called render().
    3. \n
  3. Move the body of the function into the render() method.
    4. \n
  4. Replace props with this.props in the render() body.
    5. \n
  5. Delete the remaining empty function declaration.
    6. \n
\n
class Clock extends React.Component {\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.props.date.toLocaleTimeString()}.</h2>\n      </div>\n    );\n  }\n}
\n

Try it on CodePen

\n

Clock is now defined as a class rather than a function.

\n

The render method will be called each time an update happens, but as long as we render <Clock /> into the same DOM node, only a single instance of the Clock class will be used. This lets us use additional features such as local state and lifecycle methods.

\n

Adding Local State to a Class

\n

We will move the date from props to state in three steps:

\n
    \n
  1. Replace this.props.date with this.state.date in the render() method:
    2. \n
\n
class Clock extends React.Component {\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.state.date.toLocaleTimeString()}.</h2>      </div>\n    );\n  }\n}
\n
    \n
  1. Add a class constructor that assigns the initial this.state:
    2. \n
\n
class Clock extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {date: new Date()};  }\n\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.state.date.toLocaleTimeString()}.</h2>\n      </div>\n    );\n  }\n}
\n

Note how we pass props to the base constructor:

\n
  constructor(props) {\n    super(props);    this.state = {date: new Date()};\n  }
\n

Class components should always call the base constructor with props.

\n
    \n
  1. Remove the date prop from the <Clock /> element:
    2. \n
\n
ReactDOM.render(\n  <Clock />,  document.getElementById('root')\n);
\n

We will later add the timer code back to the component itself.

\n

The result looks like this:

\n
class Clock extends React.Component {\n  constructor(props) {    super(props);    this.state = {date: new Date()};  }\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.state.date.toLocaleTimeString()}.</h2>      </div>\n    );\n  }\n}\n\nReactDOM.render(\n  <Clock />,  document.getElementById('root')\n);
\n

Try it on CodePen

\n

Next, we’ll make the Clock set up its own timer and update itself every second.

\n

Adding Lifecycle Methods to a Class

\n

In applications with many components, it’s very important to free up resources taken by the components when they are destroyed.

\n

We want to set up a timer whenever the Clock is rendered to the DOM for the first time. This is called “mounting” in React.

\n

We also want to clear that timer whenever the DOM produced by the Clock is removed. This is called “unmounting” in React.

\n

We can declare special methods on the component class to run some code when a component mounts and unmounts:

\n
class Clock extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {date: new Date()};\n  }\n\n  componentDidMount() {  }\n  componentWillUnmount() {  }\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.state.date.toLocaleTimeString()}.</h2>\n      </div>\n    );\n  }\n}
\n

These methods are called “lifecycle methods”.

\n

The componentDidMount() method runs after the component output has been rendered to the DOM. This is a good place to set up a timer:

\n
  componentDidMount() {\n    this.timerID = setInterval(      () => this.tick(),      1000    );  }
\n

Note how we save the timer ID right on this (this.timerID).

\n

While this.props is set up by React itself and this.state has a special meaning, you are free to add additional fields to the class manually if you need to store something that doesn’t participate in the data flow (like a timer ID).

\n

We will tear down the timer in the componentWillUnmount() lifecycle method:

\n
  componentWillUnmount() {\n    clearInterval(this.timerID);  }
\n

Finally, we will implement a method called tick() that the Clock component will run every second.

\n

It will use this.setState() to schedule updates to the component local state:

\n
class Clock extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {date: new Date()};\n  }\n\n  componentDidMount() {\n    this.timerID = setInterval(\n      () => this.tick(),\n      1000\n    );\n  }\n\n  componentWillUnmount() {\n    clearInterval(this.timerID);\n  }\n\n  tick() {    this.setState({      date: new Date()    });  }\n  render() {\n    return (\n      <div>\n        <h1>Hello, world!</h1>\n        <h2>It is {this.state.date.toLocaleTimeString()}.</h2>\n      </div>\n    );\n  }\n}\n\nReactDOM.render(\n  <Clock />,\n  document.getElementById('root')\n);
\n

Try it on CodePen

\n

Now the clock ticks every second.

\n

Let’s quickly recap what’s going on and the order in which the methods are called:

\n
    \n
  1. When <Clock /> is passed to ReactDOM.render(), React calls the constructor of the Clock component. Since Clock needs to display the current time, it initializes this.state with an object including the current time. We will later update this state.
    2. \n
  2. React then calls the Clock component’s render() method. This is how React learns what should be displayed on the screen. React then updates the DOM to match the Clock’s render output.
    3. \n
  3. When the Clock output is inserted in the DOM, React calls the componentDidMount() lifecycle method. Inside it, the Clock component asks the browser to set up a timer to call the component’s tick() method once a second.
    4. \n
  4. Every second the browser calls the tick() method. Inside it, the Clock component schedules a UI update by calling setState() with an object containing the current time. Thanks to the setState() call, React knows the state has changed, and calls the render() method again to learn what should be on the screen. This time, this.state.date in the render() method will be different, and so the render output will include the updated time. React updates the DOM accordingly.
    5. \n
  5. If the Clock component is ever removed from the DOM, React calls the componentWillUnmount() lifecycle method so the timer is stopped.
    6. \n
\n

Using State Correctly

\n

There are three things you should know about setState().

\n

Do Not Modify State Directly

\n

For example, this will not re-render a component:

\n
// Wrong\nthis.state.comment = 'Hello';
\n

Instead, use setState():

\n
// Correct\nthis.setState({comment: 'Hello'});
\n

The only place where you can assign this.state is the constructor.

\n

State Updates May Be Asynchronous

\n

React may batch multiple setState() calls into a single update for performance.

\n

Because this.props and this.state may be updated asynchronously, you should not rely on their values for calculating the next state.

\n

For example, this code may fail to update the counter:

\n
// Wrong\nthis.setState({\n  counter: this.state.counter + this.props.increment,\n});
\n

To fix it, use a second form of setState() that accepts a function rather than an object. That function will receive the previous state as the first argument, and the props at the time the update is applied as the second argument:

\n
// Correct\nthis.setState((state, props) => ({\n  counter: state.counter + props.increment\n}));
\n

We used an arrow function above, but it also works with regular functions:

\n
// Correct\nthis.setState(function(state, props) {\n  return {\n    counter: state.counter + props.increment\n  };\n});
\n

State Updates are Merged

\n

When you call setState(), React merges the object you provide into the current state.

\n

For example, your state may contain several independent variables:

\n
  constructor(props) {\n    super(props);\n    this.state = {\n      posts: [],      comments: []    };\n  }
\n

Then you can update them independently with separate setState() calls:

\n
  componentDidMount() {\n    fetchPosts().then(response => {\n      this.setState({\n        posts: response.posts      });\n    });\n\n    fetchComments().then(response => {\n      this.setState({\n        comments: response.comments      });\n    });\n  }
\n

The merging is shallow, so this.setState({comments}) leaves this.state.posts intact, but completely replaces this.state.comments.

\n

The Data Flows Down

\n

Neither parent nor child components can know if a certain component is stateful or stateless, and they shouldn’t care whether it is defined as a function or a class.

\n

This is why state is often called local or encapsulated. It is not accessible to any component other than the one that owns and sets it.

\n

A component may choose to pass its state down as props to its child components:

\n
<FormattedDate date={this.state.date} />
\n

The FormattedDate component would receive the date in its props and wouldn’t know whether it came from the Clock’s state, from the Clock’s props, or was typed by hand:

\n
function FormattedDate(props) {\n  return <h2>It is {props.date.toLocaleTimeString()}.</h2>;\n}
\n

Try it on CodePen

\n

This is commonly called a “top-down” or “unidirectional” data flow. Any state is always owned by some specific component, and any data or UI derived from that state can only affect components “below” them in the tree.

\n

If you imagine a component tree as a waterfall of props, each component’s state is like an additional water source that joins it at an arbitrary point but also flows down.

\n

To show that all components are truly isolated, we can create an App component that renders three <Clock>s:

\n
function App() {\n  return (\n    <div>\n      <Clock />      <Clock />      <Clock />    </div>\n  );\n}\n\nReactDOM.render(\n  <App />,\n  document.getElementById('root')\n);
\n

Try it on CodePen

\n

Each Clock sets up its own timer and updates independently.

\n

In React apps, whether a component is stateful or stateless is considered an implementation detail of the component that may change over time. You can use stateless components inside stateful components, and vice versa.

","frontmatter":{"title":"State and Lifecycle","next":"handling-events.html","prev":"components-and-props.html"},"fields":{"path":"content/docs/state-and-lifecycle.md","slug":"docs/state-and-lifecycle.html"}}},"pageContext":{"slug":"docs/state-and-lifecycle.html"}},"staticQueryHashes":[]}