onsensei-react-native-app-tour

1.6.4 • Public • Published

PRs Welcome

onsensei-react-native-app-tour

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

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

Getting started

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

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

  • Android
    • in ./android/app/src/build.gradle
      android {
        compileSdkVersion 25
        buildToolsVersion "25.0.2"
        .
        .
        .
      }
      
  • iOS
    • Add aromajoin/material-showcase-ios in Embedded Binaries & Linked Frameworks and Libraries. You can find this library from below path:
    • Please find below screenshot reference for the same

Usage

import {AppTour, AppTourSequence, AppTourView} from 'onsensei-react-native-app-tour';

Props

  • title #String
  • description #String
  • titleTextSize #String(0 - 100)
  • descriptionTextSize #String(0 - 100)
  • titleTextColor #hexCodeRGB
  • targetHolderColor #hexCodeRGB
  • descriptionTextColor #hexCodeRGB
  • outerCircleColor #hexCodeRGB
  • outerCircleAlpha #String(0.00 - 1.00)
  • targetRadius #String(0 - 100)
  • transparentTarget #Bool
  • buttonText #String
  • buttonTextColor #hexCodeRGB
  • buttonBGColor #hexCodeRGB
  • buttonRadius #String(0 - 100)
  • buttonVisable #Bool
  • buttonTextSize #String(0 - 100)

Credits

Readme

Keywords

none

Package Sidebar

Install

npm i onsensei-react-native-app-tour

Weekly Downloads

9

Version

1.6.4

License

MIT

Unpacked Size

5.58 MB

Total Files

731

Last publish

Collaborators

  • onsensei