Questera AI
  • Getting Started
    • Get Started with Questera AI
      • Overview of Questera
      • Why Choose Questera ?
      • Key Features & Benefits
      • How does it work?
    • Use Cases
      • Ecommerce & Retail
      • Saas
      • Subscriptions
  • Questera AI Platform
    • Data
      • Connect Data & Models
        • Data Ingestion
          • Snowflake
          • Amazon Redshift
          • Google BigQuery
          • Microsoft Azure
          • CSV
          • ESP (Email Service Provider)
          • CRM
        • Configure Models
          • Open AI
          • Gemini
      • Track & Measurements
        • Events
        • User Attributes
        • Counters
        • Metrics
        • Webhooks & Alerts
        • Feature Flags
    • Campaigns
      • Channels Supported in Questera
        • UI Campaigns
        • Email Campaigns
        • SMS Campaigns
        • Push Notifications Campaigns
        • In-App Messages Campaigns
        • WhatsApp Campaigns
      • Campaigns in Questera: Drive Growth Across Every Touchpoint
      • Omnichannel Marketing with Questera AI
      • Why Questera’s AI-Driven Approach Wins?
    • AI Audience Segments
    • Page
    • AI Variants
    • AI Flows
    • AI Agents
      • What are AI Agents?
      • Types of AI Agents
        • ELMA - Email Lifecycle Marketing Agent
        • GRETA - Growth Engineering Agent
        • SEGA - Intelligent Segmentation Agent
        • OMNIA - Omni-Channel Journey Creator Agent
        • GIA - Data Analysis & Graphical Interpretation Agent
        • SARA - Smart Ads Retargeting Agent
        • BECCA - Personalized Email Content Agent
        • LEXA - Language Optimization Agent
      • Create & Configure an Agents
        • Create your own marketing agents
        • Chat with Agents
    • Analytics & Reporting
      • Analytics
        • Overview of Analytics.
          • Dashboard Walkthrough
          • Add dashboard
          • Chat with data
    • Playground
      • Simulating User Interactions.
        • Test and Run Campaigns
    • Dataset
      • Connecting an external data source
      • Uploading your own file
  • Questera AI SDKs
    • SDK Component Categories
      • Onboarding
      • Engagement
      • User Assistance
      • Expansion
      • Miscellaneous
    • All Components
      • Onboarding
        • Onboarding Quiz
        • Login Component
      • Gamified Engagement
        • Rewards & Loyalty Component
        • Challenges
        • Leaderboard
        • Badges
        • Spin The Wheel
        • Scratch The Card
        • Gamified Quiz
        • Streaks
        • Dynamic Membership
      • Education
        • User Guides
        • Tooltips
        • AI Help Hub & Assistant
      • Popups
        • Special Offers
        • Upsells & Cross Sells
        • Product Recommendations
        • Celebrations
        • Alerts
      • AI Search
      • User Feedback
      • Surveys
      • Referrals
      • Banners
      • Pricing & Payments
      • Embedded Analytics
    • React SDK Components
      • Onboarding
        • Onboarding Component
        • Get Started Component
        • Tutorial/Quest List Component
        • Walk Through Component
      • Gamification
        • Challenges Component
        • DailyStreak Component
        • Leaderboard Component
        • GamifiedQuiz component
      • User Assistance
        • Feedback Workflow Component
        • Inline Feedback Component
        • Survey Component
        • Search Bar Component
        • Help Hub Component
        • CreditsPopup Component
      • Expansion
        • Referral Components
        • Cross-Selling Component
      • Miscellaneous
        • Confetti Component
        • Alert Component
        • Login Component
        • One to one Survey Component
        • Pricing & Payment Component
        • Badge Component
        • Toast Service
      • Survey
        • User Experience Feedback Survey
        • Feature Usage Survey
        • Customer Satisfaction Surveyy
        • Net Promoter Score
        • Onboarding Experience Survey
        • Customer Support Satisfaction Survey
      • Embedded Analytics
        • Line Chart
        • Scatter Chart
        • Combo Bar/Line
        • Stacked Bar Chart
        • Horizontal Bar Chart
        • Stepped Line Chart
        • Pie chart
        • Doughnut Chart
        • Multi Series Pie
        • Bubble Chart
        • Floating Bar Chart
    • React Native SDK Components
      • Onboarding
        • Embedded Onboarding ToolTip
        • Announcement Banners
        • Onboarding Component
        • Get Started Component
        • Quest List Component
      • Gamification
        • Challenges Component
        • Daily Streak Component
        • Leaderboard Component
        • Quiz component
      • User Assistance
        • HelpHub
        • Feedback Workflow Component
        • General Feedback Component
        • Inline Feedback Component
        • Credits Popup Component
      • Expansion
        • Cross-Selling
        • Share With friends
        • Referral
      • Miscellaneous
        • Spotlight Searc
        • Modal
        • Login Component
        • Membership Card
        • Badges
        • Pricing
        • Survey Form
        • Banner
        • Carousel
        • Tutorial
        • Daily Check-in Credit
    • No Code SDK Components
      • HelpHub
      • Feedback Workflow Component
    • Flutter SDK Components
      • Onboarding
        • Onboarding Quiz - Multi page Component
        • Onboarding Quiz - Single page Component
        • Get Started Component
        • Tutorial/Quest List Component
      • User Assistance
        • Feedback Workflow
        • Help Hub Component
        • Inline Feedback Component
        • Spotlight Search Component
        • Survey component
      • Gamification
        • Daily Streak Component
        • Leaderboard Component
        • Gamified Quiz Component
      • Expansion
        • Referral Component
        • Cross-Selling Component
      • General Components
        • Login Component
    • Rest APIs
      • Data Module
        • Data Object
      • Entity Module
        • Entity Object
      • User Module
        • User Object
      • Gamification
        • Badge Object
        • Web3 Module
          • Dynamic NFT Object
        • Skills Module
          • Skills Object
        • Levels Module
          • Levels Object
  • Integrations
    • Email
      • Mailchimp
      • Klaviyo
      • Mailmodo
      • Mailjet
      • Brevo (SendInBlue)
      • Constant Contact
      • Elastic Email
      • ApolloIo
      • Google OAuth
      • Instantly
      • Loops
      • AWS SES
      • SendGrid
      • Hubspot
      • Activecampaign
      • One Signal
      • Attio
    • Customer data platforms
      • Segment
      • Shopify
      • Salesforce
    • Workflow automation & ETLs
      • Zapier
    • Analytics & business intelligence
      • Mixpanel
      • Amplitude
      • Heap
      • Posthog
      • Snowflake
      • Google BigQuery
      • Clay
      • Outreach
      • Salesloft
      • Smartlead
    • Data ware house
      • Redshift
      • Microsoft Azure
    • Task management
      • Clickup
      • Jira
    • Engagement Platforms
      • Braze
      • Moengage
      • Iterable
      • Customer.io
    • Segment
      • Overview
      • Sending Data to Segment
      • Sending Data to Questera
    • In-App UI
      • Quest UI SDKs
      • Pendo
      • Appcues
      • Bubble
      • Chameleon
    • FAQ
  • recipes
    • Greta
      • SaaS Subscription
        • Activation
        • Conversion
        • Retention
      • SaaS Credit-Based
        • Activation
        • Conversion
        • Retention
        • Engagement
      • Ed-Tech
        • Activation
        • Conversion
        • Retention
        • Engagement
      • Gaming Apps
        • Activation
        • Conversion
        • Retention
        • Engagement
      • E-Commerce
        • Activation
        • Conversion
        • Retention
    • Elma
      • SaaS Subscription
        • Activation
        • Conversion
        • Retention
        • Engagement
      • SaaS Credit-Based
        • Activation
        • Conversion
        • Retention
        • Engagement
      • E-Commerce
        • Activation
        • Conversion
        • Retention
        • Engagement
  • Quest Tools
    • Saas GPT
    • Playground
    • PLGOS
  • GRETA
    • How to create your first project using Greta?
    • Playground
