Docs and example for custom mappings

Author: AydinHassan

README.md

@@ -453,6 +453,41 @@ $menu = (new CliMenuBuilder)
 $menu->open();
 ```
 
+#### Custom Control Mapping
+
+This functionality allows to map custom key presses to a callable. For example we can set the key press "x" to close the menu:
+
+```php
+$exit = function(CliMenu $menu) {
+    $menu->close();
+}
+
+$menu = (new CliMenuBuilder)
+    ->addItem('Item 1')
+    ->build();
+
+$menu->addCustomMapping("x", $exit);
+
+$menu->open();
+```
+
+Another example is mapping shortcuts to a list of items:
+
+```php
+$myCallback = function(CliMenu $menu) {
+    // Do something
+}
+
+$menu = (new CliMenuBuilder)
+    ->addItem('List of [C]lients', $myCallback)
+    ->build();
+
+// Now, pressing Uppercase C (it's case sensitive) will call $myCallback
+$menu->addCustomMapping('C', $myCallback);
+
+$menu->open();
+```
+
 #### Dialogues
 
 ##### Flash

examples/custom-mapping.php

@@ -0,0 +1,20 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$exit = function (CliMenu $menu) {
+    $menu->close();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu')
+    ->addItem('First Item', $exit)
+    ->addItem('Second Item', $exit)
+    ->addLineBreak('-')
+    ->build();
+
+$menu->addCustomControlMapping('x', $exit);
+$menu->open();