Add a new Twig component to create Action Menus

EasyCorp · Jan 4, 2025 · da8ece2 · da8ece2
1 parent 996be4b
commit da8ece2
Show file tree

Hide file tree

Showing 20 changed files with 216 additions and 112 deletions.
diff --git a/assets/css/easyadmin-theme/base.css b/assets/css/easyadmin-theme/base.css
@@ -205,6 +205,9 @@ body.ea-mobile-sidebar-visible .sidebar {
     inset-inline-start: 0;
 }
 
+.dropdown-toggle.dropdown-toggle-hidden-marker:after { display: none; }
+.dropdown-toggle.dropdown-toggle-hidden-marker:hover { cursor: pointer; }
+
 .user-menu-wrapper a.user-details,
 a.user-menu-wrapper .user-details:hover {
     align-items: center;
@@ -232,6 +235,9 @@ a.user-menu-wrapper .user-details:hover {
     inline-size: 2em;
     text-align: center;
 }
+.user-menu-wrapper .dropdown-user-details .user-avatar .icon {
+    display: block;
+}
 
 .user-menu-wrapper .dropdown-menu {
     min-inline-size: 200px;
@@ -718,6 +724,9 @@ a.user-menu-wrapper .user-details:hover {
     margin: 0 10px 0 4px;
     font-size: 15px;
 }
+.dropdown-menu .icon {
+    display: inline-flex;
+}
 
 .dropdown-menu .dropdown-item,
 .dropdown-menu .dropdown-header {

diff --git a/assets/css/easyadmin-theme/datagrids.css b/assets/css/easyadmin-theme/datagrids.css
@@ -8,6 +8,10 @@ table.datagrid {
   margin-block-end: 0;
   inline-size: 100%;
 }
+table.datagrid:not(.datagrid-empty) tr:not(.empty-row) td.actions,
+table.datagrid:not(.datagrid-empty) tr:not(.empty-row) td.actions.actions-as-dropdown {
+  min-width: 50px;
+}
 @media (max-width: 767px) {
   table.datagrid:not(.datagrid-empty) tbody,
   table.datagrid:not(.datagrid-empty) tr,
@@ -182,17 +186,22 @@ table.datagrid {
   outline: none;
 }
 
+.datagrid .dropdown-actions {
+  display: inline-block;
+}
 .datagrid .dropdown-actions .dropdown-toggle {
   border: 1px solid transparent;
   border-radius: var(--border-radius);
   color: var(--dropdown-toggle-color);
-  padding: 3px 5px;
+  display: block;
+  padding: 1px 5px;
 }
-/* hides the caret added automatically by Bootstrap */
-.datagrid .dropdown-actions .dropdown-toggle:after { display: none; }
-.datagrid .dropdown-actions .dropdown-toggle:hover { cursor: pointer; }
 
-.datagrid .dropdown-actions .dropdown-toggle svg { vertical-align: top; }
+.datagrid .dropdown-actions .dropdown-toggle .icon {
+  display: block;
+  font-size: 21px;
+  inline-size: unset;
+}
 
 .datagrid .dropdown-actions .dropdown-menu { z-index: var(--zindex-900); }
 

diff --git a/assets/icons/internal/dots-horizontal.svg b/assets/icons/internal/dots-horizontal.svg
diff --git a/composer.json b/composer.json
@@ -37,6 +37,8 @@
         "symfony/uid": "^5.4|^6.0|^7.0",
         "symfony/ux-twig-component": "^2.21",
         "symfony/validator": "^5.4|^6.0|^7.0",
+        "twig/extra-bundle": "^3.17",
+        "twig/html-extra": "^3.17",
         "twig/twig": "^3.15"
     },
     "require-dev": {

diff --git a/public/app.25fa02d0.css → public/app.62f32d02.css b/public/app.25fa02d0.css → public/app.62f32d02.css
diff --git a/public/entrypoints.json b/public/entrypoints.json
@@ -2,7 +2,7 @@
   "entrypoints": {
     "app": {
       "css": [
-        "/app.25fa02d0.css"
+        "/app.62f32d02.css"
       ],
       "js": [
         "/app.1ecd6d7a.js"

diff --git a/public/manifest.json b/public/manifest.json
@@ -1,5 +1,5 @@
 {
-  "app.css": "app.25fa02d0.css",
+  "app.css": "app.62f32d02.css",
   "app.js": "app.1ecd6d7a.js",
   "form.js": "form.bcec6c2a.js",
   "page-layout.js": "page-layout.3347892e.js",

diff --git a/src/DependencyInjection/EasyAdminExtension.php b/src/DependencyInjection/EasyAdminExtension.php
@@ -50,5 +50,17 @@ public function prepend(ContainerBuilder $builder): void
                 ],
             ],
         ]);
+
+        $bundleTemplatesOverrideDir = $builder->getParameter('kernel.project_dir').'/templates/bundles/EasyAdminBundle/';
+        $builder->prependExtensionConfig('twig', [
+            'paths' => is_dir($bundleTemplatesOverrideDir)
+                ? [
+                    'templates/bundles/EasyAdminBundle/' => 'ea',
+                    \dirname(__DIR__).'/../templates/' => 'ea',
+                ]
+                : [
+                    \dirname(__DIR__).'/../templates/' => 'ea',
+                ],
+        ]);
     }
 }
diff --git a/templates/components/ActionMenu.html.twig b/templates/components/ActionMenu.html.twig
@@ -0,0 +1,7 @@
+{# ActionMenu is a component to create dropdowns of related actions.
+   It defines several sub-components (Overlay, ActionList, etc.)
+   Inspired by https://primer.style/components/action-menu
+#}
+<div {{ attributes.defaults({class: 'dropdown'}) }}>
+    <twig:block name="content"></twig:block>
+</div>
diff --git a/templates/components/ActionMenu/ActionList.html.twig b/templates/components/ActionMenu/ActionList.html.twig
@@ -0,0 +1,3 @@
+<ul {{ attributes.defaults({class: 'dropdown-menu dropdown-menu-end'}) }}>
+    <twig:block name="content"></twig:block>
+</ul>
diff --git a/templates/components/ActionMenu/ActionList/Content.html.twig b/templates/components/ActionMenu/ActionList/Content.html.twig
@@ -0,0 +1,3 @@
+<li {{ attributes }}>
+    <twig:block name="content"></twig:block>
+</li>
diff --git a/templates/components/ActionMenu/ActionList/Divider.html.twig b/templates/components/ActionMenu/ActionList/Divider.html.twig
@@ -0,0 +1 @@
+<li class="dropdown-divider"></li>
diff --git a/templates/components/ActionMenu/ActionList/Header.html.twig b/templates/components/ActionMenu/ActionList/Header.html.twig
@@ -0,0 +1,13 @@
+{% props
+    label = null,
+    renderLabelRaw = false,
+    icon = null,
+    htmlAttributes = {},
+%}
+
+{% if label is not empty or icon is not empty %}
+    <li {{ attributes.defaults({class: 'dropdown-header'}|merge(htmlAttributes)) }}>
+        {%- if icon %}<twig:ea:Icon {{ ...attributes.nested('icon').defaults({name: icon}) }} /> {% endif -%}
+        {%- if label is not empty -%}<span {{ attributes.nested('label') }}>{{ renderLabelRaw ? label|raw : label }}</span>{%- endif -%}
+    </li>
+{% endif %}
diff --git a/templates/components/ActionMenu/ActionList/Item.html.twig b/templates/components/ActionMenu/ActionList/Item.html.twig
@@ -0,0 +1,14 @@
+{% props
+    label = null,
+    renderLabelRaw = false,
+    icon = null,
+    url = null,
+    htmlAttributes = {},
+%}
+
+<li>
+    <a {{ attributes.defaults({class: 'dropdown-item', href: url}|merge(htmlAttributes)) }}>
+        {%- if icon %}<twig:ea:Icon {{ ...attributes.nested('icon').defaults({name: icon}) }} /> {% endif -%}
+        {%- if label is not empty -%}<span {{ attributes.nested('label') }}>{{ renderLabelRaw ? label|raw : label }}</span>{%- endif -%}
+    </a>
+</li>
diff --git a/templates/components/ActionMenu/Button.html.twig b/templates/components/ActionMenu/Button.html.twig
@@ -0,0 +1,12 @@
+{% props
+    withoutDropdownToggleMarker = false,
+%}
+
+{% set css_class = html_classes(
+    'dropdown-toggle',
+    { 'dropdown-toggle-hidden-marker': withoutDropdownToggleMarker }
+) %}
+
+<a {{ attributes.defaults({class: css_class, href: '#', role: 'button', 'data-bs-toggle': 'dropdown', 'aria-haspopup': 'true', 'aria-expanded': 'false'}) }}>
+    <twig:block name="content"></twig:block>
+</a>
diff --git a/templates/components/ActionMenu/Overlay.html.twig b/templates/components/ActionMenu/Overlay.html.twig
@@ -0,0 +1,3 @@
+<div {{ attributes.defaults({class: 'dropdown-overlay'}) }}>
+    <twig:block name="content"></twig:block>
+</div>
diff --git a/templates/crud/index.html.twig b/templates/crud/index.html.twig
@@ -160,21 +160,23 @@
                             <td class="actions {{ ea.crud.showEntityActionsAsDropdown ? 'actions-as-dropdown' }}">
                                 {% if entity.actions.count > 0 %}
                                     {% if ea.crud.showEntityActionsAsDropdown %}
-                                        <div class="dropdown dropdown-actions">
-                                            <a class="dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-                                                {# don't use FontAwesome 'fa-ellipsis-h' icon here because it doesn't look good #}
-                                                {# this icon is 'dots-horizontal' icon from https://heroicons.com/ #}
-                                                <svg xmlns="http://www.w3.org/2000/svg" height="21" width="21" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-                                                    <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 12h.01M12 12h.01M19 12h.01M6 12a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0zm7 0a1 1 0 11-2 0 1 1 0 012 0z" />
-                                                </svg>
-                                            </a>
-
-                                            <div class="dropdown-menu dropdown-menu-right">
-                                                {% for action in entity.actions %}
-                                                    {{ include(action.templatePath, { action: action, entity: entity, isIncludedInDropdown: ea.crud.showEntityActionsAsDropdown }, with_context = false) }}
-                                                {% endfor %}
-                                            </div>
-                                        </div>
+                                        <twig:ea:ActionMenu class="dropdown-actions">
+                                            <twig:ea:ActionMenu:Button withoutDropdownToggleMarker>
+                                                <twig:ea:Icon name="internal:dots-horizontal" />
+                                            </twig:ea:ActionMenu:Button>
+
+                                            <twig:ea:ActionMenu:Overlay>
+                                                <twig:ea:ActionMenu:ActionList>
+                                                    {% for action in entity.actions %}
+                                                        <twig:ea:ActionMenu:ActionList:Item
+                                                            class="{{ action.cssClass }}" url="{{ action.linkUrl }}"
+                                                            icon="{{ action.icon }}" icon:class="action-icon"
+                                                            htmlAttributes="{{ action.htmlAttributes }}"
+                                                            label="{{ action.label|trans }}" label:class="action-label" renderLabelRaw />
+                                                    {% endfor %}
+                                                </twig:ea:ActionMenu:ActionList>
+                                            </twig:ea:ActionMenu:Overlay>
+                                        </twig:ea:ActionMenu>
                                     {% else %}
                                         {% for action in entity.actions %}
                                             {{ include(action.templatePath, { action: action, entity: entity, isIncludedInDropdown: ea.crud.showEntityActionsAsDropdown }, with_context = false) }}