Powered by GitBook
On this page
  • Component Visuals
  • Installation
  • Usage
  • Code & Steps
  • Example Usage
  • Props
  • Features
  • Demo
  1. Questera AI SDKs
  2. React SDK Components
  3. Expansion

Referral Components

The Referral components are reusable React components designed to facilitate user referrals and rewards. It allows users to earn rewards by sharing a referral code with friends.

PreviousExpansionNextCross-Selling Component

Last updated 3 months ago

Component Visuals

To unlock early access to the component

Installation

To install the Quest react-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:

npm install @questlabs/react-sdk

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

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

To integrate the ReferEarn component into your React application, follow these steps

  • Import the CSS: In your JavaScript or TypeScript file where you're using the ReferEarn, import the CSS styles for the component. This ensures that the component's styling is applied correctly.

import '@questlabs/react-sdk/dist/style.css'
  • Import the TutorialComponent: Import the ReferEarncomponent from the @questlabs/react-sdk package.

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

import { QuestProvider, ReferEarn } from '@questlabs/react-sdk';
  • Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, and entityId. and required props for the ReferEarncomponent are userId, questId, token

Replace "your-api-key" and "your-entity-id" with your actual Quest API credentials

Replace "your-token", "your-user-id", "your-questId" with your actual configuration details.

