Toggle extra

README.md

@@ -362,6 +362,56 @@ The third param on the `->addItem` call is what disables an item while the `->di
 
 The outcome is a full menu with dimmed rows to denote them being disabled. When a user navigates these items are jumped over to the next available selectable item.
 
+#### Redrawing the menu
+
+You can modify the menu and its style when executing an action and then you can redraw it! In this example we will toggle the background
+colour in an action.
+
+```php
+$itemCallable = function (CliMenu $menu) {
+    $menu->getStyle()->setBg($menu->getStyle()->getBg() === 'red' ? 'blue' : 'red');
+    $menu->redraw();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu')
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable)
+    ->addItem('Third Item', $itemCallable)
+    ->addLineBreak('-')
+    ->build();
+
+$menu->open();
+```
+
+#### Getting, Removing and Adding items
+
+You can also interact with the menu items in an action:
+
+```php
+use PhpSchool\CliMenu\MenuItem\LineBreakItem;
+
+$itemCallable = function (CliMenu $menu) {
+    foreach ($menu->getItems() as $item) {
+        $menu->removeItem($item);
+    }
+
+    $menu->addItem(new LineBreakItem('-'));
+
+    $menu->redraw();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu')
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable)
+    ->addItem('Third Item', $itemCallable)
+    ->addLineBreak('-')
+    ->build();
+
+$menu->open();
+```
+
 ---
 
 Once you get going you might just end up with something that looks a little like this... 

examples/crazy-redraw.php

@@ -0,0 +1,61 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\MenuItem\LineBreakItem;
+use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$itemCallable = function (CliMenu $menu) {
+    $colour = function () {
+        return array_rand(array_flip(['blue', 'green', 'red', 'yellow']));
+    };
+    $int = function () {
+        return rand(1, 20);
+    };
+
+    $bg = $colour();
+    while (($fg = $colour()) === $bg) {
+    }
+
+    $menu->getStyle()->setBg($bg);
+    $menu->getStyle()->setFg($fg);
+    $menu->getStyle()->setPadding($int());
+    $menu->getStyle()->setMargin($int());
+
+    $items = $menu->getItems();
+
+    array_walk($items, function (MenuItemInterface $item) use ($menu) {
+        $menu->removeItem($item);
+    });
+
+    $items = array_filter($items, function (MenuItemInterface $item) {
+        return !$item instanceof LineBreakItem;
+    });
+
+    foreach (range(0, rand(1, 5)) as $i) {
+        $items[] = new LineBreakItem(array_rand(array_flip(['♥', '★', '😂'])), rand(1, 3));
+    }
+    shuffle($items);
+
+    array_walk(
+        $items,
+        function (MenuItemInterface $item) use ($menu) {
+            $menu->addItem($item);
+        }
+    );
+
+    $menu->redraw();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu')
+    ->setWidth(80)
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable)
+    ->addItem('Third Item', $itemCallable)
+    ->addLineBreak('-')
+    ->build();
+
+$menu->open();

examples/redraw.php

@@ -0,0 +1,21 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$itemCallable = function (CliMenu $menu) {
+    $menu->getStyle()->setBg($menu->getStyle()->getBg() === 'red' ? 'blue' : 'red');
+    $menu->redraw();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu')
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable)
+    ->addItem('Third Item', $itemCallable)
+    ->addLineBreak('-')
+    ->build();
+
+$menu->open();

examples/toggle-item-extra.php

@@ -0,0 +1,32 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$itemCallable = function (CliMenu $menu) {
+    static $i = 1;
+
+    foreach ($menu->getItems() as $item) {
+        $i % 2 === 0
+            ? $item->showItemExtra()
+            : $item->hideItemExtra();
+
+        $menu->redraw();
+    }
+
+    $i++;
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu Custom Item Extra')
+    ->addItem('First Item', $itemCallable, true)
+    ->addItem('Second Item', $itemCallable, true)
+    ->addItem('Third Item', $itemCallable, true)
+    ->addLineBreak('-')
+    ->setItemExtra('**')
+    ->build();
+
+$menu->open();

src/CliMenu.php

@@ -72,7 +72,7 @@ public function __construct(
         $this->title      = $title;
         $this->items      = $items;
         $this->terminal   = $terminal ?: TerminalFactory::fromSystem();
-        $this->style      = $style ?: new MenuStyle();
+        $this->style      = $style ?: new MenuStyle($this->terminal);
 
         $this->selectFirstItem();
     }
@@ -153,6 +153,10 @@ public function isOpen()
     public function addItem(MenuItemInterface $item)
     {
         $this->items[] = $item;
+
+        if (count($this->items) === 1) {
+            $this->selectFirstItem();
+        }
     }
 
     /**
@@ -346,6 +350,28 @@ public function closeThis()
         $this->open = false;
     }
 
+    /**
+     * @return MenuItemInterface[]
+     */
+    public function getItems()
+    {
+        return $this->items;
+    }
+
+    /**
+     * @param MenuItemInterface $item
+     */
+    public function removeItem(MenuItemInterface $item)
+    {
+        $key = array_search($item, $this->items);
+
+        if (false === $key) {
+            throw new \InvalidArgumentException('Item does not exist in menu');
+        }
+
+        unset($this->items[$key]);
+    }
+
     /**
      * @return MenuStyle
      */

src/MenuItem/AsciiArtItem.php

@@ -125,4 +125,22 @@ public function showsItemExtra()
     {
         return false;
     }
+
+    /**
+     * Enable showing item extra
+     *
+     */
+    public function showItemExtra()
+    {
+        //noop
+    }
+
+    /**
+     * Disable showing item extra
+     *
+     */
+    public function hideItemExtra()
+    {
+        //noop
+    }
 }

src/MenuItem/LineBreakItem.php

@@ -95,4 +95,22 @@ public function showsItemExtra()
     {
         return false;
     }
+
+    /**
+     * Enable showing item extra
+     *
+     */
+    public function showItemExtra()
+    {
+        //noop
+    }
+
+    /**
+     * Disable showing item extra
+     *
+     */
+    public function hideItemExtra()
+    {
+        //noop
+    }
 }

src/MenuItem/MenuItemInterface.php

@@ -48,4 +48,16 @@ public function getSelectAction();
      * @return bool
      */
     public function showsItemExtra();
+
+    /**
+     * Enable showing item extra
+     *
+     */
+    public function showItemExtra();
+
+    /**
+     * Disable showing item extra
+     *
+     */
+    public function hideItemExtra();
 }

src/MenuItem/SelectableTrait.php

@@ -82,4 +82,22 @@ public function showsItemExtra()
     {
         return $this->showItemExtra;
     }
+
+    /**
+     * Enable showing item extra
+     *
+     */
+    public function showItemExtra()
+    {
+        $this->showItemExtra = true;
+    }
+
+    /**
+     * Disable showing item extra
+     *
+     */
+    public function hideItemExtra()
+    {
+        $this->showItemExtra = false;
+    }
 }

src/MenuItem/StaticItem.php

@@ -80,4 +80,22 @@ public function showsItemExtra()
     {
         return false;
     }
+
+    /**
+     * Enable showing item extra
+     *
+     */
+    public function showItemExtra()
+    {
+        //noop
+    }
+
+    /**
+     * Disable showing item extra
+     *
+     */
+    public function hideItemExtra()
+    {
+        //noop
+    }
 }