307

I seem to be having issues pushing data into a state array. I am trying to achieve it this way:

this.setState({ myArray: this.state.myArray.push('new value') })

But I believe this is incorrect way and causes issues with mutability?

1
  • 2
    Array.push returns the new length of the array instead of returning new array which causes issue Commented Jan 13, 2022 at 7:36

17 Answers 17

318

Using es6 it can be done like this:

this.setState({ myArray: [...this.state.myArray, 'new value'] }) //simple value
this.setState({ myArray: [...this.state.myArray, ...[1,2,3] ] }) //another array

Spread syntax

Sign up to request clarification or add additional context in comments.

8 Comments

I did the same, there are two cases myArray can have values and it won't. so in that, if it has already values, it works perfectly fine. But in no data..it does not update state with 'new value'. Any soln ?
It should work with any arrays, doesn't matter if it has values or not it will be destructured anyway. Maybe there is something wrong in other place. Could you please show an example of your code?
hi Please refer my comment under @Tamas answer. It was just a sample in console. I tried myArray: [...this.state.myArray, 'new value'] to update my state array.But it concats only the last value.Could you plz tell me the solution?
@Johncy I’m not sure if your issue is related to this question, try to ask a separate question and describe the expected behavior and I’ll try to help you.
Per the React docs: "Because this.props and this.state may be updated asynchronously, you should not rely on their values for calculating the next state." In the case of modifying an array, since the array already exists as a property of this.state and you need to reference its value to set a new value, you should use the form of setState() that accepts a function with the previous state as an argument. Example: this.setState(prevState => ({ myArray: [...this.state.myArray, 'new value'] })); See: reactjs.org/docs/…
|
246

Functional Components & React Hooks

const [array,setArray] = useState([]);

Push value at the end:

setArray(oldArray => [...oldArray,newValue] );

Push value at the start:

setArray(oldArray => [newValue,...oldArray] );

3 Comments

what do I do if I have an array of objects to add to an existing array?
Short modification - the snippet for push value at the beginning shall be: setArray(oldArray => [newValue,...oldArray] );
@SouvikRay you can use Array.concat to merge two arrays and return new array. developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/…
216

Array push returns length

this.state.myArray.push('new value') returns the length of the extended array, instead of the array itself.Array.prototype.push().

I guess you expect the returned value to be the array.

Immutability

It seems it's rather the behaviour of React:

NEVER mutate this.state directly, as calling setState() afterwards may replace the mutation you made. Treat this.state as if it were immutable.React.Component.

I guess, you would do it like this (not familiar with React):

this.setState({ myArray: [...this.state.myArray, 'new value'] })

7 Comments

When I do console.log(this.state.myArray) it's always one behind. Any idea why?
@Si8 Well, I don't use React too much unfortunately. But the docs say: setState() enqueues changes to the component state and tells React that this component and its children need to be re-rendered with the updated state. So I guess it's just not updated at that moment right after setting it. Could You please post a code example, where we can see which point You are setting and logging it, please?
Thanks for the response. It's async so it won't show you the changes right away. However setState does have a callback which did display the correct value. Thanks again.
w3schools.com/jsref/jsref_concat_array.asp concat concatenates two arrays (not array and string) , .concat('new value'); should be .concat(['new value']);
@ManoharReddyPoreddy Non-array values are perfectly valid for the concat() method. See: developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/… (Arrays and/or values to concatenate into a new array.)
|
164

Never recommended to mutate the state directly.

The recommended approach in later React versions is to use an updater function when modifying states to prevent race conditions:

Push string to end of the array

this.setState(prevState => ({
  myArray: [...prevState.myArray, "new value"]
}))

Push string to beginning of the array

this.setState(prevState => ({
  myArray: ["new value", ...prevState.myArray]
}))

Push object to end of the array

this.setState(prevState => ({
  myArray: [...prevState.myArray, {"name": "object"}]
}))

Push object to beginning of the array

this.setState(prevState => ({
  myArray: [ {"name": "object"}, ...prevState.myArray]
}))

6 Comments

I used this answer. It also works for prepending into the array: this.setState((prevState) => ({ myArray: [values, ...prevState.myArray], }));
this is a much better approach than the accepted answer and does it the way React documentation recommends.
Definitely +1ing this because the other answers don't follow the latest guidelines of using callbacks if mutating state with itself.
how to add another array objects in state array?
This creates a new array that becomes myArray: updatedContents rather than just leaving it as an array of the updated contents. If you're mapping the original array, this will cause an error due to the new structure. Is that intentional?
|
26

You should not be operating the state at all. At least, not directly. If you want to update your array, you'll want to do something like this.

