Icons ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Icons » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 5.12.0
Icons service.
An instance of the service is available via Craft::$app->getIcons().
Public Properties ​
| Property | Description |
|---|---|
| behaviors | \yii\base\Behavior<static>[] – List of behaviors attached to this component. |
| iconSetNames | array<string,string> |
| iconSets | array<string,\craft\icons\IconSet> |
iconSetNames ​
- Type
array<string,string>- Default value
null- Access
- Read-only
iconSets ​
- Type
array<string,\craft\icons\IconSet>- Default value
null- Access
- Read-only
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getIconSetByHandle() | Returns a custom icon set by its handle. |
| getIconSetNames() | Returns the names of all available icon sets, including Font Awesome, indexed by their handles. |
| getIconSets() | Returns all registered custom icon sets, indexed by their handles. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| parse() | Parses an icon value into its set handle and icon name, if it references a custom icon set. |
| trigger() | Triggers an event. |
getIconSetByHandle() ​
Returns a custom icon set by its handle.
Arguments ​
$handle(string)
Returns ​
getIconSetNames() ​
Returns the names of all available icon sets, including Font Awesome, indexed by their handles.
Returns ​
array<string,string>
getIconSets() ​
Returns all registered custom icon sets, indexed by their handles.
Returns ​
array<string,\craft\icons\IconSet>
Throws ​
- yii\base\InvalidConfigException
if an icon set has an invalid handle
parse() ​
Parses an icon value into its set handle and icon name, if it references a custom icon set.
Arguments ​
$value(string) – The icon value, e.g.my-icons:arrow
Returns ​
array{: string, : string}, null – The set handle and icon name, or null if the value doesn’t reference a custom icon set
Constants ​
| Constant | Description |
|---|---|
CUSTOM | |
FONT_AWESOME |
Events ​
EVENT_REGISTER_ICON_SETS ​
The event that is triggered when registering custom icon sets.
php
use craft\events\RegisterIconSetsEvent;
use craft\services\Icons;
use yii\base\Event;
Event::on(
Icons::class,
Icons::EVENT_REGISTER_ICON_SETS,
function(RegisterIconSetsEvent $event) {
$event->iconSets[] = new MyIconSet([
'handle' => 'my-icons',
'name' => 'My Icons',
]);
}
);