@originallyus/feedback-rn-sdk 1.0.7 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,11 +4,16 @@ A cross-platform Feedback component for React Native.
|
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Install the package using either Yarn:
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
10
|
yarn add @originallyus/feedback-rn-sdk
|
|
11
11
|
```
|
|
12
|
+
or npm:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install @originallyus/feedback-rn-sdk
|
|
16
|
+
```
|
|
12
17
|
|
|
13
18
|
## Install Peer Dependencies
|
|
14
19
|
|
|
@@ -21,15 +26,20 @@ react-native-device-info \
|
|
|
21
26
|
react-native-rate
|
|
22
27
|
```
|
|
23
28
|
|
|
29
|
+
or using npm:
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
npm install axios crypto-js \
|
|
33
|
+
react-native-encrypted-storage \
|
|
34
|
+
react-native-device-info \
|
|
35
|
+
react-native-rate
|
|
36
|
+
```
|
|
37
|
+
|
|
24
38
|
## Install Custom Fonts
|
|
25
39
|
|
|
26
40
|
Package requires custom fonts found in `fonts` folder:
|
|
27
41
|
|
|
28
42
|
```sh
|
|
29
|
-
AIAEverestBold.ttf
|
|
30
|
-
AIAEverest-Regular.ttf
|
|
31
|
-
AIAEverest-Medium.ttf
|
|
32
|
-
AIAEverest-CondensedMedium.ttf
|
|
33
43
|
OpenSans-Bold.ttf
|
|
34
44
|
OpenSans-Light.ttf
|
|
35
45
|
OpenSans-Regular.ttf
|
|
@@ -44,8 +54,10 @@ Please do not change the filenames as Android are using those to identify fonts.
|
|
|
44
54
|
|
|
45
55
|
Please initalize the SDK once in App.js. The mounting point of the SDK should be placed directly in your App.js for it to stay on top of all other views.
|
|
46
56
|
|
|
57
|
+
Note: **XXXXXXXXXXX** is to be replaced with correct class name. Please refer to the full documentation provided separately by us.
|
|
58
|
+
|
|
47
59
|
```js
|
|
48
|
-
import
|
|
60
|
+
import XXXXXXXXXXX from '@originallyus/feedback-rn-sdk';
|
|
49
61
|
|
|
50
62
|
const App = (props) => {
|
|
51
63
|
// This initialization should done once inside App.js
|
|
@@ -60,7 +72,7 @@ return (
|
|
|
60
72
|
|
|
61
73
|
{/* Please insert this mount point directly in your App.js,
|
|
62
74
|
preferably at the bottom of your root view tree for it to stay on top of all other views */}
|
|
63
|
-
<
|
|
75
|
+
<XXXXXXXXXXX ref={feedbackRef} />
|
|
64
76
|
</View>
|
|
65
77
|
);
|
|
66
78
|
```
|
|
@@ -68,7 +80,7 @@ return (
|
|
|
68
80
|
All other functions to be invoked on feedbackRef.current can be done anywhere in your application code (can also be inside App.js)
|
|
69
81
|
|
|
70
82
|
```js
|
|
71
|
-
import
|
|
83
|
+
import XXXXXXXXXXX from '@originallyus/feedback-rn-sdk';
|
|
72
84
|
|
|
73
85
|
const OtherComponent = (props) => {
|
|
74
86
|
// This is a singleton. The initialization should have already been done inside App.js
|