Feedback Workflow Component

A versatile interface for user communication, offering options to report issues, provide feedback, request features, or contact support, ensuring user engagement and problem-solving.

Component Visuals

To unlock early access to the component Get Access

In this video, you'll learn:

  1. How to set up the QuestProvider with your API credentials.

  2. Configuration of the Feedback Workflow component with required props.

  3. Customization options for the Feedback Workflowcomponent.

  4. Integration of the component into your React application.


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.


Props of Feedback Workflow Component

The Feedback Workflow component accepts the following props

Prop NameTypeRequiredDetails

userId

string

required

The unique identifier of the user.

questIds

array

required

custom quest ids or q-contact-us, q-report-a-bug, q-general-feedback, q-request-a-feature

token

string

required

An authentication token or API key necessary for accessing tutorial or quest data.

contactUrl

string

optional

The URL for contacting support or administrators.

isOpen

boolean

required

Determines whether the feedback component is open or closed.

onClose

function

optional

A function to handle the closing of the feedback component.

starColor

string

optional

The color of the stars used for rating.

starBorderColor

string

optional

The border color of the stars used for rating.

ratingStyle

string

optional

The style of rating to be used in the feedback component. example:( "Star" or "Numbers" or "Smiles")

uniqueUserId

string

optional

Unique user identifier.

uniqueEmailId

string

optional

Unique Email identifier.

descriptions

string

optional

Descriptions for different feedback options or categories.

iconColor

string

optional

The color of icons within the feedback component.

styleConfig

object

optional

An object containing CSS properties for styling various components within the feedback workflow process, including form, headings, descriptions input, label , text area, modal, footer, and buttons.

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;
    listHeading?: React.CSSProperties;
    listDescription?: React.CSSProperties;
    listHover?: {
      background?: string;
      iconBackground?: string;
      iconColor?: string;
      Heading?: string;
      Description?: string;
  }

Usage

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

  • Import the Feedback Workflow Component: Import the Feedback Workflowcomponent from the @questlabs/react-sdk package.

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

import { QuestProvider, FeedbackWorkflow } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css';
  • Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, apiSecret, and entityId. and required props for the Feedback Workflowcomponent are userId, questIds, and token

<QuestProvider
  apiKey="your-api-key"
  entityId="your-entity-id"
  apiType = {/* mention type "STAGING" or "PRODUCTION" */} 
  featureFlags={{}}
>
   <FeedbackWorkflow
     userId="userid"
     questIds={[
      "custom-questid"
      'q-general-feedback',
      'q-report-a-bug',
      'q-request-a-feature',
      'q-contact-us',
      ]}
     token="your-token"
     contactUrl="contact-support"
     styleConfig=""
    />
</QuestProvider>

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

Replace "your-token", "userid", "custom-questid" with your actual configuration details.


Example Usage

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

import { QuestProvider, FeedbackWorkflow } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css';

function App() {
  return (
    <div>
      <QuestProvider
        apiKey="k-xxxxxdc-ac8f-x1-xxx8b-a175xxxxx"
        entityId="e-xxxx-b75b-xxxx-be9a-ee11f0f0xxxx"
        apiType = {/* "STAGING" ||"PRODUCTION" */} 
      >
       <FeedbackWorkflow 
          userId="u-xxxxxx-xxxxxx-4cb3-xxxxx-xxxxx"
          token="xxxxxxx-xxxxxx.U_VyUxxxxxxxxx"
          questIds={[
            'q-general-feedback',
            'q-report-a-bug',
            'q-request-a-feature',
            'q-contact-us',
          ]}
           isOpen={true}
           styleConfig ={{
                Form: {},
                Heading: {},
                Description: {},
                Input: {},
                Label: {},
                TextArea: {},
                PrimaryButton: {},
                SecondaryButton: {},
                Modal: {},
                Footer: {},
                listHeading: {},
                listDescription: {},
                listHover: {
                  background: '',
                  iconBackground: '',
                  iconColor: '',
                  Heading: '',
                  Description: ''
                }
         }}
        />
      </QuestProvider>
    </div>
  );
}

export default App;

The above example uses all the props.

Demo

In this video, you'll learn:

  1. How to set up the QuestProvider with your API credentials.

  2. Configuration of the Feedback Workflow component with required props.

  3. Customization options for the Feedback Workflowcomponent.

  4. Integration of the component into your React application.

Last updated