Configuration

Laravel Page Builder is configured through the config/pagebuilder.php file, published to your application during installation.

php artisan vendor:publish --tag=pagebuilder-config

Editor & Routing Configuration

prefix

• Type: string
• Default: env('PAGEBUILDER_PREFIX', 'pagebuilder')

Base URL path for the page builder editor interface and internal API routes (e.g. /pagebuilder).

'prefix' => env('PAGEBUILDER_PREFIX', 'pagebuilder'),

basePath

• Type: string
• Default: env('PAGEBUILDER_BASE_PATH', '/')

The root URL prefix for dynamic public pages rendered by the page builder (e.g. /home, /about).

'basePath' => env('PAGEBUILDER_BASE_PATH', '/'),

preserved_params

• Type: array
• Default: []

Additional query parameters to preserve during editor navigation and frame reloads (e.g., utm_source, ref).

'preserved_params' => [
    // 'ref',
    // 'utm_source',
],

Storage Paths

pages

• Type: string
• Default: resource_path('views/pages')

Path to the directory storing dynamic page JSON data files.

'pages' => resource_path('views/pages'),

sections

• Type: string
• Default: resource_path('views/sections')

Path to the directory storing section Blade templates (.blade.php).

'sections' => resource_path('views/sections'),

blocks

• Type: string
• Default: resource_path('views/blocks')

Path to the directory storing theme block Blade templates (.blade.php).

'blocks' => resource_path('views/blocks'),

templates

• Type: string
• Default: resource_path('views/templates')

Path to the directory storing page layout JSON template files.

'templates' => resource_path('views/templates'),

Middleware & Security

middleware

• Type: array
• Default: ['web']

Middleware pipeline applied to page builder editor and API routes. Add authentication middleware here to restrict builder access.

'middleware' => [
    'web',
    // 'auth',
],

Asset Storage

disk

• Type: string
• Default: env('PAGEBUILDER_DISK', 'public')

Filesystem disk (configured in config/filesystems.php) used for uploaded media and images.

'disk' => env('PAGEBUILDER_DISK', 'public'),

asset_directory

• Type: string
• Default: env('PAGEBUILDER_ASSET_DIRECTORY', 'pagebuilder')

Directory path within the selected storage disk where uploaded files are stored.

'asset_directory' => env('PAGEBUILDER_ASSET_DIRECTORY', 'pagebuilder'),

Reserved Routes

preserved_pages

• Type: array
• Default: ['home', 'admin', 'user', 'api', 'storage', 'uploads', 'files', 'vendor']

Reserved URL slugs that cannot be assigned to dynamic pages created in the builder to prevent route collisions.

'preserved_pages' => [
    'home',
    'admin',
    'user',
    'api',
    'storage',
    'uploads',
    'files',
    'vendor',
],

Multilanguage

languages

• Type: array
• Default: []

Define available languages for multilanguage page editing. When non-empty, a language selector appears in the editor header. The first entry is treated as the default language. Pages are stored as {slug}.{code}.json (e.g., home.fr.json).

'languages' => [
    ['code' => 'en', 'name' => 'English'],   // default language
    ['code' => 'fr', 'name' => 'Français'],
    ['code' => 'es', 'name' => 'Español'],
],

Language array fields:

Field	Required	Description
code	Yes	Language code used in filenames (e.g. fr)
name	Yes	Display name shown in the editor (e.g. Français)

When languages is empty, multilanguage is disabled and no language selector appears.

How it works

When a language is set (e.g. fr), the system resolves files in this order:

1. pages/{slug}.fr.json — locale-specific page JSON
2. pages/{slug}.json — fallback to default

The same applies to custom Blade views and templates:

1. pages/{slug}.fr.blade.php → pages/{slug}.blade.php
2. templates/page.fr.json → templates/page.json

Setting the language

use PageBuilder\PageBuilder;

// Set language for the current request
PageBuilder::setLang('fr');

// Get the current language (null = default)
$lang = PageBuilder::getLang();

// Reset to default language
PageBuilder::setLang(null);

Middleware

The lang middleware alias is registered automatically:

// Route-level language
Route::get('/fr/{slug}', [WebPageController::class, 'pages'])
    ->middleware('lang:fr');

// Group middleware
Route::middleware(['lang:fr'])->group(function () {
    // All pages in this group resolve French locale files
});

The SetLangMiddleware reads the language from a route parameter or ?lang= query parameter.

Theme Settings

theme_settings_path

• Type: string
• Default: resource_path('settings.json')

Path to the JSON file where global theme setting values are persisted.

'theme_settings_path' => resource_path('settings.json'),

theme_settings_schema

• Type: array
• Default: Defined in config/pagebuilder.php (Colors, Typography, Radius & Shape)

Schema definition for global design tokens editable via the builder side panel. Each item defines a group containing setting fields.

'theme_settings_schema' => [
    [
        'name' => 'Colors',
        'settings' => [
            [
                'key'     => 'colors.primary',
                'label'   => 'Primary',
                'type'    => 'color',
                'mode'    => 'hsl',
                'default' => 'hsl(168 94% 7%)',
                'css_var' => '--color-primary',
            ],
        ],
    ],
    [
        'name' => 'Typography',
        'settings' => [
            [
                'key'     => 'fonts.body',
                'label'   => 'Body font',
                'type'    => 'google_font',
                'default' => 'Instrument Sans, Inter, sans-serif',
                'css_var' => '--font-body',
            ],
        ],
    ],
],

Setting Schema Fields:

Field	Required	Description
key	Yes	Dot-notation key used for storage (e.g. colors.primary)
label	Yes	Field label displayed in the editor sidebar
type	Yes	Field input type (color, text, select, google_font)
mode	No	Color format mode if type is color (e.g. hsl)
default	Yes	Fallback value when no custom value is saved
css_var	No	CSS variable updated dynamically in the preview (e.g. --color-primary)

Environment Variables

The package configuration supports environment variable overrides for common settings:

PAGEBUILDER_PREFIX=pagebuilder
PAGEBUILDER_BASE_PATH=/
PAGEBUILDER_DISK=public
PAGEBUILDER_ASSET_DIRECTORY=pagebuilder

Variable	Config Key	Default Value	Description
PAGEBUILDER_PREFIX	prefix	'pagebuilder'	Editor and API URL route prefix
PAGEBUILDER_BASE_PATH	basePath	'/'	Base URL path for dynamic public pages
PAGEBUILDER_DISK	disk	'public'	Storage disk for uploaded media assets
PAGEBUILDER_ASSET_DIRECTORY	asset_directory	'pagebuilder'	Subfolder inside the disk for uploads