Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pug-php/pug-slim
Pug template engine adapter for Slim
https://github.com/pug-php/pug-slim
Last synced: 3 months ago
JSON representation
Pug template engine adapter for Slim
- Host: GitHub
- URL: https://github.com/pug-php/pug-slim
- Owner: pug-php
- License: mit
- Fork: true (MarcelloDuarte/pug-slim)
- Created: 2017-06-28T09:03:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-13T11:24:09.000Z (over 2 years ago)
- Last Synced: 2024-05-11T00:34:26.738Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 33.2 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pug - Slim 3
README
# Pug for Slim
[](https://packagist.org/packages/pug/slim)
[](https://travis-ci.org/pug-php/pug-slim)
[](https://codeclimate.com/github/pug-php/pug-slim)
[](https://codeclimate.com/github/pug-php/pug-slim/coverage)
[](https://codeclimate.com/github/pug-php/pug-slim)
[](https://styleci.io/repos/95650139)
For details about the template engine see [phug-lang.com](https://www.phug-lang.com)
## Installation
Install with [Composer](http://getcomposer.org):
```bash
composer require pug/slim
```
## Usage with Slim 3
```php
use Slim\App;
use Slim\Pug\PugRenderer;
include 'vendor/autoload.php';
$slimOptions = []; // here you can pass Slim settings
$app = PugRenderer::create(new App($slimOptions), './templates');
$app->get('/hello/{name}', function ($request, $response, $args) {
return $this->renderer->render($response, 'hello.pug', $args);
});
$app->run();
```
PS: If you don't pass an application to the `create` method, we
will automatically initialize one, so you can just do:
```php
use Slim\Pug\PugRenderer;
include 'vendor/autoload.php';
$app = PugRenderer::create(null, './templates');
```
## Usage with any PSR-7 Project
```php
//Construct the View
$pugView = new PugRenderer('./path/to/templates', [
'option' => 'foobar',
]);
//Render a Template
$response = $pugView->render(new Response(), '/path/to/template.pug', $yourData);
```
## Template Variables
You can add variables to your renderer that will be available to all templates you render.
```php
// via the constructor
$templateVariables = [
'title' => 'Title',
];
$pugView = new PugRenderer('./path/to/templates', [], $templateVariables);
// or setter
$pugView->setAttributes($templateVariables);
// or individually
$pugView->addAttribute($key, $value);
```
Data passed in via `->render()` takes precedence over attributes.
```php
$templateVariables = [
'title' => 'Title',
];
$pugView = new PhpRenderer('./path/to/templates', $templateVariables);
//...
$pugView->render($response, $template, [
'title' => 'My Title',
]);
// In the view above, the $title will be "My Title" and not "Title"
```
By default, [pug-php](https://github.com/pug-php/pug) is used.
But you can specify an other engine:
```php
$app = PugRenderer::create(null, null, [
'renderer' => \Phug\Renderer::class,
]);
```
PS: Phug is automatically installed with default install since Pug-php 3
use it internally. But you can also install different renderer engine,
for example tale-pug:
```bash
composer require talesoft/tale-pug
```
```php
$app = PugRenderer::create(null, null, [
'renderer' => \Tale\Pug\Renderer::class,
]);
```
Note that in this case, you have no guarantee that all options
will work.
## References
* Pug-php 3 / Phug official documentation [www.phug-lang.com](https://www.phug-lang.com)
* Pug-php 3 / Phug live editor [pug-demo.herokuapp.com](https://pug-demo.herokuapp.com)
* To learn more about Pug go to [pugjs.org](https://pugjs.org)
* Here is an online HTML to Pug converter [html2pug.herokuapp.com](https://html2pug.herokuapp.com/)
## Credits
This project is forked from https://github.com/MarcelloDuarte/pug-slim
And we added to it phug, pug-php 3, tale-jade and tale-pug support.