README

Livewire Component for Real Time interactions using Laravel Conveyor Driver.

Video: https://www.youtube.com/watch?v=nQgMK2r_gww

Installation

Step 1: install package

composer require jacked-php/live-belt

Step 2: add service provider

Add the following to your bootstrap/providers.php file:

<?php

return [
    // ...
    Kanata\LaravelBroadcaster\ConveyorServiceProvider::class,
    LiveBelt\LiveBeltServiceProvider::class,
],

Step 3: install dependencies for JS

php artisan install:broadcasting --without-reverb --without-node
npm install --save socket-conveyor-client

Comment import './echo'; from resources/js/bootstrap.js.

Then add this to your app.js:

import Conveyor from "socket-conveyor-client";

window.Conveyor = Conveyor;

At this stage, be sure to follow the steps 1 to 5 at the Laravel Conveyor Driver documentation.

Step 4: adjust configuration

Add the following to your config/broadcasting.php file:

<?php

return [
    // ...
    'conveyor' => [
        'driver' => 'conveyor',
        'protocol' => env('CONVEYOR_PROTOCOL', 'ws'),
        'host' => env('CONVEYOR_URI', 'localhost'),
        'port' => env('CONVEYOR_PORT', 8181),
    ],
];

Set the configurations for the WebSocket server in the .env file:

# ...
BROADCAST_CONNECTION=conveyor
# ...
CONVEYOR_URI=127.0.0.1
CONVEYOR_PORT=8181
CONVEYOR_QUERY="token=my-secure-conveyor-token"
# ...

Usage

First, check the Laravel Conveyor Driver documentation to set up your Laravel project.

Add this to your scripts area:

<livewire:live-belt
    :channel="'private-notifications-' . auth()->id()"
    callback="console.log"
/>

This example will write to your console log.

You can communicate with it using this example event:

<?php

namespace App\Events;

use Illuminate\Broadcasting\InteractsWithBroadcasting;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;

class NotificationReady implements ShouldBroadcastNow
{
    use InteractsWithBroadcasting;

    public function __construct(
        public string $message,
        public string $channel,
    ) {
        $this->broadcastVia('conveyor');
    }

    public function broadcastOn(): array
    {
        return [
            new PrivateChannel($this->channel),
        ];
    }
}

Dispatch it like this and see the console log of your browser:

event(new NotificationReady( message: 'Message from Conveyor', channel: 'notifications-{your-user-id-here}')); // remember to replace {your-user-id-here} with your user id

Events

In Live Belt, you can listen to conveyor events and send messages with them. As seen above in the "Usage" section, you can already send events leveraging the Laravel Broadcasting system. You can also broadcast from the front end!

Let's start by examining the cases of listening events in the backend and front end. Then, we will visit the case of triggering events from the front end.

Listening Live Belt events

To listen to events in the backend, you can just listen to the event \LiveBelt\Events\OnConveyorMessage. That way, whenever you receive some event from Conveyor Server, you'll be able to react to it in the backend.

Here is an example:

<?php

namespace App\Listeners;

use App\Events\NotificationReady;
use LiveBelt\Events\OnConveyorMessage;

class SampleListener
{
    public function handle(OnConveyorMessage $event): void
    {
        logger()->info('Event received from Conveyor Server', [
            'event' => $event,
        ]);
    }
}

In the front end, you can listen to events thrown in the window scope: onConveyorMessage. Here is an example:

window.addEventListener('onConveyorMessageBroadcast', (event) => {
    console.log('Event received from Conveyor Server', event.detail);
});

Triggering Live Belt events

To trigger events to Conveyor Server from the frontend, you just dispatch the event onConveyorMessageBroadcast in the window scope. You must send the channel you want to send to and the message. Both fields are required. Here is an example:

window.dispatchEvent(new CustomEvent('onConveyorMessageBroadcast', {detail: {channel: "private-notifications-", message: "my message"}}));

Notes

There will be logs in the browser console in case of errors (shown as warnings).

jacked-php / live-belt

Maintainers

Details