Nuxt intercom

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

This nuxt 3 module provides a client side plugin that add intercom to window and provides $intercom instance so you can easily access intercom function like update user properties. Everything is in Typescript and the types are exported.

- ✨  Release Notes

Features

- ⛰  Nuxt 3 Ready
- 🚠  As lightweight as possible
- 🌲  Written in Typescript
- ⛰  Simple configuration

Quick Setup

1. Add nuxt-3-intercom dependency to your project

``bash


Using pnpm

pnpm add -D nuxt-3-intercom

Using yarn

yarn add --dev nuxt-3-intercom

Using npm

npm install --save-dev nuxt-3-intercom
`

2. Add nuxt-3-intercom to the modules section of nuxt.config.ts

`js
export default defineNuxtConfig({
modules: [
'nuxt-3-intercom'
],
intercom: {
// Required
appId: process.env.INTERCOM_APP_ID
}
})
`

internally the module config will be merged with nuxt runtimeConfig public.intercom cause we need access to the config in the plugin
So if you want to have any intercom config changes depend on environment e.g staging/prod. You could overwrite the module config via runtimeConfig e.g.:

`js
export default defineNuxtConfig({
runtimeConfig: {
public: {
intercom: {
appId: process.env.INTERCOM_APP_ID
}
}
}
})
`

That's it! You can now use intercom in your Nuxt app ✨

Plugin

This module provides a client side plugin. You can call the Intercom instance via $intercom
Note: If you want to access the plugin in script you have to import it first via

`js
const { $intercom } = useNuxtApp()
`

See /playground for more

The intercom plugin is fully typed so if you use const { $intercom } = useNuxtApp() you can navigate though the functions etc.

Development

`bash


Install dependencies

npm install

Generate type stubs

npm run dev:prepare

Develop with the playground

npm run dev

Build the playground

npm run dev:build

Run ESLint

npm run lint

Run Vitest

npm run test
npm run test:watch

Release new version

npm run release
``

[npm-version-src]: https://img.shields.io/npm/v/nuxt-3-intercom/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-3-intercom

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-3-intercom.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-3-intercom

[license-src]: https://img.shields.io/npm/l/nuxt-3-intercom.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-3-intercom

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com