@superfeedback/widget
v0.0.40
Published
**Streamline bug reporting and feature requests directly from your website to your project management tools.**
Readme
@superfeedback/widget
Streamline bug reporting and feature requests directly from your website to your project management tools.
@superfeedback/widget is a lightweight integration that bridges the gap between your users and your development team. Instead of disjointed emails or lost support tickets, capture feedback instantly where it happens.
🚀 Motivation
Collecting high-quality feedback is often a friction-heavy process for both users and developers.
- Users hate leaving the app to write an email.
- Developers hate vague tickets lacking context.
Superfeedback solves this by offering an embedded widget. When a user submits feedback (including media/screenshots), our AI engine processes the ticket, analyzes the context, and routes it directly to your existing workflow.
Key Features:
- Zero-Friction UI: Users report issues without leaving your site.
- AI-Powered Processing: Automatically analyzes media and text to categorize tickets.
- Instant Sync: Feedback goes straight to Jira, GitHub, Slack, or Asana.
🛠 Prerequisites
Before installing the widget, you need to configure your backend settings:
- Create an account: Go to app.superfeedback.ai.
- Connect Integrations: Go to app.superfeedback.ai/integrations and authorize the tools you use (Jira, GitHub, etc.).
📦 Installation
Install the package via your preferred package manager:
npm
npm install @superfeedback/widgetpnpm
pnpm add @superfeedback/widgetyarn
yarn add @superfeedback/widget💻 Usage
1. Modern Import (ES6)
Ideal for React, Vue, Angular, Svelte, or standard bundlers (Vite, Webpack).
import { Superfeedback } from "@superfeedback/widget";
import "@superfeedback/widget/style.css";
// Initialize with your public API Key
Superfeedback.init({ projectId: "YOUR_PROJECT_ID" });2. CDN (Browser / HTML)
If you are not using a build step, you can load the widget directly from unpkg.
<head>
<link
rel="stylesheet"
href="https://unpkg.com/@superfeedback/widget/style.css"
/>
</head>
<script src="https://unpkg.com/@superfeedback/widget"></script>
<script>
window.Superfeedback.init({ projectId: "YOUR_PROJECT_ID" });
</script>🔌 Supported Integrations
The widget automatically routes tickets based on your configuration in the dashboard.
| Integration | Type | Status | | :---------- | :----------------- | :----------- | | Jira | Project Management | ✅ Supported | | GitHub | Issue Tracking | ✅ Supported | | Asana | Project Management | ✅ Supported | | Slack | Chat | ✅ Supported |