integration-react-react-router-7-framework

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

PostHog integration for React Router v7 - Framework mode

适用于React Router v7框架模式应用的PostHog集成方案

This skill helps you add PostHog analytics to React Router v7 - Framework mode applications.
本技能可帮助你为React Router v7框架模式应用添加PostHog分析功能。

Workflow

操作流程

Follow these steps in order to complete the integration:
  1. basic-integration-1.0-begin.md
    - PostHog Setup - Begin ← Start here
  2. basic-integration-1.1-edit.md
    - PostHog Setup - Edit
  3. basic-integration-1.2-revise.md
    - PostHog Setup - Revise
  4. basic-integration-1.3-conclude.md
    - PostHog Setup - Conclusion
请按以下步骤完成集成:
  1. basic-integration-1.0-begin.md
    - PostHog配置 - 开始 ← 从此处启动
  2. basic-integration-1.1-edit.md
    - PostHog配置 - 编辑
  3. basic-integration-1.2-revise.md
    - PostHog配置 - 修订
  4. basic-integration-1.3-conclude.md
    - PostHog配置 - 完成

Reference files

参考文件

  • references/EXAMPLE.md
    - React Router v7 - Framework mode example project code
  • references/react-router-v7-framework-mode.md
    - React router v7 framework mode (remix v3) - docs
  • references/identify-users.md
    - Identify users - docs
  • references/basic-integration-1.0-begin.md
    - PostHog setup - begin
  • references/basic-integration-1.1-edit.md
    - PostHog setup - edit
  • references/basic-integration-1.2-revise.md
    - PostHog setup - revise
  • references/basic-integration-1.3-conclude.md
    - PostHog setup - conclusion
The example project shows the target implementation pattern. Consult the documentation for API details.
  • references/EXAMPLE.md
    - React Router v7框架模式示例项目代码
  • references/react-router-v7-framework-mode.md
    - React Router v7框架模式(Remix v3)文档
  • references/identify-users.md
    - 用户身份识别文档
  • references/basic-integration-1.0-begin.md
    - PostHog配置 - 开始
  • references/basic-integration-1.1-edit.md
    - PostHog配置 - 编辑
  • references/basic-integration-1.2-revise.md
    - PostHog配置 - 修订
  • references/basic-integration-1.3-conclude.md
    - PostHog配置 - 完成
示例项目展示了目标实现模式。如需了解API细节,请查阅相关文档。

Key principles

核心原则

  • Environment variables: Always use environment variables for PostHog keys. Never hardcode them.
  • Minimal changes: Add PostHog code alongside existing integrations. Don't replace or restructure existing code.
  • Match the example: Your implementation should follow the example project's patterns as closely as possible.
  • 环境变量:始终使用环境变量存储PostHog密钥,绝对不要硬编码。
  • 最小改动:在现有集成代码旁添加PostHog代码,不要替换或重构现有代码。
  • 匹配示例:你的实现应尽可能贴近示例项目的模式。

Framework guidelines

框架指南

  • For feature flags, use useFeatureFlagEnabled() or useFeatureFlagPayload() hooks - they handle loading states and external sync automatically
  • Add analytics capture in event handlers where user actions occur, NOT in useEffect reacting to state changes
  • Do NOT use useEffect for data transformation - calculate derived values during render instead
  • Do NOT use useEffect to respond to user events - put that logic in the event handler itself
  • Do NOT use useEffect to chain state updates - calculate all related updates together in the event handler
  • Do NOT use useEffect to notify parent components - call the parent callback alongside setState in the event handler
  • To reset component state when a prop changes, pass the prop as the component's key instead of using useEffect
  • useEffect is ONLY for synchronizing with external systems (non-React widgets, browser APIs, network subscriptions)
  • 对于功能标志,请使用useFeatureFlagEnabled()或useFeatureFlagPayload()钩子——它们会自动处理加载状态和外部同步
  • 在用户操作发生的事件处理函数中添加分析捕获逻辑,不要在响应状态变化的useEffect中添加
  • 不要使用useEffect进行数据转换——应在渲染期间计算派生值
  • 不要使用useEffect响应用户事件——将逻辑直接放在事件处理函数中
  • 不要使用useEffect链式更新状态——在事件处理函数中一次性计算所有相关更新
  • 不要使用useEffect通知父组件——在事件处理函数中调用父回调的同时执行setState
  • 当属性变化时需要重置组件状态,请将该属性作为组件的key传递,而非使用useEffect
  • useEffect仅用于与外部系统同步(非React组件、浏览器API、网络订阅)

Identifying users

用户身份识别

Identify users during login and signup events. Refer to the example code and documentation for the correct identify pattern for this framework. If both frontend and backend code exist, pass the client-side session and distinct ID using
X-POSTHOG-DISTINCT-ID
and
X-POSTHOG-SESSION-ID
headers to maintain correlation.
在登录和注册事件中识别用户。请参考示例代码和文档,了解适用于该框架的正确识别模式。如果同时存在前端和后端代码,请使用
X-POSTHOG-DISTINCT-ID
X-POSTHOG-SESSION-ID
头传递客户端会话和唯一ID,以保持关联。

Error tracking

错误追踪

Add PostHog error tracking to relevant files, particularly around critical user flows and API boundaries.
为相关文件添加PostHog错误追踪,尤其是在关键用户流程和API边界处。