@superfeedback/widget 0.0.16 → 0.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -20
- package/dist/dist-CU9w03k6.js +9483 -0
- package/dist/index.d.ts +12 -11
- package/dist/index.iife.js +23 -1
- package/dist/index.js +102 -80
- package/dist/style.css +1 -1
- package/dist/vue/index.js +15455 -0
- package/dist/vue/root.vue.d.ts +15 -0
- package/dist/vue/style.css +2 -0
- package/dist/vue/vue.d.ts +22 -0
- package/dist/widget.css +1 -1
- package/dist/widget.d.ts +12 -6
- package/dist/widget.iife.js +5 -5
- package/dist/widget.js +5837 -15384
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -4,34 +4,33 @@
|
|
|
4
4
|
|
|
5
5
|
`@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.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
---
|
|
8
8
|
|
|
9
9
|
## 🚀 Motivation
|
|
10
10
|
|
|
11
11
|
Collecting high-quality feedback is often a friction-heavy process for both users and developers.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
- **Users** hate leaving the app to write an email.
|
|
14
|
+
- **Developers** hate vague tickets lacking context.
|
|
15
15
|
|
|
16
16
|
**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.
|
|
17
17
|
|
|
18
18
|
**Key Features:**
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
- **Zero-Friction UI:** Users report issues without leaving your site.
|
|
21
|
+
- **AI-Powered Processing:** Automatically analyzes media and text to categorize tickets.
|
|
22
|
+
- **Instant Sync:** Feedback goes straight to **Jira, GitHub, Slack, or Asana**.
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
---
|
|
25
25
|
|
|
26
26
|
## 🛠 Prerequisites
|
|
27
27
|
|
|
28
28
|
Before installing the widget, you need to configure your backend settings:
|
|
29
29
|
|
|
30
30
|
1. **Create an account:** Go to [app.superfeedback.ai](https://app.superfeedback.ai).
|
|
31
|
-
2. **
|
|
32
|
-
3. **Connect Integrations:** Go to [app.superfeedback.ai/integrations](https://app.superfeedback.ai/integrations) and authorize the tools you use (Jira, GitHub, etc.).
|
|
31
|
+
2. **Connect Integrations:** Go to [app.superfeedback.ai/integrations](https://app.superfeedback.ai/integrations) and authorize the tools you use (Jira, GitHub, etc.).
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
---
|
|
35
34
|
|
|
36
35
|
## 📦 Installation
|
|
37
36
|
|
|
@@ -55,7 +54,7 @@ pnpm add @superfeedback/widget
|
|
|
55
54
|
yarn add @superfeedback/widget
|
|
56
55
|
```
|
|
57
56
|
|
|
58
|
-
|
|
57
|
+
---
|
|
59
58
|
|
|
60
59
|
## 💻 Usage
|
|
61
60
|
|
|
@@ -68,7 +67,7 @@ import { Superfeedback } from "@superfeedback/widget";
|
|
|
68
67
|
import "@superfeedback/widget/style.css";
|
|
69
68
|
|
|
70
69
|
// Initialize with your public API Key
|
|
71
|
-
Superfeedback.init("
|
|
70
|
+
Superfeedback.init({project: "YOUR_PROJECT_ID"});
|
|
72
71
|
```
|
|
73
72
|
|
|
74
73
|
### 2\. CDN (Browser / HTML)
|
|
@@ -77,23 +76,27 @@ If you are not using a build step, you can load the widget directly from `unpkg`
|
|
|
77
76
|
|
|
78
77
|
```html
|
|
79
78
|
<head>
|
|
80
|
-
|
|
79
|
+
<link
|
|
80
|
+
rel="stylesheet"
|
|
81
|
+
href="https://unpkg.com/@superfeedback/widget/style.css"
|
|
82
|
+
/>
|
|
81
83
|
</head>
|
|
82
84
|
<script src="https://unpkg.com/@superfeedback/widget"></script>
|
|
83
85
|
|
|
84
86
|
<script>
|
|
85
|
-
window.Superfeedback.init("
|
|
87
|
+
window.Superfeedback.init({project: "YOUR_PROJECT_ID"});
|
|
86
88
|
</script>
|
|
87
89
|
```
|
|
88
90
|
|
|
89
|
-
|
|
91
|
+
---
|
|
90
92
|
|
|
91
93
|
## 🔌 Supported Integrations
|
|
92
94
|
|
|
93
95
|
The widget automatically routes tickets based on your configuration in the dashboard.
|
|
94
96
|
|
|
95
|
-
| Integration | Type
|
|
96
|
-
|
|
|
97
|
-
| **Jira**
|
|
98
|
-
| **GitHub**
|
|
99
|
-
| **Asana**
|
|
97
|
+
| Integration | Type | Status |
|
|
98
|
+
| :---------- | :----------------- | :----------- |
|
|
99
|
+
| **Jira** | Project Management | ✅ Supported |
|
|
100
|
+
| **GitHub** | Issue Tracking | ✅ Supported |
|
|
101
|
+
| **Asana** | Project Management | ✅ Supported |
|
|
102
|
+
| **Slack** | Chat | ✅ Supported |
|