Onboarding Experience Survey

Share your initial experience and whether you needed more guidance. Tell us about helpful tools and suggest improvements for a smoother journey.

Component Visuals

Overview

Visual 1

Visual 2

To unlock early access to the component Get Access

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

• Versatile Onboarding Experience Survey Components: Integrate diverse survey elements into your app, allowing for comprehensive data collection tailored to various use cases.

• Seamless Integration: Enable easy incorporation of the survey solution into your customer's application, ensuring a smooth and hassle-free user experience.

• Dedicated Surveys Category: Provide a centralized hub within the app, featuring a range of templates for streamlined management and efficient access to different survey types.

• Customizable Templates: Tailor surveys to specific needs with customizable templates, empowering users to adapt and optimize data collection for their unique requirements.

Props of Survey Component

The Onboarding Experience Survey component accepts the following props

Prop Name	Type	Required	Details
userId	string	required	The unique identifier of the user.
token	string	required	An authentication token or API key necessary for accessing Survey or quest data.
questId	string	required	The unique identifier for the Survey or quest
heading	string	required	The title or heading of the Survey
subHeading	string	required	A brief description for the Survey
bgColor	string	optional	This helps to change Background color as per requirements. Works only for liner-gradient and radial-gradient.
ratingType	string	optional	This helps in Change the rating icons
btnTextColor	string	optional	The Text color of continue and Submit button
iconColor	string	optional	The quest logo icon color
onSubmit	function	optional	Callback function triggered on form submission.
uniqueEmailId	string	optional	Unique email identifier.
uniqueUserId	string	optional	Unique user identifier.
questionsPerSections	array of arrays	optional	Specify the number of questions in a section.
entityAuthenticationToken	string	optional	Authentication token for login.
variation	string	optional	To specify variation
showFooter	boolean	optional	To show or hide the component footer
styleConfig	object	optional	An object containing CSS properties for styling various components within the survey process, including form, headings, descriptions, inputs, labels, text area, buttons, modal, and footer .

You can customize the UI with type of styleConfig would be

  styleConfig?: {
      Description: React.CSSProperties,
      EmailError: {
        errorStyle: React.CSSProperties,
        text: string,
      },
      Footer: {
        FooterIcon: React.CSSProperties,
        FooterStyle: React.CSSProperties,
        FooterText: React.CSSProperties,
      },
      Form?: React.CSSProperties,
      Heading?: React.CSSProperties,
      Modal?: React.CSSProperties,
      Input?: React.CSSProperties,
      Label?: React.CSSProperties,
      MultiChoice?: {
        selectedStyle: React.CSSProperties,
        style: React.CSSProperties,
      },
      PrimaryButton: React.CSSProperties,
      Rating: {
        Hover: React.CSSProperties,
        LeftRatingText: string,
        RatingContainer: React.CSSProperties,
        RatingText: React.CSSProperties,
        RightRatingText: string,
        SingleRating: React.CSSProperties,
      },
      SecondaryButton: React.CSSProperties,
      TextArea: React.CSSProperties,
      TopBar: React.CSSProperties,
  }

Usage

To integrate the Onboarding Experience Survey component into your React application, follow these steps

• Import the CSS: In your JavaScript or TypeScript file where you're using the Onboarding Experience Survey, 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 Survey Component: Import the Onboarding Experience Survey component from the @questlabs/react-sdk package.

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

import { QuestProvider, Survey } from '@questlabs/react-sdk';

• Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, apiSecret, and entityId. and required props for the Onboarding Experience Survey component are userId, questId, token.

<QuestProvider
  apiKey="your-api-key"
  entityId="your-entity-id"
>
  <Survey
    userId="your user-id"
    token="your-token"
    questId="your quest-Id"
    heading="Heading"
    subHeading="SubHeading"
    bgColor="gradient or radial backgroung color"
    ratingType="emoji"
    iconColor="Any color"
    onSubmit={() => { }}
    uniqueEmailId="your unique user emailid"
    uniqueUserId="your unique user emailid"
    questionSections={[[1, 2], [3, 4, 5], [6, 7, 8]]}
    entityAuthenticationToken="your Entity Authentication Token"
    variation="variation string"
    showFooter={true}
    styleConfig?:{{
        Description?: CSSProperties,
        EmailError?: {
          errorStyle?: CSSProperties,
          text?: string,
        },
        Footer?: {
          FooterIcon?: CSSProperties,
          FooterStyle?: CSSProperties,
          FooterText?: CSSProperties,
        },
        Form?: CSSProperties,
        Heading?: CSSProperties,
        Input?: CSSProperties,
        Label?: CSSProperties,
        Modal?: CSSProperties,
        MultiChoice?: {
          selectedStyle?: CSSProperties,
          style?: CSSProperties,
        },
        PrimaryButton?: CSSProperties,
          Rating?: {
            Hover?: CSSProperties,
            LeftRatingText?: string,
            RatingContainer?: CSSProperties,
              RatingText?: CSSProperties,
              RightRatingText?: CSSProperties,
              SingleRating?: CSSProperties,
            },
            SecondaryButton?: CSSProperties,
            TextArea?: CSSProperties,
            TopBar?: CSSProperties,
      }}
  />
</QuestProvider>

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

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

Example Usage

Here's an example of how to use the Onboarding Experience Survey component within your React application

import { QuestProvider, Survey} from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css';
function App() {
  return (
    <div>
      <QuestProvider
        apiKey="k-xc-ac8f-x1-xxx8b-a175xx"
        entityId="e-xxxx-b75b-xxxx-be9a-ee11f0f0xxxx"
        apiType = {/* mention type "STAGING" or "PRODUCTION" */} 
      >
       <Survey
          userId="your user-id"
          token="your-token"
          questId="your quest-Id"
          heading="Heading"
          subHeading="SubHeading"
          bgColor="gradient or radial backgroung color"
          ratingType="emoji"
          iconColor="Any color"
          onSubmit={() => { }}
          uniqueEmailId="your unique user emailid"
          uniqueUserId="your unique user emailid"
          questionSections={[[1, 2], [3, 4, 5], [6, 7, 8]]}
          entityAuthenticationToken="your Entity Authentication Token"
          variation="variation string"
          showFooter={true}
          styleConfig?:{{
              Description?: CSSProperties,
              EmailError?: {
                errorStyle?: CSSProperties,
                text?: string,
              },
              Footer?: {
                FooterIcon?: CSSProperties,
                FooterStyle?: CSSProperties,
                FooterText?: CSSProperties,
              },
              Form?: CSSProperties,
              Heading?: CSSProperties,
              Input?: CSSProperties,
              Label?: CSSProperties,
              Modal?: CSSProperties,
              MultiChoice?: {
                selectedStyle?: CSSProperties,
                style?: CSSProperties,
              },
              PrimaryButton?: CSSProperties,
                Rating?: {
                  Hover?: CSSProperties,
                  LeftRatingText?: string,
                  RatingContainer?: CSSProperties,
                    RatingText?: CSSProperties,
                    RightRatingText?: CSSProperties,
                    SingleRating?: CSSProperties,
                  },
                  SecondaryButton?: CSSProperties,
                  TextArea?: CSSProperties,
                  TopBar?: CSSProperties,
            }}
  />
      </QuestProvider>
    </div>
  );
}

export default App;

The above example uses all the props.

Demo