SugarVeil
Terminal overlay compositor
Stack overlay views on top of a base TUI. Each overlay renders independently and the compositor handles z-ordering, positioning, and teardown.
Install
composer require sugarcraft/sugar-veilQuickstart
use SugarCraft\Veil\Veil;
use SugarCraft\Sprinkles\Style;
$veil = new Veil();
$veil = $veil->push($modalView, Position::Center);
$veil = $veil->push($tooltip, Position::TopRight);
echo $veil->render($baseView);What's in the box
Stack managementPush / pop overlays. Z-order handled automatically.
PositioningCenter, Top, Bottom, Left, Right, or absolute coordinates.
TeardownPer-overlay completion callbacks on removal.
Source & demos
- Source on GitHub
- Full README
- Runnable examples
- Port of rmhubbert/bubbletea-overlay (Go upstream)
API
| Class | Method | Description |
|---|---|---|
| Veil | new() | Create a new veil |
| Veil | push(view, position) | Push overlay onto stack |
| Veil | pop() | Pop top overlay |
| Veil | render(baseView) | Composite all overlays |
