@barbapapazes/plausible-tracker

中文文档
0.5.6发布于 2024/11/20MITTypeScriptESM + CJS零依赖近 30 天下载 1.4万

前端跟踪器与 Plausible 分析器交互

中文使用文档
文档目录8 节
  1. 为什么重写?
  2. 使用量
  3. 扩展
  4. 自动页面查看跟踪
  5. 输出链接点击跟踪
  6. 文件下载跟踪
  7. 贡献
  8. 许可证

活性分析跟踪器

npm version npm downloads

重写 可信跟踪器 并铭记可扩展性和未来的特点.

[大 这不是一个临时替代.

为什么重写?

来自柏拉图克球队的原追踪员在两年多的时间里没有收到更新.

从那时起 脚本跟踪器 npm 软件包已经进化,但是没有。 例如,不支持文件倒闭和收入跟踪.

此外,一些严重的问题被打开,没有得到解决。 外出追踪是打破 target="_blank" 例如,属性.

使用量

首先,安装软件包:

npm install @barbapapazes/plausible-tracker

那么,用你的代码:

import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'

const plausible = createPlausibleTracker()

plausible.trackPageview() // Track a page view
plausible.trackEvent('signup') // Track a custom event

[注] 这个 trackPageview 是一个包裹周围 trackEvent 与 pageview 事件名称.

第一项论据是: trackPageview 和第二个 trackEvent 是一个接受道具、数据和在事件发送后触发的回调对象.

道具与提供 正式可打印脚本。 。 。 .

数据允许您覆盖一些值,如 url, (中文(简体) ), referrer 财务报告和审定财务报表 deviceWidth。 。 。 .

plausible.trackEvent('signup', { props: { variation: 'button A' }, callback: () => console.log('sended') }) // Track a custom event with a custom prop with a callback

此核心跟踪器是最小的, 不包括任何扩展 。 这样你就可以轻松地编出它来避免运送你不需要的代码.

扩展

扩展是核心跟踪器中没有包含的特性.

[注] 扩展会有助于将软件包与正式脚本保持最新.

当前扩展 :

自动页面查看跟踪

import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoPageviews } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useAutoPageviews(plausible)

install()

// At any time, you can stop the auto pageview tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })
// Now, every page view will include the prop `variation: 'button A'`
import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoOutboundTracking } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useOutboundLinkTracking(plausible)

install()

// At any time, you can stop the outbound link tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })

文件下载跟踪

import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoFileDownloadsTracking } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: [] }) // You can pass the file types to track. For example: ['pdf', 'zip']

install()

// At any time, you can stop the file downloads tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })

[大 默认情况下,文件下载不会跟踪任何文件类型. 您需要通过文件类型来跟踪 .

软件包导出 defaultFileTypes 是最常用文件类型的数组 和正式剧本一样。 。 。 .

import { defaultFileTypes } from '@barbapapazes/plausible-tracker/extensions'

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: defaultFileTypes })

这使得您可以轻松自定义文件类型以跟踪 :

import { defaultFileTypes } from '@barbapapazes/plausible-tracker/extensions'

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: [...defaultFileTypes, 'svg'] })

贡献

捐款非常受欢迎。 我不是柏拉图球队的一员, 我在空闲时间这样做

  • 叉子存储器
  • 安装依赖性 : pnpm install
  • 构建工程 : pnpm build
  • 使用游乐场测试您的更改 : cd playground && pnpm dev

谢谢你的帮助!

许可证

麻省理工学院 © 巴巴多斯

此套件并不附属于"活泼分析",而是被他们的作品所启发. 可信跟踪器 活性分析跟踪器

版本与发布记录

@barbapapazes/plausible-tracker 共发布 16 个版本,首次发布于 2024/02/01;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.5.6latest2024/11/202 年前
0.5.52024/11/202 年前
0.5.42024/11/202 年前
0.5.32024/10/032 年前
0.5.22024/07/182 年前
0.5.12024/07/182 年前

关于 @barbapapazes/plausible-tracker 的常见问题

@barbapapazes/plausible-tracker 是什么?

前端跟踪器与 Plausible 分析器交互

如何安装 @barbapapazes/plausible-tracker?

在项目目录运行 npm install @barbapapazes/plausible-tracker,或使用 pnpm add / yarn add / bun add。

@barbapapazes/plausible-tracker 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@barbapapazes/plausible-tracker 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@barbapapazes/plausible-tracker 可以商用吗?

@barbapapazes/plausible-tracker 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@barbapapazes/plausible-tracker 的下载量有多少?

根据 npm 官方下载统计,@barbapapazes/plausible-tracker 在 2026/10/08 – 2026/11/06 这 30 天内被下载 13,855 次,日均约 462 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@barbapapazes/plausible-tracker 还在维护吗?

最新版本 0.5.6 发布于 2024/11/20(2 年前);至今共发布 16 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/02/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。