React-Native another VirtualizedList-backed container

Question

After upgrading to react-native 0.61 i get a lot of warnings like that:

VirtualizedLists should never be nested inside plain ScrollViews with the same orientation - use another VirtualizedList-backed container instead.

What is the other VirtualizedList-backed container that i should use, and why is it now advised not to use like that?

user_7364741 · Answer

If someone's still looking for a suggestion to the problem that @Ponleu and @David Schilling have described here (regarding content that goes above the FlatList), then this is the approach I took:

You can read more about this here: https://facebook.github.io/react-native/docs/flatlist#listheadercomponent

Hopefully it helps someone. :)

user_182677 · Answer

Just in case this helps someone, this is how I fixed the error in my case.

I had a FlatList nested inside a ScrollView:

render() {
    return (
        
            {'My Title'}
             {
                    return {item.name};
                }}
            />
            {this.state.loading && {'Loading...'}}
        
    );
}

and I got rid of the ScrollView by using the FlatList to render everything I needed, which got rid of the warning:

render() {
    const getHeader = () => {
        return {'My Title'};
    };

    const getFooter = () => {
        if (this.state.loading) {
            return null;
        }
        return {'Loading...'};
    };

    return (
         {
                return {item.name};
            }}
            ListHeaderComponent={getHeader}
            ListFooterComponent={getFooter}
        />
    );
}

user_8798220 · Answer

The best way is to disable that warning because sometimes Flatlist need to be in ScrollView.

UPDATE RN V0.63 ABOVE

YellowBox is now changed and replace with LogBox

FUNCTIONAL

import React, { useEffect } from 'react';
import { LogBox } from 'react-native';

useEffect(() => {
    LogBox.ignoreLogs(['VirtualizedLists should never be nested']);
}, [])

CLASS BASED

import React from 'react';
import { LogBox } from 'react-native';

componentDidMount() {
    LogBox.ignoreLogs(['VirtualizedLists should never be nested']);
}

UPDATE RN V0.63 BELOW

FUNCTIONAL

import React, { useEffect } from 'react';
import { YellowBox } from 'react-native';

useEffect(() => {
    YellowBox.ignoreWarnings(['VirtualizedLists should never be nested']);
}, [])

CLASS BASED

import React from 'react';
import { YellowBox } from 'react-native';

componentDidMount() {
    YellowBox.ignoreWarnings(['VirtualizedLists should never be nested']);
}

user_13342499 · Answer

Data

// dummy data array
const data = [
    {id: 1, name: 'Tom'},
    {id: 2, name: 'Jerry'},
]

Solution #1

You can make a custom component for that like this

const VirtualizedList = ({children}) => {
    return (
         "key"}
            renderItem={null}
            ListHeaderComponent={
                <>{children}
            }
        />
    )
}

then use this VirtualizedList as parent component:

...
return (
    
          item.id + index.toString()}
           renderItem={_renderItem}
         />
         
    
)

Solution #2

If you use FlatList inside the ScrollView it gives warning which is annoying, so you can use array's map property, like this -

NOTE: It is not recommended way to show list. If you have small amount of that then you can use it that's totally fine, but if you want to show a list which get data from api and have lot's of data then you can go with other solutions. if you use map with large data then it affect your app performance


    {data.map((item, index) => (
        
           {item.name}
        
    ))}

Solution #3

if you make your FlatList horizontal (as per your need) then also warning will disappear


     item.id + index.toString()}
       horizontal={true}
    />

Solution #4

you can add header and footer component

In ListHeaderComponent and ListFooterComponent you can add any component so you don't need parent ScrollView

 item.id + index.toString()}
   ListHeaderComponent={headerComponent}
   ListFooterComponent={footerComponent}
   ListEmptyComponent={emptyComponent}
   ItemSeparatorComponent={separator}
/>

// List components
const headerComponent = () => (
    
       
       
    
)
const footerComponent = () => (
    
       
       
    
)
const emptyComponent = () => (
    
       
       
    
)
const separator = () => (
    
)

user_9227557 · Answer

The warning appears because ScrollView and FlatList share the same logic, if FlatList run inside ScrollView, it's duplicated

By the way SafeAreaView doesn't work for me, the only way to solve is


    {data.map((item, index) => {
        ...your code
    }}

The error disappears

user_5273427 · Answer

Looking at the examples in docs I've changed container from:

to:

and all those warnings disappeared.

user_5225096 · Answer

In my case, I needed to have FlatLists nested in a ScrollView because I am using react-native-draggable-flatlist to move ingredients and steps around in a recipe.

If we read the warning properly, it says that we should use another VirtualizedList-backed container to nest our child FlatList in. What I did is:

 /* outside the component */
const emptyArry = []

/* render */
 )
  />

No more warning, and I think this is the pattern recommended by the warning.

user_10164608 · Answer

user_5609439 · Answer

Below code works perfectly for me to disable annoying error:

VirtualizedLists should never be nested inside plain ScrollViews with the same orientation because it can break windowing and other functionality - use another VirtualizedList-backed container instead.

React Native 0.68.2

user_13126073 · Answer

I tried some ways to solve this, including ListHeaderComponent or ListFooterComponent, but it all didn't fit for me.

layout I wanted to achieve is like this, and I wanted to get scrolled in once.


  I'm the first view
  I'm the second view

First I want to say thanks to this issue and comments, which gave me bunch of ideas.

I was thinking of ListHeaderComponent places above the Flatlist, but since my Flatlist's direction was column, the header I wanted to place went on the left of the Flatlist :(

