[4.0] Created a HTMLHelper to render an icon

administrator/language/en-GB/lib_joomla.ini

@@ -501,6 +501,7 @@ JLIB_HTML_FEATURED_PENDING_ITEM="Featured, but is Pending."
 JLIB_HTML_FEATURED_STARTED="Start: %s"
 JLIB_HTML_GOTO_PAGE="Go to page %s"
 JLIB_HTML_GOTO_POSITION="Go to %s page"
+JLIB_HTML_ICONS_NO_ICON="No icon provided."
 JLIB_HTML_MOVE_DOWN="Move Down"
 JLIB_HTML_MOVE_UP="Move Up"
 JLIB_HTML_NO_PARAMETERS_FOR_THIS_ITEM="There are no parameters for this item."

build/build-modules-js/settings.json

@@ -255,6 +255,7 @@
         },
         "filesExtra": {
           "scss": "scss",
+          "svgs": "images",
           "webfonts": "webfonts"
         },
         "provideAssets": [

language/en-GB/lib_joomla.ini

@@ -501,6 +501,7 @@ JLIB_HTML_FEATURED_PENDING_ITEM="Featured, but is Pending."
 JLIB_HTML_FEATURED_STARTED="Start: %s"
 JLIB_HTML_GOTO_PAGE="Go to page %s"
 JLIB_HTML_GOTO_POSITION="Go to %s page"
+JLIB_HTML_ICONS_NO_ICON="No icon provided."
 JLIB_HTML_MOVE_DOWN="Move Down"
 JLIB_HTML_MOVE_UP="Move Up"
 JLIB_HTML_NO_PARAMETERS_FOR_THIS_ITEM="There are no parameters for this item."

layouts/joomla/quickicons/icon.php

@@ -9,6 +9,7 @@
 
 defined('_JEXEC') or die;
 
+use Joomla\CMS\HTML\HTMLHelper;
 use Joomla\CMS\Language\Text;
 
 $id      = empty($displayData['id']) ? '' : (' id="' . $displayData['id'] . '"');
@@ -63,7 +64,12 @@
 		<a <?php echo $id . $class; ?> href="<?php echo $displayData['link']; ?>"<?php echo $target . $onclick . $title; ?>>
 			<?php if (isset($displayData['image'])): ?>
 				<div class="quickicon-icon d-flex align-items-end <?php echo $size ?>">
-					<div class="<?php echo $displayData['image']; ?>" aria-hidden="true"></div>
+					<?php echo HTMLHelper::_('icons.icon',
+							str_replace('icon-', '', $displayData['image']), [
+									'text' => Text::_($displayData['name']),
+									'svg'  => true
+							]
+					); ?>
 				</div>
 			<?php endif; ?>
 			<?php if (isset($displayData['ajaxurl'])) : ?>

libraries/src/HTML/Helpers/Icons.php

@@ -12,9 +12,11 @@
 
 use Joomla\CMS\Factory;
 use Joomla\CMS\HTML\HTMLHelper;
+use Joomla\CMS\Language\Text;
 use Joomla\CMS\Layout\FileLayout;
 use Joomla\CMS\Uri\Uri;
 use Joomla\Filesystem\Path;
+use Joomla\Utilities\ArrayHelper;
 
 /**
  * Utility class for icons.
@@ -128,4 +130,57 @@ public static function svg(string $file, bool $relative = true): ?string
 
 		return $file;
 	}
+
+	/**
+	 * Method to write a `<span>` element for an icon
+	 *
+	 * @param   string  $icon     The functional name for an icon.
+	 * @param   array   $attribs  Attributes to be added to the wrapping element
+	 *
+	 * @return  string
+	 *
+	 * @throws  \InvalidArgumentException
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public static function icon(string $icon, array $attribs = []): string
+	{
+		if ($icon === '')
+		{
+			throw new \InvalidArgumentException(Text::_('JLIB_HTML_ICONS_NO_ICON'));
+		}
+
+		$class = $icon;
+
+		if (isset($attribs['class']))
+		{
+			$class .= ' ' . $attribs['class'];
+		}
+
+		$attribs['class'] = $class;
+
+		if (!isset($attribs['aria-hidden']))
+		{
+			$attribs['aria-hidden'] = 'true';
+		}
+
+		if (isset($attribs['text']) && $attribs['aria-hidden'] === 'true')
+		{
+			$text = htmlspecialchars($attribs['text'], ENT_COMPAT, 'UTF-8');
+			$text = '<span class="sr-only">' . $text . '</span>';
+			unset($attribs['text']);
+		}
+
+		$output = '<span ' . ArrayHelper::toString($attribs) . '></span>';
+
+		if (isset($attribs['svg']))
+		{
+			$provider = $attribs['svg']['provider'] ?? 'fontawesome-free';
+			$group    = $attribs['svg']['group'] ?? 'regular';
+			$path     = '/media/vendor/' . $provider . '/svgs/' . $group;
+			$output   = HTMLHelper::_('icons.svg', $icon . '.svg', $path);
+		}
+
+		return $output . $text;
+	}
 }