This repository has been archived by the owner. It is now read-only.
Development is switched to prscX/react-native-app-tour
Switch branches/tags
Clone or download
Latest commit 69a75d9 Mar 15, 2018

README.md

Note: Development is switched to prscX/react-native-app-tour**

Migration is with respect to ISSUE: 6

Video 1

PRs Welcome

React Native Material Showcase iOS

React Native Bridge for aromajoin/material-showcase-ios

Before we dive into on how to use this library. We would like to thank all the contributor of aromajoin/material-showcase-ios for providing such a awesome nice, cool library

Android Platform

Please refer react-native-taptargetview for the Android support

Installation

  • $ npm install react-native-material-showcase-ios --save

  • $ react-native link react-native-material-showcase-ios

  • Add material-showcase-ios in Embedded Binaries & Linked Frameworks and Libraries. You can find this library from below path:

node_modules/react-native-material-showcase-ios/ios/material-showcase-ios/MaterialShowcase.xcodeproj

Please find below screenshot reference for the same:

Video 1

API's

  • AppTourView.for: AppTourTarget
let appTourTarget = AppTourView.for(Button, {
    primaryText: 'This is a target button 1',
    secondaryText: 'We have the best targets, believe me'
})

> **Note:** App Tour Target Properties are same as defined by [KeepSafe/TapTargetView](https://github.com/KeepSafe/TapTargetView)


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)

Breaking Changes

Contribution

Any type of contribution will be very much appreciated

License

Copyright @2017 Pranav Raj Singh Chauhan

The React Native Material Showcase iOS is provided under the MIT License.

Other Contributions

awesome-react-native-native-modules
react-native-spruce
react-native-taptargetview & react-native-material-showcase-ios
react-native-bottom-action-sheet
react-native-popover-menu
react-native-tooltips
react-native-shine-button
react-native-iconic
react-native-download-button
react-native-siri-wave-view
react-native-material-shadows
react-native-gradient-blur-view
react-native-about-libraries
vs-essential-plugins
prettier-pack