Icons

Where Lathe takes an icon, it takes a Lathe\Enums\Icon case. A case gives you autocompletion in your editor and a PHP error at the typo, not a blank square in the panel.

use Lathe\Enums\Icon;

MenuItem::resource('posts')->icon(Icon::FileText);

Note: Resources are discovered when the app boots. A case that does not exist stops the whole panel, not only the Resource that used it: Error: Undefined constant Lathe\Enums\Icon::Document. Check the name in the table below. There is no Icon::Document (use Icon::FileText) and no Icon::CurrencyDollar (use Icon::DollarSign).

The cases follow the Lucide icon set. A case is the PascalCase form of a Lucide name, and its value is the kebab-case name. Where an API takes a string, pass the value: Icon::ShieldCheck->value is 'shield-check'.

Where icons are used

These take an Icon case:

// Menu sections, groups and items
MenuSection::section('Content', [...])->icon(Icon::FileText);
MenuItem::link('Reports', 'pages/reports')->icon(Icon::BarChart);

// A dashboard
$dashboard->icon(Icon::LayoutDashboard);

// A value widget and a metric table row
$widget->icon(Icon::ShoppingCart);

// A layout tab
Tab::make('Billing', [...])->icon(Icon::CreditCard);

// A notification, and its action buttons
(new LatheNotification)->actionButton('Download', $url, Icon::Download);

On a dashboard class, the #[Icon] attribute has the same name as the enum, so alias the enum:

use Lathe\Attributes\Dashboard\Icon;
use Lathe\Enums\Icon as IconName;

#[Icon(IconName::LayoutDashboard)]
class Main extends Dashboard {}

These take the Lucide name as a string, so you may pass an enum value or any Lucide name:

$definition->icon(Icon::ShoppingCart->value);   // a Resource's sidebar icon
(new SendWelcomeEmail)->icon('mail');            // an action
Field::badge('Status')->icons(['active' => 'check']);

All icons

All 156 cases, in alphabetical order:

What you see

The icon you name goes with the menu entry, widget, tab or action that carries it. A case that is not in the table throws a PHP Error before the panel renders.