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

Hooks are a new addition in React 16.8. They let you use state and other React features without writing a class.

\n

The introduction page used this example to get familiar with Hooks:

\n
import React, { useState } from 'react';\n\nfunction Example() {\n  // Declare a new state variable, which we'll call \"count\"  const [count, setCount] = useState(0);\n  return (\n    <div>\n      <p>You clicked {count} times</p>\n      <button onClick={() => setCount(count + 1)}>\n        Click me\n      </button>\n    </div>\n  );\n}
\n

We’ll start learning about Hooks by comparing this code to an equivalent class example.

\n

Equivalent Class Example

\n

If you used classes in React before, this code should look familiar:

\n
class Example extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {\n      count: 0\n    };\n  }\n\n  render() {\n    return (\n      <div>\n        <p>You clicked {this.state.count} times</p>\n        <button onClick={() => this.setState({ count: this.state.count + 1 })}>\n          Click me\n        </button>\n      </div>\n    );\n  }\n}
\n

The state starts as { count: 0 }, and we increment state.count when the user clicks a button by calling this.setState(). We’ll use snippets from this class throughout the page.

\n
\n

Note

\n

You might be wondering why we’re using a counter here instead of a more realistic example. This is to help us focus on the API while we’re still making our first steps with Hooks.

\n
\n

Hooks and Function Components

\n

As a reminder, function components in React look like this:

