Stars: 315
Forks: 47
Pull Requests: 3
Issues: 15
Watchers: 7
Last Updated: 2023-02-14 12:49:23
Multi theme support for Laravel application
License: MIT License
Languages: PHP, JavaScript, CSS, Vue, Blade, SCSS
This Laravel package adds multi-theme support to your application. It also provides a simple authentication scaffolding for a starting point for building a Laravel application. And it also has preset for Bootstrap
, Tailwind
, Vue
, and React
. So, I believe it is a good alternative to the laravel/ui
& laravel/breeze
package.
laravel/ui
& laravel/breeze
laravel/breeze
Bootstrap
, Tailwind
, Vue 2
, Vue 3
and React
If you don't want to use auth scaffolding of this package, instead you want to use Laravel Fortify, no problem with that. You can use Laravel Themer with Fortify. Laravel Fortify only gives backend implementation authentication, it does not provide views or frontend presets. So, use Fortify for backend auth and Laravel Themer for views and presets.
Here is the video for Laravel Themer Tutorial.
NOTE:
Laravel Themer v2.x and the above versions support Vite. If you want to use Laravel Mix then try Laravel Themer v1.7.1
You can install this package via composer using:
composer require qirolab/laravel-themer
Publish a configuration file:
php artisan vendor:publish --provider="Qirolab\Theme\ThemeServiceProvider" --tag="config"
Run the following command in the terminal:
php artisan make:theme
This command will ask you to enter theme name, CSS framework, js framework, and optional auth scaffolding.
// Set active theme
Theme::set('theme-name');
// Get current active theme
Theme::active();
// Get current parent theme
Theme::parent();
// Clear theme. So, no theme will be active
Theme::clear();
// Get theme path
Theme::path($path = 'views');
// output:
// /app-root-path/themes/active-theme/views
Theme::path($path = 'views', $themeName = 'admin');
// output:
// /app-root-path/themes/admin/views
Theme::getViewPaths();
// Output:
// [
// '/app-root-path/themes/admin/views',
// '/app-root-path/resources/views'
// ]
Register ThemeMiddleware
in app\Http\Kernel.php
:
protected $routeMiddleware = [
// ...
'theme' => \Qirolab\Theme\Middleware\ThemeMiddleware::class,
];
Examples for middleware usage:
// Example 1: set theme for a route
Route::get('/dashboard', 'DashboardController@index')
->middleware('theme:dashboard-theme');
// Example 2: set theme for a route-group
Route::group(['middleware'=>'theme:admin-theme'], function() {
// "admin-theme" will be applied to all routes defined here
});
// Example 3: set child and parent theme
Route::get('/dashboard', 'DashboardController@index')
->middleware('theme:child-theme,parent-theme');
To compile the theme assets, first you need to add the following lines in the scripts
section of the package.json
file.
"scripts": {
...
"dev:theme-name": "vite --config themes/theme-name/vite.config.js",
"build:theme-name": "vite build --config themes/theme-name/vite.config.js"
}
Now, to compile a particular theme run the following command:
npm run dev:theme-name
# or
npm run build:theme-name
We invest a lot of resources into video tutorials and creating open-source packages. If you like what I do or if you ever made use of something I built or from my videos, consider supporting us. This will allow us to focus even more time on the tutorials and open-source projects we're working on.
Thank you so much for helping us out! 🥰
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
Authentication scaffolding stubs and presets are taken from laravel/ui, laravel/breeze, and laravel-frontend-presets/tailwindcss.
The MIT License (MIT). Please see License File for more information.