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.
Last updated
A versatile interface for user communication, offering options to report issues, provide feedback, request features, or contact support, ensuring user engagement and problem-solving.
Last updated
To unlock early access to the component Get Access
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:
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.
To integrate the Feedback Workflow component into your React application, follow these steps
Import the CSS: In your JavaScript or TypeScript file where you're using the FeedbackWorkflow, import the CSS styles for the component. This ensures that the component's styling is applied correctly.
Import the FeedbackWorkflowComponent: Import the Feedback Workflow component from the @questlabs/react-sdk package.
Import the QuestProvider Component: Import the QuestProvider component from the @questlabs/react-sdk package.
Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, and entityId. and required props for the FeedbackWorkflowcomponent 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.
Here's an example of how to use the FeedbackWorkflowcomponent within your React application
The above example uses all the props.
The Feedback Workflow component accepts the following props
| Prop Name | Type | Required | Details |
|---|---|---|---|
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. |
Headers
You can customize the UI with type of styleConfig would be