PHP Heroicons
A package to render Heroicons in your PHP application.
Preview the icons at heroicons.com, developed by Steve Schoger and Adam Wathan.
If you want to render Heroicons in your Laravel Blade views, use Blade Heroicons package.
Installation
Composer
composer require roelmagdaleno/php-heroicons
Usage
You can render a Heroicon using multiple ways:
Helper
Return the SVG by using the heroicon() helper function:
$text = heroicon('check-circle', ['width' => 60]);
echo "<p>My icon is: $text</p>";
Print the SVG directly:
echo heroicon('check-circle', ['width' => 60]);
Constructor
Instantiate an Icon class with parameters and print it directly:
use PHPHeroIcons\Icon;
echo new Icon('check-circle', ['width' => 60]);
Instantiate an Icon class with parameters and call the render() method.
use PHPHeroIcons\Icon;
$icon = new Icon('academic-cap', ['width' => 60]);
$icon->render();
Instantiate an Icon class with parameters and call the return() method.
use PHPHeroIcons\Icon;
$icon = new Icon('academic-cap', ['width' => 60]);
$text = $icon->return();
echo "<p>My icon is: $text</p>";
Render Method
If you want to render multiples icons and only use one Icon instance:
use PHPHeroIcons\Icon;
$icon = new Icon();
$icon->render('check-circle', ['width' => 60]);
$icon->render('academic-cap', ['width' => 60]);
$icon->render('library', ['width' => 60]);
Return Method
If you want to return multiples icons and only use one Icon instance:
use PHPHeroIcons\Icon;
$icon = new Icon();
$first = $icon->return('check-circle', ['width' => 60]);
$second = $icon->return('academic-cap', ['width' => 60]);
$third = $icon->return('library', ['width' => 60]);
echo "My first icon is: $first then use the $second and $third";
Parameters
The Icon constructor, heroicon(), render() and return() methods accepts these attributes in this order:
- $icon
- $attributes
- $type
Example:
heroicon($icon, $attributes, $type);
The $icon accepts any Heroicon slug and if you insert an icon that doesn't exist it won't return anything.
For $attributes (optional) you can pass only these attributes as array key/value format:
widthheightclassid
If you pass an attribute that is not listed previously it won't be attached to the SVG HTML.
And last, but not least, you can specify the Heroicon $type:
solidoutline
By default the icons will be printed in solid type.
Example:
heroicon(
'library',
[
'width' => 60,
'height' => 60,
'class' => 'my-custom-css-class',
'id' => 'my-custom-id',
]
); // Print solid icon with multiple attributes.
heroicon(
'check-circle',
[
'width' => 60,
'height' => 60,
'class' => 'my-custom-css-class',
'id' => 'my-custom-id',
],
'outline'
); // Print outline icon with multiple attributes.
Examples
For more usage examples visit the examples/index.php file.
20 Dec 8, 2018
689 Dec 27, 2022
10 Oct 2, 2022
8 Dec 14, 2022
7 Aug 12, 2022
4 Oct 15, 2022
14 Nov 4, 2022
1.3k Dec 22, 2022
5 Jul 22, 2022
2 Dec 30, 2022
7 Aug 21, 2022
3 Aug 9, 2022
18 Aug 17, 2021
279 Dec 28, 2022
338 Dec 8, 2022
174 Nov 26, 2022
196 Dec 29, 2022
7 Jul 17, 2022