React Native Coachmark
A coachmark ui for react native.
Installation
yarn
yarn add react-native-coachmark
npm
npm i react-native-coachmark --save
Getting Started
Basic Usage
Example
Documentation
- Coachmark
Importing
Props
Property | Type | Default Value | Description |
---|---|---|---|
message | string | none | required |
autoShow | boolean | none | to show the coachmark when mounting |
onShow | function | none | will be called when coachmark is showing |
onHide | function | none | will be called when coachmark is hidden |
isAnchorReady | boolean | true | a value to force coachmark not being shown yet |
Methods
Methods | Description |
---|---|
show() => Promise |
a function to trigger show the coachmark |
Roadmap
- [ ] Auto load and save in AsyncStorage
- [x] Show coachmark only when in view port
- [ ] Custom render arrow and content