Feedback Widget Software

Collect accurate product feedback directly from your platform users.

How It Works

1. Create an Account: Start by creating an account here.

2. Installation: Install the Feedback Widget Software package using npm or yarn:

   npm install feedback-widget-software
   # or
   yarn add feedback-widget-software

3. Integration: Import the FeedbackWidget component into your root component:

   import FeedbackWidget from 'feedback-widget-software'

   Add the FeedbackWidget component to your JSX and pass in a config prop:

   const config = {
     apiKey: 'YOUR-API-KEY', // Obtain from dashboard (required)
     user: {
       name: 'Marko', // Optional
       email: '[email protected]', // Required
     },
   }
   
   <FeedbackWidget config={config} />

• apiKey: Obtain this from the dashboard after creating an account. It is required for the widget to work.
• user: An object containing user information. name is optional, but email is required.

4. Deployment: Deploy your changes.

5. Create Feedback Request: Go back to the dashboard and create a feedback request. This will prompt the feedback widget to be sent to users when they use your platform. The widget will unmount once the user provides feedback or chooses not to.

Example

import React from 'react'
import FeedbackWidget from 'feedback-widget-software'

const config = {
  apiKey: 'YOUR_API_KEY',
  user: {
    name: 'Marko',
    email: '[email protected]',
  },
}

function App() {
  return (
    <div>
      {/* Your other components or routes */}
      <FeedbackWidget config={config} />
    </div>
  )
}

export default App

Support

Should you need any help or want to reach out, please me at: [email protected]

License

This project is licensed under the MIT License.