README

MoonShine package for managing pages and navigation menus in Laravel applications.

Features

• MoonShine resources for Pages, Menu positions, and Menu items
• Public page route with configurable prefix (/{slug} or /prefix/{slug})
• Configurable model, resource, and controller classes
• Menu items support three source types: direct link, page, or named route
• Dynamic route parameters — placeholders detected from the route URI and saved as JSON
• Optional image per menu item
• menu($code) helper returns a cached nested tree for frontend rendering
• Package view fallback for page rendering
• Reserved-slug protection — prevents the admin prefix from matching the page route
• Localization: en, ru

Requirements

• PHP 8.2+
• Laravel 12+
• moonshine/moonshine 4.8+

Installation

composer require mb4it/moonshine-pages

Run migrations:

php artisan migrate

Publish config, migrations, views, and/or translations as needed:

php artisan vendor:publish --tag=moonshine-pages-config
php artisan vendor:publish --tag=moonshine-pages-migrations
php artisan vendor:publish --tag=moonshine-pages-views
php artisan vendor:publish --tag=moonshine-pages-lang

Configuration

Main config file: config/moonshine-pages.php

Route

'register_page_route' => true,

'route' => [
    'route_prefix'        => '',           // '' → /{slug}, 'landings' → /landings/{slug}
    'name'                => 'page.show',
    'slug_pattern'        => '^[A-Za-z0-9-_]+$',
    'apply_reserved_slugs' => true,        // exclude admin prefix from slug matches
    'reserved_slugs'      => null,         // null = derive from moonshine.prefix
],

Models

Override Eloquent model classes without subclassing the service provider:

'models' => [
    'page'          => \App\Models\Page::class,
    'menu'          => \App\Models\Menu::class,
    'menu_position' => \App\Models\MenuPosition::class,
],

Resources

Override MoonShine resource classes:

'resources' => [
    'menu'          => \App\MoonShine\Resources\MenuResource::class,
    'menu_position' => \App\MoonShine\Resources\MenuPositionResource::class,
    'page'          => \App\MoonShine\Resources\PageResource::class,
],

Tables

Override database table names (publish and edit migrations before first migrate):

'tables' => [
    'pages'              => 'pages',
    'menus'              => 'menus',
    'menu_positions'     => 'menu_positions',
    'menu_menu_position' => 'menu_menu_position',
],

Controllers

'controllers' => [
    'page_show' => \App\Http\Controllers\PageShowController::class,
],

Media

'media' => [
    'disk'      => null,    // null = inherit moonshine.disk
    'image_dir' => 'menu',  // upload directory for menu images
],

MoonShine menu

'moonshine' => [
    'register_menu_items' => true, // set false when building a custom layout
],

Menu source types

Each menu item has a source_type that controls URL generation:

When source_type = route the admin form detects URI placeholders (e.g. {slug}, {id}) in the selected route and renders a text field for each one. Values are saved in menus.route_params (JSON):

{ "slug": "my-article", "id": "42" }

menu() helper

Returns a cached nested tree for a given menu position code:

$items = menu('main');
// [
//   ['id' => 1, 'name' => 'Home', 'url' => '/', 'image' => null, 'target' => null, 'code' => 'main', 'children' => []],
//   ...
// ]

The tree is cached forever. It is automatically invalidated when a Menu model is saved or deleted. If you mutate menu data outside of Eloquent events (bulk updates, raw SQL) call MenuRepository::forget($code) manually.

Localization

UI strings are loaded from the moonshine-pages translation namespace:

• lang/en/moonshine-pages.php
• lang/ru/moonshine-pages.php

Publish to override:

php artisan vendor:publish --tag=moonshine-pages-lang