CTkListbox

Install the CTkListbox package using pip to use the listbox widget with customtkinter.

pip install CTkListbox

To use CTkListbox, import it from CTkListbox, initialize it with a parent widget, and use .insert(index, option) to populate it. You can pass a command function to the constructor to handle selection events.

import customtkinter
from CTkListbox import *

def show_value(selected_option):
    print(selected_option)
    
root = customtkinter.CTk()

listbox = CTkListbox(root, command=show_value)
listbox.pack(fill="both", expand=True, padx=10, pady=10)

listbox.insert(0, "Option 0")
listbox.insert(1, "Option 1")
listbox.insert(2, "Option 2")
listbox.insert(3, "Option 3")
listbox.insert(4, "Option 4")
listbox.insert(5, "Option 5")
listbox.insert(6, "Option 6")
listbox.insert(7, "Option 7")
listbox.insert("END", "Option 8")

root.mainloop()

The following methods are available to manipulate the CTkListbox instance:

• .insert(index, option): add new option to the listbox
• .get(): get the selected option(s)
• .delete(index): delete any option from the listbox. Use .delete("all") to delete all options
• .size(): get the size of the listbox
• .activate(index): activate any option
• .deactivate(index): deactivate any option
• .curselection(): returns indexes of selected options
• .configure(): change some parameters for the listbox
• .see(index): move the listbox scrollbar to the index place
• .move_up(index): reorder option up in the listbox
• .move_down(index): reorder option down in the listbox