Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidepastore/lorempixel-twig-extension
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
https://github.com/davidepastore/lorempixel-twig-extension
lorempixel placeholder-image twig-extension
Last synced: about 1 month ago
JSON representation
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
- Host: GitHub
- URL: https://github.com/davidepastore/lorempixel-twig-extension
- Owner: DavidePastore
- Created: 2016-08-12T17:32:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T19:00:40.000Z (over 2 years ago)
- Last Synced: 2024-04-01T17:11:15.094Z (8 months ago)
- Topics: lorempixel, placeholder-image, twig-extension
- Language: PHP
- Size: 20.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# [LoremPixel][link-lorempixel] Twig Extension
[![Latest version][ico-version]][link-packagist]
[![Build Status][ico-github-actions]][link-github-actions]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![PSR2 Conformance][ico-styleci]][link-styleci]
This library integrates [LoremPixel][link-lorempixel] service into [Twig](http://twig.sensiolabs.org/). 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:
```php
$twig->addExtension(new LoremPixelTwigExtension());
```
In the templates, you then just call `%20}})
`.
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][link-lorempixel]. | `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:
```php
%20}})
```
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Davide Pastore](https://github.com/davidepastore)
## License
This library is released under the [MIT license](http://opensource.org/licenses/MIT).
[ico-version]: https://img.shields.io/packagist/v/DavidePastore/LoremPixel-Twig-Extension.svg?style=flat-square
[ico-github-actions]: https://github.com/DavidePastore/LoremPixel-Twig-Extension/workflows/Continuous%20Integration/badge.svg?branch=master
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/DavidePastore/LoremPixel-Twig-Extension.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/davidepastore/LoremPixel-Twig-Extension.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/davidepastore/LoremPixel-Twig-Extension.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/65571631/shield
[link-lorempixel]: http://lorempixel.com/
[link-packagist]: https://packagist.org/packages/davidepastore/LoremPixel-Twig-Extension
[link-github-actions]: https://github.com/DavidePastore/LoremPixel-Twig-Extension/actions?query=workflow%3A%22Continuous+Integration%22
[link-scrutinizer]: https://scrutinizer-ci.com/g/DavidePastore/LoremPixel-Twig-Extension/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/DavidePastore/LoremPixel-Twig-Extension
[link-downloads]: https://packagist.org/packages/davidepastore/LoremPixel-Twig-Extension
[link-styleci]: https://styleci.io/repos/65571631/