Home

How to use

Import things you need

from ConsoleMenu.menu import Menu
from ConsoleMenu.items.natives import Button

Create menu and append an new item

itemsMenu = Menu("", (0,)) # param 2 is useless
itemMenu.appendItem(Button("Item 1"))

Run menu pool

itemMenu.run_pool()

Use settings

If you want to edit the menu settings like the characters you need to show

import ConsoleMenu.settings as settings 

new_settings = settings.default_menu_settings # This is the default settings that will be used by Menu
# Change the settings you want 
new_settings["left-character"] = "["
new_settings["right-character"] = "]"

# To applay this settings do this steps

# When you create a new menu 
# Just put the new_settings into the class init
itemMenu = Menu('Items', (0,), settings=new_settings)


# Or when you want to change it when the menu pool running
itemMenu.settings = new_settings
itemMenu._rendermenu() # Render the menu to view the new settings

Example code

from ConsoleMenu.menu import Menu
from ConsoleMenu.items.natives import *
import ConsoleMenu.settings as pkg_settings

characters = {}

def tms(status):
    print(status)

def getValuesForStyle(key):
    if key in ["minimal_width", "minimal_height"]:
        return [i for i in range(0, 32)]
    
    if key in ['left-character', 'right-character']:
        isright = key == 'right-character'
        return [
            '|',
            ':',
            '!',
            ('[' if not isright else ']'),
            ('(' if not isright else ')'),
            ('{' if not isright else '}'),
            ('<' if not isright else '>'),
#            ...

        ]

    if key in ['top-character', 'middle-character', 'bottom-character']:
        return [
            '-',
            '_',
            '+',
            '=',
            'ـ', # This could be not work
            '~',
#            ...
        ]

def exit():
    menu.running = False


menu = Menu('Menu', (0,0))



stylemenu = SubMenu("Styles", None, "Style Menu")

for key, value in zip(pkg_settings.default_menu_settings.keys(), pkg_settings.default_menu_settings.values()):
    
    def style_change(key):
        chrs = characters[key]
        chrs['index'] += 1
        if chrs['index'] > len(chrs['values'])-1:
            chrs['index'] = 0
        
        menu.settings[key] = chrs['values'][chrs['index']]
        stylemenu.settings[key] = chrs['values'][chrs['index']]
        stylemenu._rendermenu()
    

    values = getValuesForStyle(key)

    characters[key] = {
        "value": value,
        "index": 0 ,
        "values": values
    }
    
    vkey = key.replace('-', ' ').replace('_', ' ')
    vkey = ''.join([vkey[0].upper(), *list(vkey)[1:]])

    stylemenu.appendItem(Button(vkey, style_change, call_params=(key,)))

menu.appendItem(CheckBox('Toggel Menu style', tms, True))
menu.appendItem(stylemenu) # sub-menu fixed
menu.appendItem(Button('Exit', exit))

menu.run_pool()