@appcues/react-native

Appcues React Native Module

NOTE: This is a pre-release project for testing as a part of our mobile beta program. If you are interested in learning more about our mobile product and testing it before it is officially released, please visit our site and request early access.

If you have been contacted to be a part of our mobile beta program, we encourage you to try out this library and provide feedback via Github issues and pull requests. Please note this library will not operate if you are not part of the mobile beta program.

Native Module to bridge the native Appcues SDKs in a React Native application.

• Appcues React Native Module
  • 🚀 Getting Started
    • Installation
    • One Time Setup
      • Initializing the SDK
      • Supporting Debugging and Experience Previewing
    • Identifying Users
    • Tracking Screens and Events
  • 📝 Documentation
  • 🎬 Examples
  • 👷 Contributing
  • 📄 License

🚀 Getting Started

Installation

1. In your app's root directory, install the Appcues React Native Module

   npm install --save @appcues/react-native
   # OR
   yarn add @appcues/react-native
   

2. Under your application's ios folder, run

   pod install
   

Note: You do not need to manually update your Podfile to add Appcues.

One Time Setup

Initializing the SDK

An instance of the Appcues SDK should be initialized when your app launches.

import * as Appcues from '@appcues/react-native'

Appcues.setup('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID')

Initializing the SDK requires you to provide two values, an Appcues account ID, and an Appcues mobile application ID. These values can be obtained from your Appcues settings.

Supporting Debugging and Experience Previewing

Supporting debugging and experience previewing is not required for the Appcues React Native Module to function, but it is necessary for the optimal Appcues builder experience. Refer to the URL Scheme Configuration Guide for details on how to configure.

Identifying Users

In order to target content to the right users at the right time, you need to identify users and send Appcues data about them. A user is identified with a unique ID.

// Identify a user
Appcues.identify('my-user-id')
// Identify a user with property
Appcues.identify('my-user-id', {'Company': 'Appcues'})

Tracking Screens and Events

Events are the “actions” your users take in your application, which can be anything from clicking a certain button to viewing a specific screen. Once you’ve installed and initialized the Appcues React Native Module, you can start tracking screens and events using the following methods:

// Track event
Appcues.track('Sent Message')
// Track event with property
Appcues.track('Deleted Contact', {'ID': 123 })

// Track screen
Appcues.screen('Contact List')
// Track screen with property
Appcues.screen('Contact Details', {'Contact Reference': 'abc'})

📝 Documentation

Full documentation is available at https://docs.appcues.com/

🎬 Examples

The example directory in this repository contains full example iOS/Android app to providing references for correct installation and usage of the Appcues API.

👷 Contributing

See the contributing guide to learn how to get set up for development and how to contribute to the project.

📄 License

This project is licensed under the MIT License. See LICENSE for more information.