fdbck-react 0.2.0 → 0.2.1
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 +21 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# fdbck-react
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/fdbck-react)
|
|
4
|
+
[](https://www.npmjs.com/package/fdbck-react)
|
|
5
|
+
|
|
6
|
+
Official React SDK for [fdbck](https://fdbck.sh) - embed feedback questions natively in your React app with Shadow DOM CSS isolation.
|
|
4
7
|
|
|
5
8
|
## Install
|
|
6
9
|
|
|
@@ -8,13 +11,21 @@ Official React SDK for [fdbck](https://fdbck.sh) — embed feedback questions na
|
|
|
8
11
|
npm install fdbck-react
|
|
9
12
|
```
|
|
10
13
|
|
|
14
|
+
```bash
|
|
15
|
+
yarn add fdbck-react
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pnpm add fdbck-react
|
|
20
|
+
```
|
|
21
|
+
|
|
11
22
|
Requires React 18+.
|
|
12
23
|
|
|
13
24
|
## Quick start
|
|
14
25
|
|
|
15
26
|
### 1. Direct token (simplest)
|
|
16
27
|
|
|
17
|
-
Generate a response token on your backend (via the
|
|
28
|
+
Generate a response token on your backend (via the REST API, node.js or python SDK), then pass it to the widget:
|
|
18
29
|
|
|
19
30
|
```tsx
|
|
20
31
|
import { FdbckWidget } from 'fdbck-react';
|
|
@@ -32,7 +43,7 @@ function App() {
|
|
|
32
43
|
|
|
33
44
|
### 2. Imperative API (provider pattern)
|
|
34
45
|
|
|
35
|
-
For showing feedback modals/popovers imperatively:
|
|
46
|
+
For showing feedback modals / popovers imperatively:
|
|
36
47
|
|
|
37
48
|
```tsx
|
|
38
49
|
import { FdbckProvider, useFdbck } from 'fdbck-react';
|
|
@@ -140,6 +151,13 @@ The widget uses `useEffect` for all DOM operations (Shadow DOM, fetch). It rende
|
|
|
140
151
|
|
|
141
152
|
~7KB gzipped (including all CSS).
|
|
142
153
|
|
|
154
|
+
## Links
|
|
155
|
+
|
|
156
|
+
- [npm](https://www.npmjs.com/package/fdbck-react)
|
|
157
|
+
- [Documentation](https://docs.fdbck.sh/sdks/react)
|
|
158
|
+
- [GitHub](https://github.com/fdbck-sh/fdbck-react)
|
|
159
|
+
- [fdbck](https://fdbck.sh)
|
|
160
|
+
|
|
143
161
|
## License
|
|
144
162
|
|
|
145
163
|
MIT
|