Laravel Themes gives the means to group together a set of views and assets for Laravel 5.3.
Begin by installing the package through Composer.
composer require pierresilva/laravel-themes
Once this operation is complete, simply add both the service provider and facade classes to your project's config/app.php file:
pierresilva\Themes\ThemesServiceProvider::class,'Theme' => pierresilva\Themes\Facades\Theme::class,php artisan vendor:publish --provider="pierresilva\Themes\ThemesServiceProvider"This will copy the bundled config file to config/themes.php
Define the default active theme.
'active' => 'default'Generating forlder structure from command line.
php artisan generate:theme themeslugAnd fallow the instructions.
Each theme must come supplied with a manifest file (theme.json) stored at the root of the theme, which defines supplemental details about the theme.
{
"slug": "default",
"name": "Default",
"author": "John Doe",
"description": "This is an example theme.",
"version": "1.0"
}echo Theme::getProperty('theme::property_key', 'default value if nothing is returned');Theme::setProperty('theme::property_key', 'new value to be set');...
'active' => 'foobar'
...use Theme;
...
public function __construct()
{
Theme::setActive('foobar');
}
...Get all themes.
Collection
$themes = Theme::all();Sets the active theme that will be used to retrieve view files from.
$theme (string) Theme slug. Required
null
Theme::setActive('bootstrap-theme');Returns the currently active theme.
string
$activeTheme = Theme::getActive();Renders the defined view. This will first check if the currently active theme has the requested view file; if not, it will fallback to loading the view file from the default view directory supplied by Laravel.
$view (string) Relative path to view file. Required $data (mixed) Any additional data you'd like to pass along to the view file to be displayed.
View
$foo = 'bar';
return Theme::view('welcome', compact('foo'));Rendered the defined view in the same manner that Theme::view() does, but allows the means to set a custom status response and header for the rendered page.
$view (string) Relative path to view file. Required $data (mixed) Any additional data you'd like to pass along to the view file to be displayed. $status (integer) HTTP status code. $header (array) HTTP headers.
Response
$posts = Post::orderBy('published', 'desc')->get();
return Theme::response('blog.rss', compact('posts'), 200, [
'Content-Type' => 'application/atom+xml; charset=UTF-8'
]);Let's say we have bootstrap theme in our application with the following structure:
public/
|-- themes/
|-- bootstrap/
|-- theme.json
|-- assets/
|-- css/
|-- bootstrap.css
|-- img/
|-- js/
|-- bootstrap.js
|-- jquery.js
|-- views/
|-- layout.blade.php
|-- auth/
|-- login.blade.php
First, we need theme.json manifest file.
{
"slug": "bootstrap",
"name": "Bootstrap",
"author": "Jhon Doe",
"description": "Bootstrap theme.",
"version": "1.0.0"
}<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Bootstrap Theme Sample</title>
<!-- Bootstrap core CSS -->
<link href="{{ Theme::asset('bootstrap::css/bootstrap.css') }}" rel="stylesheet">
</head>
<body>
<div class="container">
@yield('content')
</div>
<script src="{{ Theme::asset('bootstrap::js/jquery.js') }}"></script>
<script src="{{ Theme::asset('bootstrap::js/bootstrap.js') }}"></script>
</body>
</html>Please take note that we need to use Theme::asset() to load our theme asset files. The bootstrap is a theme slug defined in our theme.json file.
In our controller, load the view using the following code:
public function getLogin()
{
return Theme::view('auth.login');
}Now, for our login.blade.php:
@extends('bootstrap::layout')
@section('content')
<h1>Log In</h1>
<form method="POST" action="/auth/login">
{!! csrf_field() !!}
<div>
Email
<input type="email" name="email" value="{{ old('email') }}">
</div>
<div>
Password
<input type="password" name="password" id="password">
</div>
<div>
<input type="checkbox" name="remember"> Remember Me
</div>
<div>
<button type="submit">Login</button>
</div>
</form>
@endsectionNote that we are using @extends('bootstrap::layout') in our login view, where bootstrap is a theme slug defined in our theme.json and layout is our layout file.
The Laravel Themes is open-sourced software licensed under the MIT license.