[Icons] Allow to add custom pre-renderers

Author: norkunas

src/Icons/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 -   Add `aliases` configuration option to define icon alternative names.
 -   Add support for `int` and `float` attribute values in `<twig:ux:icon />`.
+-   Allow to add custom pre-renderers
 
 ## 2.19.0
 

src/Icons/config/services.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\UX\Icons\AriaHiddenPreRenderer;
 use Symfony\UX\Icons\Command\WarmCacheCommand;
 use Symfony\UX\Icons\IconCacheWarmer;
 use Symfony\UX\Icons\IconRenderer;
@@ -58,6 +59,7 @@
                 service('.ux_icons.icon_registry'),
                 abstract_arg('default_icon_attributes'),
                 abstract_arg('icon_aliases'),
+                tagged_iterator('ux_icons.icon_pre_renderer'),
             ])
 
         ->alias('Symfony\UX\Icons\IconRendererInterface', '.ux_icons.icon_renderer')
@@ -79,5 +81,8 @@
                 service('.ux_icons.cache_warmer'),
             ])
             ->tag('console.command')
+
+        ->set('.ux_icons.aria_hidden_pre_renderer', AriaHiddenPreRenderer::class)
+            ->tag('ux_icons.icon_pre_renderer')
     ;
 };

src/Icons/src/AriaHiddenPreRenderer.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons;
+
+final class AriaHiddenPreRenderer implements IconPreRendererInterface
+{
+    public function __invoke(string $name, Icon $icon): Icon
+    {
+        if ([] === array_intersect(['aria-hidden', 'aria-label', 'aria-labelledby', 'title'], array_keys($icon->getAttributes()))) {
+            return $icon->withAttributes(['aria-hidden' => 'true']);
+        }
+
+        return $icon;
+    }
+}

src/Icons/src/DependencyInjection/UXIconsExtension.php

@@ -20,6 +20,7 @@
 use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\UX\Icons\Iconify;
+use Symfony\UX\Icons\IconPreRendererInterface;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -128,5 +129,9 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         if (!$container->getParameter('kernel.debug')) {
             $container->removeDefinition('.ux_icons.command.import');
         }
+
+        $container
+            ->registerForAutoconfiguration(IconPreRendererInterface::class)
+            ->addTag('ux_icons.icon_pre_renderer');
     }
 }

src/Icons/src/IconPreRendererInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons;
+
+interface IconPreRendererInterface
+{
+    public function __invoke(string $name, Icon $icon): Icon;
+}

src/Icons/src/IconRenderer.php

@@ -18,10 +18,14 @@
  */
 final class IconRenderer implements IconRendererInterface
 {
+    /**
+     * @param iterable<IconPreRendererInterface> $preRenderers
+     */
     public function __construct(
         private readonly IconRegistryInterface $registry,
         private readonly array $defaultIconAttributes = [],
         private readonly ?array $iconAliases = [],
+        private readonly iterable $preRenderers = [],
     ) {
     }
 
@@ -42,30 +46,10 @@ public function renderIcon(string $name, array $attributes = []): string
             ->withAttributes($this->defaultIconAttributes)
             ->withAttributes($attributes);
 
-        foreach ($this->getPreRenderers() as $preRenderer) {
-            $icon = $preRenderer($icon);
+        foreach ($this->preRenderers as $preRenderer) {
+            $icon = $preRenderer($name, $icon);
         }
 
         return $icon->toHtml();
     }
-
-    /**
-     * @return iterable<callable(Icon): Icon>
-     */
-    private function getPreRenderers(): iterable
-    {
-        yield self::setAriaHidden(...);
-    }
-
-    /**
-     * Set `aria-hidden=true` if not defined & no textual alternative provided.
-     */
-    private static function setAriaHidden(Icon $icon): Icon
-    {
-        if ([] === array_intersect(['aria-hidden', 'aria-label', 'aria-labelledby', 'title'], array_keys($icon->getAttributes()))) {
-            return $icon->withAttributes(['aria-hidden' => 'true']);
-        }
-
-        return $icon;
-    }
 }

