Skip to content

Latest commit

 

History

History
executable file
·
94 lines (67 loc) · 2.28 KB

README.md

File metadata and controls

executable file
·
94 lines (67 loc) · 2.28 KB

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'

hideOnLoad

  • Type: Boolean
    • Default : process.env.ZENDESK_HIDE_ON_LOAD || 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