[README.md] Fixed the broken showcase table

This commit is contained in:
BlueFox 2024-11-13 21:33:27 +00:00
parent c7b86280a1
commit 091f61f5e7

123
README.md
View File

@ -49,21 +49,116 @@ menuItems = [("first item", first),
button_mappings = {"prev_btn":prev_btn, "next_btn": next_btn, "ok_btn": ok_btn}
```
| Result | Code |
| --------- | ------- |
| ![No title, first item & cycling on -> up & down, vertical scrolling](images/2x16-title-vertical-up-down-cycling.jpg) | ```python
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=True, hide_menu_name=True, name="Fullscreen!")
<table>
<tr>
<th>Cycling</th>
<th>Title shown</th>
<th>Scroll direction</th>
<th>Initial selection</th>
<th>Result</th>
<th>Code</th>
</tr>
<tr>
<td>yes</td>
<td>no</td>
<td>vertical</td>
<td>first</td>
<td><img src="images/2x16-title-vertical-up-down-cycling.jpg" alt="No title, first item & cycling on -> up & down, vertical scrolling"/></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=True, hide_menu_name=True)
menu.setup(menuItems)
menu.run()
``` |
| ![No title, first item & no cycling -> only down, vertical scrolling](images/2x16-no-title-vertical-only-down.jpg) | |
| ![No title, middle item -> up & down, vertical scrolling](images/2x16-no-title-vertical-up-down.jpg) | |
| ![No title, last item & no cycling -> only up, vertical scrolling](images/2x16-no-title-vertical-only-up.jpg) | |
| ![With title, only one option, vertical scrolling](images/2x16-title-vertical-no-options.jpg) | |
| ![With title, first item & no cycling -> only down, vertical scrolling](images/2x16-title-vertical-only-down.jpg) | |
| ![With title, middle item -> up & down, vertical scrolling](images/2x16-title-vertical-up-down.jpg) | |
| ![With title, last item & no cycling -> only up, vertical scrolling](images/2x16-title-vertical-only-up.jpg) | |
| ![With title, middle item -> forward and backward, horizontal scrolling](images/2x16-title-horizontal.jpg) | |
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>no</td>
<td>vertical</td>
<td>first</td>
<td><img src="images/2x16-no-title-vertical-only-down.jpg" alt="No title, first item &amp; no cycling -&gt; only down, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=<b><i>False</i></b>, hide_menu_name=True) # <- change of cycle to False!
menu.setup(menuItems)
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>no</td>
<td>vertical</td>
<td>middle</td>
<td><img src="images/2x16-no-title-vertical-up-down.jpg" alt="No title, middle item -&gt; up &amp; down, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=True
menu.setup(menuItems, <b><i>start_selection=1</i></b>) # <- change of the initial selection
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>no</td>
<td>vertical</td>
<td>last</td>
<td><img src="images/2x16-no-title-vertical-only-up.jpg" alt="No title, last item &amp; no cycling -&gt; only up, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=True)
menu.setup(menuItems, start_selection<b><i>=2</i></b>) # <- set initial selection to the last element
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>yes</td>
<td>vertical</td>
<td>no options (first and last)</td>
<td><img src="images/2x16-title-vertical-no-options.jpg" alt="With title, only one option, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=<b><i>False, name="No options!"</i></b>) # now with a title
menu.setup(<b><i>[("Only option", lambda: print("Only option chosen!"))]</i></b>) # now with only one option (ignoring menuItems!)
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>yes</td>
<td>vertical</td>
<td>first</td>
<td><img src="images/2x16-title-vertical-only-down.jpg" alt="With title, first item & no cycling -> only down, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=False, name="No options!")
menu.setup(<b><i>menuItems</i></b>) # now with menuItems again
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>yes</td>
<td>vertical</td>
<td>middle</td>
<td><img src="images/2x16-title-vertical-up-down.jpg" alt="With title, middle item -> up & down, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=False, name="lcdMenu!")
menu.setup(menuItems<b><i>, start_selection=1</i></b>) # now with an index again
menu.run()</pre></td>
</tr>
<tr>
<td>no</td>
<td>yes</td>
<td>vertical</td>
<td>last</td>
<td><img src="images/2x16-title-vertical-only-up.jpg" alt="With title, last item & no cycling -> only up, vertical scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=False, cycle=False, hide_menu_name=False, name="lcdMenu!")
menu.setup(menuItems, start_selection<b><i>=2</i></b>) # <- set initial selection to the last element
menu.run()</pre></td>
</tr>
<tr>
<td>yes</td>
<td>yes</td>
<td>horizontal</td>
<td>first</td>
<td><img src="images/2x16-title-horizontal.jpg" alt="With title, middle item -> forward and backward, horizontal scrolling"></td>
<td><pre>
menu = lcdMenu(LCD, button_mappings, scroll_direction=<b><i>True</i></b>, cycle=<b><i>True</i></b>, hide_menu_name=False, name="lcdMenu!")
menu.setup(menuItems)
menu.run()</pre></td>
</tr>
</table>
## License