feature #6537 Allow to use different icon sets in the backend (javier…

…eguiluz)

This PR was squashed before being merged into the 4.x branch.

Discussion
----------

Allow to use different icon sets in the backend

**UPDATE**: I changed the feature behavior completely since the first implementation. We no longer include the entire Tabler icon set (it took more than 22 MB of disk space) but the feature is still flexible and allows you to use any custom icon set, including tabler.

-----

This feature is the first that uses a Twig Component. I hope to add many other components soon.

Thanks `@yceruto` for publishing a fantastic article about how to use Twig Components in bundles: https://dev.to/yceruto/bundling-your-symfony-ux-twig-components-4997

Commits
-------

ce03ecc Allow to use different icon sets in the backend

UPGRADE.md

@@ -1,6 +1,19 @@
 Upgrade between EasyAdmin 4.x versions
 ======================================
 
+EasyAdmin 4.16.0
+----------------
+
+### FontAwesome Icons Are Now Inlined as SVGs
+
+As part of the new feature that allows to use custom icon sets, the FontAwesome
+icons included by default in EasyAdmin are now inlined as SVGs. The font files
+(.ttf, .woff2) and the CSS file that loads the icons have been removed.
+
+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.
+
 EasyAdmin 4.14.0
 ----------------
 

assets/css/app.css

@@ -1,7 +1,3 @@
 @import "~bootstrap/dist/css/bootstrap.min.css";
 
-@import "~@fortawesome/fontawesome-free/css/all.css";
-@import "~@fortawesome/fontawesome-free/css/v4-shims.css";
-@import "~@fortawesome/fontawesome-free/css/v5-font-face.css";
-
 @import "./easyadmin-theme/theme.css";

assets/css/easyadmin-theme/base.css

