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

Overview

Visual 1

Visual 2

Visual 3

Visual 4

Visual 5

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.

---

The Tutorialcomponent accepts the following props

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 Surveyl, 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 Surveycomponent 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, and entityId. and required props for the Surveycomponent 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

QuestProvider

import { QuestProvider, Survey } 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 
      >
        <Survey> </Survey>
      </QuestProvider>
  );
}

export default App;

Survey

<Survey
    userId=""
    questId=""
    token=""
    uniqueUserId="your-unique-user-id"
>
    // children
</Survey>

Header

<Survey.Header
    heading='your-heading' 
    subHeading='your-subHeading' 
    style= {{ backgroundcolor : 'white' }} 
    headingStyle= {{ fontSize : '20px }} 
    descriptionStyle= {{ fontSize : '14px' }}
/>

Footer

<Survey.Footer
    text='your-company-name' 
    link='redirect-link'
    style={{ background : 'white' }}
/>

Preview

<QuestProvider
    apiKey="your-apikey"
    entityId="your-entity-Id"
    apiType="PRODUCTION" // STAGING 
>
    <Survey
        userId=""
        questId=""
        token=""
        uniqueUserId="your-unique-user-id"
    >
        <Survey.Header />
        <Survey.Content />
        <Survey.Footer />
    </Survey>
</QuestProvider>

---

Example Usage

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

Survey

import { QuestProvider, Survey } 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 
            >
                <Survey
                    userId=""
                    questId=""
                    token=""
                    uniqueUserId="your-unique-user-id"
                >
                    <Survey.Header />
                    <Survey.Content />
                    <Survey.Footer />
                </Survey>
            </QuestProvider>
        </div>
    );
}

export default App;

SurveyWrapper

import { QuestProvider, SurveyWrapper } 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 
            >
                <SurveyWrapper
                    userId=""
                    questId=""
                    token=""
                    showFooter={true}
                    ratingType="number"
                    itemsPerPage={3}
                    singleChoiceModal="modal2"
                    multiChoiceModal="modal2"
                    uniqueUserId="sdsddfakmfdddcrt"
                    design={[[1, 2], [3, 4, 5]]}
                    Headers={[
                        {
                            heading: "",
                            subHeading: ""
                        }
                    ]}
                    bgColor=""
                    btnColor=""
                    btnTextColor=""
                    crossLogoForInput={false}
                    delay={ }
                    expiryDate={ }
                    font=""
                    heading=""
                    iconColor=""
                    onCancel={ }
                    onSubmit={ }
                    sections={ }
                    styleConfig={{
                        Description: {},
                        Form: {},
                        Heading: {},
                        Input: {},
                        Label: {},
                        PrimaryButton: {},
                        SecondaryButton: {},
                        TextArea: {},
                        EmailError: {},
                        Footer: {},
                        Modal: {},
                        MultiChoice: {},
                        Rating: {},
                        SingleChoice: {},
                        TopBar: {}
                    }}
                    subHeading=""
                    supportUrl=""
                    textColor=""
                    uniqueEmailId=""
                    variation=""
                />
            </QuestProvider>
        </div>
    );
}

export default App;

Props of Survey Component

The 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
font	string	optional	This helps to change Font-Family as per requirements
supportUrl	string	optional	give you url location for support
isInline	boolean	optional	true: behave inline feedback false: behave as feedback component
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
textColor	string	optional	give you color to text
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.
onCancel	function	optional	Callback function triggered on form cancelation.
uniqueEmailId	string	optional	Unique email identifier.
uniqueUserId	string	optional	Unique user identifier.
showFooter	boolean	optional	true: show footer false: hide footer
enableVariation	boolean	optinal	true: for enable multiple variation false no multiple variation
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 .

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.

You can customize the UI with type of styleConfig would be

styleConfig = {{
    Description: { },
    Form: { },
    Heading: { },
    Input: { },
    Label: { },
    PrimaryButton: { },
    SecondaryButton: { },
    TextArea: { },
    EmailError: { },
    Footer: { },
    Modal: { },
    MultiChoice: { },
    Rating: { },
    SingleChoice: { },
    TopBar: { }
}}