Banner System

Banners display important notifications at the top of the application. They can be static messages or dynamic components. Only one banner is visible at a time: the highest-priority banner the user has not dismissed.

File Location

app-configs/banner.yml

Configuration

banners:
  - priority: 100
    type: danger
    message: "Important maintenance tonight!"
    dismissible: false

  - priority: 50
    type: warning
    component: banner.demo-expiry
    dismissible: true

  - priority: 10
    type: info
    message: "New features available!"
    dismissible: true

Banner Properties

Property	Description
priority	Required — entries without a priority are ignored. The highest-priority active banner is shown
type	Visual style: danger, warning, info, success
message	Static text message
component	Dynamic Livewire component (alternative to message)
dismissible	Allow users to close the banner

Banner Types

Type	Color	Use Case
danger	Red	Critical issues, system errors
warning	Yellow	Important notices, expiring features
info	Blue	General information, announcements
success	Green	Positive confirmations

Static vs Dynamic Banners

Static Banner: Use message for simple text.

- priority: 100
  type: danger
  message: "System maintenance at 2 AM"
  dismissible: false

Dynamic Banner: Use component for complex logic.

- priority: 50
  type: warning
  component: banner.demo-expiry
  dismissible: true

Creating a Dynamic Component

Components are placed in your module's views directory and referenced with the banner.{name} prefix:

app-modules/{module}/resources/views/components/banner/{name}.blade.php

Example: Demo Expiry Banner

app-modules/my-module/resources/views/components/banner/demo-expiry.blade.php

<?php

use Livewire\Component;
use Noerd\Helpers\TenantHelper;

new class extends Component {
    public string $message = '';

    public function mount(): void
    {
        $tenant = TenantHelper::getSelectedTenant();
        $daysRemaining = 0;

        if ($tenant && isset($tenant->demo_expires_at)) {
            $daysRemaining = now()->diffInDays($tenant->demo_expires_at, false);
            $daysRemaining = max(0, (int) $daysRemaining);
        }

        $this->message = __('Your demo expires in :days days', ['days' => $daysRemaining]);
    }
}; ?>

<span>{{ $message }}</span>

Translation labels use English text as the key; add the German mapping to the module's de.json (e.g. "Your demo expires in :days days": "Ihre Demo läuft in :days Tagen ab").

Key Concepts

• Single active banner: When multiple banners are configured, only the highest-priority non-dismissed banner renders. Dismissing it reveals the next one
• Component prefix: Use banner.{name} to reference components in the banner/ subdirectory
• Dismissible banners: Users can close them; the dismissal is stored in the session (dismissed_banners) and resets on the next login/session
• Non-dismissible banners: Always visible until removed from the configuration