{"id":17291266,"url":"https://github.com/l-hammer/v-track","last_synced_at":"2025-04-04T17:05:35.416Z","repository":{"id":34518101,"uuid":"179952691","full_name":"l-hammer/v-track","owner":"l-hammer","description":"🕹 A manual tracking decoupling plugin based on Vue directive / 一个基于Vue指令实现的埋点解耦插件~","archived":false,"fork":false,"pushed_at":"2022-12-10T14:50:50.000Z","size":2445,"stargazers_count":344,"open_issues_count":34,"forks_count":63,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-28T16:04:31.558Z","etag":null,"topics":["directive","javascript","plugin","track","vue","vue-components"],"latest_commit_sha":null,"homepage":"https://lhammer.cn/v-track","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/l-hammer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://raw.githubusercontent.com/l-hammer/You-need-to-know-css/master/static/reward-code.png"]}},"created_at":"2019-04-07T10:54:06.000Z","updated_at":"2025-02-11T09:09:01.000Z","dependencies_parsed_at":"2023-01-15T07:45:41.356Z","dependency_job_id":null,"html_url":"https://github.com/l-hammer/v-track","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l-hammer%2Fv-track","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l-hammer%2Fv-track/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l-hammer%2Fv-track/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l-hammer%2Fv-track/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/l-hammer","download_url":"https://codeload.github.com/l-hammer/v-track/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247217174,"owners_count":20903008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["directive","javascript","plugin","track","vue","vue-components"],"created_at":"2024-10-15T10:40:32.681Z","updated_at":"2025-04-04T17:05:35.401Z","avatar_url":"https://github.com/l-hammer.png","language":"JavaScript","funding_links":["https://raw.githubusercontent.com/l-hammer/You-need-to-know-css/master/static/reward-code.png"],"categories":[],"sub_categories":[],"readme":"# v-track\n\n\u003ca href=\"https://travis-ci.org/l-hammer/v-track\"\u003e\u003cimg alt=\"Travis (.org) branch\" src=\"https://img.shields.io/travis/l-hammer/v-track/master.svg?logoColor=%23666666\u0026style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://unpkg.com/v-track/dist/v-track.min.js\"\u003e\u003cimg src=\"https://img.badgesize.io/https://unpkg.com/v-track/dist/v-track.min.js?compression=gzip\u0026style=flat-square\" alt=\"Gzip Size\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/v-track\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/v-track.svg?colorB=brightgreen\u0026style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/l-hammer/v-track/tree/master/tests/unit\"\u003e\u003cimg src=\"https://img.shields.io/badge/tested_with-jest-99424f.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"http://hits.dwyl.io/l-hammer/v-track\" alt=\"hit count\"\u003e\u003cimg src=\"http://hits.dwyl.io/l-hammer/v-track.svg\" /\u003e\u003c/a\u003e\n\u003ca href=\"http://hits.dwyl.io/l-hammer/v-track\" alt=\"downloads\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/v-track.svg?style=flat-square\" /\u003e\u003c/a\u003e\n\nv-track通过 Vue [自定义指令](https://cn.vuejs.org/v2/guide/custom-directive.html)的方式将埋点代码与业务代码完全解耦~\n\n## 安装\n\n### YARN\n\n```shell\n$ yarn add v-track\n```\n\n### NPM\n\n```shell\n$ npm install v-track --save\n```\n\n### CDN\n\n目前可以通过[unpkg.com/v-track](https://unpkg.com/v-track/)获取到最新版本的资源，在页面上使用 script 标签直接引入文件即可开始使用\n\n```html\n\u003cscript src=\"https://unpkg.com/v-track/dist/v-track.min.js\"\u003e\u003c/script\u003e\n```\n\n或者\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/v-track/dist/v-track.min.js\"\u003e\u003c/script\u003e\n```\n\n\u003e 建议使用 CDN 引入 v-track 的用户在链接地址上锁定版本，以免将来 v-track 升级时受到非兼容性更新的影响。锁定版本的方法请查看 [unpkg.com](https://unpkg.com/) or [jsdelivr.com](https://www.jsdelivr.com/)。\n\n## 用法\n\n```js\nimport Vue from \"vue\"\nimport VTrack from \"v-track\"\nimport trackEvents from \"./track-events\"\n\nVue.use(VTrack, {\n  trackEvents, // 埋点事件对象\n  trackEnable: {\n    UVPV: true, // 是否开启UVPV统计，v0.8.3新增routeUpdate，即在当前路由参数发生改变时埋点，默认为false\n    TONP: true // 是否开启页面停留时长统计，默认为false\n  }\n})\n```\n\n```js\n/* track-events.js */\nexport default {\n  /**\n   * @name UVPV 固定名称不支持修改\n   * @desc UV、PV埋点\n   * @param {Object} context 当前上下文\n   */\n  UVPV(context) {\n    ...\n  },\n  /**\n   * @name TONP 固定名称不支持修改\n   * @desc 页面停留时间埋点（Time on Page）\n   * @param {Object} context 当前上下文\n   * @param {Timestamp} et 进入页面时间\n   * @param {Timestamp} dt 离开页面时间\n   */\n  TONP(context, { et, dt }) {\n    ...\n  },\n  /**\n   * @name 18015 埋点唯一标识ID（自定义）\n   * @param {Object} context 当前上下文\n   * @param {Object} args 剩余参数\n   */\n  18015(context, args) {\n    ...\n  }\n  ...\n}\n```\n\n```HTML\n\u003c!-- 页面行为埋点（track-view为v-track全局注册的组件） --\u003e\n\u003ctrack-view v-track:18015\u003e\u003c/track-view\u003e\n\u003ctrack-view v-track:18015.watch=\"{ rest }\"\u003e\u003c/track-view\u003e\n\u003ctrack-view v-track:18015.watch.delay=\"{ rest }\"\u003e\u003c/track-view\u003e\n\u003ctrack-view v-if=\"rest\" v-track:18015\u003e\u003c/track-view\u003e\n\n\u003c!-- 事件行为埋点（DOM） --\u003e\n\u003cdiv v-track:18015.click=\"handleClick\"\u003e\u003c/div\u003e\n\u003cdiv v-track:18015.click=\"{ handleClick, item, index }\"\u003e\u003c/div\u003e\n\u003cdiv v-track:18015.click.async=\"{ handleSearch, rest }\"\u003e\u003c/div\u003e\n\u003cdiv v-track:18015.click.delay=\"handleClick\"\u003e\u003c/div\u003e\n\n\u003c!-- 事件行为埋点（组件） --\u003e\n\u003ccmp v-track:18015.click=\"handleClick\"\u003e\u003c/cmp\u003e\n\u003ccmp v-track:18015.[自定义事件名]=\"handleSearch\"\u003e\u003c/cmp\u003e\n\u003ccmp v-track:18015.[自定义事件名].delay=\"handleSearch\"\u003e\u003c/cmp\u003e\n\u003ccmp v-track:18015.[自定义事件名].async=\"{ handleSearch, rest }\"\u003e\u003c/cmp\u003e\n\n\u003c!-- 区域展现埋点（block 可以是 DOM 或者组件） --\u003e\n\u003cblock v-track:18015.show\u003e\u003c/block\u003e\n\u003cblock v-track:18015.show.once\u003e\u003c/block\u003e\n\u003cblock v-track:18015.show.custom=\"{ ref: 'scroll' }\"\u003e\u003c/block\u003e\n\u003cblock v-track:18015.show.custom.once=\"{ ref: 'scroll' }\"\u003e\u003c/block\u003e\n```\n\n## 指令修饰符\n\n- `.click` 表示事件行为的埋点\n- `.[custom-event]` 表示自定义事件行为的埋点\n- `.native` 表示监听组件原生click事件行为的埋点\n- `.watch` 表示页面异步行为的埋点\n- `.async` 配合`.click`指令，表示异步事件行为的埋点\n- `.delay` 表示埋点是否延迟执行，默认先执行埋点再执行回调\n- `.show` 表示区域曝光埋点\n- `.once` 配合`.show`指令，只执行一次埋点\n- `.custom` 配合`.show`指令，表示使用自定义scroll事件\n\n## LICENSE\n\n[MIT](https://github.com/l-hammer/v-track/blob/master/LICENSE) © 2019-present, LHammer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fl-hammer%2Fv-track","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fl-hammer%2Fv-track","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fl-hammer%2Fv-track/lists"}