Skip to content

README.md

Latest commit

 

History

History
62 lines (41 loc) · 1.54 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.54 KB

CommonPHP Twig UI Driver

UI driver for CommonPHP that wraps Twig for output rendering and reusable component templates.

Requirements

  • PHP ^8.5
  • comphp/ui:^0.3
  • twig/twig

Installation

Once this package is available through your Composer repositories, install it with:

composer require comphp/ui-twig

Usage

<?php

use CommonPHP\Drivers\UI\Twig\TwigRenderer;
use CommonPHP\UI\Component;
use CommonPHP\UI\ComponentRegistry;
use CommonPHP\UI\Layout;
use CommonPHP\UI\View;

$components = new ComponentRegistry([
    new Component('badge', 'components.badge', ['label' => 'Default']),
]);

$renderer = new TwigRenderer([__DIR__ . '/templates'], $components);

$html = $renderer->render(new View(
    'pages.dashboard',
    ['title' => 'Dashboard', 'label' => 'Ready'],
    new Layout('layouts.app'),
));

Driver Notes

This driver is intended to let CommonPHP UI render components, layouts, and interface elements through Twig while keeping the core UI package rendering-engine neutral.

Global components should be provided through the driver or its configuration so applications can share consistent UI primitives without locking the UI package to Twig directly.

Error Handling

Template lookup, rendering, component, configuration, and driver failures should throw CommonPHP UI driver exceptions instead of returning ambiguous false values.

Documentation

License

MIT. See LICENSE.md.