README

Addon for Bear Framework

This addon enables you to easily create lazy-loaded images that are SEO friendly. It's based on the popular library Responsively Lazy. Multiple versions with different sizes are created on the fly and only the best one is loaded. This saves bandwidth and loads the website faster.

Download and install

Install via Composer

composer require ivopetkov/lazy-image-bearframework-addon

Download an archive

Download the latest release from the GitHub page and include the autoload file.

include '/path/to/the/addon/autoload.php';

Enable the addon

Enable the addon for your Bear Framework application.

$app->addons->add('ivopetkov/lazy-image-bearframework-addon');

Usage

<component src="lazy-image" filename="path/to/the/file.jpg" />

Attributes

filename

      The name of the file to be shown. It must be in a publicly accessible directory.

aspectRatio

      The proportional relationship between the width and the height of the image. It is useful for cropping and resizing the image. Example values: 1:1, 1:2, 1.5:1, etc.

loadingBackground

      The type of background shown while the image is loading. Available values: none and checkered.

class

      HTML class attribute value

style

      HTML style attribute value

alt

      HTML alt attribute value

title

      HTML title attribute value

Examples

The image rendered is a square

<component src="lazy-image" filename="path/to/the/file.jpg" aspectRatio="1:1" />

A custom class name is added to the image HTML code

<component src="lazy-image" filename="path/to/the/file.jpg" class="my-class-name" />

A title is added

<component src="lazy-image" filename="path/to/the/file.jpg" title="New Year's Eve" />

License

Lazy image addon for Bear Framework is open-sourced software. It's free to use under the MIT license. See the license file for more information.

Author

This addon is created by Ivo Petkov. Feel free to contact me at @IvoPetkovCom or ivopetkov.com.