Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

react-native-hotspot

npm version

A React Native component that displays hotspots over desired components to help lead your users through an onboarding flow or direct them towards new UI elements

iOS Example Android Example

Examples

Run example

Getting Started

Installing

npm install react-native-hotspot

Using

import { RNHotspot, RNHotspotHelper } from "react-native-hotspot";

// in your screen's constructor, use the helper with an array of onPress actions you want your hotspots to trigger
this.componentRefs = RNHotspotHelper([
    () => {
        // here you can drop in whatever action(s) you want to occur on tap of the hotspot.
        // you'll also likely want to use local storage here and/or an api call to mark each one as seen.
        Alert.alert(null, "This button does this thing.");
    },
    () => {
        Alert.alert(null, "This button does other thing.");
    }
]);

// drop the component below the outer wrapping parent of your screen
<RNHotspot componentRefs={this.componentRefs} />


// expose the refs in the same order as the array defined above
<Button
    title="Button #1"
    onPress={() => {}}
    ref={this.componentRefs[0].ref}
/>
<Button
    title="Button #2"
    onPress={() => {}}
    ref={this.componentRefs[1].ref}
/>

Testing

This component has been tested on React Native v0.57

License

react-native-hotspot is MIT licensed and built with ❀️ in Austin, TX by the team at LawnStarter

About

🎯 A React Native component that displays hotspots over desired components to help lead your users through an onboarding flow or direct them towards new UI elements

Topics

Resources

License

Releases

No releases published

Packages

No packages published