https://github.com/kolohelios/react-native-recoil-flipper-client

https://github.com/kolohelios/react-native-recoil-flipper-client

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kolohelios/react-native-recoil-flipper-client
• Owner: kolohelios
• License: mit
• Created: 2021-08-07T19:25:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-10T14:59:09.000Z (over 3 years ago)
• Last Synced: 2024-04-24T04:11:38.406Z (9 months ago)
• Language: TypeScript
• Size: 2.34 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-recoil-flipper-client

## Important Notes

* This state provider client requires that the [flipper-plugin-react-native-recoil

](https://www.npmjs.com/package/flipper-plugin-react-native-recoil

) plugin be installed within your desktop Flipper client application in order to work.

* State reporting functionality may be relying on experimental or unstable Recoil hooks.

## Requires

* React Native

* Recoil

## Installation

Make sure you NPM install `react-native-flipper` in addition to this client. (e.g. `npm i --save react-native-recoil-flipper-client react-native-flipper`). Although Flipper support is enabled in React Native by default, the functionality provided by react-native-flipper is not.

## Usage

Add this client to your React Native project by mounting it within your App JSX tree anywhere, but ideally immediately inside RecoilRoot.

To mount the client, you'll want to import the client (1) and use the JSX tag as follows:

```

import React from 'react';

import { RecoilRoot } from 'recoil';

import { RootRouter } from './route';

import { RecoilFlipperClient } from 'react-native-recoil-flipper-client'; (1)

function App() {

    return (

        

             (2)

            

        

    );

}

export default App;

```

Where RootRouter is your main App's entry point.

## Development

...

## Todo

- [ ] add supported Recoil version to README requires section