Get Started Component

The GetStarted component is a part of the Quest Labs React Native SDK. It provides a quick start guide for users to explore and engage with Application.

Components Visuals

Visual 1

Visual 2

To unlock early access to the component Get Access

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:

npm install @questlabs/react-native-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

Root Component

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

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.

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

Component Usage

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

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

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

• Pass the Required Props: Pass the required props to the useGetStarted. 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.

import { useGetStarted, GetStarted } from "@questlabs/react-native-sdk";

Don't not use QuestProvider and useGetStarted Hook in same file.

Props of GetStarted Component

The GetStarted component accepts the following props.

Props Name	Type	Require	Details
questId	string	optional	ID of the Quest.
questUserId	string	optional	User ID for authentication.
userToken	string	optional	Authentication token.
campaignVariationId	string	optional	Id For verification.
showDetailed	boolean	optional	show detaile mode.
onClose	Function	optional	Create the function for onClose.
isModal	boolean	optional	Open as Modal.
actions	ICriteria[]	Require	in offline user need to provide the require filed data.
loading	boolean	optional	don't use in offline mode.
title	string	Require	Component title.
description	string	Require	Component Descroption.
onClick	Funtion	optional	when it offline the create own Funtion.
isOffline	boolean	optional	for verification.
onError	Function	optional	For Showing the Error.
showProgressBar	boolean	optional	User Want to show progressBar or not
showFooter	boolean	optional	user Want to show the footer or not
ButtonType	"Buttons" | "Arrow"	optional	Want kind of button user want.
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 Props

styleConfig {
  Form?: ViewStyle;
  Heading?: TextStyle;
  Description?: TextStyle;
  PrimaryButton?: ViewStyle | TextStyle;
  SecondaryButton?: ViewStyle | TextStyle;
  Footer?: {
    FooterStyle?: ViewStyle;
    FooterText?: TextStyle;
    FooterIcon?: TextStyle;
  };
  Card?: ViewStyle;
  ProgressBar?: {
    barColor?: string;
    ProgressText?: string;
    barParentColor?: string;
  };
  CardContainer?: ViewStyle;
  Icon?: ViewStyle;
  TopBar?: ViewStyle;
  Arrow?: {
    Background?: string;
    IconColor?: string;
    CompletedBackground?: string;
    CompletedIconColor?: string;
  };
}

Example Usage

App.js

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

import React from "react";
import {GetStarted,useGetStarted} from "@questlabs/react-native-sdk";
const DemoComponent = () => {
  // const getStarted = useGetStarted({
  //   questId: "Your-Quest_ID" ,
  //   userId:"5235trfet365try67ywry5"
  //   })

  const getStarted = useGetStarted({
    questId: "Your-Quest_ID" ,
    questUserId: "Your-user-id",
    questToken: "Your-Token-id" 
    });
  return (
    <>
      <GetStarted
        actions={getStarted.actions}
        // actions={[
        //   {
        //     actionId: "123",
        //     completed: false,
        //     description: 'first description',
        //     imageUrl: "url",
        //     postlink: "https://google.com",
        //     title: 'first title',
        //     buttonText: 'start',
        //     demoButtonText: 'demo visit',
        //     demoLink: "https://zoho.com"
        //   },
        //   {
        //     actionId: "456",
        //     completed: false,
        //     description: '2nd description',
        //     imageUrl: "url",
        //     postlink: "https://facebook.com",
        //     title: '2nd title',
        //     buttonText: 'facebook',
        //     demoButtonText: 'demo visit',
        //     demoLink: "https://clickup.com"
        //   },
        //   {
        //     actionId: "4356",
        //     completed: false,
        //     description: '3nd description',
        //     imageUrl: "url",
        //     postlink: "https://facebook.com",
        //     title: '2nd title',
        //     buttonText: 'facebook',
        //     demoButtonText: 'demo visit',
        //     demoLink: "https://clickup.com"
        //   },
        //   {
        //     actionId: "4546",
        //     completed: false,
        //     description: '24nd description',
        //     imageUrl: "url",
        //     postlink: "https://facebook.com",
        //     title: '24nd title',
        //     buttonText: 'facebook',
        //     demoButtonText: 'demo visit',
        //     demoLink: "https://clickup.com"
        //   },

        // ]}
        description={getStarted.description}
        loading={getStarted.loading}
        questId={getStarted.questId}
        title={getStarted.title}
        userToken={getStarted.userToken}
        questUserId={getStarted.questUserId}
        showDetailed={false}
        campaignVariationId={getStarted.campaignVariationId}
        ButtonType="Arrow"
        showProgressBar={true}
        showFooter={true}
        isModal={true}
      // onClick={() => console.log(" click")}
      // onClose={() => console.log('close')}
      // styleConfig={{
      //   Card: {
      //     backgroundColor: 'lightgray'
      //   },
      //   CardContainer: {
      //     backgroundColor: "red"
      //   },
      //   Heading: {
      //     color: "blue"
      //   },

      //   Description: {
      //     color: "red"
      //   },
      //   Form: {
      //     backgroundColor: "yellow"
      //   },
      //   Arrow: {
      //     Background: "yellow",
      //     CompletedBackground: "blue",
      //     CompletedIconColor: "white",
      //     IconColor: "red"
      //   },
      //   Footer: {
      //     FooterIcon: {
      //       color: "red"
      //     },
      //     FooterStyle: {
      //       backgroundColor: "orange"
      //     },
      //     FooterText: {
      //       color: "blue"
      //     },

      //   },
      //   Icon: {
      //     backgroundColor: "red"
      //   },
      //   PrimaryButton: {

      //   },
      //   ProgressBar: {

      //   },
      //   SecondaryButton: {

      //   },
      //   TopBar: {

      //   }
      // }}

      />
    </>
  );
};
export default DemoComponent;

Demo