@s-ui/react-molecule-coachmark
v0.9.0
Published
`MoleculeCoachmark` is a wrapper of the [react-joyride](https://react-joyride.com/) library in order to create smooth guided tours in the apps to explain new features to the users.
Downloads
4,695
Maintainers
Keywords
Readme
MoleculeCoachmark
MoleculeCoachmark
is a wrapper of the react-joyride library in order to create smooth guided tours in the apps to explain new features to the users.
For more information on how to use the provided props, visit the react-joyride documentation site
Installation
$ npm install @s-ui/react-molecule-coachmark
Usage
Basic usage
Import package and use the component
import MoleculeCoachmark from '@s-ui/react-molecule-coachmark'
return <MoleculeCoachmark {...props} />
Import the styles (Sass)
@import '~@s-ui/theme/lib/index';
/* @import 'your theme'; */
@import '~@s-ui/react-molecule-coachmark/lib/index';
Overwriting styles
Overwriting styles is possible thanks to the styles
prop. Here you can find a list of possible properties to be overwritten
Find full description and more examples in the demo page.