Survey Component

Offer a versatile survey solution for your app, enabling comprehensive data collection across various use cases. Provide a dedicated Surveys category with diverse templates for seamless integration in

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 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 Survey component accepts the following props

Prop NameTypeRequiredDetails

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

font

string

optional

This helps to change Font-Family as per requirements

color

string

optional

The text color of other UI elements in the component.

bgColor

string

optional

The background color of the entire component.

btnColor

string

optional

The background color of continue and Submit button

ratingType

string

optional

This helps in Change the rating icons

btnTextColor

boolean

optional

The Text color of continue and Submit button

itemsPerPage

number

optional

To set number of questions per page

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.

showFooter

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?: {
    Form?: React.CSSProperties,
    Heading?: React.CSSProperties,
    Description?: React.CSSProperties,
    Input?: React.CSSProperties,
    Label?: React.CSSProperties,
    TextArea?: React.CSSProperties,
    PrimaryButton?: React.CSSProperties,
    SecondaryButton?: React.CSSProperties,
    Modal?: React.CSSProperties,
    Footer?: React.CSSProperties,
  }

Usage

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

  • Import the CSS: In your JavaScript or TypeScript file where you're using the 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 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 Surveycomponent 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"
  />
</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 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" */} 
      >
       <
          userId="your user-id"
          token="your-token"
          questId="your quest-Id"
          iconColor="bxx"
          bgColor="#8B0xxx"
          color="xxxx"
          btnTextColor="rxx"
          textColor="bxx"
          font="sansxx"
          ratingType?="emoji | number | colored | star"
          styleConfig= {{
            Form: {},
            Heading: {},
            Description: {},
            Input: {},
            Label: {},
            TextArea: {},
            PrimaryButton: {},
            SecondaryButton: {},
            Modal: {},
            Footer: {},
  }
          }}
        />
      </QuestProvider>
    </div>
  );
}

export default App;

The above example uses all the props.

Last updated