Skip to content

Add a jumbotron images with title and description to your pages. The titles and descriptions support multilanguage.

License

Notifications You must be signed in to change notification settings

davide-casiraghi/laravel-jumbotron-images

Repository files navigation

Laravel Jumbotron Images

Latest Version on Packagist Build Status Quality Score Coverage Status GitHub last commit

Add a jumbotron images with title and description to the pages of your Laravel application.
The titles and descriptions support multilanguage.

Installation

You can install the package via composer:

composer require davide-casiraghi/laravel-jumbotron-images

Publish all the vendor files

php artisan vendor:publish --force

Run the database migrations

php artisan migrate

Add the JS files to /resources/js/app.js

require('./vendor/laravel-jumbotron-images/jquery.stellar');  
require('./vendor/laravel-jumbotron-images/laravel-jumbotron-images');  

Add the SCSS file to /resources/sass/app.scss

@import 'vendor/laravel-jumbotron-images/laravel-jumbotron-images';

Add your jumbotrons to the jumbotrons table

Once you have published the package you can go to this route to manage your jumbotrons:
/jumbotron-images

Usage

Include the facade in your controller:

use DavideCasiraghi\LaravelJumbotronImages\Facades\LaravelJumbotronImages;

In the controller, pass to the view the Jumbotron datas. (In this case we want to show the jumbotron with id = 1)

$jumbotronImage = LaravelJumbotronImages::getJumbotronImage(1);
return view('welcome', [
    'jumbotronImage' => $jumbotronImage,
    'jumbotronImageParameters' => LaravelJumbotronImages::getParametersArray($jumbotronImage),
]);

Then include in the view the jumbotron view.

@include('vendor.laravel-jumbotron-images.show-jumbotron-image', $jumbotronImage)

The snippet

The library replace all the occurrences of this kind of snippet

{# jumbotron id=[1] #}

Testing

You can run unit tests checking the code coverage using this command.

./vendor/bin/phpunit --coverage-html=html

So you can find the reports about the code coverage in this file /html/index.html

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.

About

Add a jumbotron images with title and description to your pages. The titles and descriptions support multilanguage.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published