README

A flexible page builder plugin for Filament v3 with multiple content blocks, perfect for creating dynamic pages in your Laravel applications.

Features

Multiple Content Blocks: Hero sections, image galleries, banners, rich text, and more
File Management: Integrated file uploads with configurable storage disks
Status Management: Draft, Published, and Archived page states
Multi-language Support: Built-in language switching capability

Installation

You can install the package via composer:

composer require threls/filament-page-builder

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-page-builder-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-page-builder-config"

Usage

Basic Setup

Install the plugin in your Filament panel:

use Threls\FilamentPageBuilder\PageBuilderPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            PageBuilderPlugin::make(),
        ]);
}

Available Content Blocks

The page builder comes with the following content blocks out of the box:

Hero Section: Large banner with title, subtitle, image, and call-to-action button
Image Gallery: Collection of images with optional text and button
Image Cards: Repeatable cards with image, text, and button
Horizontal Ticker: Rotating content sections with images and descriptions
Banner: Simple banner with title, text, image, and button
Rich Text: WYSIWYG text editor content
Key-Value Section: FAQ-style content with title/description pairs
Map Location: Geographic location with coordinates and address
Relationship Content: Display related models (testimonials, FAQs, events)

Configuration

The package publishes a configuration file where you can customize:

return [
    // Default storage disk for uploads
    'disk' => env('FILAMENT_PAGE_BUILDER_DISK', 'public'),

    // Navigation settings
    'navigation_group' => 'Content',
    'navigation_icon' => 'heroicon-o-rectangle-stack',


    // API settings
    'api' => [
        'enabled' => env('FILAMENT_PAGE_BUILDER_API_ENABLED', true),
        'prefix' => env('FILAMENT_PAGE_BUILDER_API_PREFIX', 'api'),
        'middleware' => ['api'],
    ],
];

Working with Pages

Creating Pages

Pages can be created through the Filament admin interface. Each page has:

Title (automatically generates slug)
Status (Draft, Published, Archived)
Content blocks (built using the visual builder)

Retrieving Page Data

You can retrieve and work with page data using the included Data Transfer Objects:

use Threls\FilamentPageBuilder\Models\Page;
use Threls\FilamentPageBuilder\Data\PageData;

$page = Page::where('slug', 'home')->first();
$pageData = PageData::fromModel($page);

// Access structured content
foreach ($pageData->content as $block) {
    echo $block->type; // e.g., 'hero-section'
    // $block->data contains the structured block data
}

Using the API

The package includes a built-in API for retrieving page data:

// Available endpoints:
// GET /api/pages - Returns all published pages
// You can filter by slug using query parameters: /api/pages?filter[slug]=home

// Example controller usage in your app:
Route::get('pages', function() {
    return Http::get('https://yourdomain.com/api/pages')->json();
});

Route::get('pages/{slug}', function($slug) {
    return Http::get("https://yourdomain.com/api/pages?filter[slug]={$slug}")->json();
});

You can configure the API in the config file:

// In your config/filament-page-builder.php
'api' => [
    'enabled' => env('FILAMENT_PAGE_BUILDER_API_ENABLED', true),
    'prefix' => env('FILAMENT_PAGE_BUILDER_API_PREFIX', 'api'),
    'middleware' => ['api'],
],

// Language Switch Settings
'language_switch' => [
    'enabled' => true,
    'locales' => [
        'en' => 'EN',
        // Add more languages as needed
    ],
    'default_locale' => 'en',
],

Requirements

PHP 8.2 or higher (including PHP 8.4)
Laravel 10.0 or higher
Filament 3.2 or higher
Spatie Laravel Query Builder 6.3 or higher (for API functionality)

Playground (In-Repo Example App)

A full Laravel app is available at ./playground for live development and testing via a Composer path repository. Changes to the plugin code are reflected immediately in the playground.

Quick Start

Requirements
- MySQL running locally
- Update playground/.env DB credentials if needed (defaults: DB_DATABASE=filament_playground, DB_USERNAME=root, DB_PASSWORD=)
Setup
- Run the setup script:
```
./bin/setup-playground
```
  This will install dependencies, publish the plugin config and migrations, run migrations, and seed demo data (including an admin user).
Use
- Start the app from the playground directory:
```
php artisan serve
```
- Admin Panel: http://localhost:8000/admin
  - Login: admin@example.com
  - Password: password
- API Endpoint: http://localhost:8000/api/pages

Developer Workflow

The playground consumes this plugin via a Composer path repository ("url": "../"), so code edits in src/ are reflected without re-install.

If you change service providers, config, or migrations, re-run the setup steps as needed:

php artisan vendor:publish --provider="Threls\\FilamentPageBuilder\\PageBuilderServiceProvider" --tag="filament-page-builder-config" --force
php artisan vendor:publish --provider="Threls\\FilamentPageBuilder\\PageBuilderServiceProvider" --tag="filament-page-builder-migrations" --force
php artisan migrate --force
php artisan db:seed --force

To reset demo data during development, you can truncate the pages tables or create additional seeders tailored to your needs.

Troubleshooting

If the panel isn’t accessible, ensure the provider is registered in playground/bootstrap/providers.php:

return [
    App\Providers\AppServiceProvider::class,
    App\Providers\Filament\AdminPanelProvider::class,
];

If publishing fails, confirm the plugin service provider class name and tags match your local code.
Ensure MySQL credentials in playground/.env are correct and the database exists.

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

License

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

threls / filament-page-builder

Maintainers

Details