@@ -25,6 +25,22 @@ i.fal {
 i.fad {
     font-family: 'Font Awesome 6 Duotone' !important;
 }
+span.icon {
+    display: inline-block;
+    inline-size: 1.25em;
+    text-align: center;
+}
+span.icon svg {
+    inline-size: 100%;
+    block-size: 100%;
+    max-block-size: 1em;
+    max-inline-size: 1em;
+    vertical-align: text-bottom;
+}
+body[data-ea-icon-prefix="tabler"] span.icon svg {
+    max-block-size: 1.15em;
+    max-inline-size: 1.15em;
+}
 
 a {
     color: var(--link-color);
@@ -203,17 +219,14 @@ a.user-menu-wrapper .user-details:hover {
 }
 
 .user-menu-wrapper .user-avatar {
+    background: var(--user-avatar-icon-bg);
     border-radius: var(--border-radius);
+    color: var(--user-avatar-icon-color);
     display: block;
-}
-.user-menu-wrapper span.user-avatar .fa-stack { border-radius: var(--border-radius); font-size: 14px; vertical-align: middle; inline-size: 2em; }
-.user-menu-wrapper span.user-avatar .user-avatar-icon-background { color: var(--user-avatar-icon-bg); }
-.user-menu-wrapper span.user-avatar .user-avatar-icon-foreground { color: var(--user-avatar-icon-color); }
-.user-menu-wrapper img.user-avatar {
-    border: 1px solid var(--user-menu-border-color);
     block-size: 21px;
     max-inline-size: 21px;
-    inline-size: auto;
+    inline-size: 2em;
+    text-align: center;
 }
 
 .user-menu-wrapper .dropdown-menu {
@@ -226,20 +239,15 @@ a.user-menu-wrapper .user-details:hover {
     padding: 0 5px;
 }
 .user-menu-wrapper .dropdown-menu .dropdown-user-details .user-avatar {
-    margin-inline-end: 10px;
-}
-.user-menu-wrapper .dropdown-menu .dropdown-user-details span.user-avatar .fa-stack {
-    font-size: 24px;
-}
-.user-menu-wrapper .dropdown-menu .dropdown-user-details span.user-avatar .fa-stack .user-avatar-icon-background { font-size: 48px; }
-.user-menu-wrapper .dropdown-menu .dropdown-user-details span.user-avatar .fa-stack .user-avatar-icon-foreground { font-size: 24px; }
-.user-menu-wrapper .dropdown-menu .dropdown-user-details span.user-avatar .fa-stack i { block-size: 48px; inline-size: 48px; margin: 0; }
-.user-menu-wrapper .dropdown-menu .dropdown-user-details img.user-avatar {
     block-size: 39px;
     max-inline-size: 39px;
     margin-block-start: 2px;
+    margin-inline-end: 10px;
     inline-size: auto;
 }
+.user-menu-wrapper .dropdown-menu .dropdown-user-details .user-avatar .icon {
+    font-size: 25px;
+}
 .user-menu-wrapper .dropdown-menu .dropdown-user-details .user-label {
     color: var(--text-muted);
     display: block;
@@ -272,7 +280,8 @@ a.user-menu-wrapper .user-details:hover {
     box-shadow: var(--dropdown-settings-active-item-shadow);
     color: var(--dropdown-settings-active-item-color);
 }
-.dropdown-settings .dropdown-item.active i {
+.dropdown-settings .dropdown-item.active i,
+.dropdown-settings .dropdown-item.active .icon {
     color: var(--dropdown-settings-active-item-color);
 }
 
@@ -699,7 +708,8 @@ a.user-menu-wrapper .user-details:hover {
 .dropdown-menu a:hover {
     background: var(--dropdown-link-hover-bg);
 }
-.dropdown-menu i {
+.dropdown-menu i,
+.dropdown-menu .icon {
     color: var(--dropdown-icon-color);
     margin: 0 10px 0 4px;
     font-size: 15px;
@@ -770,6 +780,9 @@ a.user-menu-wrapper .user-details:hover {
         margin-block-start: 15px;
     }
 }
+.page-item .page-link {
+    white-space: nowrap;
+}
 .page-item.active .page-link, .page-item.active .page-link:hover {
     background: var(--pagination-active-bg);
     border-color: var(--pagination-active-bg);
@@ -796,9 +809,6 @@ a.user-menu-wrapper .user-details:hover {
 .page-item .page-link:hover {
     border-color: var(--pagination-hover-border-color);
 }
-.pager .page-item i {
-    vertical-align: middle;
-}
 
 @media (max-inline-size: 768px) {
     .pager .page-item:not(.page-item-previous, .page-item-next, .page-item.active) {

assets/css/easyadmin-theme/datagrids.css

@@ -79,7 +79,7 @@ table.datagrid {
   box-shadow: inset 0 -2px 0 var(--table-cell-border-color);
   padding: 0;
 }
-.datagrid thead a, .datagrid thead span {
+.datagrid thead a, .datagrid thead > span {
   color: var(--table-thead-color);
   display: block;
   font-weight: 500;
@@ -106,7 +106,8 @@ table.datagrid {
 .datagrid thead .sorted a, .datagrid thead .sorted span {
   font-weight: 700;
 }
-.datagrid thead i {
+.datagrid thead i,
+.datagrid thead .icon {
   color: var(--table-thead-marker-color);
   margin-inline-start: 2px;
 }
@@ -116,8 +117,10 @@ table.datagrid {
 .datagrid thead .sorted a, .datagrid thead .sorted span {
   color: var(--table-thead-sorted-color);
 }
-.datagrid thead .sorted i {
+.datagrid thead .sorted i,
+.datagrid thead .sorted .icon {
   color: var(--table-thead-sorted-marker-color);
+  display: inline-block;
 }
 .datagrid th, .datagrid td {
   border: none;
@@ -349,7 +352,7 @@ table.datagrid {
   border-radius: var(--border-radius);
   padding: 15px;
 }
-.action-filters-button i {
+.action-filters-button .icon {
   color: var(--text-color-light);
 }
 .action-filters-button.action-filters-applied i {

assets/css/easyadmin-theme/menu.css

@@ -45,7 +45,7 @@
 }
 
 #main-menu .menu .menu-item.active:not(.expanded) a,
-#main-menu .menu .menu-item.active:not(.expanded) .menu-icon {
+#main-menu .menu .menu-item.active:not(.expanded) .menu-icon svg {
     color: var(--sidebar-menu-active-item-color);
 }
 
@@ -60,8 +60,6 @@
 
 #main-menu .menu .menu-item .submenu-toggle .submenu-toggle-icon {
     color: var(--sidebar-menu-icon-color);
-    position: relative;
-    inset-block-start: 5px;
     transition: transform 0.25s ease;
     inline-size: auto; /* this is needed to make it look better */
 }
@@ -75,11 +73,16 @@
 
 #main-menu .menu .menu-icon {
     color: var(--sidebar-menu-icon-color);
-    font-size: var(--font-size-lg);
     margin-inline-end: 10px;
-    transform: translateY(3px);
+    text-align: center;
     block-size: 16px;
-    inline-size: 20px;
+    inline-size: 1.25em;
+}
+#main-menu .menu .menu-icon svg {
+    color: var(--sidebar-menu-icon-color);
+    max-block-size: 16px;
+    max-inline-size: 20px;
+    vertical-align: sub;
 }
 
 #main-menu .menu .menu-item-badge {

assets/icons/fa6-brands/LICENSE.txt

@@ -0,0 +1,165 @@
+Fonticons, Inc. (https://fontawesome.com)
+
+--------------------------------------------------------------------------------
+
+Font Awesome Free License
+
+Font Awesome Free is free, open source, and GPL friendly. You can use it for
+commercial projects, open source projects, or really almost whatever you want.
+Full Font Awesome Free license: https://fontawesome.com/license/free.
+
+--------------------------------------------------------------------------------
+
+# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
+
+The Font Awesome Free download is licensed under a Creative Commons
+Attribution 4.0 International License and applies to all icons packaged
+as SVG and JS file types.
+
+--------------------------------------------------------------------------------
+
+# Fonts: SIL OFL 1.1 License
+
+In the Font Awesome Free download, the SIL OFL license applies to all icons
+packaged as web and desktop font files.
+
+Copyright (c) 2024 Fonticons, Inc. (https://fontawesome.com)
+with Reserved Font Name: "Font Awesome".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+SIL OPEN FONT LICENSE
+Version 1.1 - 26 February 2007
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting — in part or in whole — any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+# Code: MIT License (https://opensource.org/licenses/MIT)
+
+In the Font Awesome Free download, the MIT license applies to all non-font and
+non-icon files.
+
+Copyright 2024 Fonticons, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+# Attribution
+
+Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
+Awesome Free files already contain embedded comments with sufficient
+attribution, so you shouldn't need to do anything additional when using these
+files normally.
+
+We've kept attribution comments terse, so we ask that you do not actively work
+to remove them from files, especially code. They're a great way for folks to
+learn about Font Awesome.
+
+--------------------------------------------------------------------------------
+
+# Brand Icons
+
+All brand icons are trademarks of their respective owners. The use of these
+trademarks does not indicate endorsement of the trademark holder by Font
+Awesome, nor vice versa. **Please do not use brand logos for any purpose except
+to represent the company, product, or service to which they refer.**