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.
Component Visuals
To unlock early access to the component Get Access
Demo
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.
Features
The ReferEarn component offers the following features:
Referral Code Retrieval: It fetches a unique referral code for the user, which they can share with others to earn rewards.
Copy to Clipboard: Users can easily copy their referral code to the clipboard with a single click, simplifying the sharing process.
Social Media Sharing: The component provides icons for sharing the referral code on popular social media platforms, such as Twitter and Telegram.
Customization: Users can customize the appearance of the component by specifying the color and bgColor props to match their application's design.
Props
The ReferEarn component accepts the following props:
You can customize the UI with type of styleConfig would be
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 .