Spinner - your task is running
🇺🇦 🏵️ PHP Console Spinner
New version 1.0.0
- WIP
‼️ API is subject to change until1.0.0-BETA.0
- is intended to be used with event loop (see limitations)
Old version
0.55.0
is available in branch 0.55.x
Why?
Main purpose of this library is to provide a simple way to show spinner in console applications. Spinner could be an indicator of running task. Also this library provides a way to show progress of running task and messages of some sort, like status messages. For more information see Features and Examples.
Installation
composer require alecrabbit/php-console-spinner
Quick start (asynchronous)
use AlecRabbit\Spinner\Factory;
$spinner = Factory::createSpinner();
// that's basically it :)
Examples can be found in example directory
For more information see Usage
Features
See Features and limitations for more details
Feature | |
---|---|
Extremely flexible | 🟢️ ️ |
Zero dependencies ️ | 🟢️ * |
Asynchronous | 🟢️ ️ |
Synchronous | 🟢️ ️ |
AutoStart (async) | 🟢️ ️ |
Signal handling (async) | 🟢️ ️ |
Cursor auto hide/show | 🟢️ ️ |
Links
- Inspired by sindresorhus/cli-spinners