You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-2Lines changed: 26 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
## Important Notes
4
4
5
-
* This state provider client requires that the flipper-plugin-recoil plugin be installed within your Desktop Flipper client application in order to work.
5
+
* This state provider client requires that the [flipper-plugin-react-native-recoil
) plugin be installed within your desktop Flipper client application in order to work.
6
8
* State reporting functionality may be relying on experimental or unstable Recoil hooks.
7
9
8
10
## Requires
@@ -12,11 +14,33 @@
12
14
13
15
## Installation
14
16
15
-
Make sure you install `react-native-flipper`as well as this client.
17
+
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.
16
18
17
19
## Usage
18
20
19
21
Add this client to your React Native project by mounting it within your App JSX tree anywhere, but ideally immediately inside RecoilRoot.
22
+
23
+
To mount the client, you'll want to import the client (1) and use the JSX tag as follows:
24
+
25
+
```
26
+
import React from 'react';
27
+
import { RecoilRoot } from 'recoil';
28
+
import { RootRouter } from './route';
29
+
import { RecoilFlipperClient } from 'react-native-recoil-flipper-client'; (1)
0 commit comments