davidepastore/lorempixel-twig-extension

A Twig extension for the lorempixel service

v0.1.2 2022-03-26 18:59 UTC

This package is auto-updated.

Last update: 2024-03-26 23:21:10 UTC


README

Latest version Build Status Coverage Status Quality Score Total Downloads PSR2 Conformance

This library integrates LoremPixel service into Twig. You can use it to generate random image urls that you can use as placeholders in your application.

Installation

composer require "davidepastore/lorempixel-twig-extension"

Usage

Add LoremPixelTwigExtension to your Twig extensions:

$twig->addExtension(new LoremPixelTwigExtension());

In the templates, you then just call <img src="{{ lorempixel() }}">.

You can use different parameters for this function in this order:

Name Type Description Default Example
gray boolean Is it a gray image? false lorempixel(true)
width int The width of the image. 400 lorempixel(true, 500)
height int The height of the image. 200 lorempixel(true, 500, 300)
category string The category of the image. You can find all supported categories here. null lorempixel(true, 500, 300, 'cats')
number int The number of the image from the given category. null lorempixel(true, 500, 300, 'cats', 2)
text string The custom text to add to the image. null lorempixel(true, 500, 300, 'cats', 2, 'Dummy Text')

An example with all the parameters could be:

<img src="{{ lorempixel(true, 500, 300, 'cats', 2, 'Dummy Text') }}">

Testing

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

This library is released under the MIT license.