Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discoverydesign/filament-gaze
👀 See who's viewing a resource in Filament PHP ðŸ”
https://github.com/discoverydesign/filament-gaze
filament-plugin filamentadmin filamentphp filamentphp-plugin laravel livewire
Last synced: 25 days ago
JSON representation
👀 See who's viewing a resource in Filament PHP ðŸ”
- Host: GitHub
- URL: https://github.com/discoverydesign/filament-gaze
- Owner: discoverydesign
- License: mit
- Created: 2024-07-21T17:00:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T11:00:02.000Z (about 2 months ago)
- Last Synced: 2024-10-01T09:21:59.426Z (about 1 month ago)
- Topics: filament-plugin, filamentadmin, filamentphp, filamentphp-plugin, laravel, livewire
- Language: PHP
- Homepage:
- Size: 1.69 MB
- Stars: 122
- Watchers: 3
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Filament Gaze
👀 See who's viewing a resource in Filament PHP ðŸ”
## Demo
[](https://www.loom.com/share/eb45fbb9088145888c066bb2d2303457?sid=64fdd7d4-0e53-4a01-a417-d73d1acf2439)
This package allows you to display when other users are viewing the same resource in Filament PHP.
https://packagist.org/packages/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()
])
```
3. Publish the assets with `php artisan filament:assets`.
4. Import the package inside your Filament Resource with `use DiscoveryDesign\FilamentGaze\Forms\Components\GazeBanner`.
5. Add the `GazeBanner` form component to your form with `GazeBanner::make()`.
6. If required, publish the translation files with `php artisan vendor:publish --tag=filament-gaze-translations`.
## Examples
### Basic Example
```php
schema([
GazeBanner::make(),
// ...
]);
}
// ...
}
```
### Poll Timer Example
```php
GazeBanner::make()
->pollTimer(10),
```
### Identifier Example
```php
GazeBanner::make()
->identifier('any-order'),
```
### Lock Example
```php
GazeBanner::make()
->lock()
```
### Lock With Control Example
```php
GazeBanner::make()
->lock()
->canTakeControl(fn() => auth()->user()->isAdmin())
```
### Hiding Gaze Banner on Create Form Example
```php
GazeBanner::make()
->hidden(fn (?Order $record) => $record === null),
```
There is also a helper function
```php
GazeBanner::make()
->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](https://filamentphp.com/docs/3.x/support/icons#replacing-the-default-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](https://discoverydesign.co.uk)