Getting Started

Installation

Learn how to install and configure nuxt-tawk-to in your Nuxt application.

Add to dependency

Run one of the following commands to add the module to your project:

npm install nuxt-tawk-to

Register Module

Add nuxt-tawk-to to the modules section of your nuxt.config.ts and provide your Tawk.to credentials:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-tawk-to'],

  tawkTo: {
    propertyId: 'your-tawk-property-id',
    widgetId: 'your-widget-id'
  }
})
You can find your Property ID and Widget ID in the Tawk.to Dashboard under Administration > Channels > Chat Widget.

TypeScript Support

This module comes with full TypeScript support. You can import the config types if needed:

import type { TawkToConfig } from 'nuxt-tawk-to/types'