# @ryntab/panel-bear

> Panel Bear Module for Nuxt.js

Latest version **1.0.1** (published 2022-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ryntab/panel-bear
pnpm add @ryntab/panel-bear
yarn add @ryntab/panel-bear
bun add @ryntab/panel-bear
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-09-26 |
| First published | 2022-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 469 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | ryntab |

## Links

- npm: https://www.npmjs.com/package/@ryntab/panel-bear
- Repository: https://github.com/ryntab/panel-bear-module
- Homepage: https://github.com/ryntab/panel-bear-module#readme
- Issues: https://github.com/ryntab/panel-bear-module/issues
- npm.io page: https://npm.io/package/@ryntab/panel-bear

## Dependencies (1)

- [@panelbear/panelbear-js](https://npm.io/package/@panelbear/panelbear-js.md) ^1.3.3

## Recent versions

- 1.0.1 (latest) — 2022-09-26
- 1.0.0 — 2022-09-15

## README

![Panelbear](/assets/banner.png)
A simple module for using Panelbear analytics with Nuxt.js

## Installation
`npm i @ryntab/panel-bear`

Then include the module in your config.
```JS
// Modules: https://go.nuxtjs.dev/config-modules
modules: [
	'@ryntab/panel-bear',
],
```

## Configuration
Add the configuration settings to your `nuxt.config.js`, for the minimum configuration you need to pass your Panelbear site ID. [Where to find your site ID](https://panelbear.com/docs/how-to-find-site-id/)
```JS
panelBear: {
	id:  'YOUR-PROJECT-ID',
},
```
This can also be done by passing along your configuration object in the module.
```JS
modules: [
	["@ryntab/panel-bear",{
		id:  "HYleEXITkCD",
	}],
],
```
 ## 
### Additional Configuration
This module supports all Panelbear configuration options. [@Configuration Docs](https://panelbear.com/docs/#configuration)

```JS
panelBear: {
	id:  'YOUR-PROJECT-ID',
	autoTrack: false,
	honorDNT: true,
	includeURLFragment: true,
	enabled: true
},
```
## 
### Debug Mode
For tracking locally, enable debugging mode in your config. [@Local Development](https://panelbear.com/docs/local-development/)
```JS
panelBear: {
	id:  'YOUR-PROJECT-ID',
	debug: true,
},
```

## Event Tracking
To track custom events, you can use the plugins track property. Event names must not include spaces or special characters.

```JS
this.$panelBear.track("Custom-Event");
```

---
_Source: https://npm.io/package/@ryntab/panel-bear · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
