Add a notice to the top of a table page

I'd like to add a Shout (https://filamentphp.com/plugins/awcodes-shout) to the top of a resource page (i.e. a table listing), but this doesn't seem to be an option. Is there another way to achieve this?

For example, in the screenshot attached, I'd like to show a notice above or below the "Airtable Accounts" heading

Filament

Shout by Adam Weston - Filament

A simple inline contextual notice for Filament Forms, basically just a fancy placeholder.

Solution

In the end I did it as middleware on hte panel as I needed to do things based on the user's Auth status

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

Middleware

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

Jump to solution

Dennis Koch•8/9/23, 8:07 AM

You could add a table header widget instead with your own styling.

toeknee•8/9/23, 8:19 AM

So shout is only for forms, what you want to do is use a render hook

toeknee•8/9/23, 8:19 AM

Or Denis approach

awcodes•8/9/23, 11:36 AM

Not possible with the plugin at the moment. But it is planned now that widgets are configurable in v3.

ScottOP•8/9/23, 2:22 PM

@toeknee_iom Thank you, hooks look like the solution. However, the documentation isn't clear where in a service provider the render hooks go. This is a common theme I'm finding wiht the docs, where it doesn't give an example in context :/

SScott @toeknee_iom Thank you, hooks look like the solution. However, the documentation...

toeknee•8/9/23, 2:23 PM

Did you read:

To register render hooks, you can call FilamentView::registerRenderHook() from a service provider or middleware.

toeknee•8/9/23, 2:23 PM

https://filamentphp.com/docs/3.x/support/render-hooks#registering-render-hooks

Render hooks - Core Concepts - Filament

ScottOP•8/9/23, 2:24 PM

yep, but it doesnt say whether it goes in a boot function

toeknee•8/9/23, 2:24 PM

It doesn't, because it's a given

but I see your point

ScottOP•8/9/23, 2:25 PM

Still learning I suppose! I've tried doing this, but I get errors about the $scope

class AdminPanelProvider extends PanelProvider
{

    public function boot()
    {
        FilamentView::registerRenderHook(
            'panels::page.start',
            fn (): \Illuminate\Contracts\View\View => view('subscription-notice'),
            scopes: [
                \App\Filament\Resources\SiteResource\Pages\ListSites::class,
                \App\Filament\Resources\SiteResource\Pages\CreateSite::class,
                \App\Filament\Resources\UserResource\Pages\EditSite::class,
            ],
        );
  }
}

class AdminPanelProvider extends PanelProvider
{

    public function boot()
    {
        FilamentView::registerRenderHook(
            'panels::page.start',
            fn (): \Illuminate\Contracts\View\View => view('subscription-notice'),
            scopes: [
                \App\Filament\Resources\SiteResource\Pages\ListSites::class,
                \App\Filament\Resources\SiteResource\Pages\CreateSite::class,
                \App\Filament\Resources\UserResource\Pages\EditSite::class,
            ],
        );
  }
}

Error: Unknown named parameter $scopes

Any ideas what I might be doing wrong?

SScott Still learning I suppose! I've tried doing this, but I get errors about the $sco...

toeknee•8/9/23, 2:26 PM

Are you on V3?

ScottOP•8/9/23, 2:26 PM

yep

toeknee•8/9/23, 2:26 PM

Actually I don't

ScottOP•8/9/23, 2:28 PM

lol

ScottOP•8/9/23, 2:29 PM

I'm on a beta version, will try upgrading to the released v3

SScott I'm on a beta version, will try upgrading to the released v3

toeknee•8/9/23, 2:29 PM

Definitely upgrade

toeknee•8/9/23, 2:29 PM

also I think you can do this in the AdminPanelProvider.php

toeknee•8/9/23, 2:29 PM

as ->renderHook()

ScottOP•8/9/23, 2:30 PM

oohhh, ok, cool - will take a look at that

ScottOP•8/9/23, 2:30 PM

thanks for your help!

toeknee•8/9/23, 2:31 PM

Not tested it, but theory on the PanelProvider.php (likely AdminPanelProvider.php):

            ->renderHook(    
                'panels::page.start',
                fn (): View => view('warning-banner'),
                scopes: [
                    \App\Filament\Resources\UserResource\Pages\CreateUser::class,
                    \App\Filament\Resources\UserResource\Pages\EditUser::class,
                ]
            );

            ->renderHook(    
                'panels::page.start',
                fn (): View => view('warning-banner'),
                scopes: [
                    \App\Filament\Resources\UserResource\Pages\CreateUser::class,
                    \App\Filament\Resources\UserResource\Pages\EditUser::class,
                ]
            );

ScottOP•8/9/23, 2:35 PM

fab, thank you, will give it a go!

Solution

Scott•8/9/23, 3:40 PM

In the end I did it as middleware on hte panel as I needed to do things based on the user's Auth status

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

            ->authMiddleware([
                Authenticate::class,
                RegisterSubscriptionNotice::class,
            ]);

Middleware

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Contracts\View\View;
use Illuminate\Support\Facades\Auth;
use Filament\Support\Facades\FilamentView;

class RegisterSubscriptionNotice
{
    public function handle($request, Closure $next)
    {

       if (Auth::check()) {
            $subscriptionData = [
                'subscribed' => Auth::user()->currentTeam->subscribed(),
                'trial_expired' => now()->greaterThanOrEqualTo(Auth::user()->currentTeam->trial_ends_at),
                'team' => Auth::user()->currentTeam,
            ];

            FilamentView::registerRenderHook(
                'panels::content.start',
                fn (): View => view('filament.hooks.subscription-notice', $subscriptionData)
            );
        }

        return $next($request);
    }
}

ScottOP•8/9/23, 3:40 PM

Thanks again for all the help!

toeknee•8/9/23, 3:50 PM

Good work!

Add a notice to the top of a table page

Similar Threads

Similar Threads

Similar Threads