Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hcodes/lyam
Лёгкая Я.Метрика
https://github.com/hcodes/lyam
lightweight metrika typescript yandex yandex-metrika
Last synced: 4 days ago
JSON representation
Лёгкая Я.Метрика
- Host: GitHub
- URL: https://github.com/hcodes/lyam
- Owner: hcodes
- License: mit
- Created: 2019-09-02T05:32:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T13:40:13.000Z (about 1 month ago)
- Last Synced: 2024-12-06T00:02:12.529Z (17 days ago)
- Topics: lightweight, metrika, typescript, yandex, yandex-metrika
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/lyam
- Size: 536 KB
- Stars: 28
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Лёгкая Я.Метрика
[](https://www.npmjs.com/package/lyam)
[](https://www.npmjs.org/package/lyam)
[](https://packagephobia.com/result?p=lyam)
## Мотивация
[Скрипт Метрики](https://mc.yandex.ru/metrika/tag.js) занимает более 350 КБ (90 КБ в GZIP), для лёгких страниц и небольших пакетов он громоздкий.
## Преимущества
- [Сверхмалый размер кода](https://bundlephobia.com/result?p=lyam).
- Код подключается в основной бандл проекта, нет дополнительного запроса на загрузку скрипта и парсинга кода Метрики.
- Использование в serviceWorker’е, электрон-приложениях и т.д.
## Использование
```js
import { hit } from 'lyam';
const counterId = '12345';
// Если не указаны параметры, то адрес страницы берётся из location.href,
// заголовок страницы из document.title и
// реферер из document.referrer.
hit(counterId);
```
Со всеми параметрами:
```js
import { hit } from 'lyam';
const counterId = '12345';
const userVars = { myParam: 123 };
hit(counterId, {
referrer: 'https://anothersite.ru',
title: 'My document title',
url: 'https://mysite.ru'
}, userVars);
```
### Отправка цели
```js
import { hit, reachGoal } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
reachGoal(counterId, 'MY_GOAL_NAME');
```
### Отправка цели с параметрами визита
```js
import { hit, reachGoal } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
const userVars = { myParam: 123 };
reachGoal(counterId, 'MY_GOAL_NAME', userVars);
```
### Внешняя ссылка
```js
import { hit, extLink } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
extLink(counterId, 'https://externalsite.ru');
```
### Загрузка файла
```js
import { hit, file } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
file(counterId, 'https://mysite.ru/file.zip');
```
### Не отказ
```js
import { hit, notBounce } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
setTimeout(() => {
notBounce(counterId);
}, 15000); // 15 сек.
```
### Параметры визита
```js
import { hit, params } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
params(counterId, { myParam: 123 });
```
### Пользовательские параметры
```js
import { hit, userParams } from 'lyam';
const counterId = '12345';
hit(counterId);
// ...
userParams(counterId, { myParam: 1, UserID: 12345 });
```
## CSP
```
Content-Security-Policy:
...
img-src https://mc.yandex.ru;
connect-src https://mc.yandex.ru;
...
```
## [Лицензия](./LICENSE)
MIT
## Ссылки
- [React/Preact-компонент для Яндекс Метрики](https://github.com/hcodes/react-metrika)