Referral

Referral, These provide functionality to enable referral programs and sharing features in your application effortlessly.

Components Visuals

circle-info

To unlock early access to the component Get Accessarrow-up-right

Installation

To install the Quest react-native-sdk into your project, follow these steps:

  • Open your terminal/command prompt.

  • Navigate to your project's root directory using the cd command if you're not already there.

  • Run the following command to install the quest-sdk package using npm:

This command will download and install the package and its dependencies into your project.

circle-info

Make sure your project has npm and Node.js installed, and that you have the necessary permissions to install packages in your project directory.

Usage

Root Component

  • Import the QuestProvider Component: Import the QuestProvider component from the @questlabs/react-sdk package.

  • Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, entityId, authenticationToken and fontFamily.

circle-info

To load external fonts, please refer this doc to setup expo-fontarrow-up-right on your expo app.

Component Usage

To integrate the useReferral component into your React native application, follow these steps.

  • Import useReferral Hook: Import the useReferral component from the @questlabs/react-sdk package.

  • Import the Referral Component: Import the Referral component from the @questlabs/react-sdk package.

  • Pass the Required Props: Pass the required props to the useReferral . The required props are questId, questUserId, and userToken or if user don't have quest User id then they can pass own userId to get questUserId and Token.

circle-info

Don't not use QuestProvider and useReferral Hook in same file

Props of Referral Component

The Referral component accepts the following props

Props Name
Type
Require
Details

header

string

Optional

Compoent Header Text.

descrption

string

Optional

Component Header Description Text.

referralLink

string

Require

referral link text

referralCode

string

Require

Referral Code Text.

primaryHeading

string

Optional

Title Text main view

primaryDescription

string

Optional

Description Text Main View.

shareButtonText

string

Optional

Send Button Text.

showRefferalLogo

boolean

Optional

To show the logo

loading

boolean

Optional

don't use in offline mode.

styleConfig

Object

Optional

An object containing Styling properties for styling various components within the get started process, including form, topbar, headings, descriptions, and buttons.

Style Prop

Example Usage

App.js

DemoComponent.tsx

Demo

Last updated