Skip to content
Nuxt.js module for Zendesk Web Widget
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.editorconfig
.eslintignore
.eslintrc.js
.gitignore feat: add zendesk script to head and update test Apr 20, 2019
CHANGELOG.md
LICENSE.md chore: add nuxt module base files Apr 19, 2019
README.md feat: add gdpr compliance from vue-zendesk May 3, 2019
babel.config.js
commitlint.config.js
husky.config.js
jest.config.js chore: add nuxt module base files Apr 19, 2019
package.json
renovate.json
yarn.lock

README.md

nuxt-zendesk

npm version npm downloads Dependencies Standard JS

Nuxt.js module for Zendesk

This module allows to automatically add Zendesk Web Widget. Please refer vue-zendesk plugin for configurations.

📖 Release Notes

Setup

  1. Add the @dansmaculotte/nuxt-zendesk dependency with yarn or npm to your project
  2. Add @dansmaculotte/nuxt-zendesk to the modules section of nuxt.config.js
  3. Configure it:
{
  modules: [
    // Simple usage
    '@dansmaculotte/nuxt-zendesk',

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

  // Or with global options
  zendesk: {
    key: '',
    disabled: false,
    settings: {
      webWidget: {
        color: {
          theme: '#78a300'
        }
      }
    }
  }
}

Options

key

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

disabled

  • Type: Boolean
    • Default: process.env.ZENDESK_DISABLED || false'

settings

This option comes directly from Zendesk documentation.

  • Type: Object
    • Default: {}

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

You can’t perform that action at this time.