npm 包 ek-track 使用教程

阅读时长 5 分钟读完

本文介绍了 npm 包 ek-track 的使用方法,包括安装、初始化、配置、使用等方面。

什么是 ek-track

ek-track 是一款轻量级前端埋点工具,通过对网页进行代码注入,自动采集用户行为数据,用于分析用户行为和优化产品体验。ek-track 支持单页面应用和多页面应用,支持自定义事件和属性,可导出数据并交付给数据分析团队。

安装与初始化

  1. 安装

  2. 初始化

    如果采用 CDN 引入,也可直接在 HTML 文件中初始化:

    -- -------------------- ---- -------
    ------- ---------------------------------------------------------------
    --------
        --------------
            ---- -------------
            ---------- --------------------------
            ------- ---------
            ---------- ------
        ---
    ---------

配置与使用

  1. 配置

    ek-track 支持多种配置项,包括:

    • env:环境类型,可选值为 "dev"、"test"、"production",默认为 "production"。
    • serverUrl:数据上报服务器地址。
    • userId:用户 ID,用于标识用户身份。
    • projectId:项目 ID,用于标识产品。
    • whiteList:事件名称白名单,不在白名单中的事件将被忽略。
    • blackList:事件名称黑名单,黑名单中的事件将被忽略。
    • autoReport:是否自动上报数据,可选值为 true 或者 false, 默认为 true。
    • autoTrack:是否自动埋点,可选值为 true 或者 false,默认为 true。
    • enableSPA:是否启用单页面应用模式,可选值为 true 或者 false,默认为 false。

    例如:

    -- -------------------- ---- -------
    --------------
        ---- -------------
        ---------- --------------------------
        ------- ---------
        ---------- -------
        ---------- --------- ----------
        ----------- -----
        ---------- -----
        ---------- -----
    ---
  2. 使用

    ek-track 支持多种事件类型,包括:

    • click:鼠标点击事件。
    • change:表单元素内容改变事件。
    • input:表单元素输入事件。
    • submit:表单提交事件。
    • load:页面加载事件。
    • scroll:页面滚动事件。
    • error:页面错误事件。

    例如:

    -- -------------------- ---- -------
    -- -------
    ------------------- ---------- ------ ---
    
    -- ----------
    -------------------
        ---------- --------
        ------------- -------- ------- -
            -- ---
        -
    ---
    
    -- ------
    ----------------
        ---------- --------
        ------------ ---------
        ---------- -----------
        ---------- - ---- ------- -
    ---
  3. 示例代码

    HTML:

    JavaScript:

    -- -------------------- ---- -------
    -- -- --------
    ------ ------- ---- -----------
    
    -- ---
    --------------
        ---- -------------
        ---------- --------------------------
        ------- ---------
        ---------- ------
    ---
    
    -- --
    --------------------
    
    -- ----
    ----- --- - -------------------------------
    ----------------------------- -- -- -
        -- ----
        ----------------
            ---------- --------
            ------------ ---------
            ---------- -----------
            ---------- - ---- ------- -
        ---
    ---

总结

ek-track 是一款简单易用的前端埋点工具,通过对网页进行代码注入,自动采集用户行为数据,用于分析用户行为和优化产品体验。ek-track 支持多种配置项和事件类型,可满足不同场景下的需求。使用该工具,可以大大提高数据分析效率和产品优化效果,推动业务发展。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671a530d09270238224a1

纠错
反馈