Dashboard accessibility improvements

CHANGELOG-WIP.md

@@ -6,7 +6,8 @@
 - Added `craft\web\View::EVENT_AFTER_CREATE_TWIG`. ([#11774](https://github.com/craftcms/cms/pull/11774))
 
 ### Changed
-- Improved the control panel accessibility. ([#11534](https://github.com/craftcms/cms/pull/11534), [#11565](https://github.com/craftcms/cms/pull/11565), [#11578](https://github.com/craftcms/cms/pull/11578), [#11589](https://github.com/craftcms/cms/pull/11589), [#11610](https://github.com/craftcms/cms/pull/11610), [#11613](https://github.com/craftcms/cms/pull/11613), [#11768](https://github.com/craftcms/cms/pull/11768))
+- Improved the control panel accessibility. ([#11534](https://github.com/craftcms/cms/pull/11534), [#11565](https://github.com/craftcms/cms/pull/11565), [#11578](https://github.com/craftcms/cms/pull/11578), [#11589](https://github.com/craftcms/cms/pull/11589), [#11610](https://github.com/craftcms/cms/pull/11610), [#11613](https://github.com/craftcms/cms/pull/11613), [#11703](https://github.com/craftcms/cms/pull/11703), [#11768](https://github.com/craftcms/cms/pull/11768))
 - `users/session-info` responses now include a `csrfTokenName` key. ([#11706](https://github.com/craftcms/cms/pull/11706))
+- `craft\helpers\Component::iconSvg()` now namespaces the SVG contents, and adds `aria-hidden="true"`. ([#11703](https://github.com/craftcms/cms/pull/11703))
 - `craft\services\Search::EVENT_BEFORE_INDEX_KEYWORDS` is now cancellable by setting `$event->isValid` to `false`. ([#11705](https://github.com/craftcms/cms/discussions/11705))
 - `checkboxSelect` inputs without `showAllOption: true` now post an empty value if no options were selected. ([#11748](https://github.com/craftcms/cms/issues/11748))

src/helpers/Component.php

@@ -10,6 +10,7 @@
 use Craft;
 use craft\base\ComponentInterface;
 use craft\errors\MissingComponentException;
+use yii\base\InvalidArgumentException;
 use yii\base\InvalidConfigException;
 
 /**
@@ -144,7 +145,7 @@ public static function mergeSettings(array $config): array
     }
 
     /**
-     * Returns an SVG icon’s contents.
+     * Returns an SVG icon’s contents, namespaced and with `aria-hidden="true"` added to it.
      *
      * @param string|null $icon The path to the SVG icon, or the actual SVG contents
      * @param string $label The label of the component
@@ -157,23 +158,35 @@ public static function iconSvg(?string $icon, string $label): string
             return self::_defaultIconSvg($label);
         }
 
-        if (stripos($icon, '<svg') !== false) {
-            return $icon;
-        }
+        if (stripos($icon, '<svg') === false) {
+            $icon = Craft::getAlias($icon);
 
-        $icon = Craft::getAlias($icon);
+            if (!is_file($icon)) {
+                Craft::warning("Icon file doesn't exist: $icon", __METHOD__);
+                return self::_defaultIconSvg($label);
+            }
 
-        if (!is_file($icon)) {
-            Craft::warning("Icon file doesn't exist: $icon", __METHOD__);
-            return self::_defaultIconSvg($label);
+            if (!FileHelper::isSvg($icon)) {
+                Craft::warning("Icon file is not an SVG: $icon", __METHOD__);
+                return self::_defaultIconSvg($label);
+            }
+
+            $icon = file_get_contents($icon);
         }
 
-        if (!FileHelper::isSvg($icon)) {
-            Craft::warning("Icon file is not an SVG: $icon", __METHOD__);
-            return self::_defaultIconSvg($label);
+        // Namespace it
+        $ns = StringHelper::randomString(10);
+        $icon = Html::namespaceAttributes($icon, $ns, true);
+
+        // Add aria-hidden="true"
+        try {
+            $icon = Html::modifyTagAttributes($icon, [
+                'aria' => ['hidden' => 'true'],
+            ]);
+        } catch (InvalidArgumentException) {
         }
 
-        return file_get_contents($icon);
+        return $icon;
     }
 
     /**