Getting Started

Introduction

Welcome to Nuxt Laravel Echo module documentation.

This Nuxt module for Laravel Echo integration provides a seamless experience with application broadcasting.

Since Laravel Echo requires additional authentication for Private channels, you may consider using this module to get this out-of-the-box.

Nuxt Laravel Echo provides a wrapper on top of laravel-echo and pusher.js packages, that takes care of creating an Echo instance and setting up an authentication handler.

Key Features

This module includes a range of features designed to streamline broadcasting:

Sanctum-based authentication
CSRF cookie and token management for Private and Presence channels
CSR-only mode (plugin is not loaded in SSR)
TypeScript support
Simple configuration
Request interceptors, token storage, composables and more...

Note: Before using this module, please configure Laravel Echo / Reverb on your backend. Click to learn more.

We recommend looking at our breeze-nuxt template that works flawlessly with breeze-api Laravel application with preconfigured Sanctum and Echo modules.

Ecosystem

This project is a part of Nuxt Laravel modules ecosystem which you may find useful:

Sanctum

Module for Sanctum authentication

Echo

Module for Echo broadcasting

Precognition

Module for Precognition form validation and Nuxt UI support, based on Sanctum

Breeze Nuxt

Nuxt application starter with configured modules for Laravel

Breeze API

Laravel API application starter with preconfigured Sanctum, Echo and Precognition

Support

If you like this module, please support the project to help me maintain and improve it!

Installation

How to add nuxt-laravel-echo to your Nuxt application!