React Native Copilot

Step-by-step walkthrough for your react native app!

Demo

Installation

npm install --save @okgrow/react-native-copilot

Optional: If you want to have the smooth SVG animation, you should install and link react-native-svg. If you are using Expo, you can skip this as Expo comes with react-native-svg.

npm install --save react-native-svg
react-native link react-native-svg

Usage

Use the copilot() higher order component for the screen component that you want to use copilot with:

1import { copilot } from '@okgrow/react-native-copilot';
2
3class HomeScreen extends Component { /* ... */ }
4
5export default copilot()(HomeScreen);

Before defining walkthrough steps for your react elements, you must make them walkthroughable. The easiest way to do that for built-in react native components, is using the walkthroughable HOC. Then you must wrap the element with CopilotStep.

1import { copilot, walkthroughable, CopilotStep } from '@okgrow/react-native-copilot';
2
3const CopilotText = walkthroughable(Text);
4
5class HomeScreen {
6  render() {
7    return (
8      <View>
9        <CopilotStep text="This is a hello world example!" order={1} name="hello">
10          <CopilotText>Hello world!</CopilotText>
11        </CopilotStep>
12      </View>
13    );
14  }
15}

Every CopilotStep must have these props:

1. name: A unique name for the walkthrough step.
2. order: A positive number indicating the order of the step in the entire walkthrough.
3. text: The text shown as the description for the step.

In order to start the tutorial, you can call the start prop function in the root component that is injected by copilot:

1class HomeScreen extends Component {
2  handleStartButtonPress() {
3    this.props.start();
4  }
5
6  render() {
7    // ...
8  }
9}
10
11export default copilot()(HomeScreen);

If you are looking for a working example, please check out this link.

Overlays and animation

The overlay in react-native copilot is the component that draws the dark transparent over the root component. React-native copilot comes with two overlay components: view and svg.

The view overlay uses 4 rectangles drawn around the target element using the <View /> component. We don't recommend using animation with this overlay since it's sluggish on some devices specially on Android devices.

The svg overlay uses an SVG path component for drawing the overlay. It offers a nice and smooth animation but it depends on react-native-svg. If you are using expo, you don't need to install anything and the svg overlay works out of the box. If not, you need to install and this package:

npm install --save react-native-svg
react-native link react-native-svg

You can specify the overlay when applying the copilot HOC:

1copilot({
2  overlay: 'svg', // or 'view'
3  animated: true, // or false
4})(RootComponent);

Custom tooltip component

You can customize the tooltip by passing a component to the copilot HOC maker. If you are looking for an example tooltip component, take a look at the default tooltip implementation.

1const TooltipComponent = ({
2  isFirstStep,
3  isLastStep,
4  handleNext,
5  handlePrev,
6  handleStop,
7  currentStep,
8}) => (
9  // ...
10);
11
12copilot({
13  tooltipComponent: TooltipComponent
14})(RootComponent)

Custom step number component

You can customize the step number by passing a component to the copilot HOC maker. If you are looking for an example step number component, take a look at the default step number implementation.

1const StepNumberComponent = ({
2  isFirstStep,
3  isLastStep,
4  currentStep,
5  currentStepNumber,
6}) => (
7  // ...
8);
9
10copilot({
11  stepNumberComponent: StepNumberComponent
12})(RootComponent)

Custom components as steps

The components wrapped inside CopilotStep, will receive a copilot prop of type Object which the outermost rendered element of the component or the element that you want the tooltip be shown around, must extend.

1import { copilot, CopilotStep } from '@okgrow/react-native-copilot';
2
3const CustomComponent = ({ copilot }) => <View {...copilot}><Text>Hello world!</Text></View>;
4
5class HomeScreen {
6  render() {
7    return (
8      <View>
9        <CopilotStep text="This is a hello world example!" order={1} name="hello">
10          <CustomComponent />
11        </CopilotStep>
12      </View>
13    );
14  }
15}

Triggering the tutorial

Use this.props.start() in the root component in order to trigger the tutorial. You can either invoke it with a touch event or in componentDidMount. Note that the component and all its descendants must be mounted before starting the tutorial since the CopilotSteps need to be registered first.

Listening to the events

Along with this.props.start(), copilot HOC passes copilotEvents function to the component to help you with tracking of tutorial progress. It utilizes mitt under the hood, you can see how full API there.

List of available events is:

• start — Copilot tutorial has started.
• stop — Copilot tutorial has ended or skipped.
• stepChange — Next step is triggered. Passes Step instance as event handler argument.

Example:

1import { copilot, CopilotStep } from '@okgrow/react-native-copilot';
2
3const CustomComponent = ({ copilot }) => <View {...copilot}><Text>Hello world!</Text></View>;
4
5class HomeScreen {
6  componentDidMount() {
7    this.props.copilotEvents.on('stop', () => {
8      // Copilot tutorial finished!
9    });
10  }
11  
12  componentWillUnmount() {
13    // Don't forget to disable event handlers to prevent errors
14    this.props.copilotEvents.off('stop');
15  }
16
17  render() {
18    // ...
19  }
20}

Contributing

Issues and Pull Requests are always welcome.

Please read OK GROW!'s global contribution guidelines.

If you are interested in becoming a maintainer, get in touch with us by sending an email or opening an issue. You should already have code merged into the project. Active contributors are encouraged to get in touch.

Please note that all interactions in @okgrow's repos should follow our Code of Conduct.

License

MIT © 2017 OK GROW!, https://www.okgrow.com.