Make an interactive step by step tour guide for you react-native app
npm install react-native-joyride
npm install --save react-native-joyride
Usage
Use the higher order component for the screen component that you want to use joyride with:`js
import { joyride } from 'react-native-joyride';class HomeScreen extends Component { / ... / }
export default joyride()(HomeScreen);
`Before defining walkthrough steps for your react elements, you must make them
. The easiest way to do that for built-in react native components, is using the joyridable HOC. Then you must wrap the element with JoyrideStep.`js
import { joyride, joyridable, JoyrideStep } from 'react-native-joyride';const JoyrideText = joyridable(Text);
class HomeScreen {
render() {
return (
Hello world!
);
}
}
`Every
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.
$3
The components wrapped inside JoyrideStep, will receive a joyride 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.`js
import { joyride, JoyrideStep } from 'react-native-joyride';const CustomComponent = ({ joyride }) => Hello world!
class HomeScreen {
render() {
return (
);
}
}
``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.
MIT © 2017 OK GROW!, https://www.okgrow.com.