From 2c5e0d6a43785409f30eeb5ae793cec0883f6554 Mon Sep 17 00:00:00 2001
From: minlingchao <738509878@qq.com>
Date: Thu, 13 Jul 2017 23:52:49 +0800
Subject: [PATCH] change readme
---
README.md | 35 ++++++++++++++++++++++++-----------
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index a78736c..934d0c5 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,12 @@
----
-title: VueJs百度统计插件
-date: 2017-07-13 23:10:31
-tags:
- - vue
- - 百度统计
-
----
-
# vue-ba
> vuejs 百度统计埋点插件
>
-> 参考项目:https://github.com/raychenfj/vue-uweb
+> 项目参考:https://github.com/raychenfj/vue-uweb
+
+## 项目地址
+
+https://github.com/minlingchao1/vue-ba
## 1. 安装
@@ -43,36 +38,53 @@ Vue.use(uweb,options)
```
#### options
+
参数 | 必须 | 默认 | 说明 | 备注 |
siteId | 是 | | 绑定要接受API请求的统计代码 | |
debug | 否 | false | 调试模式下将在控制台中输出调用window._hmt时传递的参数 | 请不要在生产环境中使用,避免造成安全隐患 |
src | 否 | https://hm.baidu.com/hm.js?SITEID | 指定统计脚本标签的 src 属性 | |
+
## 2. ba API
### 2.1 trackEvent
+
用于发送页面上按钮等交互元素被触发时的事件统计请求。
+
#### 用法
+
```
this.$ba.trackEvent(category,action,opt_label,opt_value)
```
+
#### 参数
+
参数 | 必须 | 类型 | 说明 |
category | 是 | string | 表示事件发生在谁身上 |
action | 是 | string | 表示访客跟元素交互的行为动作 |
opt_label | 否 | string | 用于更详细的描述事件 |
opt_value | 否 | int | 用于填写打分型事件的分值,加载时间型事件的时长,如果填写为其他形式,系统将按0处理。若填写为浮点小数,系统会自动取整,去掉小数点。 |
+
### 2.2 trackPageview
+
用于发送某个URL的PV统计请求,适用于统计AJAX、异步加载页面,友情链接,下载链接的流量
+
#### 用法
+
```
this.$ba.trackPageview(pageURL)
```
+
#### 参数
+
参数 | 必须 | 类型 | 说明 |
pageURL | 是 | string | 自定义虚拟PV页面的URL地址,填写以斜杠‘/’开头的相对路径,系统会自动补全域名 |
+
## 3. ba 指令
+
vue-ba 提供 track-event,track-pageview 两个指令,开发者可以直接在 html 模版中使用来统计网站数据
### 3.1 track-event
+
使用指令 v-track-event 监听事件, 通过 modifiers 指定事件类型,将自动为绑定元素添加事件监听,当事件触发调用统计代码。 如不指定事件,默认监听 click 事件。
可通过逗号分隔的字符串或对象字面量传递参数,以字符串传递时请注意参数顺序,可参考trackEvent API。
#### 用法
+
```
// 统计click事件
@@ -86,6 +98,7 @@ vue-ba 提供 track-event,track-pageview 两个指令,开发者可以直接
```
### 3.2 track-pageview
+
使用指令 track-pageview 统计虚拟 PV ,一般可以配合 v-show 或 v-if 来统计局部动态视图的 PV。
可通过逗号分隔的字符串或对象字面量传递参数,以字符串传递时请注意参数顺序,可参考trackPageview API
@@ -99,4 +112,4 @@ vue-ba 提供 track-event,track-pageview 两个指令,开发者可以直接
// 以字符串指定受访页面和来源
// 以对象字面量指定受访页面和来源
-```
+```
\ No newline at end of file