@appcues/segment-react-native
v4.3.0
Published
Segment destination plugin for Appcues.
Downloads
9,510
Maintainers
Readme
@appcues/segment-react-native
DestinationPlugin
for Appcues. Wraps @appcues/react-native
.
Installation
You need to install the @appcues/segment-react-native
and the @appcues/react-native
dependency.
Using NPM:
npm install --save @appcues/segment-react-native @appcues/react-native
Using Yarn:
yarn add @appcues/segment-react-native @appcues/react-native
Run pod install
after the installation to autolink the Appcues SDK.
See Appcues React Native Module for more details of this dependency.
Usage
Follow the instructions for adding plugins on the main Analytics client:
In your code where you initialize the analytics client call the .add(plugin)
method with an AppcuesPlugin
instance:
import { createClient } from '@segment/analytics-react-native';
import { AppcuesPlugin } from '@appcues/segment-react-native';
const segmentClient = createClient({
writeKey: 'SEGMENT_KEY'
});
segmentClient.add({ plugin: new AppcuesPlugin() });
Supporting Builder Preview and Screen Capture
During installation, follow the steps outlined in in the Appcues React Native Module documentation for Configuring the Appcues URL Scheme. This is necessary for the complete Appcues builder experience, supporting experience preview, screen capture and debugging.
Support
Please use Github issues, Pull Requests, or feel free to reach out to our support team.