# @datapunt/matomo-tracker-react 中文文档
规范地址：https://npmcn.com/package/%40datapunt/matomo-tracker-react/
版本：0\.5\.1
npm 元数据更新时间：2022-04-05T03:02:01.965Z
中文译文更新时间：2026-11-11T15:04:09.683Z
软件包许可：MPL-2\.0
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40datapunt/matomo-tracker-react
原文对照：https://npmcn.com/package/%40datapunt/matomo-tracker-react/?lang=original
项目主页：https://github.com/Amsterdam/matomo-tracker#readme
源码仓库：https://github.com/Amsterdam/matomo-tracker
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：51.2 kB，59 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：react \>= 16\.8\.0
- 首次发布：2019-08-22T08:21:16.060Z
- 最新版本发布：2021-08-11T07:56:06.110Z
- 近 30 天下载量：63289（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）
## 中文简介
反应项目的 Matomo 跟踪器
## 安装
```sh
npm install @datapunt/matomo-tracker-react
```
也可以使用：`pnpm add @datapunt/matomo-tracker-react`、`yarn add @datapunt/matomo-tracker-react`、`bun add @datapunt/matomo-tracker-react`
## README
# Matomo 跟踪器( 反应)
在 React 工程中使用 Matamo 跟踪的独立库
## 安装
```sh
npm install @datapunt/matomo-tracker-react
```
## 使用量
在使用Matomo Tracker之前,您需要用您的项目细节创建 Matomo 实例,并将您的应用程序包入 `MatomoProvider` 这个包裹暴露.
```tsx
import { MatomoProvider, createInstance } from '@datapunt/matomo-tracker-react'
const instance = createInstance({
urlBase: 'https://LINK.TO.DOMAIN',
siteId: 3,
userId: 'UID76903202', // optional, default value: `undefined`.
trackerUrl: 'https://LINK.TO.DOMAIN/tracking.php', // optional, default value: `${urlBase}matomo.php`
srcUrl: 'https://LINK.TO.DOMAIN/tracking.js', // optional, default value: `${urlBase}matomo.js`
disabled: false, // optional, false by default. Makes all tracking calls no-ops if set to true.
heartBeat: { // optional, enabled by default
active: true, // optional, default value: true
seconds: 10 // optional, default value: `15
},
linkTracking: false, // optional, default value: true
configurations: { // optional, default value: {}
// any valid matomo configuration, all below are optional
disableCookies: true,
setSecureCookie: true,
setRequestMethod: 'POST'
}
})
ReactDOM.render(
,
)
```
将您的申请与 `MatomoProvider` 您可以使用 `useMatomo` matomo Provider 组件树内任何地方跟踪您的应用程序的钩子 :
```tsx
import React from 'react'
import { useMatomo } from '@datapunt/matomo-tracker-react'
const MyPage = () => {
const { trackPageView, trackEvent } = useMatomo()
// Track page view
React.useEffect(() => {
trackPageView()
}, [])
const handleOnClick = () => {
// Track click on button
trackEvent({ category: 'sample-page', action: 'click-event' })
}
return (
)
}
```
## 高级用途
默认情况下, Matomo Tracker 会发送窗口的文档标题和位置, 或者发送自己的值 。 还有.., [自定义维度](https://matomo.org/docs/custom-dimensions/) 可用于:
```tsx
import React from 'react'
import { useMatomo } from '@datapunt/matomo-tracker-react'
const MyPage = () => {
const { trackPageView, trackEvent } = useMatomo()
// Track page view
React.useEffect(() => {
trackPageView({
documentTitle: 'Page title', // optional
href: 'https://LINK.TO.PAGE', // optional
customDimensions: [
{
id: 1,
value: 'loggedIn',
},
], // optional
})
}, [])
const handleOnClick = () => {
// Track click on button
trackEvent({ category: 'sample-page', action: 'click-event' })
}
return (
)
}
```
你也可以为 `trackEvent` 方法 :
```tsx
import React from 'react'
import { useMatomo } from '@datapunt/matomo-tracker-react'
const MyPage = () => {
const { trackEvent } = useMatomo()
const handleOnClick = () => {
// Track click on button
trackEvent({
category: 'sample-page',
action: 'click-event',
name: 'test', // optional
value: 123, // optional, numerical value
documentTitle: 'Page title', // optional
href: 'https://LINK.TO.PAGE', // optional
customDimensions: [
{
id: 1,
value: 'loggedIn',
},
], // optional
})
}
return (
)
}
```
这个 `useMatomo` 钩子还暴露出以下方法:
- `trackEvents()`
- `trackSiteSearch()`
- `trackLink()`
- `pushInstruction()`
例如 `pushInstruction()` 函数可以用来将指令推给Matomo执行. 这个 等于将条目推入 `_paq` 阵列.
```javascript
const { pushInstruction } = useMatomo();
pushInstruction('setUserId', 'USER_ID_HERE');
```
## SPA 链接跟踪
Matomo提供了追踪出行链接的选项,然而,这种执行对于SPA(单一页面应用程序)来说是片面的 **无** SSR (Server side rendering) 跨不同版本的马多摩. 因此,你可以使用 `enableLinkTracking` 在锁定元素上点击。 这种方法应放在您 `MatomoProvider` 每个页面视图都显示的组件 另外,确保使 `linkTracking` 选项:
```tsx
import { MatomoProvider, createInstance, useMatomo } from '@datapunt/matomo-tracker-react'
const instance = createInstance({
urlBase: "https://LINK.TO.DOMAIN",
linkTracking: false // Important!
});
ReactDOM.render(
)
const MyApp = () => {
const { enableLinkTracking } = useMatomo()
enableLinkTracking()
return (
// Render components
)
}
```
## 参考资料
- [Matomo JavaScript 跟踪指南](https://developer.matomo.org/guides/tracking-javascript-guide)
## 常见问题
### @datapunt/matomo-tracker-react 是什么？
反应项目的 Matomo 跟踪器
### 如何安装 @datapunt/matomo-tracker-react？
在项目目录运行 npm install @datapunt/matomo-tracker-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>= 16\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @datapunt/matomo-tracker-react 支持 TypeScript 吗？
该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/datapunt\_\_matomo-tracker-react 是否存在。
### @datapunt/matomo-tracker-react 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @datapunt/matomo-tracker-react 可以商用吗？
@datapunt/matomo-tracker-react 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。
### @datapunt/matomo-tracker-react 的下载量有多少？
根据 npm 官方下载统计，@datapunt/matomo-tracker-react 在 2026/10/12 – 2026/11/10 这 30 天内被下载 63,289 次，日均约 2,110 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @datapunt/matomo-tracker-react 还在维护吗？
最新版本 0\.5\.1 发布于 2021/08/11（5 年前）；至今共发布 22 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/08/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。