minor #6578 Misc tweaks related to icons (javiereguiluz)

This PR was merged into the 4.x branch.

Discussion
----------

Misc tweaks related to icons

Commits
-------

b49c4df Misc tweaks related to icons

Author: javiereguiluz

UPGRADE.md

@@ -12,7 +12,22 @@ icons included by default in EasyAdmin are now inlined as SVGs. The font files
 
 This doesn't require any change on your side, unless you were relying on the
 FontAwesome CSS classes to style the icons, which is something undocumented and
-not recommended.
+not recommended. In that case, replace the `fa-*` CSS classes by the new Twig
+Component that renders icons:
+
+```twig
+{# Before: #}
+<i class="fa-regular fa-user"></i>
+<i class="far fa-user"></i>
+<i class="fa-solid fa-tags"></i>
+<i class="fas fa-tags"></i>
+
+{# After: #}
+<twig:ea:Icon name="fa6-regular:user" />
+<twig:ea:Icon name="fa6-regular:user" />
+<twig:ea:Icon name="fa6-solid:tags" />
+<twig:ea:Icon name="fa6-solid:tags" />
+```
 
 EasyAdmin 4.14.0
 ----------------

doc/dashboards.rst

@@ -537,11 +537,11 @@ the second argument is the icon to display. The icon name follows the pattern
     (``fa6-regular:``, ``fa6-solid:`` and ``fa6-brands:``), but you can
     :ref:`use your own icon sets <icon-customization>`.
 
-    .. deprecated:: 4.16
+.. deprecated:: 4.16
 
-        In EasyAdmin versions prior to 4.16.0, the icon name was defined as the full
-        FontAwesome CSS class: e.g., ``fa-regular fa-user``. This syntax is now
-        deprecated and will be removed in EasyAdmin 5.0.0.
+    In EasyAdmin versions prior to 4.16.0, the icon name was defined as the full
+    FontAwesome CSS class: e.g., ``fa-regular fa-user`` or ``far fa-user``.
+    This syntax is now deprecated and will be removed in EasyAdmin 5.0.0.
 
 Menu Item Configuration Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/design.rst

@@ -63,7 +63,7 @@ icons), pass it to the ``useCustomIconSet()`` method::
 
     return Assets::new()->useCustomIconSet('tabler');
 
-Now, the `tabler:`` prefix will be added automatically to all your custom icon
+Now, the ``tabler:`` prefix will be added automatically to all your custom icon
 names. This way, you can use names like ``user`` and ``file`` instead of
 ``tabler:user`` and ``tabler:file``.
 

src/Config/Action.php

@@ -43,7 +43,7 @@ public function __toString()
 
     /**
      * @param TranslatableInterface|string|false|null $label Use FALSE to hide the label; use NULL to autogenerate it
-     * @param string|null                             $icon  The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null                             $icon  The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function new(string $name, $label = null, ?string $icon = null): self
     {

src/Config/MenuItem.php

@@ -22,63 +22,63 @@ private function __construct()
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToCrud(TranslatableInterface|string $label, ?string $icon, string $entityFqcn): CrudMenuItem
     {
         return new CrudMenuItem($label, $icon, $entityFqcn);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToDashboard(TranslatableInterface|string $label, ?string $icon = null): DashboardMenuItem
     {
         return new DashboardMenuItem($label, $icon);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToExitImpersonation(TranslatableInterface|string $label, ?string $icon = null): ExitImpersonationMenuItem
     {
         return new ExitImpersonationMenuItem($label, $icon);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToLogout(TranslatableInterface|string $label, ?string $icon = null): LogoutMenuItem
     {
         return new LogoutMenuItem($label, $icon);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToRoute(TranslatableInterface|string $label, ?string $icon, string $routeName, array $routeParameters = []): RouteMenuItem
     {
         return new RouteMenuItem($label, $icon, $routeName, $routeParameters);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function linkToUrl(TranslatableInterface|string $label, ?string $icon, string $url): UrlMenuItem
     {
         return new UrlMenuItem($label, $icon, $url);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function section(TranslatableInterface|string|null $label = null, ?string $icon = null): SectionMenuItem
     {
         return new SectionMenuItem($label, $icon);
     }
 
     /**
-     * @param string|null $icon The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null $icon The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function subMenu(TranslatableInterface|string $label, ?string $icon = null): SubMenuItem
     {

src/Field/FormField.php

@@ -37,7 +37,7 @@ public static function new(string $propertyName, $label = null)
 
     /**
      * @param TranslatableInterface|string|false|null $label
-     * @param string|null                             $icon  The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null                             $icon  The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function addPanel($label = false, ?string $icon = null): self
     {
@@ -52,7 +52,7 @@ public static function addPanel($label = false, ?string $icon = null): self
 
     /**
      * @param TranslatableInterface|string|false|null $label
-     * @param string|null                             $icon  The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)
+     * @param string|null                             $icon  The full FontAwesome icon name to render (e.g. 'fa6-solid:user', 'fa6-regular:lines') (see https://fontawesome.com/v6/search?m=free)
      */
     public static function addFieldset($label = false, ?string $icon = null): self
     {