Greeter by Mücahit Uğur

• Version compatibility
• Installation
• Usage
  • Customizing visibility
• Examples
• Upgrading from 0.2.x (Filament 3)
• Contributing
• Security
• Credits
• License

This Filament plugin is the sibling of nova-greeter that extends the default account widget and lets you:

• Give yourself and your users fancy titles
• Add a custom action
• Change welcome message
• Change avatar size
• Disable avatar

#Version compatibility

#Installation

You can install the package via composer:

composer require oriondevelops/filament-greeter

If you are still on Filament 3, stay on the 0.2.x line:

composer require oriondevelops/filament-greeter:^0.2

#Usage

You need to register the plugin with your preferred Filament panel providers. This can be done inside your PanelProvider, e.g. AdminPanelProvider.

<?php

namespace App\Providers\Filament;

use Filament\Panel;
use Filament\PanelProvider;
use Filament\Actions\Action;
use Orion\FilamentBackup\BackupPlugin;
use Orion\FilamentGreeter\GreeterPlugin;
use Orion\FilamentFeedback\FeedbackPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugins([
                BackupPlugin::make()
                    ->queue('monitors'),
                // ...    
                GreeterPlugin::make()
                    ->message('Welcome,')
                    ->name('Daenerys Targaryen')
                    ->title('The First of Her Name, the Unburnt, Queen of Meereen, Queen of the Andals and the Rhoynar and the First Men, Khalisee of the Great Grass Sea, Breaker of Chains and Mother of Dragons')
                    ->avatar(size: '2xl', url: 'https://avatarfiles.alphacoders.com/236/236674.jpg')
                    ->action(
                        Action::make('action')
                            ->label('Buy more unsullied')
                            ->icon('heroicon-o-shopping-cart')
                            ->url('https://buyunsulliedonline.com')
                    )
                    ->sort(-1)
                    ->columnSpan('full'),
                // ...
                FeedbackPlugin::make()
                    ->sendResponsesTo(email: '[email protected]'),
            ])
    }
}

Message

->message(text: 'Welcome')

To determine the welcome message dynamically you can use a closure:

 ->message(text: fn() => auth()->user()->hasRole('Super Administrator') ? __('Welcome my lord') : __('Welcome'))

Time-Sensitive Greeting

->timeSensitive(morningStart: 6, afternoonStart: 12, eveningStart: 17, nightStart: 22)

The greeting message will change to "Good morning", "Good afternoon", "Good evening", or "Good night" based on the current time. You can omit the hour parameters to use the default times.

Title

->title(text: 'Administrator', enabled: true)

To change the title based on the user you can use a closure:

->title(text: fn() => auth()->user()->title)

Avatar

Setting up user avatars

->avatar(size: 'lg', enabled: true),

Sizes are sm, md, lg, xl and 2xl. Any other value is added as CSS classes, which Filament only renders if your custom theme compiles them.

Action

->action(
    Action::make('action')
        ->label('Buy more unsullied')
        ->icon('heroicon-o-shopping-cart')
        ->url('https://buyunsulliedonline.com')
)

#Customizing visibility

<?php

namespace App\Providers\Filament;

use Filament\Panel;
use Filament\PanelProvider;
use Orion\FilamentGreeter\GreeterPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                GreeterPlugin::make()
                    ->visible(fn() => auth()->user()->can('view greeter'))
                    // OR
                    ->hidden(fn() => auth()->user()->cannot('view greeter')),
            );
    }
}

#Examples

GreeterPlugin::make()
    ->message('Welcome')
    ->name("Rand al'Thor")
    ->title("Dragon Reborn, Coramoor, Car'a'carn, He Who Comes With the Dawn, Shadowkiller, King of Illian, Lord of the Morning")
    ->avatar(size: '2xl')
    ->columnSpan('full')
    ->action(
        Action::make('action')
            ->label('Reborn')
            ->color('danger')
            ->icon('heroicon-o-arrow-path')
            ->action(function () {
                Notification::make()
                    ->title('Reborn successfully')
                    ->success()
                    ->send();
            })
    ),

GreeterPlugin::make()
    ->message('Welcome')
    ->name("Annatar")
    ->action(
        Action::make('action')
            ->label('Gift a ring')
            ->color('warning')
            ->icon('heroicon-o-gift')
            ->action(function () {
                Notification::make()
                    ->title('Target deceived successfully')
                    ->warning()
                    ->send();
            })
    ),

GreeterPlugin::make()
    ->avatar(enabled: false),

GreeterPlugin::make()
    ->timeSensitive()
    ->name('Ser Arthur Dayne')
    ->title('Sword of the Morning')
    ->avatar(size: '2xl')
    ->columnSpan('full')
    ->action(
        Action::make('action')
            ->label('Protect the Heir')
            ->icon('heroicon-o-shield-check')
            ->action(fn () => Notification::make()->title('You failed! You’ve been stabbed in the back.')->danger()->send())
    ),

#Upgrading from 0.2.x (Filament 3)

1. Upgrade your app to Filament 4 or 5 first (v4 upgrade guide, v5 upgrade guide).
2. Require the new version: composer require oriondevelops/filament-greeter:^1.0.
3. Replace Tailwind classes passed to ->avatar(size: ...), such as 'w-16 h-16', with 'xl' or '2xl'. Filament 4+ no longer compiles classes used in plugin views.
4. If you extend GreeterWidget, note that $view is no longer static and the custom action now comes from getGreeterAction() instead of action().

#Contributing

Please see CONTRIBUTING for details.

#Security

Please review Security Policy on how to report security vulnerabilities.

#Credits

• Mücahit Uğur
• All Contributors

#License

The MIT License (MIT). Please see License File for more information.