Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxt-community/nuxt-logrocket
LogRocket module for Nuxt
https://github.com/nuxt-community/nuxt-logrocket
logrocket nuxt nuxt-module
Last synced: about 2 months ago
JSON representation
LogRocket module for Nuxt
- Host: GitHub
- URL: https://github.com/nuxt-community/nuxt-logrocket
- Owner: nuxt-modules
- License: mit
- Created: 2019-01-19T17:02:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T10:55:06.000Z (about 2 months ago)
- Last Synced: 2024-08-01T12:23:21.944Z (about 2 months ago)
- Topics: logrocket, nuxt, nuxt-module
- Language: TypeScript
- Homepage:
- Size: 2.8 MB
- Stars: 143
- Watchers: 4
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt LogRocket
[](https://npmjs.com/package/nuxt-logrocket)
[](https://npmjs.com/package/nuxt-logrocket)
[](https://circleci.com/gh/nuxt-modules/logrocket)
[](https://codecov.io/gh/nuxt-community/nuxt-logrocket)
[](http://standardjs.com)
Session replays, product analytics and more for Nuxt apps.
[📖 **Release Notes**](./CHANGELOG.md)
## Features
- Nuxt 3 & Nuxt Bridge
- Supports [Pinia](https://pinia.vuejs.org) integration
- Ability to run in development mode
## Setup
- Add `nuxt-logrocket` dependency to your project
```sh
npm i nuxt-logrocket
```
- Add `nuxt-logrocket` to the `modules` section of your `nuxt.config.ts` file
```ts
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
modules: ['nuxt-logrocket'],
logRocket: {
id: '',
dev: false,
config: {
//
}
}
})
```
## Options
Options can be passed using either [Runtime Config](https://v3.nuxtjs.org/guide/features/runtime-config/#environment-variables) or the `logRocket` section in `nuxt.config.ts`.
Setting a value for the required `id` option is enough in most cases.
Below is the complete list of options:
| Option | Type | Default | Required |
| :-- | :-- | :-- | :-- |
| id | `String` | `''` | True |
| dev | `Boolean` | `true` | False |
| enablePinia | `Boolean` | `true` | False |
| release | `String` | `null` | False |
| consoleEnabled | `Boolean` | `true` | False |
| networkEnabled | `Boolean` | `true` | False |
| networkRequestSanitizer | `Function` | - | False |
| networkResponseSanitizer | `Function` | - | False |
| domEnabled | `Boolean` | `true` | False |
| inputSanitizer | `Boolean` | `false` | False |
| textSanitizer | `Boolean` | `false` | False |
| baseHref | `String` | `null` | False |
| shouldCaptureIP | `Boolean` | `true` | False |
| rootHostname | `String` | `null` | False |
| shouldDebugLog | `Boolean` | `true` | False |
| mergeIframes | `Boolean` | `false` | False |
This is an example containing the default values for the options:
```ts
{
id: '',
dev: true,
enablePinia: true,
config: {
release: null,
console: {
isEnabled: true
},
network: {
isEnabled: true,
networkRequestSanitizer: () => {},
networkResponseSanitizer: () => {}
},
dom: {
isEnabled: true,
inputSanitizer: false,
textSanitizer: false,
baseHref: null
},
shouldCaptureIP: true,
rootHostname: null,
shouldDebugLog: true,
mergeIframes: false
}
}
```
## Usage
LogRocket gets automatically injected into your application when it is setup correctly. By default this module works only in `production` and on client-side events.
In order to use LogRocket's injected functionality in your application, you can use :
```ts
const { $logRocket } = useNuxtApp()
```
Visit LogRocket's website for a full list of features : [Docs](https://docs.logrocket.com/docs)
### Pinia
This module automatically detects [Pinia](https://pinia.vuejs.org) store mutations and attaches them to the LogRocket session.
This functionality is enabled by **default**, and can be disabled by setting the `enablePinia` options to `false`.
```ts
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
modules: ['nuxt-logrocket'],
logRocket: {
id: '',
enablePinia: false
}
})
```
## Development
- Clone this repository
- Install dependencies using `yarn install`
- Start development server using `yarn run dev`
- Point your browser to `http://localhost:3000`
## License
[MIT License](./LICENSE) - Alibaba Travels Co