https://github.com/jaxon-php/jaxon-twig
Jaxon view renderer for Twig templates
https://github.com/jaxon-php/jaxon-twig
Last synced: 4 months ago
JSON representation
Jaxon view renderer for Twig templates
- Host: GitHub
- URL: https://github.com/jaxon-php/jaxon-twig
- Owner: jaxon-php
- License: bsd-3-clause
- Created: 2017-05-04T23:51:37.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-07-23T14:54:26.000Z (12 months ago)
- Last Synced: 2025-10-29T13:46:27.728Z (8 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Jaxon View for Twig
===================
Render Twig templates in Jaxon applications.
Installation
------------
Install this package with Composer.
```json
"require": {
"jaxon-php/jaxon-twig": "^5.0"
}
```
Usage
-----
For each directory containing Twig templates, add an entry to the `app.views` section in the configuration.
```php
'app' => [
'views' => [
'demo' => [
'directory' => '/path/to/demo/views',
'extension' => '.html.twig',
'renderer' => 'twig',
],
],
],
```
In the following example, the DOM element with id `content-id` is assigned the value of the `/path/to/demo/views/sub/dir/file.html.twig` template.
```php
class MyClass extends \Jaxon\App\FuncComponent
{
public function action()
{
$this->response->html('content-id', $this->view()->render('demo::/sub/dir/file'));
}
}
```
Twig functions
--------------
This extension provides the following Twig functions to insert Jaxon js and css codes in the pages that need to show Jaxon related content.
```php
// /path/to/demo/views/sub/dir/file.html.twig
{{ jxnCss() }}
{{ jxnJs() }}
{{ jxnScript() }}
```
Call factories
--------------
This extension registers the following Twig functions for Jaxon [call factories](https://www.jaxon-php.org/docs/v5x/ui-features/call-factories.html) functions.
> [!NOTE]
> In the following examples, the `rqAppTest` template variable is set to the value `rq(Demo\Ajax\App\AppTest::class)`.
The `jxnBind` function attaches a UI component to a DOM element, while the `jxnHtml` function displays a component HTML code in a view.
```php
{{ jxnHtml(rqAppTest) }}
```
The `jxnPagination` function displays pagination links in a view.
```php
```
The `jxnOn` function binds an event on a DOM element to a Javascript call defined with a `call factory`.
```php
Black
Red
Green
Blue
```
The `jxnClick` function is a shortcut to define a handler for the `click` event.
```php
Click me
```
The `jxnEvent` function defines a set of events handlers on the children of a DOM element, using `jQuery` selectors.
```php
Black
Red
Green
Blue
Black
Red
Green
Blue
```
The `jxnEvent` function takes as parameter an array in which each entry is an array with a `jQuery` selector, an event and a `call factory`.
Contribute
----------
- Issue Tracker: github.com/jaxon-php/jaxon-twig/issues
- Source Code: github.com/jaxon-php/jaxon-twig
License
-------
The package is licensed under the BSD license.