Inspired by bigecko/laravel-theme. Themes are stored inside default laravel's resources folder
This package provides a simple way to manage themes in Laravel applications.
For example, you can develop multiple themes for your application and easily switch between themes for different purposes.
This version requires PHP 8.1 and supports Laravel 10-11.
This package also provides support for Laravel Mix and Vite configurations.
| Themes | L5.5 | L5.6 | L5.7 | L5.8 | L6 | L7 | L8 | L9 | L10 | L11 |
|---|---|---|---|---|---|---|---|---|---|---|
| 2.4 | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| 3.0 | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| 4.1 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |
| 5.0 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
| 5.1 | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
To get the latest version, simply require the project using Composer:
composer require "yaap/theme:^5.0"or manually add line to composer.json
{
"require": {
"yaap/theme": "^5.0"
}
}Optionally, publish config using artisan CLI (if you want to overwrite default config).
php artisan vendor:publish --provider="YAAP\Theme\ThemeServiceProvider"Config in config/theme.php file.
return [
/*
|--------------------------------------------------------------------------
| Path to directory with themes
|--------------------------------------------------------------------------
|
| The directory with your themes.
|
*/
'path' => base_path('themes'),
/*
|--------------------------------------------------------------------------
| Path to directory with assets build
|--------------------------------------------------------------------------
|
| The directory with assets build in public directory.
|
*/
'assets_path' => 'themes',
/*
|--------------------------------------------------------------------------
| A pieces of theme collections
|--------------------------------------------------------------------------
|
| Inside a theme path we need to set up directories to
| keep "layouts", "assets" and "partials".
|
*/
'containerDir' => [
'assets' => 'assets',
'lang' => 'lang',
'layout' => 'views/layouts',
'partial' => 'views/partials',
'view' => 'views',
],
];Config in theme folder. Placeholder %theme_name% will be replaced with theme name on creation.
return [
/*
|--------------------------------------------------------------------------
| Theme name
|--------------------------------------------------------------------------
|
| Use in assets publishing etc.
|
*/
'name' => '%theme_name%',
/*
|--------------------------------------------------------------------------
| Inherit from another theme
|--------------------------------------------------------------------------
|
| Set up inherit from another if the file is not exists.
|
*/
'inherit' => null,
];The first time you have to create theme default structure, using the artisan command:
php artisan theme:create defaultBy default, it will use vite as assets builder. If you want to use laravel mix instead, use the command:
or with laravel mix:
php artisan theme:create default mixTo delete an existing theme, use the command:
php artisan theme:destroy defaultHere is an example of the folder structure of project with theme
project-root
├── app/
<...>
├── public/
| ├── index.php
| └── themes/
| └── default/
| ├── js/
| | └── app.js
| ├── css/
| | └── styles.css
| └── images/
| └── icon.png
├── resources/
<...>
├── themes/
| ├── default/
| | ├── assets/
| | ├── lang/
| | ├── views/
| | | ├── layouts/
| | | ├── partials/
| | | └── hello.blade.php
| | └── config.php
| ├── admin/
| ├── views/
| ├── emails/
| | └── notify.blade.php
| └── hello.blade.php
To init and use theme in your application, add the following code to any boot method in application service provider (e.g. AppServiceProvider):
use YAAP\Theme\Facades\ThemeLoader;
class AppServiceProvider extends ServiceProvider
{
public function boot()
{
ThemeLoader::init('default');
}
}This will add to views find path:
themes/{$name}/views
Lang files will be added as well:
themes/{$name}/lang
View::make('hello');
View::make('emails.notify');
// or
view('hello');
view('emails.notify');If you use Vite, ensure vite.config.js have specified the input path for theme
import {defineConfig} from 'vite';
import laravel from 'laravel-vite-plugin';
export default defineConfig({
plugins: [
laravel({
input: [
'themes/default/assets/js/app.js', // for default theme
// ...
],
refresh: true,
}),
],
});Because app.js includes app.scss you can use the following code to include assets in your views:
<head>
<!--...-->
@vite([
'themes/default/assets/js/app.js',
])
</head>If you use Laravel Mix, ensure webpack.mix.js have specified mix configuration for theme
const mix = require('laravel-mix');
mix.disableNotifications();
mix.browserSync({
open: true,
proxy: 'localhost:8000',
files: [
'app/**/*',
'routes/**/*',
'themes/**/*', // manually add this line
]
});
// other configutraions...
// mix for default theme
mix.copyDirectory('themes/default/assets/img', 'public/themes/default/img');
mix.copyDirectory('themes/default/assets/fonts', 'public/themes/default/fonts');
// js
mix.js(['themes/default/assets/js/app.js'], 'public/themes/default/js/app.min.js')
// sass
mix.sass('themes/default/assets/sass/app.scss', 'public/themes/default/css/app.min.css')Then you can use the following code to include assets in your views:
in the <head> tag
<head>
<!--...-->
<link rel="stylesheet" href="{{ mix('/themes/default/css/app.min.css') }}"/>
</head>and before </body> tag
<body>
<!--...-->
<script type="text/javascript" src="{{ mix('/themes/default/js/app.min.js') }}"></script>
</body>To use images, you can use the following code:
<img src="{{ mix('themes/default/img/icon.png') }}" alt="icon">To build layouts we use template inheritance.
You can use @extends directive to specify a parent layout.
@extends('layouts.master')
@include('partials.header')
@section('content')
<section id="main">
<h1>HOME</h1>
</section>
@stop
@include('partials.footer')You still able to use default View::make('emails.notify') which is stored outside the themes directory.
Yes! Say hi: [email protected]
We will be happy to work with you! Other work we’ve done
Stay up to date with the latest news! Follow us on LinkedIn or Facebook
MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent