PHPackages                             miravel/miravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. miravel/miravel

ActiveLibrary[Framework](/categories/framework)

miravel/miravel
===============

Theme engine for the Laravel framework

v0.4.0(8y ago)023MITPHPPHP ^7.0

Since Mar 30Pushed 7y ago2 watchersCompare

[ Source](https://github.com/TheChipmunks/miravel)[ Packagist](https://packagist.org/packages/miravel/miravel)[ RSS](/packages/miravel-miravel/feed)WikiDiscussions master Synced yesterday

READMEChangelog (6)Dependencies (3)Versions (15)Used By (0)

[![Warning](https://camo.githubusercontent.com/b14b4161e6756cf2ac870e08dcd0fe909221181a179eb0d885b48c1aa41ad58a/68747470733a2f2f706c616365686f6c642e69742f33352f6630336331352f6666666666663f746578743d21)](https://camo.githubusercontent.com/b14b4161e6756cf2ac870e08dcd0fe909221181a179eb0d885b48c1aa41ad58a/68747470733a2f2f706c616365686f6c642e69742f33352f6630336331352f6666666666663f746578743d21) Warning: work in progress
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

[](#-warning-work-in-progress)

Miravel is currently a work in progress and cannot yet be used in real projects. Most things described below are not yet implemented. When a usable version is released, this warning will go away.

Miravel
=======

[](#miravel)

A theme engine for the Laravel framework, with its own theme repository, and with the ability for everyone to develop and contribute their own themes.

The full documentation is available at:

### Features:

[](#features)

- Miravel comes with a default theme that already contains most popular layouts: fluid, fixed width, one- and two-column, sticky footer, form centered on a screen etc.
- Themes consists of skins, layouts, elements (blocks) and templates. All of them can be used independently and even with conjunction with components from other themes.
- Miravel is very inobtrusive and can co-exist with any other frontend logic, being called / used only when needed. You can limit its use for only a couple of layouts/elements should you so decide.
- Offers special Blade tags `@element`, `@js`, `@css`, etc.
- Whenever you need, override the entire theme or any of its components (css, js, view files) separately in your app.
- Command line interface offers one-liners for many complex operations, e.g. "install this theme and use its 'home page' template as my home page".
- Templates are built with Blade and around php variables, so in many cases all you need is just to eloquent-pull data into a variable with proper name.
- But of course you can easily add custom logic to elements by creating your own class for an element.
- Themes can inherit (extend / override) each other.
- Miravel leverages Assetic to easily orchestrate asset build pipeline (such as css/js preprocessing, concatenation, minification etc).
- And also has tools for creating a very fine-grained asset build for every specific page of your app. Some pages do not need jQuery? No problem, create a jquery-less `app.js` just for these pages. Miravel automates most of these routines.
- Setting a theme as "Global" automatically gives you the error pages and basic email templates that are consistent with the chosen theme/skin.
- It is just a Laravel miracle.

### Usage

[](#usage)

Quick dive into using Miravel with your Laravel project:

#### Pull in the package

[](#pull-in-the-package)

```
composer require miravel/miravel
```

#### Laravel 5.4 or earlier, or Laravel 5.5 without auto-discovery

[](#laravel-54-or-earlier-or-laravel-55-without-auto-discovery)

Below Laravel 5.5, package auto-discover is not available so some extra steps are also necessary:

Add the provider and facade to your `config/app.php`

```
'providers' => [
//...
Miravel\ThemeServiceProvider::class,
//...
],
```

```
'aliases' => [
//...
'Miravel' => Miravel\Facade::class,
//...
],
```

#### Use a template

[](#use-a-template)

This line will replace your `welcome.blade.php` with a template from Miravel's default theme:

```
php artisan miravel:use default.home-page --as=welcome
```

And go visit your page in browser to see the change.

#### Use a layout

[](#use-a-layout)

You can use Miravel's theme layouts as you traditionally do that by extending them inside your blade views:

```
@extends('miravel::default.one-column')

@section('content')
Awesome stuff here
@endsection

```

Your awesome stuff will be placed inside the "one-column" layout from the "default" theme.

#### Use an element

[](#use-an-element)

Inside your view:

```
// Assuming "$items" is holding something like this
// [['text' => 'Home', 'url' => '/'], ['text' => 'About Us', 'url' => '/about']]
// this will render the "menu" template from the "default" theme with these items.

@element('default.menu', $items);
```

#### Override any layout or element

[](#override-any-layout-or-element)

To start playing with the view file, just copy it from the `vendor` folder to `app/resources/views/vendor/miravel/theme-name`.

E.g. to override the "fixed" layout from the "default" theme, copy:

*vendor/miravel/miravel/resources/themes/**default/layouts/fixed/view.blade.php***

to

*app/resources/vendor/miravel/**default/layouts/fixed/view.blade.php***

Miravel offer an artisan one-liner for this operation to somewhat shorten your typing:

```
php artisan miravel:clone default.layouts.fixed.view
```

or to pull the entire layout (with all styles and scripts)

```
php artisan miravel:clone default.layouts.fixed
```

to pull the entire theme

```
php artisan miravel:clone default
```

You get the idea.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 92.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

11

Last Release

2945d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6d56829e2a51c6f2ae5584fc313cc8ae334d7ebbb44e7b0a83ad9e04a23a8abc?d=identicon)[miravel](/maintainers/miravel)

---

Top Contributors

[![neskodi](https://avatars.githubusercontent.com/u/34277852?v=4)](https://github.com/neskodi "neskodi (145 commits)")[![reb2020](https://avatars.githubusercontent.com/u/19814526?v=4)](https://github.com/reb2020 "reb2020 (9 commits)")[![neskhodovskiy](https://avatars.githubusercontent.com/u/16799030?v=4)](https://github.com/neskhodovskiy "neskhodovskiy (2 commits)")

### Embed Badge

![Health badge](/badges/miravel-miravel/health.svg)

```
[![Health](https://phpackages.com/badges/miravel-miravel/health.svg)](https://phpackages.com/packages/miravel-miravel)
```

###  Alternatives

[symfony/framework-bundle

Provides a tight integration between Symfony components and the Symfony full-stack framework

3.6k235.4M9.7k](/packages/symfony-framework-bundle)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19462.3M1.3k](/packages/drupal-core)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[silverstripe/framework

The SilverStripe framework

7213.5M2.5k](/packages/silverstripe-framework)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)