> For the complete documentation index, see [llms.txt](https://docs.questera.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.questera.ai/questera-ai-sdks/react-native-sdk-components/expansion/referral.md).

# Referral

## Components Visuals 

{% tabs %}
{% tab title="Overview" %}

<figure><img src="/files/0tTh7fzWnEMxsWR6hG04" alt="" width="563"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

{% hint style="info" %}
To unlock early access to the component                                                           [**Get Access**](https://bijfwfnqtsj.typeform.com/to/eUXDpbuh)
{% endhint %}

## 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:

```jsx
npm install @questlabs/react-native-sdk
```

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

{% hint style="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.
{% endhint %}

## Usage

### Root Component

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

```jsx
import { QuestProvider } from '@questlabs/react-sdk';
```

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

{% hint style="info" %}
To load external fonts, please refer this doc to setup [expo-font](https://docs.expo.dev/versions/latest/sdk/font/) on your expo app.
{% endhint %}

### 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.&#x20;

```typescript
import { useReferral, Referral } from "@questlabs/react-native-sdk";
```

{% hint style="info" %}
Don't not use QuestProvider and useReferral Hook in same file
{% endhint %}

## Props of Referral Component

The Referral component accepts the following props

<table><thead><tr><th width="212">Props Name</th><th width="120">Type</th><th width="103">Require </th><th>Details</th></tr></thead><tbody><tr><td>header</td><td>string</td><td>Optional</td><td>Compoent Header Text.</td></tr><tr><td>descrption</td><td>string</td><td>Optional</td><td>Component Header Description Text.</td></tr><tr><td>referralLink</td><td>string</td><td>Require</td><td>referral link text</td></tr><tr><td>referralCode</td><td>string</td><td>Require</td><td>Referral Code Text.</td></tr><tr><td>primaryHeading</td><td>string</td><td>Optional</td><td>Title Text main view</td></tr><tr><td>primaryDescription</td><td>string</td><td>Optional</td><td>Description Text Main View.</td></tr><tr><td>shareButtonText</td><td>string</td><td>Optional</td><td>Send Button Text.</td></tr><tr><td>showRefferalLogo</td><td>boolean</td><td>Optional</td><td>To show the logo </td></tr><tr><td>loading</td><td>boolean</td><td>Optional</td><td>don't use in offline mode.</td></tr><tr><td>styleConfig</td><td>Object</td><td>Optional</td><td>An object containing Styling properties for styling various components within the get started process, including form, topbar, headings, descriptions, and buttons.</td></tr></tbody></table>

### Style Prop

```typescript
styleConfig {
  Form?: ViewStyle;
  Heading?: TextStyle;
  Description?: TextStyle;
  Input?: ViewStyle;
  Label?: TextStyle;
  PrimaryButton?: ViewStyle;
  Modal?: ViewStyle;
  Footer?: {
    FooterStyle?: ViewStyle;
    FooterText?: TextStyle;
    FooterIcon?: TextStyle;
  };
 
}
```

## Example Usage

App.js

```typescript
import { SafeAreaView, StyleSheet, StatusBar } from "react-native";
import React, { useState } from "react";
import { QuestProvider } from "@questlabs/react-native-sdk";
import DemoComponent from "./DemoComponent";

export default function App() {
return (
    <SafeAreaView style={styles.container}>
      <StatusBar />
      <QuestProvider
        apiKey="Your-Api-Key"
        apiSecret="Your-Api-Secret"
        entityId="Your-Api-entityId"
        authenticationToken="Your-authentication-token"  
         fontFamily= "Your-Font-FamFamily"
         >
        
        <DemoComponent />
        
        </QuestProvider>
   
    </SafeAreaView>
  );
}
```

DemoComponent.tsx

```typescript
import React from "react";
import { Referral , useReferral} from "@questlabs/react-native-sdk";
const DemoComponent = () => {
  // const referral = useReferral ({
  //   questId: "Your-Quest_ID" ,
  //   userId:"5235trfet365try67ywry5"
  //   })

  const referral= useReferral({
    questId: "Your-Quest_ID" ,
    questUserId: "Your-user-id",
    questToken: "Your-Token-id" 
    });
  return (
    <>
     <Referral 
        shareButtonText="Please share it"
        referralCode={referral.referralCode}
        referralLink={"https://www.questlabs.ai/"}
        loading={referral.loading}
        header={referral.title}
        descrption={referral.description}
        // primaryDescription="sgnanopgjnaohgoh"
        // primaryHeading=""
        showRefferalLogo={true}
        // styleConfig={{
        //   Description:{color:"yellow"},
        //   Footer:{
        //     FooterIcon:{color:"red"},
        //   },
        //   Form:{
        //     backgroundColor:"red"
        //   },
        //   Heading:{color:'orange'},
        //  Input:{backgroundColor:"lightgray"},
        //  Label:{color:"blue"},
        //  Modal:{backgroundColor:"gray"},
        //  PrimaryButton:{backgroundColor:"orange"}
        // }}
      />
    </>
  );
};
export default DemoComponent;
```

## Demo

{% embed url="<https://www.loom.com/share/ec9f8f7239924993994ff409ef8082a9?sid=947300e8-d5de-47fe-ae45-42224f2c24e1>" %}