open-index/open-npm huggingface dataset:
npm package: @panelbear/panelbear-js
Description: Official Panelbear client (browser)
Author: Anthony N. Simon
Latest version: 1.3.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Panelbear client (browser)

A simple JavaScript library for [Panelbear Analytics](https://panelbear.com).

## Highlights

- Just a thin wrapper around the Panelbear analytics script.
- Integrates with most JS frameworks.
- Typed (Typescript).

## Quickstart

### Install

Run the following command to install in your project:

```
npm install @panelbear/panelbear-js
```

Or with yarn:

```
yarn add @panelbear/panelbear-js
```

### Basic usage

You can now import, and use the Panelbear client on your project.

```javascript
import * as Panelbear from '@panelbear/panelbear-js';

// Load the Panelbear tracker once in your app
Panelbear.load('YOUR_SITE_ID');

// This is how you record page views
Panelbear.trackPageview();

// You can also trigger custom events
Panelbear.track('NewsletterSignup');
```

## Framework integrations

- [Next.js](https://www.npmjs.com/package/@panelbear/panelbear-nextjs)
- [Vuepress](https://www.npmjs.com/package/@panelbear/vuepress-plugin-panelbear)
- [Gatsby](https://www.npmjs.com/package/gatsby-plugin-panelbear)

## Changelog

### 1.3.3

- Handle error on bind queue to window when element with same name exists (eg. <div id="panelbear"></div>).

### 1.3.2

- Update docs.

### 1.3.1

- Export config interface and event schema.

### 1.3.0

- Update PanelbearConfig interface available fields.
- Upgrade package dependencies.
- Add interface docs.

### 1.2.0

- Allow scriptSrc config option to load Panelbear script from own domain.

### 1.1.0

- By default, load tracker with `autoTrack` set to `false`.

### 1.0.2

- Initial open source release.

## Security Disclosure

If you discover any issue regarding security, please disclose the information responsibly by following the instructions [here](https://panelbear.com/security/). Do NOT create a Issue on the GitHub repo.

## Contributors

[@jondcallahan](https://github.com/jondcallahan)

## Contributing

Please check for any existing issues before openning a new Issue. If you'd like to work on something, please open a new Issue describing what you'd like to do before submitting a Pull Request.

## License

See [LICENSE](https://github.com/panelbearhq/panelbear-js/blob/master/LICENSE).
npm package: @panelbear/panelbear-nextjs
Description: Official Panelbear integration for Next.js
Author: Anthony N. Simon
Latest version: 2.0.1
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Panelbear Next.js integration

> **Important:** As of version 2.0.1 of this package only Next.js 13 or later will be supported. For previous versions of Next.js please install version 1.0.5 of this package.

Official [Panelbear](https://panelbear.com) integration for Next.js.

## Quickstart

### Install

Run the following command to install in your project:

```
npm install @panelbear/panelbear-nextjs
```

Or with yarn:

```
yarn add @panelbear/panelbear-nextjs
```

### Basic usage

You can now import, and use the Panelbear hook on your project.

```javascript
// ./pages/_app.js

import { usePanelbear } from '@panelbear/panelbear-nextjs';

function CustomApp({ Component, pageProps }) {
  // Load Panelbear only once during the app lifecycle
  usePanelbear('YOUR_SITE_ID');

  return <Component {...pageProps} />;
}

export default CustomApp;
```

### Debug-mode

When developing in localhost, Panelbear does not send events to avoid using your quota.

You can enable debug mode to send events when testing things locally. It will also log messages to console.

```javascript
// ./pages/_app.js

import { usePanelbear } from '@panelbear/panelbear-nextjs';

function CustomApp({ Component, pageProps }) {
  
  usePanelbear('YOUR_SITE_ID', {
    debug: true
  });

  return <Component {...pageProps} />;
}

export default CustomApp;
```


## Changelog

### 2.0.1

- Fix breaking change to function export level

### 2.0.0

- Support new Next.js 13 'app' directory and client-only components.

### 1.0.5

- Add peer dependency support for NextJS 13.

### 1.0.4

- Add peer dependency support for React 18.

### 1.0.3

- Update peer dependencies

### 1.0.2

- Upgrade deps

### 1.0.1

- Update docs

### 1.0.0

- Initial open source release.

## Security Disclosure

If you discover any issue regarding security, please disclose the information responsibly by following the instructions [here](https://panelbear.com/security/). Do NOT create a Issue on the GitHub repo.

## Contributors

[@anthonynsimon](https://github.com/anthonynsimon)
[@EndBug](https://github.com/EndBug)

## Alternatives

For community alternatives to this package, you can check out:

- [next-use-panelbear](https://github.com/alizahid/next-use-panelbear)

## Contributing

Please check for any existing issues before openning a new Issue. If you'd like to work on something, please open a new Issue describing what you'd like to do before submitting a Pull Request.

## License

See [LICENSE](https://github.com/panelbearhq/panelbear-nextjs/blob/master/LICENSE).
npm package: @panelbear/vuepress-plugin-panelbear
Description: Official Panelbear Vuepress Plugin
Author: Anthony N. Simon
Latest version: 1.0.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Panelbear Vuepress Plugin

The Vuepress Plugin for [Panelbear Analytics](https://panelbear.com).

## Quickstart

### Install

Run the following command to install in your project:

```
npm install --dev @panelbear/vuepress-plugin-panelbear
```

Or with yarn:

```
yarn add --dev @panelbear/vuepress-plugin-panelbear
```

### Usage

You can now add the Panelbear plugin to your project's site or theme config file (`.vuepress/config.js`). Simply include Panelbear in the plugins section:

```javascript
module.exports = {
  plugins: [
    [
      '@panelbear/vuepress-plugin-panelbear',
      {
        site: '', // Your Site ID
        debug: false, // Enable if you wish to send events from localhost / log to console
      },
    ],
  ],
  // Other Vuepress config
};
```

## Options

### site

The Site ID of your Panelbear website.

- Required: true
- Type: `string`
- Default: `undefined`

### debug

Enable debug mode on your Panelbear installation.

- Required: false
- Type: `bool`
- Default: `undefined`

## Changelog

### 1.0.0

- Initial open source release.

## Security Disclosure

If you discover any issue regarding security, please disclose the information responsibly by following the instructions [here](https://panelbear.com/security/). Do NOT create a Issue on the GitHub repo.

## Contributing

Please check for any existing issues before openning a new Issue. If you'd like to work on something, please open a new Issue describing what you'd like to do before submitting a Pull Request.

## License

See [LICENSE](https://github.com/panelbearhq/vuepress-plugin-panelbear/blob/master/LICENSE).