solid-posthog/README.md

Allows you to PostHog within SolidJS

# solid-posthog

[![npm package](https://img.shields.io/npm/v/posthog-js?style=flat-square)](https://www.npmjs.com/package/posthog-js)
[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)

Integrates PostHog with the SolidJS environment.

## Quick start

```bash
npm i solid-posthog
# or
yarn add solid-posthog
# or
pnpm add solid-posthog
```

```tsx
import { PostHogProvider } from 'solid-posthog'
```

```tsx
const App: Component = () => {
  return (
    <PostHogProvider apiKey="phg-token" options={{ debug: true }}>
      <div class={styles.App}>
        <header class={styles.header}>
          <img src={logo} class={styles.logo} alt="logo" />
          <h1></h1>
          <p>
            Edit <code>src/App.tsx</code> and save to reload.
          </p>
          <a
            class={styles.link}
            href="https://github.com/solidjs/solid"
            target="_blank"
            rel="noopener noreferrer"
          >
            Learn Solid
          </a>
        </header>
      </div>
    </PostHogProvider>
  )
}
```