If set, it will override this class with same class name, but containing formatted constants with icon names.

This parameter combined with iconPrefix can be used to select icons based on class constants, with IDE autocomplete support, and shorter names.

Possible example usage, assume class name is Icon or some namespaced name, let's say Maslosoft\Module\Icon and is imported here:

Icon::Folder; // icon-folder

With iconPrefix constant name will be the same, however CSS name will be prefixed:

Icon::Folder; // icon-module-folder

Set this to create class if not yet exists

Define any valid PHP callback to customize transformation constant names. By default they are camelized, ie:

document-folder

Will become:

DocumentFolder

Function accepts two parameter, package interface instance and sprite object.

Example function:

$converter = function(SpritePackageInterface $package, SpriteImage $sprite)
{
            // Basic camelize function
        return lcfirst(str_replace('-', '', ucwords($sprite->name, '-')));
};

Define any valid PHP callback to customize transformation of CSS class names. By default they are decamelized, ie:

Document-Folder

Will become:

document-folder

Function accepts two parameter, package interface instance and sprite object.

Example function:

$converter = function(SpritePackageInterface $package, SpriteImage $sprite)
{
            // Basic camelize function
        return lcfirst(str_replace('-', '', ucwords($sprite->name, '-')));
};

Icon prefix. It is used by CSS as selector. This can be usefull to create icon namespace for application module. Example icon CSS class name without prefix:

icon-folder

With prefix it will append this prefix after icon part

Absolute paths to scan for icons. It cat be paths to folder or to single icons:

$paths = [
        '/var/www/some/application/assets/',
        '/tmp/some-icon.png'
]

If path have sub directories these will be added to icon name as prefix. For example, when configured path is

$paths = [
        '/var/www/some/application/assets/',
]

And real paths are

Paths:
/var/www/some/application/assets/16/
/var/www/some/application/assets/32/

This will result in icons with two prefixes of 16 and 32. This is useful for icon sizing. So when using icon, one would know it's size just by the icon name.