clitube/clitube

CliTube is data viewer in console

0.3.4 2023-07-30 00:42 UTC

This package is auto-updated.

Last update: 2024-03-30 00:24:54 UTC


README

CLI Tube

68747470733a2f2f706f7365722e707567782e6f72672f636c69747562652f636c69747562652f726571756972652f706870 68747470733a2f2f706f7365722e707567782e6f72672f636c69747562652f636c69747562652f76657273696f6e 68747470733a2f2f706f7365722e707567782e6f72672f636c69747562652f636c69747562652f646f776e6c6f616473 badge.svg 68747470733a2f2f73686570686572642e6465762f6769746875622f636c69747562652f636c69747562652f636f7665726167652e737667 68747470733a2f2f73686570686572642e6465762f6769746875622f636c69747562652f636c69747562652f6c6576656c2e737667

The package will help you to render paginated tables and any plain text content in a console.

Requirements

Make sure that your server is configured with following PHP version and extensions:

  • PHP 8.1+

Installation

You can install the package via composer:

composer require clitube/clitube

Examples

Paginator Component

$core = (new \CliTube\Core($output))
$core->createComponent(\CliTube\Component\Paginator::class, [
    new MyPaginator(), // Instanceof \CliTube\Data\Paginator
])
$core->run();

Navigation

pagination-navigation.gif

A wide table scrolling

pagination-scroll-horizontally.gif

Scroll Component

$core = (new \CliTube\Core($output))
$core->createComponent(\CliTube\Component\Scroll::class, [
    'content' => 'Very long text',
    'overwrite' => true,
])
$core->run();

Testing

composer test

License

The MIT License (MIT). Please see License File for more information.