Skip to content

: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.

5.0 KB
Raw Blame
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'

import { StepDefinition } from '../steps'

export const getIOSInstallSteps = (
    ctx: OnboardingComponentsContext,
    options?: {
        includeExperimentalSpi?: boolean
        experimentalDescription?: string
        minVersionPod?: string
        minVersionSPM?: string
    }
): StepDefinition[] => {
    const { CodeBlock, Markdown, CalloutBox, dedent } = ctx

    const podVersion = options?.minVersionPod || '3.56'
    const spmVersion = options?.minVersionSPM || '3.56.0'

    return [
        {
            title: 'Install dependency',
            badge: 'required',
            content: (
                <>
                    {options?.experimentalDescription && (
                        <CalloutBox type="fyi" title="Experimental API">
                            <Markdown>{options.experimentalDescription}</Markdown>
                        </CalloutBox>
                    )}
                    <Markdown>Install via Swift Package Manager:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'swift',
                                file: 'Package.swift',
                                code: dedent`
                                    dependencies: [
                                      .package(url: "https://github.com/PostHog/posthog-ios.git", from: "${spmVersion}")
                                    ]
                                `,
                            },
                        ]}
                    />
                    <Markdown>Or add PostHog to your Podfile:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'ruby',
                                file: 'Podfile',
                                code: dedent`
                                    pod "PostHog", "~> ${podVersion}"
                                `,
                            },
                        ]}
                    />
                </>
            ),
        },
        {
            title: 'Configure PostHog',
            badge: 'required',
            content: (
                <>
                    <Markdown>Initialize PostHog in your AppDelegate:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'swift',
                                file: 'AppDelegate.swift',
                                code: dedent`
                                    import Foundation
                                    ${options?.includeExperimentalSpi ? '@_spi(Experimental) ' : ''}import PostHog
                                    import UIKit

                                    class AppDelegate: NSObject, UIApplicationDelegate {
                                        func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
                                            let POSTHOG_PROJECT_TOKEN = "<ph_project_token>"
                                            let POSTHOG_HOST = "<ph_client_api_host>"

                                            let config = PostHogConfig(projectToken: POSTHOG_PROJECT_TOKEN, host: POSTHOG_HOST)
                                            PostHogSDK.shared.setup(config)

                                            return true
                                        }
                                    }
                                `,
                            },
                        ]}
                    />
                </>
            ),
        },
    ]
}

export const getIOSEventStep = (ctx: OnboardingComponentsContext): StepDefinition => {
    const { CodeBlock, Markdown, dedent } = ctx

    return {
        title: 'Send events',
        badge: 'recommended',
        content: (
            <>
                <Markdown>
                    Once installed, PostHog will automatically start capturing events. You can also manually send events
                    to test your integration:
                </Markdown>
                <CodeBlock
                    blocks={[
                        {
                            language: 'swift',
                            file: 'Swift',
                            code: dedent`
                                    PostHogSDK.shared.capture("button_clicked", properties: ["button_name": "signup"])
                                `,
                        },
                    ]}
                />
            </>
        ),
    }
}

export const getIOSSteps = (
    ctx: OnboardingComponentsContext,
    options?: {
        includeExperimentalSpi?: boolean
        experimentalDescription?: string
        minVersionPod?: string
        minVersionSPM?: string
    }
): StepDefinition[] => [...getIOSInstallSteps(ctx, options), getIOSEventStep(ctx)]

export const IOSInstallation = createInstallation(getIOSSteps)