Code & Steps

import { QuestProvider, ReferEarn } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
  return (
      <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id" 
        apiType= "PRODUCTION" // STAGING 
      >
      <ReferEarn> </ReferEarn>
      </QuestProvider>
  );
}

export default App;

<ReferEarn
    userId=""
    questId=""
    token=""
    uniqueUserId="your-unique-user-id"
>
    // childrens
</ReferEarn>
<ReferEarn.Header
    heading='your-heading' 
    description:""
/>
<ReferEarn.Footer
    text='your-company-name' 
    link='redirect-link'
    style={{ background : 'white' }}
/>
<QuestProvider
    apiKey="your-apikey"
    entityId="your-entity-Id"
    apiType="PRODUCTION" // STAGING 
>
    <ReferEarn
        userId=""
        questId=""
        token=""
        uniqueUserId="your-unique-user-id"
    >
        <ReferEarn.Header />
        <ReferEarn.MainContent />
        <ReferEarn.Footer />
    </ReferEarn>
</QuestProvider>

Example Usage

Here's an example of how to use the ReferEarn component within your React application

import { QuestProvider, ReferEarn } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
    return (
        <div>
            <QuestProvider
                apiKey="your-apikey"
                entityId="your-entity-Id"
                apiType="PRODUCTION" // STAGING 
            >
                <ReferEarn
                    userId=""
                    questId=""
                    token=""
                    uniqueUserId="your-unique-user-id"
                >
                    <ReferEarn.Header />
                    <ReferEarn.MainContent/>
                    <ReferEarn.Footer />
                </ReferEarn>
            </QuestProvider>
        </div>
    );
}

export default App;
import { QuestProvider, ReferEarnWrapper } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
  return (
    <div>
      <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id"
        apiType= "PRODUCTION" // STAGING 
      >
       <ReferEarnWrapper
          userId=""
          questId=""
          token=""
          uniqueUserId="your-unique-user-id"
          styleConfig= {{
              Form: {},
              Heading: {},
              Description: {},
              Footer: {},
              TopBar: {},
          }}
          showFooter={false}
        />
      </QuestProvider>
    </div>
  );
}

export default App;

Props

The ReferEarn component accepts the following props:

questId

string

required

The unique identifier for the referral quest associated with the user.

userId

string

required

The user's unique identifier, often used for tracking referrals.

token

string

required

A user authentication token required for making API requests.

heading

string

optional

Heading for the referral component.

headingColor

string

optional

set the heading color

description

string

optional

Description for the referral component.

referralLink

string

optional

Referral link.

shareButtonText

string

optional

Text for the share button.

secondaryIconColor

string

optional

Color of secondary icons.

gradientBackground

boolean

optional

Indicates whether to use a gradient background.

primaryHeading

string

optional

Primary heading for the gradient background.

primaryDescription

string

optional

Primary description for the gradient background.

onCopy

function

optional

Callback function triggered on referral code copy.

showReferralCode

boolean

optional

Indicates whether to show the referral code.

isOpen

boolean

optional

if true open the component else not

bgColor

string

optional

set background color

uniqueUserId

string

optional

a unique user'id for all user

showPoweredBy

boolean

optional

Indicates whether to show the "Powered by QuestLabs" footer.

uniqueEmailId

string

optional

a unique email'id for all user

styleConfig

object

optional

An object containing CSS properties for styling various components within the refer earn process, including form, topbar, label, headings, descriptions, Primary button .

The above example uses all the props.

You can customize the UI with type of styleConfig would be

styleConfig= {{
    Form: {},
    Heading : {},
    Description : {},
    Footer: {
    FooterStyle: {},
    FooterText: {},
    FooterIcon: {}
    },
    TopBar: {},
}}

Features

The ReferEarn component offers the following features:

  1. Referral Code Retrieval: It fetches a unique referral code for the user, which they can share with others to earn rewards.

  2. Copy to Clipboard: Users can easily copy their referral code to the clipboard with a single click, simplifying the sharing process.

  3. Social Media Sharing: The component provides icons for sharing the referral code on popular social media platforms, such as Twitter and Telegram.

  4. Customization: Users can customize the appearance of the component by specifying the color and bgColor props to match their application's design.

Demo

Get Access