Integrate Luciq on React Native

This page covers how to install the Luciq SDK in your React Native application.

Our React Native SDK support starts from React Native 0.60.x and up to the latest version. We always try to keep our SDK compatible with the latest React Native version while trying to maintain backward-compatibility whenever possible.

Installation

This installation process will install the Luciq SDK that supports Bug reporting, Crash reporting, and Application performance moniroting.

If you are upgrading from versions prior to v11.0, check our migration guide: /docs/react-native-migration-guide

1

Add the SDK package

Choose your package manager:

npm

Install with npm

npm install @luciq/react-native

yarn

2

iOS — install CocoaPods dependencies

Run the following in your project root:

Install CocoaPods (iOS)

cd ios && pod install && cd ..

Using Luciq

Import and initialize the SDK in your index.js (or main entry) file. The default behavior shows Luciq when the device is shaken; you can customize this via the SDK APIs.

index.js

import Luciq, { InvocationEvent } from '@luciq/react-native';

Luciq.init({
  token: 'APP_TOKEN',
  invocationEvents: [InvocationEvent.shake],
});

You can find your app token by selecting SDK Integration in the Settings menu from your Luciq dashboard.

Managing Permissions

Luciq needs access to the device microphone and photo library to allow users to add audio, image, and video attachments. Starting from iOS 10, apps that don’t provide usage descriptions for these permissions will be rejected by the App Store.

Add the following keys to your app’s info.plist with a user-facing explanation:

• NSMicrophoneUsageDescription

• NSPhotoLibraryUsageDescription

Example wording if your app doesn't already access these resources:

• " needs access to your microphone so you can attach voice notes."

• " needs access to your photo library so you can attach images."

The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note or photo while using Luciq.

Permissions Are Required

The above permissions are required in order for you to receive attachments from your users through the Luciq SDK.