README

Filament Site Snippets

This Filament plugin provides a simple way to manage "snippets" – small, reusable pieces of content like text, rich text, or images – directly from your Filament admin panel. These snippets can be easily integrated into various parts of your website, such as footer copyright notices, site taglines, or other dynamic content elements that you want to manage centrally.

This package is also a standalone part of a CMS project: FilaPress.

Installation

You can install the package via composer:

composer require rectitude-open/filament-site-snippets

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-site-snippets-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-site-snippets-config"

Optionally, you can publish the translations using

php artisan vendor:publish --tag="filament-site-snippets-translations"

This is the contents of the published config file:

return [
    'filament_resource' => RectitudeOpen\FilamentSiteSnippets\Resources\SiteSnippetResource::class,
    'model' => RectitudeOpen\FilamentSiteSnippets\Models\SiteSnippet::class,
    'navigation_sort' => 0,
    'navigation_icon' => 'heroicon-o-puzzle-piece',
    'editor_component_class' => \Filament\Forms\Components\RichEditor::class,
];

Usage

The package provides a resource page that allows you to view snippets in your Filament admin panel.

To use the resource page provided by this package, you need to register it in your Panel Provider first.

namespace App\Providers\Filament;

use RectitudeOpen\FilamentSiteSnippets\FilamentSiteSnippetsPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugins([
                FilamentSiteSnippetsPlugin::make()
            ]);
    }
}

Retrieving Snippets in Your Application

This package also provides a helper class RectitudeOpen\FilamentSiteSnippets\FilamentSiteSnippets to easily retrieve snippet values in your application code (e.g., in your Blade views, controllers, or services).

Here are some common ways to use it:

use RectitudeOpen\FilamentSiteSnippets\FilamentSiteSnippets;

$copyright = FilamentSiteSnippets::get('footer_copyright');
$allSnippets = FilamentSiteSnippets::all();
if(FilamentSiteSnippets::exists('promo_banner_text')) { ... }

Cache Management

Snippets are cached by default to improve performance. You can clear the cache for a specific snippet or all snippets:

// Clear cache for a specific snippet
FilamentSiteSnippets::clearCache('footer_copyright');

// Clear cache for all snippets
FilamentSiteSnippets::clearCache();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Aspirant Zhang
• All Contributors

License

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