@originallyus/feedback-rn-sdk 1.0.8 → 2.0.0

package/README.md

@@ -56,6 +56,7 @@ Please initalize the SDK once in App.js. The mounting point of the SDK should be
 
 Note: **XXXXXXXXXXX** is to be replaced with correct class name. Please refer to the full documentation provided separately by us.
 
+
 ```js
 import XXXXXXXXXXX from '@originallyus/feedback-rn-sdk';
 
@@ -66,9 +67,9 @@ const App = (props) => {
 
 // in your render function
 return (
-  // Make sure the app is full screen and vertical align center
+  {/* The root view wrapper makes sure the app is full screen and vertical align center */}
   <View style={{ flex: 1, justifyContent: 'center' }}>
-    <YourOtherContainerView></YourOtherContainerView>
+    <YourAppContainerView></YourAppContainerView>
 
     {/* Please insert this mount point directly in your App.js,
         preferably at the bottom of your root view tree for it to stay on top of all other views */}
@@ -76,6 +77,24 @@ return (
   </View>
 );
 ```
+**Optional inline feedback component**
+
+Place `<FeedbackInlineSurvey />` component anywhere in your app view hierarchy where the feedback inline prompt should be shown.
+
+- If `<FeedbackInlineSurvey />` component is not present, feedback survey will shown as non-intrusive style
+- The inline component may or may not be shown depends on configuration of the survey in backend
+
+```js
+import { FeedbackInlineSurvey } from '@originallyus/feedback-rn-sdk';
+
+return (
+  ...
+  <SomeContainerView>
+    <FeedbackInlineSurvey />
+  </SomeContainerView>
+  ...
+);
+```
 
 All other functions to be invoked on feedbackRef.current can be done anywhere in your application code (can also be inside App.js)
 
@@ -114,11 +133,24 @@ const OtherComponent = (props) => {
     feedbackRef.current.testRatingForm(eventTag);
   };
 
+  const testInlineForm = (eventTag, slug) => {
+    // This will always show the inline Feedback component for testing/debugging purpose
+    // You may troubleshoot this in "Request (Testing)" section in CMS
+    feedbackRef.current.testInlineForm(eventTag, slug);
+  };
+
   const showRatingForm = (eventTag) => {
     // This may not always show/trigger the form, depending on the Response Frequency & Prompt Frequency configuration on backend
     // You may troubleshoot this in "Request" section in CMS
     feedbackRef.current.showRatingForm(eventTag);
   };
+
+  const showInlineForm = (eventTag, slug) => {
+    // This may not always show/trigger the form, depending on the Response Frequency & Prompt Frequency configuration on backend
+    // You may troubleshoot this in "Request" section in CMS
+    feedbackRef.current.showInlineForm(eventTag, slug);
+  };
+  
 };
 ```
 
@@ -137,4 +169,27 @@ feedbackRef.current.testRatingForm(eventTag, (formDidShow) => {
 feedbackRef.current.showRatingForm(eventTag, (formDidShow) => {
   console.log('formDidShow', formDidShow);
 });
+
+feedbackRef.current.showInlineForm(eventTag, slug, (formDidShow) => {
+  console.log('formDidShow', formDidShow);
+});
+
+```
+
+## Extra configuration
+To ensure that the External Survey works properly, check your AndroidManifest.xml file for the following configuration.
+
+```
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example">
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.VIEW" />
+            <data android:scheme="http" />
+            <data android:scheme="https" />
+        </intent>
+    </queries>
+    ...
+    <!-- Another config -->
+</manifest>
+
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@originallyus/feedback-rn-sdk",
-  "version": "1.0.8",
+  "version": "2.0.0",
   "description": "A cross-platform Feedback component for React Native.",
   "main": "lib/commonjs/index",
   "react-native": "lib/commonjs/index",
@@ -15,6 +15,7 @@
     "email": "hello@originallyus.us"
   },
   "devDependencies": {
+    "@babel/runtime": "^7.24.0",
     "babel-preset-react-native": "^4.0.0",
     "react": "^16.2.0",
     "react-native": "^0.53.0"
@@ -30,5 +31,6 @@
   },
   "dependencies": {
     "react-native-android-keyboard-adjust-originallyus": "*"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
 }