176

I've initialized a state that is an array, and when I update it my component does not re-render. Here is a minimal proof-of-concept:

function App() {
  const [numbers, setNumbers] = React.useState([0, 1, 2, 3]);
  console.log("rendering...");
  return (
    <div className="App">
      {numbers.map(number => (
        <p>{number}</p>
      ))}
      <input
        type="text"
        value={numbers[0].toString()}
        onChange={newText => {
          let old = numbers;
          old[0] = 1;
          setNumbers(old);
        }}
      />
    </div>
  );
}

Based on this code, it seems that the input should contain the number 0 to start, and any time it is changed, the state should change too. After entering "02" in the input, the App component does not re-render. However, if I add a setTimeout in the onChange function which executes after 5 seconds, it shows that numbers has indeed been updated.

Any thoughts on why the component doesn't update?

Here is a CodeSandbox with the proof of concept.

Antony Hatchkins
  • 28,884
  • 9
  • 105
  • 105
Ryan Z
  • 2,151
  • 2
  • 7
  • 20

6 Answers6

446

You're calling setNumbers and passing it the array it already has. You've changed one of its values but it's still the same array, and I suspect React doesn't see any reason to re-render because state hasn't changed; the new array is the old array.

One easy way to avoid this is by spreading the array into a new array:

setNumbers([...old])
ray hatfield
  • 21,681
  • 4
  • 26
  • 25
  • 1
    Very good answer. I'm doing a sorting after object.likes, and setRecipes([...recipes.sort((a, b) => (b.likes.length - a.likes.length))]) triggered the re-render, and everything works like a charm. Thanks. – Stephan Bakkelund Valois Jul 26 '20 at 17:35
  • 3
    ohhhh so it internally compares the reference instead of checking for full equality. makes sense. would be nice if we could decide rerenders ourselfs instead of letting state setters do it in the background (maybe its already possible i have no idea) – Alan Oct 12 '20 at 13:28
  • 1
    What about child component? – digz6666 Apr 06 '21 at 16:03
  • 2
    This is the best answer. Thanks! – Calin Vlasin May 31 '21 at 02:19
  • Are there any performance impacts to this solution? – ripytide Jun 02 '21 at 16:03
  • Brilliant and simple solution – Robby Hoover Aug 02 '21 at 04:19
  • This was my problem... but why would it behave like this? I'm changing a top-level string property. Even a shallow equal check would see a different object.... – adamdabb Aug 15 '21 at 17:49
  • @adamdabb It's not checking the _contents_ of the array, it's testing whether the array itself is the same object. And even if it did test the contents you'd get the same result because you'd be checking it against itself. – ray hatfield Aug 17 '21 at 16:47
  • I understand that this will work because the state updater is always passed a new reference, but why not fix the actual state mutation causing the problem? This fixes the symptom, but really just hides the true bug. – Brian Thompson Oct 25 '21 at 19:26
  • It very helped me, too. – dbld Dec 02 '21 at 13:35
  • I have the same problem with boolean. have any Idea?! – kamiyar Dec 13 '21 at 13:06
  • Is the boolean a property in an object? Same thing could occur. – ray hatfield Dec 13 '21 at 15:30
39

You need to copy numbers like so let old = [...numbers];

useState doesn't update the value only if it has changed so if it was 44 and it became 7 it will update. but how can it know if an array or object have changed. it's by reference so when you do let old = numbers you are just passing a reference and not creating a new one

evgeni fotia
  • 4,320
  • 2
  • 14
  • 31
27

Others have already given the technical solution. To anyone confused as to why this happens, is because setSomething() only re renders the component if and only if the previous and current state is different. Since arrays in javascript are reference types, if you edit an item of an array in js, it still doesn't change the reference to the original array. In js's eyes, these two arrays are the same, even though the original content inside those arrays are different. That's why setSomething() fails do detect the changes made to the old array.

Note that if you use class components and update the state using setState() then the component will always update regardless of whether the state has changed or not. So, you can change your functional component to a class component as a solution. Or follow the answers provided by others.

KMA Badshah
  • 691
  • 5
  • 16
  • Ok, so regardless of array vs object since both are references to the original, why not just always do an `Object.assign([], original)` when updating properties of a state object? Why is that not the de-facto answer and in the documentation? – AlxVallejo May 03 '22 at 12:43
20

You can change state like this

const [state, setState] = ({})
setState({...state})

or if your state is Array you can change like this

const [state, setState] = ([])
setState([...state])
Dharman
  • 26,923
  • 21
  • 73
  • 125
-1
  //define state using useState hook
  const [numbers, setNumbers] = React.useState([0, 1, 2, 3]);

  //copy existing numbers in temp
  let tempNumbers = [...numbers];
  // modify/add no
  tempNumbers.push(4);
  tempNumbers[0] = 10;
  // set modified numbers
  setNumbers(tempNumbers);
  • 4
    Don't simply post a snippet of code. Rather try to give a bit more context/explanation please. – kissu Jun 22 '21 at 14:42
-4

useState is a React hook which provides functionality of having State in a functional component. Usually it informs React to re-render the component whenever there is change in useState variables.

{
      let old = numbers;
      old[0] = 1;
      setNumbers(old);
}

In the above code since you are referring to the same variable it stores the reference not the value hence React doesn't know about the latest changes as the reference is same as previous.

To overcome use the below hack, which will not copy the reference instead it's a deep copy(copies the values)

{
      let old = JSON.parse(JSON.stringify(numbers));
      old[0] = 1;
      setNumbers(old);
}

Happy coding :)

ajaykumar mp
  • 330
  • 3
  • 10