Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dogchef-be/nuxt-intercom
💬 NuxtJS module for Intercom
https://github.com/dogchef-be/nuxt-intercom
intercom intercom-api intercom-client nuxt nuxt-module nuxtjs nuxtjs-ts nuxtjs-typescript typescript-support
Last synced: 6 days ago
JSON representation
💬 NuxtJS module for Intercom
- Host: GitHub
- URL: https://github.com/dogchef-be/nuxt-intercom
- Owner: dogchef-be
- License: mit
- Created: 2020-09-11T08:13:02.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-22T13:50:11.000Z (about 2 years ago)
- Last Synced: 2024-04-25T14:41:34.625Z (7 months ago)
- Topics: intercom, intercom-api, intercom-client, nuxt, nuxt-module, nuxtjs, nuxtjs-ts, nuxtjs-typescript, typescript-support
- Language: TypeScript
- Homepage:
- Size: 2.08 MB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
nuxt-intercom
NuxtJS module for Intercom
## Table of contents
- [Main features](#main-features)
- [Setup](#setup)
- [Options](#options)
- [Usage](#usage)
- [License](#license)
## Main features
- Load Intercom only when required (once `$intercom` is called)
- Reuse the same instance across all components
- TypeScript support
## Setup
1. Add `nuxt-intercom` dependency to your project:
```bash
npm install nuxt-intercom
```
2. Add `nuxt-intercom` module and configuration to `nuxt.config.js`:
```js
export default {
// ...other config options
modules: ["nuxt-intercom"];
intercom: {
appId: 'my_app_id',
}
}
```
3. (Optional) TypeScript support. Add `nuxt-intercom` to the `types` section of `tsconfig.json`:
```json
{
"compilerOptions": {
"types": ["nuxt-intercom"]
}
}
```
## Options
### `disabled`
- Type: `Boolean`
- Default: `false`
Disable Intercom. Useful for non-production environments.
### `appId`
- Type: `String`
The app_id of your Intercom app which will indicate where to store any data.
### `i18n`
- Type: `Boolean`
- Default: `false`
Enable [i18n-module](https://github.com/nuxt-community/i18n-module) integration.
### `hideDefaultLauncher`
- Type: `Boolean`
- Default: `false`
Hide the default launcher icon. Setting to false will forcefully show the launcher icon.
### `alignment`
- Type: `String`
- Default: `right`
Dictate the alignment of the default launcher icon to be on the left/right. Possible values: "left" or "right" (any other value is treated as right).
### `horizontalPadding`
- Type: `Number`
- Default: `20`
Move the default launcher icon horizontally. Padding from right side of screen Minimum value: 20.
### `verticalPadding`
- Type: `Number`
- Default: `20`
Move the default launcher icon vertically. Padding from bottom of screen. Minimum value: 20.
### `enableMobilePadding`
- Type: `Boolean`
- Default: `false`
Apply the `verticalPadding` property to mobile devices.
## Usage
It can be used inside components like:
```html
Chat with us
```
Intercom: [Javascript API: Methods](https://developers.intercom.com/installing-intercom/docs/intercom-javascript)
## License
See the LICENSE file for license rights and limitations (MIT).