https://github.com/DansMaCulotte/nuxt-zendesk

Nuxt.js module for Zendesk Web Widget
https://github.com/DansMaCulotte/nuxt-zendesk

nuxt nuxt-module zendesk

Last synced: about 2 months ago
JSON representation

Nuxt.js module for Zendesk Web Widget

• Host: GitHub
• URL: https://github.com/DansMaCulotte/nuxt-zendesk
• Owner: dansmaculotte
• License: mit
• Created: 2019-04-18T14:46:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T20:48:46.000Z (6 months ago)
• Last Synced: 2024-08-02T01:21:51.126Z (5 months ago)
• Topics: nuxt, nuxt-module, zendesk
• Language: JavaScript
• Homepage:
• Size: 3.28 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# nuxt-zendesk

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Dependencies][david-dm-src]][david-dm-href]

[![Standard JS][standard-js-src]][standard-js-href]

> Nuxt.js module for Zendesk

This module allows to automatically add Zendesk Web Widget.

Please refer [vue-zendesk](https://github.com/dansmaculotte/vue-zendesk) plugin for configurations.

[📖 **Release Notes**](./CHANGELOG.md)

## 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:

```js

{

  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](https://developer.zendesk.com/embeddables/docs/widget/settings).

- 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](./LICENSE.md)

[npm-downloads-src]: https://img.shields.io/npm/dt/@dansmaculotte/nuxt-zendesk.svg?style=flat-square

[npm-downloads-href]: https://npmjs.com/package/@dansmaculotte/nuxt-zendesk

[npm-version-src]: https://img.shields.io/npm/v/@dansmaculotte/nuxt-zendesk/latest.svg?style=flat-square

[npm-version-href]: https://npmjs.com/package/@dansmaculotte/nuxt-zendesk

[david-dm-src]: https://david-dm.org/dansmaculotte/nuxt-zendesk/status.svg?style=flat-square

[david-dm-href]: https://david-dm.org/dansmaculotte/nuxt-zendesk

[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square

[standard-js-href]: https://standardjs.com