sroze/live-twig

dev-master 2020-10-05 10:39 UTC

Requires

• symfony/framework-bundle: ^5.1
• symfony/mercure-bundle: *
• symfony/twig-bundle: ^5.1

MIT

README

Let's get rid of the SPAs! Here's how to get real-time Twig blocks basically. Bisous. 😘

Setup

1. Install the dependency

   composer req sroze/live-twig

2. Get Mercure Hub running. You can have a look to the Mercure documentation. Simplest is with Docker:

   docker run --rm -e CORS_ALLOWED_ORIGINS='https://127.0.0.1:8000' -e JWT_KEY='!ChangeMe!' -e DEMO=1 -e ALLOW_ANONYMOUS=1 -e PUBLISH_ALLOWED_ORIGINS='http://localhost,http://localhost:8000' -p 80:80 dunglas/mercure

3. Get your Mercure JWT token. If you are using the default demo JWT_KEY, you can get the token from your running hub's homepage..

4. Set environment variables

   .env

   ...

   MERCURE_PUBLISH_URL=http://localhost/.well-known/mercure MERCURE_JWT_TOKEN=[your-token]

5. (While the Flex recipe is not done) Regisyer the bundle:

   // config/bundles.php
   return [
       // ...
       Symfony\Bundle\LiveTwigBundle\LiveTwigBundle::class => ['all' => true],
   ];

   Create the following configuration file:

   # config/packages/live_twig.yaml
   live_twig:
       mercure_public_url: "%env(MERCURE_PUBLISH_URL)%"

Use it!

Anywhere in your Twig templates, render a live block:

{{
    render_live(
        controller('App\\Controller\\YourController::yourAction', { some: 'parameter' }),
        {'topics': ['foo', 'bar-' ~ baz]}
    )
}}

When the data contained in this block change, publish an empty Mercure update:

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mercure\Publisher;
use Symfony\Component\Mercure\Update;
use Symfony\Component\Routing\Annotation\Route;

class LiveController extends AbstractController
{
    /**
     * @Route("/foo")
     */
    public function index(Publisher $publisher)
    {
        // ...
        $publisher(new Update(['foo', 'bar-'.$bar]));
        // ...
    }
}

When the browser will receive the signal, it will send a GET request to retrieve the new version of the block. Alternatively, you can also pass the data to display as the content of the update. In this case no extra HTTP request is triggered:

// ...
$publisher(new Update(['foo', 'bar-'.$bar], 'the updated content of the block'));