React web analytics installation
- 1
Install the package
RequiredInstall
posthog-jsand@posthog/reactusing your package manager: - 2
Add environment variables
RequiredAdd your PostHog API key and host to your environment variables. For Vite-based React apps, use the
VITE_PUBLIC_prefix:.env - 3
Initialize PostHog
RequiredWrap your app with the
PostHogProvidercomponent at the root of your application (such asmain.tsxif you're using Vite):main.tsxdefaults optionThe
defaultsoption automatically configures PostHog with recommended settings for new projects. See SDK defaults for details. - 4
Accessing PostHog in your code
RecommendedUse the
usePostHoghook to access the PostHog instance in any component wrapped byPostHogProvider:MyComponent.tsxYou can also import
posthogdirectly for non-React code or utility functions:utils/analytics.ts - 5
Send events
RecommendedClick around and view a couple pages to generate some events. PostHog automatically captures pageviews, clicks, and other interactions for you.
If you'd like, you can also manually capture custom events:
JavaScript - 6
Next steps
RecommendedAfter installing PostHog and ensuring autocapture is enabled, head to your web analytics dashboard to see your data. And then check out our getting started guide.
PostHog tip: Web analytics works with anonymous events. This means if you are primarily using PostHog for web analytics, it can be significantly cheaper for you.