npm package: @huntersofbook/plausible-nuxt
Description: Plausible Analytics module for Nuxt 3
Author: Mehmet - productdevbook
Latest version: 1.0.1
Deprecated: package moved to new location https://github.com/productdevbookcom/v-plausible

![alt text](https://github.com/huntersofbook/huntersofbook/blob/main/docs/public/images/plausible-nuxt.png?raw=true)

# Plausible Nuxt 3 Module

<br/>

### @huntersofbook/plausible-nuxt [![npm](https://img.shields.io/npm/v/@huntersofbook/plausible-nuxt.svg)](https://npmjs.com/package/@huntersofbook/plausible-nuxt)
<br/>

This module huntersofbook team created.

> [Plausible](https://plausible.io/docs) integration for [Nuxt](https://nuxtjs.org)

## Features

- Zero-config required
- Auto-import composables usePlausible()

## Setup
```
pnpm add @huntersofbook/plausible-nuxt
```
```
yarn add @huntersofbook/plausible-nuxt
```
```
pnpm add @huntersofbook/plausible-nuxt
```
### Nuxt Config

```ts
export default defineNuxtConfig({
  modules: [
    '@huntersofbook/plausible-nuxt'
  ],
  plausible: {
    init: {
      domain: 'localhost',
      apiHost: 'https://site.com',
      trackLocalhost: true
    },
    // If this is loaded you can make it true, https://github.com/nuxt-modules/partytown
    partytown: false,
  }
})
```

### Composables

```vue
<script setup lang="ts">
const { trackEvent } = usePlausible()
</script>

<template>
  <div>
    <button @click="trackEvent('nuxt')">
      click me
    </button>
  </div>
</template>
```

```vue
<script setup lang="ts">
const { trackPageview } = usePlausible()
</script>
```


## Init Default

`Plausible()` accepts some [options](https://plausible-tracker.netlify.app/globals.html#plausibleinitoptions) that you may want to provide:

| Option         | Type     | Description                                                       | Default                  |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------ |
| domain         | `string` | Your site's domain, as declared by you in Plausible's settings    | `location.hostname`      |
| hashMode       | `bool`   | Enables tracking based on URL hash changes.                       | `false`                  |
| trackLocalhost | `bool`   | Enables tracking on *localhost*.                                  | `false`                  |
| apiHost        | `string` | Plausible's API host to use. Change this if you are self-hosting. | `'https://plausible.io'` |

## Settings Default

| Option         | Type     | Description                                                       | Default                  |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------ |
| enableAutoPageviews | `bool` | Your site's domain, as declared by you in Plausible's settings    | `true`      |
| enableAutoOutboundTracking       | `bool`   | Enables tracking based on URL hash changes.                       | `false`                  |


## 💻 Development

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
- Install dependencies using `pnpm install`
- Stub module with `pnpm dev:prepare`
- Run `pnpm dev` to start [playground](./playground) in development mode

## License

MIT License © 2022-PRESENT [productdevbook](https://github.com/productdevbook)


## 💚 Credits

Nuxt 3 Plugin [danielroe](https://github.com/danielroe)