React native app tour library to create iOS and Android App Tour

PRs Welcome

ReactNative: Native App Tour Library (Android/iOS)

If this project has helped you out, please support us with a star 🌟

This library is a React Native bridge around native app tour libraries. It allows show/guide beautiful tours:

Android: KeepSafe/TapTargetView
iOS: aromajoin/material-showcase-ios

📖 Getting started

$ npm install react-native-app-tour --save

RN61 >= RNAT V1 >

RN60 above please use react-native-app-tour V1 and above

  • iOS

iOS Prerequisite: Please make sure CocoaPods is installed on your system

- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:
  use_native_modules!

  pod 'RNAppTour', :path => '../node_modules/react-native-app-tour/ios'

  use_frameworks!

  pod 'MaterialShowcase', :git => 'https://github.com/aromajoin/material-showcase-ios', :tag => '0.7.1'
  • Android

Please add below snippet into your app build.gradle

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

RN61 < RNAT V1 <

RN60 below please use react-native-app-tour V.0.*

$ react-native link react-native-app-tour

  • Android

    • Please add below script in your build.gradle
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
        ...
    }
}

Note

  • Android SDK 27 > is supported
  • iOS

    • After react-native link react-native-app-tour, please verify node_modules/react-native-app-tour/ios/ contains Pods folder. If does not exist please execute pod install command on node_modules/react-native-app-tour/ios/, if any error => try pod repo update then pod install
    • After verification, open your project and create a folder 'RNAppTour' under Libraries.
    • Drag node_modules/react-native-app-tour/ios/pods/Pods.xcodeproject into RNAppTour, as well as the RNAppTour.xcodeproject if it does not exist.
    • Add the MaterialShowcase.framework into your project's Embedded Binaries and make sure the framework is also in linked libraries.
    • Go to your project's Build Settings -> Frameworks Search Path and add ${BUILT_PRODUCTS_DIR}/MaterialShowcase non-recursive.

    • Now build your iOS app through Xcode

💬 ISSUES

  • If you install this package and get an error saying postinstall failed this most likely means
    • You are trying to run install modules from outside of project root (react-native-git-upgrade)
      • FIX: remove react-native-app-tour from package.json and rerun
    • Pods version is out of date.
      • pod repo update
  • If you encounter File not found in iOS issue while setup, please refer ISSUE - 3 issue which might help you in order to resolve.
  • If you have problems with Android Trying to resolve view with tag which doesn't exist or can't resolve tag. Please add props collapasable: false to your View

🎨 API's

  • AppTourView.for: AppTourTarget
let appTourTarget = AppTourView.for(Button, {...native-library-props})

AppTour.ShowFor(appTourTarget)
  • AppTourSequence
    • add(AppTourTarget)
    • remove(AppTourTarget)
    • removeAll
    • get(AppTourTarget)
    • getAll
let appTourSequence = new AppTourSequence()
this.appTourTargets.forEach(appTourTarget => {
appTourSequence.add(appTourTarget)
})

AppTour.ShowSequence(appTourSequence)
  • AppTour
    • ShowFor(AppTourTarget)
    • ShowSequence(AppTourTargets)

💡 Props

Note:

  • General(iOS & Android)
PropTypeDefaultNote
order: mandatorynumberSpecify the order of tour target
titlestringSpecify the title of tour
descriptionstringSpecify the description of tour
outerCircleColorstring: HEX-COLORSpecify a color for the outer circle
targetCircleColorstring: HEX-COLORSpecify a color for the target circle
titleTextSizenumber20Specify the size (in sp) of the title text
titleTextColorstring: HEX-COLORSpecify the color of the title text
descriptionTextSizenumber10Specify the size (in sp) of the description text
descriptionTextColorstring: HEX-COLORSpecify the color of the description text
targetRadiusnumber60Specify the target radius (in dp)
cancelablebooltrueWhether tapping anywhere dismisses the view
  • Android
PropTypeDefaultNote
collapsable: mandatoryboolSpecify collapsable false if your view just contains children. Please read view#collapsable for the details
outerCircleAlphanumber0.96fSpecify the alpha amount for the outer circle
textColorstring: HEX-COLORSpecify a color for both the title and description text
dimColorstring: HEX-COLORIf set, will dim behind the view with 30% opacity of the given color
drawShadowbooltrueWhether to draw a drop shadow or not
tintTargetbooltrueWhether to tint the target view's color
transparentTargetbooltrueSpecify whether the target is transparent (displays the content underneath)
  • iOS
PropTypeDefaultNote
backgroundPromptColorstring: HEX-COLORUIColor.blueSpecify background prompt color
backgroundPromptColorAlphanumber0.96Specify background prompt color alpha
titleTextAlignmentstringleftSpecify primary text alignment: Left, Right, Top, Bottom
descriptionTextAlignmentstringleftSpecify secondary text alignment: Left, Right, Top, Bottom
aniComeInDurationnumber0.5Specify animation come In Duration
aniGoOutDurationnumber1.5Specify animation Go Out Duration
aniRippleColorstring: HEX-COLOR#FFFFFFSpecify ripple color
aniRippleAlphanumber0.2Specify ripple alpha

🔧 Breaking Changes

  • V0.0.4

    • Generalized props across platforms @congnguyen91
    • Migrated License to Apache 2.0
  • V0.0.10

    • Added order as a mandatory property to each target
    • Each component which is to be rendered in the tour should have a key prop. It is mandatory.

✨ Credits

🤔 How to contribute

Have an idea? Found a bug? Please raise to ISSUES. Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list below. ✨

📜 License

This library is provided under the Apache 2 License.

RNAppTour @ prscX

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀
  • If you're feeling especially charitable, please follow prscX on GitHub.

    Buy Me A Coffee

    Thanks! ❤️
    prscX.github.io
    </ Pranav >

Check it on GitHub