README

👀 See who's viewing a resource in Filament PHP 🔭

Now supporting FilamentPHP 4 & FilamentPHP 5

Demo

This package allows you to display when other users are viewing the same resource in Filament PHP.

https://packagist.org/packages/discoverydesign/filament-gaze

composer require discoverydesign/filament-gaze

Features

• Ability to see who else is currently viewing a resource.
• Ability to lock a resource to only 1 editor at a time.
• Ability to conditionally allow users to take control of a locked resource.

How to use

1. Install the package using composer require discoverydesign/filament-gaze
2. Add \DiscoveryDesign\FilamentGaze\FilamentGazePlugin::make() to your Filament Panel provider.

$panel->plugins([
    \DiscoveryDesign\FilamentGaze\FilamentGazePlugin::make()
])

1. Publish the assets with php artisan filament:assets.
2. Import the package inside your Filament Resource with use DiscoveryDesign\FilamentGaze\Forms\Components\GazeBanner.
3. Add the GazeBanner form component to your form with GazeBanner::make().
4. If required, publish the translation files with php artisan vendor:publish --tag=filament-gaze-translations.

Examples

Basic Example

<?php

namespace App\Filament\Resources;

use DiscoveryDesign\FilamentGaze\Forms\Components\GazeBanner;
// ...

class OrderResource extends Resource
{
    // ...

    public static function form(Form $form): Form
    {
        return $form
            ->schema([
                GazeBanner::make('gaze_banner'), // Must be unique to each banner. If you have 2 or more banners in 1 schema, you must pass unique identifiers to them.
                    
                // ...
            ]);
    }
    
    // ...
}

Poll Timer Example

GazeBanner::make()
    ->pollTimer(10),

Identifier Example

GazeBanner::make()
    ->identifier('any-order'),

Lock Example

GazeBanner::make()
    ->lock()

Lock With Control Example

GazeBanner::make('gaze_banner')
    ->lock()
    ->canTakeControl(fn() => auth()->user()->isAdmin())

Hiding Gaze Banner on Create Form Example

GazeBanner::make('gaze_banner')
    ->hidden(fn (?Order $record) => $record === null),

There is also a helper function

GazeBanner::make('gaze_banner')
    ->hideOnCreate(),

Docs

->pollTimer($timeInSecs)

Description

polltimer can be used to set how often the browser should inform Filament that the user is still viewing the page, along with getting an updated list of other users also viewing. It is advised not to put this value too short, as it can cause rate limiting issues. But also not to have this value too long, as it will result in a delayed update of new users viewing the page.

Arguments

timeInSeconds - (int) The amount of time in seconds between each poll. Default is 30 seconds.

->identifier($fnc)

Description

identifier is used as a unique identifier for this gaze banner. Any other gaze banners with the same identifier will share the same list of active users. This can be useful if you want 2 or more difference resources to share the same list of active viewing users.

Arguments

fnc - (optional, closure | string) The name of the identifier. Default is the resource's model class combines with model Id.

->lock($fnc)

Description

lock can be used to lock the resource for anyone but the current person editing the form. This can be useful if you want to prevent multiple people from editing the same resource at the same time. The designated controller is the first person to access the resource, or the person who has taken control of the resource. If you enable this after recently accessing a resource, you may need to run php artisan cache:clear as it is possible that the current cached viewers don't have a marked controller (This is only an issue for development).

Arguments

fnc - (optional, closure | bool) If the resource is lockable or not.

->canTakeControl($fnc)

Description

canTakeControl can be used to allow the user to take control of the resource if it is locked by someone else. This can be useful if you want to allow the user to take control of the resource.

Arguments

fnc - (optional, closure | bool) If the user can take control of the resource. Default is true. If a closure is passed, it should return a bool.

->hideOnCreate()

Description

hideOnCreate is a helper function that can be used to hide the banner on create forms.

Customization

Change icons

To customize the icons in the banner, you may use the following aliases:

• filament-gaze::banner.locked for the lock icon
• filament-gaze::banner.view for the eye icon

Author

🚀 Discovery Design