Then I had to try on VirtualizedList-backed thing. I just tried to pack all components in VirtualizedList, where renderItems gives index and there I could pass components conditionally to renderItems.

I could have worked this with Flatlist, but I haven't tried yet.
Finally it looks like this.


  {
      props.index===0 ? (1st view here) : props.index===1 ? (2nd view here) : (my flatlist)
    }}
    keyExtractor={item => item.key}
    getItemCount={2}
    getItem={ (data, index) => {
      return {
        id: Math.random().toString(12).substring(0),
      }
    }}
  />


(inside which lazyly renders↓)
  I'm the first view
  I'm the second view

and of course able to scroll the whole screen.

user_11247413 · Answer

As @Brahim stated above, setting the horizontal property to true seem to resolve the issues for a FlatList embedded in a ScrollView.

user_9724369 · Answer

So I faced the same problem while using a picker-based component inside and the one thing that helped me solve the problem was adding keyboardShouldPersistTaps={true} inside the as a prop.

This is my code snippet.

user_7900610 · Answer

In my opinion i can use map instead of FlatList. But in my case i wan't to show large list. Not using FlatList may cause performance issue. so i used this to suppress warning https://github.com/GeekyAnts/NativeBase/issues/2947#issuecomment-549210509

user_1950242 · Answer

Without hiding YellowBox you still can implement scroollable view inside scrollable view. You can use this library. It replace the default Scrollview from React Native.

user_5102933 · Answer

This may help someone down the line, be sure you to check how your components are nested. Removing the ScrollView from the top component fixed the issue.

I ran into this issue because I had two components nested like this essentially:

Component 1

My second component 'ListComponent' had a FlatList already wrapped with SafeAreaView.


     }
        keyExtractor={item => item.id.toString()}
    />

In the end I replaced the ScrollView from the first component with a View instead.

user_9464846 · Answer

I was having this issue using a scrollview as parent view, and nesting a SelectBox from react-native-multi-selectbox package. I was able to solve this by adding listOptionProps={{nestedScrollEnabled: true}} like this:


  
      inputHandlerLang('elementSelected', event, key)
    }
    hideInputFilter={false}
  />

the error still present but scrolling within SelectBox works as well as within the parent scrollview. I also do have to suppress the error with LogBox. I don't know if there are any drawbacks to this but I'll try to test this more.

user_14448694 · Answer

Use flatList like this ListHeaderComponent and ListFooterComponent:


        
        
    
    }
    data={this.state.images}
    renderItem={({ item, index }) => {
        return (
            
                
                
                    {item.name}
                
            
        );
    }}
    keyExtractor={({ name }, index) => index.toString()}
    ListFooterComponent={
        
    }
/>

user_441894 · Answer

This worked for me (as a bit of a hack). Use a FlatList with empty data and null renderItem props instead of using a ScrollView

const emptyData = [];

const renderNullItem = () => null;

const App = () => {
  const ListFooterComponent = (
    
  );

  return (
    
      
    
  );
};

user_11153326 · Answer

If you use ScrollView and FlatList together you'll get inconsistent scroll behaviour. So just remove ScrollView and use FlatList in a View.


 this.renderItem(item) }
    keyExtractor={item => item.id}
    />

user_9327447 · Answer

I have two Flatlist; each of them has many Item also has a feature to collapse and expand. Because of that, I can't use SafeAreaView.

I saw another solution and found a new way.

I define one Flatlist in the core component ( without Scrollview) and render each Flatlist with a map function inside ListHeaderComponent and ListFooterComponent.

 
     sample()}
        ListHeaderComponent = {
          
             {collapse/expandComponent}
             {this.state.sample1&& content1.map((item, index) => this.renderList1(item,index))}
          
        }
        ListFooterComponent = {
          
            {collapse/expandComponent}
            {this.state.sample2 && content2.map((item, index) => this.renderlist2(item,index))}
          
        }
      />

user_466823 · Answer

import React from 'react';
import { FlatList, ScrollViewProps } from 'react-native';

export const ScrollView: React.FC = props => {
  return (
     null}
      ListHeaderComponent={() => (
        {props.children}
      )}
      ListEmptyComponent={null}
      keyExtractor={() => 'blank'}
    />
  );
};

This will essentially work exactly like a ScrollView except without this error.

user_10408028 · Answer

Actually as I know, using nested VirtualizedLists, caused always performance issues, just the warning to that issue is new. I tried everything I found on the internet, non of them helped. I use now ScrollView or when you just have a normall View with maxHeight then you will be able to scroll if the content-height is bigger then the maxHeight of you View. So:


   {items.map((item, index) =>
       
   )}

Or just:


    {items.map((item, index) =>
       
    )}

user_11802548 · Answer

This error disappeared because of using FlatList inside ScrollView. You can write like the following code.


            
              
                
              

                {(list.length == 0) &&
                  
                    No peripherals
                  
                }
                 this.renderItem(item) }
                  keyExtractor={item => item.id}
                />

user_13886623 · Answer

You can add horizontal=True and contentContainerStyle={{ width: '100%' }} to the ScrollView parent.


   item.cc}
    ItemSeparatorComponent={Separator}
    renderItem={({ item }) => (
      
    )}
  />

user_12082380 · Answer

I had the same issue, and just got rid of it by removing the ScrollView around the FlatList. Because by default FlatList provides Scroll Functionality based on the length of content that it renders.