Blog Detail

17

May
Optimize Your Site by Minifying With Laravel HTML Minifier cover image

arrow_back Optimize Your Site by Minifying With Laravel HTML Minifier

Laravel HTMLMin is currently maintained by Raza Mehdi. It is a fantastic and straightforward HTML minifier for Laravel. It utilizes Mr Clay’s Minify package to minify entire responses, but can also minify blade at compile time. Laravel HTMLMin requires PHP 5.5+. This particular version supports Laravel 5.1-5.8, 6.x, 7.x and 8.x.

Installation

To get the latest version, simply require the project using Composer:

$ composer require htmlmin/htmlmin

Once installed, you need to register the HTMLMin\HTMLMin\HTMLMinServiceProvider service provider in your config/app.php, and optionally alias our facade:

        'HTMLMin' => HTMLMin\HTMLMin\Facades\HTMLMin::class,

Configuration

Laravel HTMLMin supports optional configuration. To get started, you’ll need to publish all vendor assets:

$ php artisan vendor:publish

This will create a config/htmlmin.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are three config options:

Automatic Blade Optimizations

This option (‘blade’) enables minification of the blade views as they are compiled. These optimizations have little impact on php processing time as the optimizations are only applied once and are cached. This package will do nothing by default to allow it to be used without minifying pages automatically. The default value for this setting is false.

Force Blade Optimizations

This option (‘force’) forces blade minification on views where such minification may be dangerous. This should only be used if you are fully aware of the potential issues this may cause. Obviously, this setting is dependent on blade minification actually being enabled. The default value for this setting is false.

Ignore Blade Files

This option (‘ignore’) is where you can specify paths, which you don’t want to minify. A sensible default for this setting is provided.

Usage

HTMLMin

This is the class of most interest. It is bound to the ioc container as htmlmin and can be accessed using the Facades\HTMLMin facade. There are four public methods of interest.

The blade method will parse a string as a blade and minify it as quickly as possible. This is a method the compiler class uses when blade minification is enabled.

The css and js methods will parse a string as css/js and will minify it using Mr Clay’s Minify package.

The HTML method will parse a string as html and will minify it as best as possible using Mr. Clay’s Minify package. It will also be able to minify inline css and js. This is the method that is used by the minification middleware.

Facades\HTMLMin

This facade will dynamically pass static method calls to the htmlmin object in the ioc container which by default is the HTMLMin class.

Minifiers\MinifierInterface

This interface defines the public method a minifier class must implement. Such a class must only provide a render method that takes one parameter as a string and should return a string. This package ships with 4 implementations of this interface, but these classes are not intended for public use, so have not been documented here.

Skipping Minification

As well as being able to skip folders using the (ignore) config, there are occasions where you will want to ‘skip’ single files.

Just add the following comment to each file you want to skip:

<!-- skip.minification -->

Please note that if you use the force option in the config it will not work.

HTMLMinServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in config/app.php. This class will setup ioc bindings and register automatic blade minification based on the config.

There are other classes in this package that are not documented here (such as the compiler class). This is because they are not intended for public use and are used internally by this package.

Please note to clear view cache to see changes.

php artisan view:clear

For more details, you can visit its complete documentation and source code on Github

Published at : 17-05-2022

Author : Rizwan Aslam
AUTHOR
Rizwan Aslam

I am a highly results-driven professional with 12+ years of collective experience in the grounds of web application development especially in laravel, native android application development in java, and desktop application development in the dot net framework. Now managing a team of expert developers at Codebrisk.

Launch your project

Launch project