Skip to content

Commit

Permalink
Merge pull request #1 from avito-tech/add-generate-script
Browse files Browse the repository at this point in the history
Добавлена возможность генерации минифицированного скрипта
  • Loading branch information
vinokurov-and authored Mar 13, 2024
2 parents 0ef4bc2 + 12597ec commit 7a0fdd8
Show file tree
Hide file tree
Showing 8 changed files with 798 additions and 32 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ lerna-debug.log*

node_modules
dist
dist-script
dist-ssr
coverage
*.local
Expand Down
12 changes: 10 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

```@avito/pixel-web-client``` - это клиент для AvitoPixel, используемый для отслеживания событий в приложении, веб-сайте. Он предоставляет методы для инициализации и отправки событий.


# Начало работы

## Установка
Expand All @@ -12,6 +11,15 @@ npm i @avito/pixel-web-client
```

## Использование
### Пример
Вставьте код в файл, который отвечает за генерацию заголовка всех страниц сайта. Если все страницы вашего сайта — отдельные файлы, написанные вручную, добавьте код счетчика в HTML-код всех страниц сайта.
```html
<script src="https://www.avito.st/s/pixel/script.js" data-host="<url host>" data-paths-hit="<url method hit>" data-platform="<you platform>"></script>
```
- Атрибут data-host указывает на URL сервера AvitoPixel (опционально);
- Атрибут data-paths-hit указывается на путь к методу hit;
- Атрибут data-platform указывает на платформу вашего приложения (по умолчанию установлен "web").

### Пример с React

В главном компоненте, например в App.tsx, импортируйте пакет @avito/pixel-web-client:
Expand Down Expand Up @@ -42,7 +50,7 @@ React.useEffect(() => {
Используйте тот же самый подход, что и в предыдущем примере. Анализируйте логику работы вашего сайта и вызывайте функцию hit, когда необходимо отслеживать события, например, при переходе на другую страницу.

```react
instance.hit({type: 'location_changed'});
instance.hit.request({type: 'location_changed'});
```

## License
Expand Down
10 changes: 5 additions & 5 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
presets: [
['@babel/preset-env', {targets: {node: 'current'}}],
'@babel/preset-typescript',
],
};
presets: [
['@babel/preset-env', { targets: { node: 'current' }, include: ['@babel/plugin-transform-classes'] }],
'@babel/preset-typescript',
],
};
Loading

0 comments on commit 7a0fdd8

Please sign in to comment.