Skip to content

Commit 282ce81

Browse files
author
宋慧武
committed
📝update started docs
1 parent 7e1b73f commit 282ce81

7 files changed

+61
-46
lines changed

‎docs/dist/js/app.23cb6a6d.js

-2
This file was deleted.

‎docs/dist/js/app.23cb6a6d.js.map

-1
This file was deleted.

‎docs/dist/js/app.2e4508ff.js

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/dist/js/app.2e4508ff.js.map

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=dist/favicon.ico><link href=//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/nord.min.css rel=stylesheet><title>v-track</title><link href=dist/css/app.1efa72a7.css rel=preload as=style><link href=dist/css/chunk-vendors.7ed2d91f.css rel=preload as=style><link href=dist/js/app.23cb6a6d.js rel=preload as=script><link href=dist/js/chunk-vendors.8d6844e1.js rel=preload as=script><link href=dist/css/chunk-vendors.7ed2d91f.css rel=stylesheet><link href=dist/css/app.1efa72a7.css rel=stylesheet></head><body><noscript><strong>We're sorry but v-track doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=dist/js/chunk-vendors.8d6844e1.js></script><script src=dist/js/app.23cb6a6d.js></script></body></html>
1+
<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=dist/favicon.ico><link href=//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/nord.min.css rel=stylesheet><title>v-track</title><link href=dist/css/app.1efa72a7.css rel=preload as=style><link href=dist/css/chunk-vendors.7ed2d91f.css rel=preload as=style><link href=dist/js/app.2e4508ff.js rel=preload as=script><link href=dist/js/chunk-vendors.8d6844e1.js rel=preload as=script><link href=dist/css/chunk-vendors.7ed2d91f.css rel=stylesheet><link href=dist/css/app.1efa72a7.css rel=stylesheet></head><body><noscript><strong>We're sorry but v-track doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=dist/js/chunk-vendors.8d6844e1.js></script><script src=dist/js/app.2e4508ff.js></script></body></html>

‎docs/pages/started.vue

+42-31
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@
3030
</section>
3131

