paladindigital/laravel-theme-installer

There is no license information available for the latest version (dev-master) of this package.

Laravel Theme Installer Plugin

dev-master 2017-02-06 16:42 UTC

This package is auto-updated.

Last update: 2024-11-08 00:39:19 UTC


README

This packages enables themes to be installed using composer - in a consistant place seperate from an applications view directory.

Themes installed using this installer package creates a themes folder within the resources folder and thus can be used regardless of which actual laravel version is used (some laravel versions may need to add additional loading configuration for this path, eg. Laravel 4).

Creating a theme

WIP:

Composer.json

{
  "name": "yournamespace/laravel-{themename}",
  "type": "laravel-community-theme",
  "require": {
    "paladindigital/laravel-theme-installer": "dev-master"
    "paladindigital/laravel-theme-loader": "dev-master"
  }
}

Slots, Yields

In order to enable user switching of themes they should use a consistent set of yields, slots and if applicable components.

This idea is inspired by wordpress hooks, laravel community themes should create standardised area's to allow custom 'plugins' to also interact with the theme.

We have defined some common ones below and welcome further community discussion on this via the issue board.

Yields

  • head
  • meta
  • styles
  • navigation (The themes primary navigation area)
  • secondary_navigation (Optional: May not be used on all themes, in which case output should be along side the primary navigation).
  • content
  • footer
  • sidebar (Optional: Again, some themes may not have a sidebar as such, however they should still yield the content somewhere.)
  • widgets
  • scripts (Scripts which are usually output before the closing body tag.)

Components

TODO

Child Themes

Since themes should be developed using Blade templates, child themes can easily be created by simply extending the master theme.

For example if you want to use the PaladinDigital Bootstrap template as a base simply create your master layout like so

yourtheme/master.blade.php

@extends('themes::paladindigital.laravel-bootstrap.master')