@cavegiant/insight-reporter

Cave Insight 官方 React SDK — 用户行为数据采集与上报。

专有软件 — © CAVEGIANT TECHNOLOGY LIMITED。完整接入文档与 appKey 申请请联系 [email protected]。

安装

npm install @cavegiant/insight-reporter
# 或
pnpm add @cavegiant/insight-reporter

Peer dependency：react >= 18.0.0

快速开始

import { init, InsightProvider, track } from '@cavegiant/insight-reporter';

init({
  appId: 'your-app-id',
  appKey: 'your-app-key',
  appVersion: '1.0.0',
  env: 'prod',
});

function App() {
  return (
    <InsightProvider>
      {/* your app */}
    </InsightProvider>
  );
}

track('module.click', { button_id: 'submit' });

完整接入说明（初始化、路由模式、identify、离线队列等）请联系 Cave Insight 团队获取 SDK 接入指南。

公开 API

| 导出 | 说明 | |------|------| | init | 初始化 SDK（应用入口调用一次） | | track | 自定义事件 | | page | 页面浏览 | | identify | 绑定用户身份 | | setUserProperties | 更新用户属性 | | InsightProvider | React Provider | | useInsight | Hook：track / page / identify | | usePageView | SPA 路由自动 sys.page_view | | TrackOnView | 元素进入视口曝光 |

本地开发（维护者）

npm install
npm run build
npm run dev
npm run typecheck

发版（维护者）

见 RELEASE.md。

许可

© CAVEGIANT TECHNOLOGY LIMITED，保留所有权利。详见 LICENSE。