Add information about skipped step

mohebifar · Aug 11, 2018 · 7f7ca95 · 7f7ca95
1 parent 7bbeefc
commit 7f7ca95
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -184,7 +184,6 @@ Along with `this.props.start()`, `copilot` HOC passes `copilotEvents` function t
 List of available events is:
 
 - `start` — Copilot tutorial has started.
-- `skip` — Copilot tutorial has skipped. Passes and object with currentStep and nextStep information. Both are instances of [`Step`](https://github.com/okgrow/react-native-copilot/blob/master/src/types.js#L2)
 - `stop` — Copilot tutorial has ended.
 - `stepChange` — Next step is triggered. Passes [`Step`](https://github.com/okgrow/react-native-copilot/blob/master/src/types.js#L2) instance as event handler argument.
 

diff --git a/src/components/CopilotModal.js b/src/components/CopilotModal.js
@@ -9,7 +9,6 @@ type Props = {
   stop: () => void,
   next: () => void,
   prev: () => void,
-  skip: () => void,
   currentStepNumber: number,
   currentStep: ?Step,
   visible: boolean,
@@ -213,14 +212,11 @@ class CopilotModal extends Component<Props, State> {
     this.props.prev();
   }
 
-  handleStop = () => {
-    this.reset();
-    this.props.stop();
-  }
+  handleStop = (wasSkipped?: boolean) => {
+    wasSkipped = typeof wasSkipped !== "boolean" ? false : wasSkipped;
 
-  handleSkip = () => {
     this.reset();
-    this.props.skip();
+    this.props.stop(wasSkipped);
   }
 
   renderMask() {

diff --git a/src/hocs/copilot.js b/src/hocs/copilot.js
@@ -148,19 +148,21 @@ const copilot = ({
         }
       }
 
-      skip = async (): void => {
+      stop = async (wasSkipped: boolean): void => {
         await this.setVisibility(false);
-        this.eventEmitter.emit('skip', {
-          currentStep: this.state.currentStep,
-          nextStep: this.getNextStep()
+        this.eventEmitter.emit('stop', wasSkipped
+          ? {
+            wasSkipped: true,
+            skippedStep: this.state.currentStep,
+            nextStep: this.getNextStep()
+          }
+          : {
+            wasSkipped: false,
+            skippedStep: null,
+            nextStep: null
         });
       }
 
-      stop = async (): void => {
-        await this.setVisibility(false);
-        this.eventEmitter.emit('stop');
-      }
-
       async moveToCurrentStep(): void {
         const size = await this.state.currentStep.target.measure();
 
@@ -186,7 +188,6 @@ const copilot = ({
               next={this.next}
               prev={this.prev}
               stop={this.stop}
-              skip={this.skip}
               visible={this.state.visible}
               isFirstStep={this.isFirstStep()}
               isLastStep={this.isLastStep()}