var newStateArray = this.state.myArray.slice();
newStateArray.push('new value');
this.setState(myArray: newStateArray);

Working on the state object directly is not desirable. You can also take a look at React's immutability helpers.

https://facebook.github.io/react/docs/update.html

1 Comment

I believe this answer to be the correct one although I would have liked to know why we can't operate on state, i.e. why it is not desirable. After a little digging I found the following React tutorial - Why Immutability is Important, which helped to fill in the missing info and the tutorial also uses .slice() to create a new array and preserve immutability. Thanks for the help.
23

Here you can not push the object to a state array like this. You can push like your way in normal array. Here you have to set the state,

this.setState({ 
     myArray: [...this.state.myArray, 'new value'] 
})

Comments

17

You can use .concat method to create copy of your array with new data:

this.setState({ myArray: this.state.myArray.concat('new value') })

But beware of special behaviour of .concat method when passing arrays - [1, 2].concat(['foo', 3], 'bar') will result in [1, 2, 'foo', 3, 'bar'].

Comments

15

Using react hooks, you can do following way

const [countryList, setCountries] = useState([]);


setCountries((countryList) => [
        ...countryList,
        "India",
      ]);

2 Comments

what do I do if I have an array of objects to add to an existing array?
setCountries((countryList) => [ ...countryList, {id:1, name:'india'}, ]);
4

This Code work for me :

fetch('http://localhost:8080')
  .then(response => response.json())
  .then(json => {
  this.setState({mystate: this.state.mystate.push.apply(this.state.mystate, json)})
})

4 Comments

Welcome to Stack Overflow! Please don't answer just with source code. Try to provide a nice description about how your solution works. See: How do I write a good answer?. Thanks
I tried this but to no avail. Here's my code fetch(`api.openweathermap.org/data/2.5/forecast?q=${this.searchBox.value + KEY} `) .then( response => response.json() ) .then( data => { this.setState({ reports: this.state.reports.push.apply(this.state.reports, data.list)}); });
and i firstly initialized state as an empty array i.e this.state = { reports=[] }...pls i'll like to know what i'm doing wrong
@Hamid Hosseinpour
3
  setState([...prevState, {
    label: newState.name,
    value: newState.id
  }]);

Was working with the dropdowns and wanted to implement this scenario there, i found this simple solution for dropdown with multiple values.

Comments

2

React-Native

if u also want ur UI (ie. ur flatList) to be up to date, use PrevState: in the example below if user clicks on the button , it is going to add a new object to the list( both in the model and UI)

data: ['shopping','reading'] // declared in constructor
onPress={() => {this.setState((prevState, props) => {
return {data: [new obj].concat(prevState.data) };
})}}. 

Comments

2

In the following way we can check and update the objects

this.setState(prevState => ({
    Chart: this.state.Chart.length !== 0 ? [...prevState.Chart,data[data.length - 1]] : data
}));

Comments

1

If you use:

const[myArr, setMyArr] = useState([]);

for add:

setMyArr([...myArr, value]);

and for remove:

let index = myArr.indexOf(value);
if(index !== -1)
    setPatch([...myArr.slice(0, index), ...myArr.slice(index, myArr.length-1)]);

Comments

0

you are breaking React principles, you should clone the old state then merge it with the new data, you shouldn't manipulate your state directly, your code should go like this

fetch('http://localhost:8080').then(response => response.json()).then(json ={this.setState({mystate[...this.state.mystate, json]}) })

Comments

0

It is the best and simplest way in reactJS if you working in functional components!

setSelectedTaxDec((oldArray) => [...oldArray, dec]);

oldArray is the previousState in which I am pushing the new value dec, is the value I am pushing in this state array

you can avoid pushing the same item again by doing this

if (selectedTaxDec.includes(dec)) {
    return;
  } else {
    setSelectedTaxDec((oldArray) => [...oldArray, dec]);
  }

Comments

0

If your array is too large for conventional [...oldArray, newValue] to be feasible (as it is O(N) complexity contrary to the O(1) complexity of .push() operation), you can wrap the array in an object to make sure to notify react of the update every time you mutate the array:

this.state = {
    myArrayUpdateWrapper: {
        myArray: [],
    },
};
...
function pushToStateArray(newValue) {
    const { myArray } = this.state.myArrayUpdateWrapper;
    myArray.push(newValue);
    this.setState({ myArrayUpdateWrapper: { myArray } });
}

I believe this approach is both compliant with React principles and is efficient too. Very surprised that nobody mentioned it so far, even in the downvoted answers.

Comments

-1

I guess this is a little bit late for an answer but for those new to react

You can use this tiny package called immer

see this example: https://immerjs.github.io/immer/produce

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.