Git Product home page Git Product logo

react-navigation-app-state-aware-focus-effect's Introduction

react-navigation-app-state-aware-focus-effect

linmic

AppState-aware focus effect for React Native with React Navigation

Background

In React Native app development, there's an everyday use case where we would like to perform actions whenever the view is re-focused or re-surfaced from the background, e.g., re-fetching data to make sure it's up-to-date. It is often necessary for apps to display the information that accuracy can be critical, such as financial applications.

This hook could be helpful for those applications that use React Navigation and have a similar need.

Installation

npm i react-navigation-app-state-aware-focus-effect # or
yarn add react-navigation-app-state-aware-focus-effect

Note: if you are using React Native 0.64 or below, please install v0.1.3 instead.

Usage

Minimal example

import useAppStateAwareFocusEffect from 'react-navigation-app-state-aware-focus-effect';

const req = fetch('https://example.com/dummy.json');

// make sure you memoize the effect
useAppStateAwareFocusEffect(
  useCallback(() => {
    req();
  }, [])
);

A more comprehensive example

import React, { useCallback } from 'react';
import { View, Text } from 'react-native';
import { gql, useQuery } from '@apollo/client';
import useAppStateAwareFocusEffect from 'react-navigation-app-state-aware-focus-effect';

const GET_DOGS = gql`
  query GetDogs {
    dogs {
      id
      breed
    }
  }
`;

const Dogs = () => {
  const { loading, error, data, refetch } = useQuery(GET_DOGS, {
    fetchPolicy: 'cache-and-network',
  });

  useAppStateAwareFocusEffect(
    useCallback(() => {
      refetch();
    }, [])
  );

  if (loading) return 'Loading...';
  if (error) return `Error! ${error.message}`;

  return (
    <View>
      {data.dogs.map(({ id, breed }) => (
        <Text key={id}>{breed}</Text>
      ))}
    </View>
  );
};

Note: Just like useFocusEffect, to avoid running the effect too often, it's important to wrap the callback in useCallback before passing it to useAppStateAwareFocusEffect as shown in the example.

Contributing

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

License

MIT

react-navigation-app-state-aware-focus-effect's People

Contributors

linmic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

nightstomp othree

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.