PHPackages                             terminalui/framework - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. terminalui/framework

ActiveLibrary[Framework](/categories/framework)

terminalui/framework
====================

A powerful, CSS-like TUI (Text User Interface) framework for PHP - inspired by Turbo Vision

00PHP

Since Jan 2Pushed 4mo agoCompare

[ Source](https://github.com/mschandr/TerminalUI)[ Packagist](https://packagist.org/packages/terminalui/framework)[ RSS](/packages/terminalui-framework/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

TerminalUI Framework
====================

[](#terminalui-framework)

> A powerful, CSS-like TUI (Text User Interface) framework for PHP - Inspired by Turbo Vision

[![PHP Version](https://camo.githubusercontent.com/b5d4f7901c58ad1ddfff679966f426cc25a9354bab763846b9a7276c2feab4e0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545382e322d626c7565)](https://www.php.net)

✨ Features
----------

[](#-features)

- **CSS-like Styling** - Familiar syntax for terminal UI styling
- **Two-Point Window Definition** - Define windows with coordinates like `(x1, y1) → (x2, y2)`
- **Customizable Borders** - Full control over every border character
- **Component Library** - Buttons, Labels, Lists, Inputs, and more
- **Event System** - Keyboard and mouse event handling
- **Layout System** - Box, Grid, and Flex layouts
- **256-Color Support** - RGB colors and hex values
- **Turbo Vision-inspired** - Classic DOS-era TUI design modernized

📦 Installation
--------------

[](#-installation)

```
composer require terminalui/framework
```

🚀 Quick Start
-------------

[](#-quick-start)

### Basic Window with CSS-like Styling

[](#basic-window-with-css-like-styling)

```
use TerminalUI\Core\{Application, Window, Rect};
use TerminalUI\Styling\{StyleSheet, Color};
use TerminalUI\Layout\Border;

// Create application
$app = new Application();

// Define window with CSS-like styles
$style = StyleSheet::create([
    'width' => '80%',        // Percentage of parent
    'height' => 20,          // Fixed height
    'top' => 5,              // Position from top
    'left' => 10,            // Position from left
    'background' => Color::BLUE,
    'foreground' => Color::WHITE,
    'border' => 'double',    // Border style
    'border-color' => Color::CYAN,
    'padding' => '1 2',      // Top/Bottom Left/Right
    'margin' => 2,           // All sides
]);

// Create window
$window = new Window($style, "My Window");
$app->addWindow($window);

// Run application
$app->run();
```

### Two-Point Window Definition

[](#two-point-window-definition)

The feature you specifically asked for!

```
use TerminalUI\Core\Rect;

// Define window from two coordinates
// Creates a window from (10, 5) to (90, 25)
$rect = Rect::fromPoints(
    x1: 10,  // Top-left X
    y1: 5,   // Top-left Y
    x2: 90,  // Bottom-right X
    y2: 25   // Bottom-right Y
);

$window = new Window($rect, "Two-Point Window");
```

### Customizable Borders

[](#customizable-borders)

Full control over every border character:

```
use TerminalUI\Layout\Border;

// Use preset styles
$border = Border::double();  // ╔═══╗
$border = Border::rounded(); // ╭───╮
$border = Border::thick();   // ┏━━━┓
$border = Border::ascii();   // +---+

// Or customize each character
$border = Border::create()
    ->top('═')
    ->bottom('═')
    ->left('║')
    ->right('║')
    ->topLeft('╔')
    ->topRight('╗')
    ->bottomLeft('╚')
    ->bottomRight('╝');

// Apply to window
$window->setBorder($border);
```

🎨 CSS-like Styling Reference
----------------------------

[](#-css-like-styling-reference)

### Supported Properties

[](#supported-properties)

```
$style = StyleSheet::create([
    // Dimensions
    'width' => '50%',          // Percentage of parent
    'width' => 80,             // Fixed pixels
    'height' => '100%',        // Fill parent
    'height' => 30,            // Fixed

    // Position
    'position' => 'absolute',  // or 'relative'
    'top' => 5,                // From top edge
    'left' => 10,              // From left edge
    'right' => 5,              // From right edge (calculates width)
    'bottom' => 3,             // From bottom edge (calculates height)

    // Spacing
    'padding' => 1,            // All sides
    'padding' => '1 2',        // Top/Bottom Left/Right
    'padding' => '1 2 3',      // Top Left/Right Bottom
    'padding' => '1 2 3 4',    // Top Right Bottom Left
    'margin' => 2,             // Same syntax as padding

    // Colors
    'background' => Color::BLUE,
    'foreground' => Color::WHITE,
    'color' => Color::GREEN,   // Alias for foreground

    // Borders
    'border' => 'single',      // single, double, rounded, thick, ascii
    'border-color' => Color::CYAN,
    'border-style' => 'solid',

    // Text
    'font-weight' => 'bold',   // normal, bold
    'text-align' => 'center',  // left, center, right
    'text-decoration' => 'underline',

    // Display
    'display' => 'block',      // block, inline, none
    'visibility' => 'visible', // visible, hidden
    'z-index' => 10,           // Stack order
]);
```

### Color Support

[](#color-support)

```
use TerminalUI\Styling\Color;

// 16 Basic Colors
Color::BLACK, Color::RED, Color::GREEN, Color::YELLOW,
Color::BLUE, Color::MAGENTA, Color::CYAN, Color::WHITE

// Bright Variants
Color::BRIGHT_RED, Color::BRIGHT_GREEN, etc.

// Grays (256-color)
Color::GRAY_DARK, Color::GRAY, Color::GRAY_LIGHT

// RGB Colors (256-color mode)
Color::rgb(255, 100, 50);

// Hex Colors
Color::hex('#FF6432');
```

📐 Layout System
---------------

[](#-layout-system)

### Two-Point Definition (Your Request!)

[](#two-point-definition-your-request)

```
// Define any UI element with two coordinates
$fullScreenRect = Rect::fromPoints(0, 0, 120, 30);
$topHalfRect = Rect::fromPoints(0, 0, 120, 15);
$bottomHalfRect = Rect::fromPoints(0, 15, 120, 30);
$centerBoxRect = Rect::fromPoints(40, 10, 80, 20);

// Windows, panels, buttons - anything can use two-point definition
$window = new Window($centerBoxRect, "Centered Box");
```

### CSS-style Positioning

[](#css-style-positioning)

```
// Full-screen window
$style = StyleSheet::create([
    'width' => '100%',
    'height' => '100%',
    'top' => 0,
    'left' => 0,
]);

// Right-side panel (30% width, full height, stick to right)
$style = StyleSheet::create([
    'width' => '30%',
    'height' => '100%',
    'top' => 0,
    'right' => 0,  // Stick to right edge
]);

// Centered dialog (like CSS: top/left with calculated dimensions)
$style = StyleSheet::create([
    'width' => 60,
    'height' => 15,
    'top' => 7,      // (30 - 15) / 2 for center
    'left' => 30,    // (120 - 60) / 2 for center
]);
```

🧩 Component Library
-------------------

[](#-component-library)

### Button

[](#button)

```
use TerminalUI\Components\Button;

$button = new Button(
    text: "Click Me",
    style: StyleSheet::create([
        'background' => Color::GREEN,
        'foreground' => Color::BLACK,
        'padding' => '0 2',
    ]),
    onClick: fn() => echo "Clicked!\n"
);
```

### Label

[](#label)

```
use TerminalUI\Components\Label;

$label = new Label(
    text: "Status: Ready",
    style: StyleSheet::create([
        'font-weight' => 'bold',
        'foreground' => Color::BRIGHT_GREEN,
    ])
);
```

### ListBox

[](#listbox)

```
use TerminalUI\Components\ListBox;

$list = new ListBox(
    items: ['Option 1', 'Option 2', 'Option 3'],
    style: StyleSheet::create([
        'width' => 40,
        'height' => 10,
        'border' => 'rounded',
    ])
);
```

🎯 Complete Example: Galaxy Map Window
-------------------------------------

[](#-complete-example-galaxy-map-window)

```
use TerminalUI\Core\{Application, Window};
use TerminalUI\Components\{Label, ListBox, Button};
use TerminalUI\Styling\{StyleSheet, Color};
use TerminalUI\Layout\Border;

$app = new Application();

// Main window - two-point definition
$mainWindow = new Window(
    Rect::fromPoints(5, 2, 115, 28),
    "Galaxy Map - Sector View"
);

// Custom border
$mainWindow->setBorder(
    Border::double()->borderColor(Color::CYAN)
);

// Title label
$titleStyle = StyleSheet::create([
    'top' => 1,
    'left' => 2,
    'font-weight' => 'bold',
    'foreground' => Color::BRIGHT_YELLOW,
]);
$title = new Label("Current Sector: Alpha Centauri", $titleStyle);
$mainWindow->add($title);

// Star list
$listStyle = StyleSheet::create([
    'top' => 3,
    'left' => 2,
    'width' => '40%',
    'height' => 15,
    'border' => 'single',
    'border-color' => Color::GREEN,
]);
$starList = new ListBox([
    '⭐ Sol System',
    '⭐ Proxima Centauri',
    '⭐ Betelgeuse',
], $listStyle);
$mainWindow->add($starList);

// Action buttons
$buttonStyle = StyleSheet::create([
    'top' => 20,
    'left' => 2,
    'background' => Color::BLUE,
    'foreground' => Color::WHITE,
    'padding' => '0 2',
]);
$travelButton = new Button("Travel", $buttonStyle);
$mainWindow->add($travelButton);

$app->addWindow($mainWindow);
$app->run();
```

🎨 Border Examples
-----------------

[](#-border-examples)

```
// All preset styles
Border::single();   // ┌─┐ │ │ └─┘
Border::double();   // ╔═╗ ║ ║ ╚═╝
Border::rounded();  // ╭─╮ │ │ ╰─╯
Border::thick();    // ┏━┓ ┃ ┃ ┗━┛
Border::ascii();    // +--+ | | +--+
Border::dots();     // ···· · · ····
Border::stars();    // **** * * ****
Border::none();     // No border (invisible)

// Custom border for sci-fi theme
$scifiBorder = Border::create()
    ->top('▀')->bottom('▄')
    ->left('█')->right('█')
    ->topLeft('▛')->topRight('▜')
    ->bottomLeft('▙')->bottomRight('▟');
```

📊 Performance
-------------

[](#-performance)

- Minimal memory footprint
- Fast rendering with ANSI escape codes
- Efficient event loop
- Supports terminals with 16, 256, or true color

🔧 Requirements
--------------

[](#-requirements)

- PHP ^8.2
- ext-pcntl (for signal handling)
- ext-posix (for terminal control)
- POSIX-compatible terminal

📝 License
---------

[](#-license)

Apache 2.0 License - see [LICENSE](LICENSE) file

🙏 Acknowledgments
-----------------

[](#-acknowledgments)

Inspired by:

- **Turbo Vision** (Borland's classic TUI framework)
- **React** (component-based architecture)
- **CSS** (styling syntax)

---

**Made with ❤️ for terminal enthusiasts**

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance51

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/be447f5fd1f8d777007695415e7dc783b7302ac47f4f1f7f3a3f4ed71a53b65e?d=identicon)[mschandr](/maintainers/mschandr)

---

Top Contributors

[![mschandr](https://avatars.githubusercontent.com/u/1372966?v=4)](https://github.com/mschandr "mschandr (5 commits)")

### Embed Badge

![Health badge](/badges/terminalui-framework/health.svg)

```
[![Health](https://phpackages.com/badges/terminalui-framework/health.svg)](https://phpackages.com/packages/terminalui-framework)
```

###  Alternatives

[laravel/passport

Laravel Passport provides OAuth2 server support to Laravel.

3.4k85.0M532](/packages/laravel-passport)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

712181.8M596](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M121](/packages/cakephp-chronos)[laravel/pail

Easily delve into your Laravel application's log files directly from the command line.

91545.3M590](/packages/laravel-pail)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)