\n
const Example = (props) => {\n  // You can use Hooks here!\n  return <div />;\n}
\n

or this:

\n
function Example(props) {\n  // You can use Hooks here!\n  return <div />;\n}
\n

You might have previously known these as “stateless components”. We’re now introducing the ability to use React state from these, so we prefer the name “function components”.

\n

Hooks don’t work inside classes. But you can use them instead of writing classes.

\n

What’s a Hook?

\n

Our new example starts by importing the useState Hook from React:

\n
import React, { useState } from 'react';\nfunction Example() {\n  // ...\n}
\n

What is a Hook? A Hook is a special function that lets you “hook into” React features. For example, useState is a Hook that lets you add React state to function components. We’ll learn other Hooks later.

\n

When would I use a Hook? If you write a function component and realize you need to add some state to it, previously you had to convert it to a class. Now you can use a Hook inside the existing function component. We’re going to do that right now!

\n
\n

Note:

\n

There are some special rules about where you can and can’t use Hooks within a component. We’ll learn them in Rules of Hooks.

\n
\n

Declaring a State Variable

\n

In a class, we initialize the count state to 0 by setting this.state to { count: 0 } in the constructor:

\n
class Example extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = {      count: 0    };  }
\n

In a function component, we have no this, so we can’t assign or read this.state. Instead, we call the useState Hook directly inside our component:

\n
import React, { useState } from 'react';\n\nfunction Example() {\n  // Declare a new state variable, which we'll call \"count\"  const [count, setCount] = useState(0);
\n

What does calling useState do? It declares a “state variable”. Our variable is called count but we could call it anything else, like banana. This is a way to “preserve” some values between the function calls — useState is a new way to use the exact same capabilities that this.state provides in a class. Normally, variables “disappear” when the function exits but state variables are preserved by React.

\n

What do we pass to useState as an argument? The only argument to the useState() Hook is the initial state. Unlike with classes, the state doesn’t have to be an object. We can keep a number or a string if that’s all we need. In our example, we just want a number for how many times the user clicked, so pass 0 as initial state for our variable. (If we wanted to store two different values in state, we would call useState() twice.)

\n

What does useState return? It returns a pair of values: the current state and a function that updates it. This is why we write const [count, setCount] = useState(). This is similar to this.state.count and this.setState in a class, except you get them in a pair. If you’re not familiar with the syntax we used, we’ll come back to it at the bottom of this page.

\n

Now that we know what the useState Hook does, our example should make more sense:

\n
import React, { useState } from 'react';\n\nfunction Example() {\n  // Declare a new state variable, which we'll call \"count\"  const [count, setCount] = useState(0);
\n

We declare a state variable called count, and set it to 0. React will remember its current value between re-renders, and provide the most recent one to our function. If we want to update the current count, we can call setCount.

\n
\n

Note

\n

You might be wondering: why is useState not named createState instead?

\n

“Create” wouldn’t be quite accurate because the state is only created the first time our component renders. During the next renders, useState gives us the current state. Otherwise it wouldn’t be “state” at all! There’s also a reason why Hook names always start with use. We’ll learn why later in the Rules of Hooks.

\n
\n

Reading State

\n

When we want to display the current count in a class, we read this.state.count:

\n
  <p>You clicked {this.state.count} times</p>
\n

In a function, we can use count directly:

\n
  <p>You clicked {count} times</p>
\n

Updating State

\n

In a class, we need to call this.setState() to update the count state:

\n
  <button onClick={() => this.setState({ count: this.state.count + 1 })}>    Click me\n  </button>
\n

In a function, we already have setCount and count as variables so we don’t need this:

\n
  <button onClick={() => setCount(count + 1)}>    Click me\n  </button>
\n

Recap

\n

Let’s now recap what we learned line by line and check our understanding.

\n\n
 1:  import React, { useState } from 'react'; 2:\n 3:  function Example() {\n 4:    const [count, setCount] = useState(0); 5:\n 6:    return (\n 7:      <div>\n 8:        <p>You clicked {count} times</p>\n 9:        <button onClick={() => setCount(count + 1)}>10:         Click me\n11:        </button>\n12:      </div>\n13:    );\n14:  }
\n\n

This might seem like a lot to take in at first. Don’t rush it! If you’re lost in the explanation, look at the code above again and try to read it from top to bottom. We promise that once you try to “forget” how state works in classes, and look at this code with fresh eyes, it will make sense.

\n

Tip: What Do Square Brackets Mean?

\n

You might have noticed the square brackets when we declare a state variable:

\n
  const [count, setCount] = useState(0);
\n

The names on the left aren’t a part of the React API. You can name your own state variables:

\n
  const [fruit, setFruit] = useState('banana');
\n

This JavaScript syntax is called “array destructuring”. It means that we’re making two new variables fruit and setFruit, where fruit is set to the first value returned by useState, and setFruit is the second. It is equivalent to this code:

\n
  var fruitStateVariable = useState('banana'); // Returns a pair\n  var fruit = fruitStateVariable[0]; // First item in a pair\n  var setFruit = fruitStateVariable[1]; // Second item in a pair
\n

When we declare a state variable with useState, it returns a pair — an array with two items. The first item is the current value, and the second is a function that lets us update it. Using [0] and [1] to access them is a bit confusing because they have a specific meaning. This is why we use array destructuring instead.

\n
\n

Note

\n

You might be curious how React knows which component useState corresponds to since we’re not passing anything like this back to React. We’ll answer this question and many others in the FAQ section.

\n
\n

Tip: Using Multiple State Variables

\n

Declaring state variables as a pair of [something, setSomething] is also handy because it lets us give different names to different state variables if we want to use more than one:

\n
function ExampleWithManyStates() {\n  // Declare multiple state variables!\n  const [age, setAge] = useState(42);\n  const [fruit, setFruit] = useState('banana');\n  const [todos, setTodos] = useState([{ text: 'Learn Hooks' }]);
\n

In the above component, we have age, fruit, and todos as local variables, and we can update them individually:

\n
  function handleOrangeClick() {\n    // Similar to this.setState({ fruit: 'orange' })\n    setFruit('orange');\n  }
\n

You don’t have to use many state variables. State variables can hold objects and arrays just fine, so you can still group related data together. However, unlike this.setState in a class, updating a state variable always replaces it instead of merging it.

\n

We provide more recommendations on splitting independent state variables in the FAQ.

\n

Next Steps

\n

On this page we’ve learned about one of the Hooks provided by React, called useState. We’re also sometimes going to refer to it as the “State Hook”. It lets us add local state to React function components — which we did for the first time ever!

\n

We also learned a little bit more about what Hooks are. Hooks are functions that let you “hook into” React features from function components. Their names always start with use, and there are more Hooks we haven’t seen yet.

\n

Now let’s continue by learning the next Hook: useEffect. It lets you perform side effects in components, and is similar to lifecycle methods in classes.

","frontmatter":{"title":"Using the State Hook","next":"hooks-effect.html","prev":"hooks-overview.html"},"fields":{"path":"content/docs/hooks-state.md","slug":"docs/hooks-state.html"}}},"pageContext":{"slug":"docs/hooks-state.html"}},"staticQueryHashes":[]}