nuxt-logrocket

Nuxt.js module for LogRocket

📖 Release Notes

Features

• Supports logrocket-vuex plugin integration by default
• Ability to run in development mode

Setup

1. Add the @dansmaculotte/nuxt-logrocket dependency with yarn or npm to your project
2. Add @dansmaculotte/nuxt-logrocket to the modules section of nuxt.config.js
3. Configure it:

{
  modules: [
    // Simple usage
    '@dansmaculotte/nuxt-logrocket',

    // With options
    [
      '@dansmaculotte/nuxt-logrocket',
      { /* module options */ }
    ]
  ],

  // Or with global options
  logRocket: {
    id: '',
    devModeAllowed: false,
    disabled: false
  }
}

Options

Options can be passed using either environment variables or logRocket section in nuxt.config.js. Setting a value for the required id option is enough in most cases.

id

• Type: String
  • Default: process.env.LOGROCKET_ID || ''

devModeAllowed

Force LogRocket to load in development.

• Type: Boolean
  • Default: process.env.LOGROCKET_DEV_MODE_ALLOWED || false

disabled

Prevent LogRocket from loading automatically, useful for GDPR compliance.

• Type: Boolean
  • Default: process.env.LOGROCKET_DISABLED || false

You can manually load LogRocket by using load method in your application:

this.$logRocket.load()

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 :

this.$logRocket

in your components or :

app.$logRocket

in plugins.

If Vuex store is initialized, LogRocket Vuex plugin will be automatically registered.

Visit LogRocket's website for a full list of features : Docs

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev

License

MIT License