Skip to content
Enable Laravel Blade Template Engine for Kirby 3
Branch: master
Clone or download
Latest commit fad7995 Jul 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml Jul 4, 2019
src v1.2 Jul 4, 2019
templates Initial version Jun 22, 2019
vendor v1.2 Jul 4, 2019
.gitignore Initial version Jun 22, 2019
LICENSE Initial version Jun 22, 2019
README.md v1.2 Jul 4, 2019
composer.json Update composer.json Jul 4, 2019
config.php Initial version Jun 22, 2019
helpers.php Initial version Jun 22, 2019
index.php Initial version Jun 22, 2019

README.md

Kirby Blade

Source Download Open Issues Last Commit Tag Version License

Kirby Blade use Laravel illuminate/view 5.8+ package and compatible with Kirby 3.

This package enable Laravel Blade for your own Kirby applications.

Installation

Installation with composer

composer require afbora/kirby-blade

Add as git submodule

git submodule add https://github.com/afbora/kirby-blade.git site/plugins/kirby-blade

What is Blade?

According to Laravel Blade documentation is:

Blade is the simple, yet powerful templating engine provided with Laravel. Unlike other popular PHP templating engines, Blade does not restrict you from using plain PHP code in your views. In fact, all Blade views are compiled into plain PHP code and cached until they are modified, meaning Blade adds essentially zero overhead to your application. Blade view files use the .blade.php file extension.

Usage

You can use the power of Blade like Layouts, Control Structures, Sub-Views, Directives and your Custom If Statements.

All the documentation about Laravel Blade is in the official documentation.

Options

The default values of the package are:

Option Default Values Description
afbora.blade.templates site/templates (string) Location of the templates
afbora.blade.views site/cache/views (string) Location of the views cached
afbora.blade.directives [] (array) Array with the custom directives
afbora.blade.ifs [] (array) Array with the custom if statements

All the values can be updated in the config.php file.

Templates

Default templates folder is site/templates directory or wherever you define your templates directory, but you can change this easily:

'afbora.blade.templates' => '/theme/default/templates',

You can find Kirby Starterkit blade templates in repository /templates folder.

├── layouts
│   └── default.blade.php
├── partials
│   ├── album.blade.php
│   ├── image.blade.php
│   ├── note.blade.php
│   └── photography.blade.php
├── about.blade.php
├── album.blade.php
├── default.blade.php
├── home.blade.php
├── note.blade.php
├── notes.blade.php
└── photography.blade.php

Views

All the views generated are stored in site/cache/views directory or wherever you define your cache directory, but you can change this easily:

'afbora.blade.views' => '/site/storage/views',

Directives

By default Kirby Blade comes with following directives:

@asset($path)
@csrf()
@css($path)
@dump($variable)
@e($condition, $value, $alternative)
@get($key, $default)
@gist($url)
@go($url, $code)
@h($string, $keepTags)
@html($string, $keepTags)
@js($path)
@image($path, $attr) // @image('forrest.jpg', 'url')
@kirbytag($type, $value, $attr)
@kirbytags($text, $data)
@kirbytext($text, $data)
@kirbytextinline($text)
@kt($text)
@markdown($text)
@option($key, $default)
@page($key, $attr) // @page('blog', 'title')
@param($key, $fallback)
@site($attr) // @site(title')
@size($value)
@smartypants($text)
@snippet($name, $data)
@svg($file)
@t($key, $fallback)
@tc($key, $count)
@tt($key, $fallback, $replace, $locale)
@u($path, $options)
@url($path, $options)
@video($url, $options, $attr)
@vimeo($url, $options, $attr)
@widont($string)
@youtube($url, $options, $attr)

But you can create your own:

'afbora.blade.directives' => [
    'greeting' => function ($text)
    {
        return "<?php echo 'Hello: ' . $text ?>";
    },
],

Kirby Helpers Documentation:

https://getkirby.com/docs/reference/templates/helpers

If Statements

Like directives, you can create your own if statements:

'afbora.blade.ifs' => [
    'logged' => function ()
    {
        return !!kirby()->user();
    },
],

After declaration you can use it like:

@logged
    Welcome back {{ $kirby->user()->name() }}
@else
    Please Log In
@endlogged

Developed from Kirby Blade Repository maintained by @beebmx

You can’t perform that action at this time.