README.md

react-native-fresh-flatlist

Do you need to update FlatList data frequently? Are people constantly complaining that they don't see the most up-to-date information? Try using this component by simply entering data. Refreshing is the responsibility of this component, Get away from data refreshing logic and focus on other things.

Features

• Flatlist based on infinite scroll page.
• Take a page and combine them existen pages.
• When you move to another screen and then come back, only the page you are currently viewing is retrieved and the page in the list is updated.
  • If the page you are currently viewing is between the current page and the next page, both pages will be refreshed.
• Reset by external request.
• refresh only the page currently being viewed or a specific page.
• Props that can utilize caching data

Installation

npm install react-native-fresh-flatlist
# or
yarn add react-native-fresh-flatlist

Usage

function SampleList() {
  const navigation = useNavigation();
  const isFocused = useIsFocused();

  const renderItem = useCallback(
    ({ item, index }: { item: Board; index: number }) => {
      return (
        <Pressable
          style={{ backgroundColor: 'gray', gap: 8, padding: 12 }}
          onPress={() => navigation.navigate('DetailScreen', { item })}
        >
          <View>
            <Text style={{ fontWeight: 'bold' }}>index : {index}</Text>
            <Text>{item.content}</Text>
          </View>

          <Pressable
            onPress={() => {
              // If you want to refresh the page to which the item belongs after changing the status of the item.
              // Example)
              freshFlatListRef.current?.refreshWatching(index);
            }}
          >
            <Text>LIKE!</Text>
          </Pressable>
        </Pressable>
      );
    },
    [navigation]
  );

  const fetchList = useCallback(
    async (fetchInputMeta: FetchInputMeta<T>) => {
      const { fetchPage } = fetchInputMeta;

      // Enter your fetch logic here.
      const response = await fetch(`https://api.example.com/boards?page=${fetchPage}`);
      const data: {
        list: Array<T>;
        isLast: boolean;
      } = await response.json();

      let list: T[] = [];
      if (data && data.list && data.list.length > 0) {
        list = data.list;
      }

      return {
        list: list as Board[],
        isLastPage: data.isLast,
      }
    },
    [category, ownerId, size]
  );

  return (
    <FreshFlatList<T>
      ref={freshFlatListRef}
      isFocused={isFocused}
      fetchList={fetchList}
      renderItem={renderItem}
    />
  )
};

Props

FreshFlatListProps<T>

Prop	Type	Description
fetchList	(fetchInputMeta: FetchInputMeta<T>) => FetchOutputMeta<T>	Required. Function to fetch the list data.
isFocused	boolean	Optional. refresh watchging list if the screen is focused.
unshiftData	T[]	Optional. If there is data you want to add in front of data. ex) for filter bar
initData	T[]	Optional. If you want to reduce fetch by utilizing cached data. ( Not recommended. )
fetchCoolTime	number	Optional. Time to prevent the issue of quickly calling the API with the same params multiple times.
FlatListComponent	ComponentType<FlatListProps<T>> typeof Animated.FlatList<T>	Optional. If you need animation processing using Animated.FlatList or Reanimated.FlatList
LoadingComponent	ReactNote	Optional. Loading component.

fetchList Props

FetchInputMeta<T>

Prop	Type	Description
fetchType	'first' | 'watching' | 'end-reached'	Type of fetch operation.
fetchPage	number	Page number to fetch. When the fetchList function is first executed, it is 1.
previousAllData	T[]	Data held by Fresh FlatList before fetchList function was completed.

FetchOutputMeta<T>

Prop	Type	Description
list	T[]	Required. Fetched list data. Calculated cumulatively within FreshFlatList
isLastPage	boolean	If you enter true in isLastPage, fetch will not occur even if the end of the list is reached.
isRenderReady	boolean	The Loading component is displayed until isRenderReady is returned with true at least once.

FYI

The base of this component is FlatList, so FlatListProps can be used, but the following props cannot be used.

• 'data' : Fetch data is being accumulated inside the component.
• 'onEndReached' : When onEndReached is reached, the fetching logic is used internally.

Methods

FreshFlatListRef

Method	Parameter	Type	Description
reset	index	number undefined	Resets the list to the initial state. If the index is given, the page containing the index is refreshed. If not, the current watching page is refreshed.
refreshWatching	void	number	Refreshes the current page of the list.
flatList			This is the "flatList ref" inside the FreshFlatList.

Hooks

Hook	Description
usePageKeyMapper	If the API's next fetch information is id-based, this component can be used.
useCacheInitData	A hook that can help if you want to save caching data and apply it to the initData prop.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Made with create-react-native-library