Add skip event listener

Author: Pedro

README.md

@@ -184,7 +184,8 @@ Along with `this.props.start()`, `copilot` HOC passes `copilotEvents` function t
 List of available events is:
 
 - `start` — Copilot tutorial has started.
-- `stop` — Copilot tutorial has ended or skipped.
+- `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.
 
 

src/components/CopilotModal.js

@@ -9,6 +9,7 @@ type Props = {
   stop: () => void,
   next: () => void,
   prev: () => void,
+  skip: () => void,
   currentStepNumber: number,
   currentStep: ?Step,
   visible: boolean,
@@ -217,6 +218,11 @@ class CopilotModal extends Component<Props, State> {
     this.props.stop();
   }
 
+  handleSkip = () => {
+    this.reset();
+    this.props.skip();
+  }
+
   renderMask() {
     /* eslint-disable global-require */
     const MaskComponent = this.props.overlay === 'svg'
@@ -270,6 +276,7 @@ class CopilotModal extends Component<Props, State> {
           handleNext={this.handleNext}
           handlePrev={this.handlePrev}
           handleStop={this.handleStop}
+          handleSkip={this.handleSkip}
         />
       </Animated.View>,
     ];

src/hocs/copilot.js

@@ -148,6 +148,14 @@ const copilot = ({
         }
       }
 
+      skip = async (): void => {
+        await this.setVisibility(false);
+        this.eventEmitter.emit('skip', {
+          currentStep: this.state.currentStep,
+          nextStep: this.getNextStep()
+        });
+      }
+
       stop = async (): void => {
         await this.setVisibility(false);
         this.eventEmitter.emit('stop');
@@ -178,6 +186,7 @@ const copilot = ({
               next={this.next}
               prev={this.prev}
               stop={this.stop}
+              skip={this.skip}
               visible={this.state.visible}
               isFirstStep={this.isFirstStep()}
               isLastStep={this.isLastStep()}