[Icons] Set aria-hidden="true" when title/label not set

Author: smnandre

src/Icons/src/DependencyInjection/UXIconsExtension.php

@@ -43,6 +43,15 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->info('Default attributes to add to all icons.')
                     ->defaultValue(['fill' => 'currentColor'])
                 ->end()
+                ->arrayNode('renderer')
+                    ->info('Options for the icon renderer.')
+                    ->children()
+                        ->booleanNode('auto_aria_hidden')
+                            ->info('Automatically set aria-hidden="true" when no label or title is provided.')
+                            ->defaultTrue()
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('iconify')
                     ->info('Configuration for the "on demand" icons powered by Iconify.design.')
                     ->{interface_exists(HttpClientInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
@@ -94,6 +103,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
 
         $container->getDefinition('.ux_icons.icon_renderer')
             ->setArgument(1, $mergedConfig['default_icon_attributes'])
+            ->setArgument(2, $mergedConfig['renderer'] ?? [])
         ;
 
         if ($mergedConfig['iconify']['enabled']) {

src/Icons/src/IconRenderer.php

@@ -21,6 +21,12 @@ final class IconRenderer
     public function __construct(
         private readonly IconRegistryInterface $registry,
         private readonly array $defaultIconAttributes = [],
+        /**
+         * @var array{
+         *     auto_aria_hidden: bool
+         * }
+         */
+        private readonly array $rendererConfiguration = [],
     ) {
     }
 
@@ -38,8 +44,22 @@ public function __construct(
     public function renderIcon(string $name, array $attributes = []): string
     {
         return $this->registry->get($name)
-            ->withAttributes([...$this->defaultIconAttributes, ...$attributes])
+            ->withAttributes($this->getIconAttributes($name, $attributes))
             ->toHtml()
         ;
     }
+
+    private function getIconAttributes(string $name, array $attributes): array
+    {
+        $iconAttributes = $this->defaultIconAttributes;
+
+        // Add aria-hidden attribute
+        if ($this->rendererConfiguration['auto_aria_hidden'] ?? false) {
+            if ([] === array_intersect(['aria-hidden',  'aria-label', 'aria-labelledby', 'title'], array_keys($attributes))) {
+                $iconAttributes['aria-hidden'] = 'true';
+            }
+        }
+
+        return [...$iconAttributes, ...$attributes];
+    }
 }

src/Icons/tests/Unit/IconRendererTest.php

@@ -159,6 +159,45 @@ public static function provideAttributesWithDefaultAttributesCases()
         ];
     }
 
+    /**
+     * @dataProvider provideAriaHiddenCases
+     *
+     * @param array<string, string> $attributes
+     */
+    public function testRenderIconWithAutoAriaHidden(array $attributes, string $expectedSvg): void
+    {
+        $registry = $this->createRegistry([
+            'foo' => '<path d="M0 0L12 12"/>',
+        ]);
+        $iconRenderer = new IconRenderer($registry, [], ['auto_aria_hidden' => true]);
+
+        $svg = $iconRenderer->renderIcon('foo', $attributes);
+        $this->assertSame($expectedSvg, $svg);
+    }
+
+    /**
+     * @return iterable<array{array<string, string>, string}>
+     */
+    public static function provideAriaHiddenCases(): iterable
+    {
+        yield "no attributes" => [
+            [],
+            '<svg aria-hidden="true"><path d="M0 0L12 12"/></svg>',
+        ];
+        yield "aria-hidden attribute" => [
+            ['aria-hidden' => 'true'],
+            '<svg aria-hidden="true"><path d="M0 0L12 12"/></svg>',
+        ];
+        yield "title attribute" => [
+            ['title' => 'foo'],
+            '<svg title="foo"><path d="M0 0L12 12"/></svg>',
+        ];
+        yield "aria-labelledby attribute" => [
+            ['aria-labelledby' => 'foo'],
+            '<svg aria-labelledby="foo"><path d="M0 0L12 12"/></svg>',
+        ];
+    }
+
     private function createRegistry(array $icons): IconRegistryInterface
     {
         $registryIcons = [];