React Native Copilot

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

Demo

## Installation ``` yarn add react-native-copilot # or with npm: npm install --save react-native-copilot ``` **Optional**: If you want to have the smooth SVG animation, you should install and link [`react-native-svg`](https://github.com/software-mansion/react-native-svg). ## Usage Wrap the portion of your app that you want to use copilot with inside ``: ```js import { CopilotProvider } from "react-native-copilot"; const AppWithCopilot = () => { return ( ); }; ``` **NOTE**: The old way of using copilot with the `copilot()` HOC maker is deprecated in v3. It will continue to work but it's not recommended and may be removed in the future. 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`. ```jsx import { CopilotProvider, CopilotStep, walkthroughable, } from "react-native-copilot"; const CopilotText = walkthroughable(Text); const HomeScreen = () => { return ( Hello world! ); }; ``` 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. Additionally, a step may set the **active** prop, a boolean that controls whether the step is used or skipped. In order to start the tutorial, you can call the `start` function from the `useCopilot` hook: ```js const HomeScreen = () => { return (

	Stars	Issues	Version	Updated	Created
react-native-copilot	2,154	106	3.3.2	18 days ago	5 years ago
react-native-popover-view	543	25	5.1.8	9 months ago	6 years ago
react-native-tooltip-menu	158	14	3.0.7	2 years ago	7 years ago

react-native-copilot vs react-native-popover-view vs react-native-tooltip-menu

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past