Configuration and navigation

OddenPlugin has no configuration of its own. It has no fluent options, no config file and no environment variables. What it registers depends only on which Odden packages are installed. You change the rest (the panel path, how navigation groups are ordered, colors and so on) on the Filament panel itself.

Plugin API#

Odden\Filament\OddenPlugin implements Filament\Contracts\Plugin and exposes only:

There are no methods for turning individual modules, resources or pages on or off. If you need a smaller panel, register the resources yourself instead of using the plugin. See Customizing and extending.

How modules are detected#

When the panel is registered, OddenPlugin::register() checks whether one model class from each optional module exists:

Resources live in Odden\Filament\Resources and pages in Odden\Filament\Pages.

The check only asks whether the package's code is autoloadable. It doesn't check that the module's service provider booted or that its migrations ran, so run each module's migrations as soon as you install it. Otherwise its pages fail with missing-table errors.

The same checks apply inside the core resources:

• The contact and company Associated Deals relation managers only appear when sales is installed.
• The contact Sales Sequences & Cadences relation manager only appears when sales is installed.
• The contact Marketing Campaigns & Email Touchpoints, Lead Capture & Form Submissions and Lead Score & Decay History relation managers only appear when marketing is installed.
• The contact Playbook and Auto-Route actions only appear when sales is installed.
• The company Recalculate Intent action only appears when marketing is installed.
• The Executive Overview shows zeros for the sales, service and marketing metrics of modules that are not installed.

Navigation groups#

The plugin uses plain string navigation groups:

Sales and Marketing each have an item labelled Email Templates. The Sales one manages SalesEmailTemplate records used by cadences, and the Marketing one manages MarketingTemplate records used by campaigns.

Ordering the groups#

To control the order of the groups in the sidebar, list them on the panel with Filament's navigationGroups(). The labels must match exactly:

use Odden\Filament\OddenPlugin;

return $panel
    // ...
    ->plugins([
        OddenPlugin::make(),
    ])
    ->navigationGroups([
        'Executive',
        'CRM',
        'Sales',
        'Service',
        'Marketing',
        'Settings',
    ]);

You can also pass Filament\Navigation\NavigationGroup objects with the same labels to make groups collapsible or give them icons. Item order within a group comes from each resource's or page's $navigationSort, which the plugin hard-codes. To change it, see Customizing and extending.

URLs and route names#

Resource and page URLs sit under your panel's path. With a panel whose ID and path are both admin:

Resources also have create, edit and, where they exist, view routes (/admin/contacts/create, /admin/contacts/{record}/edit, /admin/contacts/{record}). Resources lists which pages each resource has.

Pages use filament.admin.pages.{slug}:

To build URLs in code, use Filament's helpers rather than hard-coding paths:

use Odden\Filament\Pages\SalesCockpit;
use Odden\Filament\Resources\DealResource;

$board = DealResource::getUrl('board');
$deal = DealResource::getUrl('view', ['record' => $deal]);
$cockpit = SalesCockpit::getUrl();

Using more than one panel#

You can register OddenPlugin::make() on several panels. Each panel gets its own copy of the resources and pages under its own path and route prefix (filament.{panel-id}.…).