README

Addon for Bear Framework

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

Download and install

Install via Composer

composer require ivopetkov/image-gallery-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/image-gallery-bearframework-addon');

Usage

<component src="image-gallery">
    <file filename="/path/to/file1.jpg"/>
    <file filename="/path/to/file2.jpg"/>
    <file filename="/path/to/file3.jpg"/>
</component>

Attributes

onclick

Defines the behaviour on image click. Available values: fullscreen, url, custom, none

image-aspect-ratio

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

columns-count

The number of columns that will be filled with the images

imageSize

The size of the images, if columnsCount is not specified. Available values: tiny, small, medium, large, huge

image-loading-background

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

spacing

The spacing between the images. Example values: 10px, 1rem, etc.

class

HTML class attribute value

Examples

3 columns of square images that will be opened in fullscreen when clicked

<component src="image-gallery" columns-count="3" image-aspect-ratio="1:1" onclick="fullscreen">
    <file filename="/path/to/file1.jpg"/>
    <file filename="/path/to/file2.jpg"/>
    <file filename="/path/to/file3.jpg"/>
</component>

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.

ivopetkov / image-gallery-bearframework-addon

Maintainers

Details