Skip to content

Commit 134a317

Browse files
committed
Item extra and marker notes
1 parent ddb5cd9 commit 134a317

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,8 @@ The outcome is a full menu with dimmed rows to denote them being disabled. When
579579
#### Item Markers
580580

581581
The marker displayed by the side of the currently active item can be modified, UTF-8 characters are supported.
582-
The marker for un-selected items can also be modified. If you want to disable it, just set it to a space character.
582+
The marker for un-selected items can also be modified. If you want to disable it, just set it to a space character. Item
583+
markers only display on *selectable* items, which are: `\PhpSchool\CliMenu\MenuItem\SelectableItem` & `\PhpSchool\CliMenu\MenuItem\MenuMenuItem`.
583584

584585
```php
585586
$menu = (new CliMenuBuilder)
@@ -595,7 +596,9 @@ $menu = (new CliMenuBuilder)
595596

596597
You can optionally display some arbitrary text on the right hand side of an item. You can customise this text and
597598
you indicate which items to display it on. We use it to display `[COMPLETED]` on completed exercises, where the menu lists
598-
exercises for a workshop application.
599+
exercises for a workshop application.
600+
601+
Item Extra is currently limited to only `\PhpSchool\CliMenu\MenuItem\SelectableItem`.
599602

600603
The third parameter to `addItem` is a boolean whether to show the item extra or not. It defaults to false.
601604

0 commit comments

Comments
 (0)