src/Icons/tests/Unit/IconRendererTest.php

@@ -12,8 +12,10 @@
 namespace Symfony\UX\Icons\Tests\Unit;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\UX\Icons\AriaHiddenPreRenderer;
 use Symfony\UX\Icons\Exception\IconNotFoundException;
 use Symfony\UX\Icons\Icon;
+use Symfony\UX\Icons\IconPreRendererInterface;
 use Symfony\UX\Icons\IconRegistryInterface;
 use Symfony\UX\Icons\IconRenderer;
 use Symfony\UX\Icons\Tests\Util\InMemoryIconRegistry;
@@ -61,7 +63,7 @@ public function testRenderIconWithAttributes(): void
         $registry = $this->createRegistry([
             'foo' => '<path d="M0 0L12 12"/>',
         ]);
-        $iconRenderer = new IconRenderer($registry);
+        $iconRenderer = new IconRenderer($registry, [], [], [new AriaHiddenPreRenderer()]);
         $attributes = ['viewBox' => '0 0 24 24', 'class' => 'icon', 'id' => 'FooBar'];
 
         $svg = $iconRenderer->renderIcon('foo', $attributes);
@@ -74,7 +76,7 @@ public function testRenderIconWithDefaultAttributes(): void
         $registry = $this->createRegistry([
             'foo' => '<path d="M0 0L12 12"/>',
         ]);
-        $iconRenderer = new IconRenderer($registry, ['viewBox' => '0 0 24 24', 'class' => 'icon']);
+        $iconRenderer = new IconRenderer($registry, ['viewBox' => '0 0 24 24', 'class' => 'icon'], [], [new AriaHiddenPreRenderer()]);
 
         $svg = $iconRenderer->renderIcon('foo');
 
@@ -172,7 +174,7 @@ public function testRenderIconWithAutoAriaHidden(string|array $icon, array $attr
         $registry = $this->createRegistry([
             'foo' => $icon,
         ]);
-        $iconRenderer = new IconRenderer($registry);
+        $iconRenderer = new IconRenderer($registry, [], [], [new AriaHiddenPreRenderer()]);
 
         $svg = $iconRenderer->renderIcon('foo', $attributes);
         $this->assertSame($expectedSvg, $svg);
@@ -237,7 +239,7 @@ public function testRenderIconWithAliases(): void
             'bar' => '<path d="M0 BAR"/>',
             'baz' => '<path d="M0 BAZ"/>',
         ]);
-        $iconRenderer = new IconRenderer($registry, [], ['foo' => 'bar']);
+        $iconRenderer = new IconRenderer($registry, [], ['foo' => 'bar'], [new AriaHiddenPreRenderer()]);
 
         $svg = $iconRenderer->renderIcon('bar');
         $this->assertSame('<svg aria-hidden="true"><path d="M0 BAR"/></svg>', $svg);
@@ -249,6 +251,25 @@ public function testRenderIconWithAliases(): void
         $this->assertSame('<svg aria-hidden="true"><path d="M0 BAZ"/></svg>', $svg);
     }
 
+    public function testRenderWithMultiplePreRenders(): void
+    {
+        $registry = $this->createRegistry([
+            'foo' => '<path d="M0 0L12 12"/>',
+        ]);
+        $customPreRenderer = new class implements IconPreRendererInterface {
+            public function __invoke(string $name, Icon $icon): Icon
+            {
+                return $icon->withAttributes(['data-test-id' => $name]);
+            }
+        };
+        $iconRenderer = new IconRenderer($registry, [], [], [new AriaHiddenPreRenderer(), $customPreRenderer]);
+        $attributes = ['viewBox' => '0 0 24 24', 'class' => 'icon', 'id' => 'FooBar'];
+
+        $svg = $iconRenderer->renderIcon('foo', $attributes);
+
+        $this->assertSame('<svg viewBox="0 0 24 24" class="icon" id="FooBar" aria-hidden="true" data-test-id="foo"><path d="M0 0L12 12"/></svg>', $svg);
+    }
+
     private function createRegistry(array $icons): IconRegistryInterface
     {
         $registryIcons = [];