@picked/hotjar 0.0.101-next.2 → 0.0.101-next.3
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 +38 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @picked/hotjar
|
|
2
|
+
|
|
3
|
+
Sends the events of the Picked client to Hotjar, and identifies the Hotjar user by the Picked
|
|
4
|
+
session ID.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install picked @picked/hotjar
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { createClient } from 'picked'
|
|
16
|
+
import { hotjarPlugin } from '@picked/hotjar'
|
|
17
|
+
|
|
18
|
+
export const picked = createClient({
|
|
19
|
+
projectId: 'your-project-id',
|
|
20
|
+
plugins: [hotjarPlugin({ siteId: 1234567 })],
|
|
21
|
+
})
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
| Option | Default | Description |
|
|
25
|
+
| --------------------- | ----------------------------------------------------- | ----------------------------------------------------------------- |
|
|
26
|
+
| `siteId` | required | Your Hotjar site ID. |
|
|
27
|
+
| `trackedEvents` | step, field-validation, experience and session events | The client events sent to Hotjar. |
|
|
28
|
+
| `getUserAttributes` | none | Extra attributes for the Hotjar user. |
|
|
29
|
+
| `autoStartRecording` | `true` | Sends `recordingStartEvent` on the first `experience_initialize`. |
|
|
30
|
+
| `recordingStartEvent` | `'hotjar_start'` | The Hotjar event that starts a recording. |
|
|
31
|
+
| `snippetVersion` | `6` | The Hotjar script version. |
|
|
32
|
+
|
|
33
|
+
## Docs
|
|
34
|
+
|
|
35
|
+
- **Web:** [Hotjar](https://docs.picked.app/reference/sdk/plugins/hotjar)
|
|
36
|
+
- **Local:** `node_modules/picked/docs/reference/sdk/plugins/hotjar.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
|
|
37
|
+
- **CLI:** `npx picked docs read /reference/sdk/plugins/hotjar`. `npx picked docs list [words]` lists the pages.
|
|
38
|
+
- **MCP:** call `read_picked_doc` with `{ "path": "/reference/sdk/plugins/hotjar" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@picked/hotjar",
|
|
3
3
|
"description": "Picked Hotjar Plugin",
|
|
4
|
-
"version": "0.0.101-next.
|
|
4
|
+
"version": "0.0.101-next.3",
|
|
5
5
|
"dependencies": {
|
|
6
6
|
"@hotjar/browser": "^1.0.9"
|
|
7
7
|
},
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"main": "./dist/cjs/index.js",
|
|
55
55
|
"module": "./dist/esm/index.js",
|
|
56
56
|
"peerDependencies": {
|
|
57
|
-
"@picked/client": "0.0.101-next.
|
|
57
|
+
"@picked/client": "0.0.101-next.3",
|
|
58
58
|
"effector": "^23.4.4"
|
|
59
59
|
},
|
|
60
60
|
"private": false,
|