Skip to content

codeat3/blade-icon-generation-helpers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blade Icon Generation Helpers

A helper package to convert the icons to make it compatible to be used with the blade-icons package.

Installation

composer require codeat3/blade-icon-generation-helpers

Usage

Kindly refer the Generating Icons section from Blade Icons. This Package utilizes the after callback to process the icons as per our need.

The after callback received 3 arguments string $icon - this is the pathname of the icon, array $config - the config specified in the generation.php & SplFileInfo $file - the original icon file instance.

Inside a callback we instantiate our Processor class & use its helper methods to our benefit.

$iconProcessor = new IconProcessor($icon, $config, $sourceFile);

This IconProcessor instance itself does some optimization on its own by default. Minimal usage would be as follows.

$iconProcessor = new IconProcessor($icon, $config, $sourceFile);
    $iconProcessor
        ->optimize()
        ->save();

The optimize method does the following things by default:

  • it removes the following attributes from the svg
    • 'width', 'height', 'class', 'style', 'id',
  • if in the config provided is-outline is set as true
    • if fill attribute exists - it will updated to none
    • if stroke attribute exists - it will updated to currentColor
  • if in the config provided is-solid is set as true
    • if fill attribute exists - it will updated to currentColor
  • if in the config provided custom-attributes is set`
    • it will set the attributes to the svg
  • optionally it provides 2 callable methods pre & post
    • both callback receives the $svgEL as the DOMDocument - its the DOMDocument instance of the current icon
    • pre can be used if you have to perform some operation before Processor does the default processing
    • post can be used if you have to perform some operation after Processor does the default processing

The save method

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages