stone-analytics 0.0.9 → 0.0.11
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 +41 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Пакет с функцией отправки аналитики stone
|
|
2
|
+
|
|
3
|
+
Npm-пакет для отправки аналитики по api/send-event
|
|
4
|
+
|
|
5
|
+
## Установка
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i stone-analytics@latest
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Пример использования
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
import { useEffect } from 'react'
|
|
15
|
+
import { sendAnalytics } from 'stone-analytics'
|
|
16
|
+
|
|
17
|
+
export const AllProviders = () => {
|
|
18
|
+
useEffect(() => {
|
|
19
|
+
sendAnalytics({
|
|
20
|
+
event: 'page_view',
|
|
21
|
+
name: 'Переход на страницу',
|
|
22
|
+
})
|
|
23
|
+
}, [])
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
#### Параметры
|
|
28
|
+
|
|
29
|
+
| Поле | Тип | Описание |
|
|
30
|
+
| -------- | ------------------------ | ----------------------------------------------------- |
|
|
31
|
+
| `event` | `string` | Название события (например, `"click"`, `"page_view"`) |
|
|
32
|
+
| `name` | `string` | Уникальное имя события |
|
|
33
|
+
| `params` | `TAnalyticsVisitParams?` | Дополнительные параметры события (необязательно) |
|
|
34
|
+
|
|
35
|
+
##### Локальная разработка
|
|
36
|
+
|
|
37
|
+
Для того , чтобы локально ничего не отправлялось добавить в env.local
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
process.env.NEXT_PUBLIC_IS_TEST === 'true'
|
|
41
|
+
```
|