Add border styling

src/CliMenu.php

@@ -319,6 +319,27 @@ protected function draw() : void
         $frame = new Frame;
 
         $frame->newLine(2);
+
+        $borderRow = [
+            sprintf(
+                "%s%s%s%s%s%s%s%s%s\n",
+                str_repeat(' ', $this->style->getMargin()),
+                $this->style->getBorderColourCode(),
+                str_repeat(' ', $this->style->getBorderLeftWidth()),
+                str_repeat(' ', $this->style->getPadding()),
+                str_repeat(' ', $this->style->getContentWidth()),
+                str_repeat(' ', $this->style->getPadding()),
+                str_repeat(' ', $this->style->getBorderRightWidth()),
+                "\033[0m",
+                str_repeat(' ', $this->style->getMargin())
+            )
+        ];
+
+        if ($this->style->getBorderTopWidth() > 0) {
+            for ($b = 0; $b < $this->style->getBorderTopWidth(); $b++) {
+                $frame->addRows($borderRow);
+            }
+        }
 
         if ($this->title) {
             $frame->addRows($this->drawMenuItem(new LineBreakItem()));
@@ -331,6 +352,12 @@ protected function draw() : void
         }, $this->items, array_keys($this->items));
 
         $frame->addRows($this->drawMenuItem(new LineBreakItem()));
+
+        if ($this->style->getBorderBottomWidth() > 0) {
+            for ($b = 0; $b < $this->style->getBorderBottomWidth(); $b++) {
+                $frame->addRows($borderRow);
+            }
+        }
 
         $frame->newLine(2);
 
@@ -360,15 +387,21 @@ protected function drawMenuItem(MenuItemInterface $item, bool $selected = false)
         $unsetColour = $selected
             ? $this->style->getSelectedUnsetCode()
             : $this->style->getUnselectedUnsetCode();
+
+        $borderColour = $this->style->getBorderColourCode();
 
-        return array_map(function ($row) use ($setColour, $unsetColour) {
+        return array_map(function ($row) use ($setColour, $unsetColour, $borderColour) {
             return sprintf(
-                "%s%s%s%s%s%s%s\n",
+                "%s%s%s%s%s%s%s%s%s%s%s\n",
                 str_repeat(' ', $this->style->getMargin()),
+                $borderColour,
+                str_repeat(' ', $this->style->getBorderLeftWidth()),
                 $setColour,
                 str_repeat(' ', $this->style->getPadding()),
                 $row,
                 str_repeat(' ', $this->style->getRightHandPadding(mb_strlen(s::stripAnsiEscapeSequence($row)))),
+                $borderColour,
+                str_repeat(' ', $this->style->getBorderRightWidth()),
                 $unsetColour,
                 str_repeat(' ', $this->style->getMargin())
             );

src/MenuStyle.php

@@ -73,6 +73,31 @@ class MenuStyle
      */
     private $titleSeparator;
 
+    /**
+     * @var int
+     */
+    private $borderTopWidth;
+
+    /**
+     * @var int
+     */
+    private $borderRightWidth;
+
+    /**
+     * @var int
+     */
+    private $borderBottomWidth;
+
+    /**
+     * @var int
+     */
+    private $borderLeftWidth;
+
+    /**
+     * @var string
+     */
+    private $borderColour;
+
     /**
      * Default Values
      *
@@ -89,6 +114,11 @@ class MenuStyle
         'itemExtra' => '✔',
         'displaysExtra' => false,
         'titleSeparator' => '=',
+        'borderTopWidth' => 0,
+        'borderRightWidth' => 0,
+        'borderBottomWidth' => 0,
+        'borderLeftWidth' => 0,
+        'borderColour' => 'white',
     ];
 
     public static function getDefaultStyleValues() : array
@@ -155,6 +185,12 @@ public function __construct(Terminal $terminal = null)
         $this->setItemExtra(static::$defaultStyleValues['itemExtra']);
         $this->setDisplaysExtra(static::$defaultStyleValues['displaysExtra']);
         $this->setTitleSeparator(static::$defaultStyleValues['titleSeparator']);
+        $this->setBorderTopWidth(static::$defaultStyleValues['borderTopWidth']);
+        $this->setBorderRightWidth(static::$defaultStyleValues['borderRightWidth']);
+        $this->setBorderBottomWidth(static::$defaultStyleValues['borderBottomWidth']);
+        $this->setBorderLeftWidth(static::$defaultStyleValues['borderLeftWidth']);
+        $this->setBorderColour(static::$defaultStyleValues['borderColour']);
+
     }
 
     public static function getAvailableColours() : array
@@ -233,7 +269,7 @@ public function getUnselectedUnsetCode() : string
      */
     protected function calculateContentWidth() : void
     {
-        $this->contentWidth = $this->width - ($this->padding*2) - ($this->margin*2);
+        $this->contentWidth = $this->width - ($this->padding*2) - ($this->margin*2) - ($this->borderRightWidth + $this->borderLeftWidth);
     }
 
     public function getFg() : string
@@ -267,7 +303,7 @@ public function getWidth() : int
 
     public function setWidth(int $width) : self
     {
-        $availableWidth = $this->terminal->getWidth() - ($this->margin * 2) - ($this->padding * 2);
+        $availableWidth = $this->terminal->getWidth() - ($this->margin * 2) - ($this->padding * 2) - ($this->borderRightWidth + $this->borderLeftWidth);
 
         if ($width >= $availableWidth) {
             $width = $availableWidth;
@@ -387,4 +423,74 @@ public function setTitleSeparator(string $actionSeparator) : self
 
         return $this;
     }
+
+    /**
+     * Shorthand function to set all borders values at once
+     */
+    public function setBorder(int $topWidth, int $rightWidth = null, int $bottomWidth = null, int $leftWidth = null, string $colour = null) : self
+    {
+        $this->borderTopWidth = $topWidth;
+        $this->borderRightWidth = $rightWidth ?? $topWidth;
+        $this->borderBottomWidth = $bottomWidth ?? $topWidth;
+        $this->borderLeftWidth = $leftWidth ?? $rightWidth ?? $topWidth;
+        if ($colour !== null) {
+            $this->borderColour = $colour;
+        }
+
+        return $this;
+    }
+    public function setBorderTopWidth(int $width) : self
+    {
+        $this->borderTopWidth = $width;
+
+        return $this;
+    }
+    public function setBorderRightWidth(int $width) : self
+    {
+        $this->borderRightWidth = $width;
+
+        return $this;
+    }
+    public function setBorderBottomWidth(int $width) : self
+    {
+        $this->borderBottomWidth = $width;
+
+        return $this;
+    }
+    public function setBorderLeftWidth(int $width) : self
+    {
+        $this->borderLeftWidth = $width;
+
+        return $this;
+    }
+    public function setBorderColour(string $colour) : self
+    {
+        $this->borderColour = $colour;
+
+        return $this;
+    }
+    public function getBorderTopWidth() : int
+    {
+        return $this->borderTopWidth;
+    }
+    public function getBorderRightWidth() : int
+    {
+        return $this->borderRightWidth;
+    }
+    public function getBorderBottomWidth() : int
+    {
+        return $this->borderBottomWidth;
+    }
+    public function getBorderLeftWidth() : int
+    {
+        return $this->borderLeftWidth;
+    }
+    public function getBorderColour() : string
+    {
+        return $this->borderColour;
+    }
+    public function getBorderColourCode() : string
+    {
+        return sprintf("\033[%sm", self::$availableBackgroundColors[$this->getBorderColour()]['set']);
+    }
 }