CustomTkinter Documentation

Install the customtkinter module using pip. It is recommended to update frequently as the library is under active development.

To install:

pip3 install customtkinter

To update an existing installation:

pip3 install customtkinter --upgrade

To create a window, use customtkinter.CTk(). This is the CustomTkinter equivalent of the standard Tkinter Tk window. Widgets like CTkButton are used instead of standard tkinter widgets to ensure modern styling and HighDPI scaling support.

import customtkinter

customtkinter.set_appearance_mode("System")
customtkinter.set_default_color_theme("blue")

app = customtkinter.CTk()  # create CTk window
app.geometry("400x240")

def button_function():
    print("button pressed")

# Use CTkButton instead of tkinter Button
button = customtkinter.CTkButton(master=app, text="CTkButton", command=button_function)
button.place(relx=0.5, rely=0.5, anchor=customtkinter.CENTER)

app.mainloop()

You can quickly view all available widgets by running the built-in showroom function.

import customtkinter as ctk
ctk.run_showroom()

To add an image to a CTkButton, pass a PhotoImage object to the image argument.

To remove text entirely, set text="". Alternatively, use the compound option to specify how the text and image should be positioned relative to each other.

CustomTkinter allows you to set the global appearance mode and the default color theme for all widgets.

Appearance Modes:

• "System" (default): Adapts to the operating system's light/dark mode.
• "light": Forces light mode.
• "dark": Forces dark mode.

Color Themes:

• "blue" (default)
• "dark-blue"
• "green"

import customtkinter

customtkinter.set_appearance_mode("System")  # Modes: system, light, dark
customtkinter.set_default_color_theme("blue")  # Themes: blue, dark-blue, green