imokhles-react-native-app-tour v2.0.8

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:

📖 Getting started

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

RN61 >= RNAT V1 >

RN60 above please use imokhles-react-native-app-tour V2 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/imokhles-react-native-app-tour/ios'

  use_frameworks!

  pod 'MaterialShowcase'

• Android

Please add below snippet into your app build.gradle

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

Note

• Android SDK 27 > is supported

• iOS

  • After react-native link imokhles-react-native-app-tour, please verify node_modules/imokhles-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/imokhles-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 imokhles-react-native-app-tour from package.json and rerun
  • Pods version is out of date.
    • pod repo update
• 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:

• Each component which is to be rendered in the tour should have a key prop. It is mandatory.
• App Tour Target Properties are same as defined by KeepSafe/TapTargetView & aromajoin/material-showcase-ios

• General(iOS & Android)

• Android

• iOS

🔧 Breaking Changes

• V1.0

  • make material-showcase-ios non required ( install manually ) by following Objective-C description

✨ Credits

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

🤔 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 MIT License.

Original Source By

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 imokhles on GitHub.

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