mb-react-walkthrough

MB React Walkthrough

MB React Walkthrough is a simple React component to realize walkthrough UI in your application. With this UI, You can add tutorials, onboardings and short storires very easliy.

Installation

npm install --save mb-react-walkthrough

Import css to your project

@import './node_modules/mb-react-walkthrough/src/dist/css/mb-react-walkthrough'

Useage

import Walkthrough from 'mb-react-walkthrough'

<Walkthrough onHide={()=>{this.setState({show: false})}}>
    <Walkthrough.Content>
    	PAGE 1
    </Walkthrough.Content>
    <Walkthrough.Content>
    	PAGE 2
    </Walkthrough.Content>
</Walkthrough>

Props

Prop	Type	Default	Note
className	string
width	number	450
height	numbe	360
onHide	func		Required
onClickBackdrop	func
onSlide	func
onShow	func
nextBtnTitle	string	Nex
backBtnTitle	string	Back
closeBtnTitle	string	Close
animated	bool	true
animationDuration	number	200
showBackdrop	bool	true
showIndicator	bool	true
topSpace	number	100

Development

git clone [e-mail]:mountainboooy/mb-react-walkthrough.git
cd mb-react-walkthrough
npm install
npm run:watch