From 9d17cc279ad78d5e0d6d4dcb720ae407ed31dd75 Mon Sep 17 00:00:00 2001 From: Liam Hammett Date: Thu, 17 Jul 2025 11:04:37 +0100 Subject: [PATCH] Update "Replacing the default icons" docs to use enums instead of strings --- docs/08-styling/04-icons.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/08-styling/04-icons.md b/docs/08-styling/04-icons.md index 362e3fd627..c4e625499a 100644 --- a/docs/08-styling/04-icons.md +++ b/docs/08-styling/04-icons.md @@ -92,10 +92,11 @@ To replace an icon, you can use the `FilamentIcon` facade. It has a `register()` ```php use Filament\Support\Facades\FilamentIcon; +use Filament\View\PanelsIconAlias; FilamentIcon::register([ - 'PanelsIconAlias::GLOBAL_SEARCH_FIELD' => 'fas-magnifying-glass', - 'PanelsIconAlias::SIDEBAR_GROUP_COLLAPSE_BUTTON' => view('icons.chevron-up'), + PanelsIconAlias::GLOBAL_SEARCH_FIELD => 'fas-magnifying-glass', + PanelsIconAlias::SIDEBAR_GROUP_COLLAPSE_BUTTON => view('icons.chevron-up'), ]); ``` @@ -103,6 +104,8 @@ FilamentIcon::register([ ### Actions icon aliases +Using class `Filament\Actions\View\ActionsIconAlias` + - `ActionsIconAlias::ACTION_GROUP` - Trigger button of an action group - `ActionsIconAlias::CREATE_ACTION_GROUPED` - Trigger button of a grouped create action - `ActionsIconAlias::DELETE_ACTION` - Trigger button of a delete action @@ -130,6 +133,8 @@ FilamentIcon::register([ ### Forms icon aliases +Using class `Filament\Forms\View\FormsIconAlias` + - `FormsIconAlias::COMPONENTS_BUILDER_ACTIONS_CLONE` - Trigger button of a clone action in a builder item - `FormsIconAlias::COMPONENTS_BUILDER_ACTIONS_COLLAPSE` - Trigger button of a collapse action in a builder item - `FormsIconAlias::COMPONENTS_BUILDER_ACTIONS_DELETE` - Trigger button of a delete action in a builder item @@ -173,11 +178,15 @@ FilamentIcon::register([ ### Infolists icon aliases +Using class `Filament\Infolists\View\InfolistsIconAlias` + - `InfolistsIconAlias::COMPONENTS_ICON_ENTRY_FALSE` - Falsy state of an icon entry - `InfolistsIconAlias::COMPONENTS_ICON_ENTRY_TRUE` - Truthy state of an icon entry ### Notifications icon aliases +Using class `Filament\Notifications\View\NotificationsIconAlias` + - `NotificationsIconAlias::DATABASE_MODAL_EMPTY_STATE` - Empty state of the database notifications modal - `NotificationsIconAlias::NOTIFICATION_CLOSE_BUTTON` - Button to close a notification - `NotificationsIconAlias::NOTIFICATION_DANGER` - Danger notification @@ -187,6 +196,8 @@ FilamentIcon::register([ ### Panels icon aliases +Using class `Filament\View\PanelsIconAlias` + - `PanelsIconAlias::GLOBAL_SEARCH_FIELD` - Global search field - `PanelsIconAlias::PAGES_DASHBOARD_ACTIONS_FILTER` - Trigger button of the dashboard filter action - `PanelsIconAlias::PAGES_DASHBOARD_NAVIGATION_ITEM` - Dashboard page navigation item @@ -219,10 +230,14 @@ FilamentIcon::register([ ### Schema icon aliases +Using class `Filament\Schemas\View\SchemaIconAlias` + - `SchemaIconAlias::COMPONENTS_WIZARD_COMPLETED_STEP` - Completed step in a wizard ### Tables icon aliases +Using class `Filament\Tables\View\TablesIconAlias` + - `TablesIconAlias::ACTIONS_DISABLE_REORDERING` - Trigger button of the disable reordering action - `TablesIconAlias::ACTIONS_ENABLE_REORDERING` - Trigger button of the enable reordering action - `TablesIconAlias::ACTIONS_FILTER` - Trigger button of the filter action @@ -249,6 +264,8 @@ FilamentIcon::register([ ### UI components icon aliases +Using class `Filament\Support\View\SupportIconAlias` + - `SupportIconAlias::BADGE_DELETE_BUTTON` - Button to delete a badge - `SupportIconAlias::BREADCRUMBS_SEPARATOR` - Separator between breadcrumbs - `SupportIconAlias::BREADCRUMBS_SEPARATOR_RTL` - Separator between breadcrumbs (right-to-left direction) @@ -265,4 +282,6 @@ FilamentIcon::register([ ### Widgets icon aliases +Using class `Filament\Widgets\View\WidgetsIconAlias` + - `WidgetsIconAlias::CHART_WIDGET_FILTER` - Button of the filter action