React Native Joyride
Step-by-step walkthrough for your react native app
Installation
npm install --save react-native-joyride
Usage
Use the joyride()
higher order component for the screen component that you want to use joyride with:
; /* ... */ HomeScreen;
Before defining walkthrough steps for your react elements, you must make them joyridable
. 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
.
; const JoyrideText = ; { return <View> <JoyrideStep text="This is a hello world example!" order=1 name="hello"> <JoyrideText>Hello world!</JoyrideText> </JoyrideStep> </View> ; }
Every JoyrideStep
must have these props:
- name: A unique name for the walkthrough step.
- order: A positive number indicating the order of the step in the entire walkthrough.
- text: The text shown as the description for the step.
Custom components as steps
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.
; const CustomComponent = <View ...joyride><Text>Hello world!</Text></View>; { return <View> <JoyrideStep text="This is a hello world example!" order=1 name="hello"> <CustomComponent /> </JoyrideStep> </View> ; }
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.