3232
<section class="snippets">
33-
<CodeSnippet class="snippet" :code="eventsSnippet" lang="js" />
33+
<CodeSnippet class="snippet" :code="installSnippet" lang="shell" />
3434
<div class="plus">+</div>
3535
<CodeSnippet class="snippet" :code="mainSnippet" lang="js" />
3636
<div class="plus">+</div>
37+
<CodeSnippet class="snippet" :code="eventsSnippet" lang="js" />
38+
<div class="plus">+</div>
3739
<CodeSnippet class="snippet" :code="componentSnippet" lang="html" />
3840
</section>
3941
</div>
@@ -42,8 +44,28 @@
4244
<script>
4345
import CodeSnippet from "../components/code-snippet";
4446
47+
const installSnippet = `
48+
# YARN
49+
$ yarn add v-track
50+
51+
# NPM
52+
$ npm install v-track --save
53+
`;
54+
const mainSnippet = `
55+
import Vue from "vue";
56+
import VTrack from "v-track";
57+
import trackEvents from "./track-events";
58+
59+
Vue.use(VTrack, {
60+
trackEvents, // 埋点事件对象
61+
trackEnable: {
62+
UVPV: false, // 是否开启UVPV统计，默认为false
63+
TONP: true // 是否开启页面停留时长统计，默认为false
64+
}
65+
})
66+
`;
4567
const eventsSnippet = `
46-
import trackAction from "./action";
68+
import trackAction from "./action"; // 自定义埋点上报的方法
4769
4870
export default {
4971
/**
@@ -56,46 +78,34 @@ export default {
5678
/**
5779
* @name TONP 固定名称不支持修改
5880
* @desc 页面停留时间埋点（Time on Page）
59-
* @param {String} stt 进入页面时长，单位为秒
81+
* @param {Timestamp} et 进入页面时间
82+
* @param {Timestamp} dt 离开页面时间
6083
*/
61-
TONP({ stt }) {
62-
trackAction("2", { stt });
84+
TONP({ et, dt }) {
85+
trackAction("2", {
86+
stt: dt - et
87+
});
6388
},
6489
/**
65-
* @desc 测试埋点
66-
* @param {*} { $route: { name } }
67-
* @param {*} { item: { id, level4Tag }, index }
90+
* @param {Object} context 当前上下文
91+
* @param {Object} item 事件参数
92+
* @param {Object} event 事件对象
6893
*/
69-
19058(
94+
18015(
7095
{
7196
$route: { name }
7297
},
73-
{
74-
item: { id },
75-
index
76-
}
98+
{ id },
99+
{ target }
77100
) {
78-
trackAction("19058", {
79-
knowledge_id: id, // 知识ID
80-
click_position: index + 1, // 点击位置
81-
source_page: name // 页面来源
101+
trackAction("18015", {
102+
id,
103+
source_page: name,
104+
target
82105
});
83-
}
106+
},
84107
};
85108
`;
86-
const mainSnippet = `
87-
import Vue from "vue";
88-
import VTrack from "v-track";
89-
import trackEvents from "./tracks";
90-
91-
Vue.use(VTrack, {
92-
trackEvents, // 埋点事件对象
93-
trackEnable: {
94-
UVPV: false, // 是否开启UVPV统计，默认为false
95-
TONP: true // 是否开启页面停留时长统计，默认为false
96-
}
97-
})
98-
`;
99109
const componentSnippet = `
100110
<!-- 页面行为埋点（track-view为v-track全局注册的组件） -->
101111
<track-view v-track:18015></track-view>
@@ -129,6 +139,7 @@ export default {
129139
},
130140
data() {
131141
return {
142+
installSnippet,
132143
mainSnippet,
133144
eventsSnippet,
134145
componentSnippet

‎docs/tracks/events.js

+15-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @Author: 宋慧武
33
* @Date: 2019-04-14 17:10:31
44
* @Last Modified by: 宋慧武
5-
* @Last Modified time: 2019-04-17 22:26:42
5+
* @Last Modified time: 2019-04-27 23:13:43
66
*/
77
import trackAction from "./action";
88

@@ -17,32 +17,36 @@ export default {
1717
/**
1818
* @name TONP 固定名称不支持修改
1919
* @desc 页面停留时间埋点（Time on Page）
20-
* @param {String} stt 进入页面时长，单位为秒
20+
* @param {Timestamp} et 进入页面时间
21+
* @param {Timestamp} dt 离开页面时间
2122
*/
22-
TONP({ stt }) {
23-
trackAction("2", { stt });
23+
TONP({ et, dt }) {
24+
trackAction("2", {
25+
stt: `${(dt - et) / 1e3}s`
26+
});
2427
},
2528
/**
2629
* @desc 测试埋点
27-
* @param {*} { $route: { name } }
28-
* @param {*} { item: { id, level4Tag }, index }
2930
*/
3031
18015({ $route: { name } }) {
3132
trackAction("18015", {
3233
source_page: name // 页面来源
3334
});
3435
},
36+
/**
37+
* @param {Object} context 当前上下文
38+
* @param {Object} item 事件参数
39+
* @param {Object} event 事件对象
40+
*/
3541
18016(
3642
{
3743
$route: { name }
3844
},
39-
{
40-
item: { id }
41-
},
45+
{ id },
4246
{ target }
4347
) {
4448
trackAction("18016", {
45-
id, // 知识ID
49+
id,
4650
source_page: name,
4751
target
4852
});
@@ -67,7 +71,7 @@ export default {
6771
{ target }
6872
) {
6973
trackAction("18019", {
70-
id, // 知识ID
74+
id,
7175
source_page: name,
7276
target
7377
});

0 commit comments

Comments
 (0)