:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
import { StepDefinition } from '../steps'
import { SDK_DEFAULTS_DATE } from './_snippets/sdkDefaults'
export const getTanStackInstallSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
const { CodeBlock, Markdown, CalloutBox, dedent } = ctx
return [
{
title: 'Install the package',
badge: 'required',
content: (
<>
<Markdown>Install the PostHog JavaScript library using your package manager:</Markdown>
<CodeBlock
blocks={[
{
language: 'bash',
file: 'npm',
code: dedent`
npm install posthog-js
`,
},
{
language: 'bash',
file: 'yarn',
code: dedent`
yarn add posthog-js
`,
},
{
language: 'bash',
file: 'pnpm',
code: dedent`
pnpm add posthog-js
`,
},
{
language: 'bash',
file: 'bun',
code: dedent`
bun add posthog-js
`,
},
]}
/>
</>
),
},
{
title: 'Add environment variables',
badge: 'required',
content: (
<>
<Markdown>Add your PostHog project token and host to your environment variables:</Markdown>
<CodeBlock
blocks={[
{
language: 'bash',
file: '.env',
code: dedent`
VITE_POSTHOG_PROJECT_TOKEN=<ph_project_token>
VITE_POSTHOG_HOST=<ph_client_api_host>
`,
},
]}
/>
</>
),
},
{
title: 'Initialize PostHog',
badge: 'required',
content: (
<>
<Markdown>
Wrap your app with the `PostHogProvider` component at the root of your application (such as
`main.tsx`):
</Markdown>
<CodeBlock
blocks={[
{
language: 'tsx',
file: 'main.tsx',
code: dedent`
import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
import './index.css'
import App from './App.jsx'
import { PostHogProvider } from '@posthog/react'
const options = {
api_host: import.meta.env.VITE_POSTHOG_HOST,
defaults: '${SDK_DEFAULTS_DATE}',
} as const
createRoot(document.getElementById('root')).render(
<StrictMode>
<PostHogProvider apiKey={import.meta.env.VITE_POSTHOG_PROJECT_TOKEN} options={options}>
<App />
</PostHogProvider>
</StrictMode>
)
`,
},
]}
/>
<CalloutBox type="fyi" title="defaults option">
<Markdown>
The `defaults` option automatically configures PostHog with recommended settings for new
projects. See [SDK defaults](https://posthog.com/docs/libraries/js#sdk-defaults) for
details.
</Markdown>
</CalloutBox>
</>
),
},
]
}
export const getTanStackEventStep = (ctx: OnboardingComponentsContext): StepDefinition => {
const { snippets } = ctx
const JSEventCapture = snippets?.JSEventCapture
return {
title: 'Send events',
content: <>{JSEventCapture && <JSEventCapture />}</>,
}
}
export const getTanStackSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => [
...getTanStackInstallSteps(ctx),
getTanStackEventStep(ctx),
]
export const TanStackInstallation = createInstallation(getTanStackSteps)