ttkbootstrap

Common errors

• TclError: image "pyimageX" doesn't exist

  cause A `PhotoImage` object used by a widget (e.g., a button or label) has been garbage collected because no strong reference to it was maintained.
  fix Store the `PhotoImage` object as an attribute of the widget's parent (e.g., `self.my_image = PhotoImage(...)`) or as a global variable. This ensures it remains in memory as long as the widget needs it.

• ModuleNotFoundError: No module named 'ttkbootstrap.dialog'

  cause Attempting to import dialogs (like `Dialog` or `Messagebox`) from an old path that was removed or changed in `ttkbootstrap` v1.19.1 and later.
  fix Update your import statement. For general dialogs, use `from ttkbootstrap.dialogs import Messagebox` or `Querybox`. For the base custom `Dialog` class, use `from ttkbootstrap.dialogs.dialog import Dialog`.

• AttributeError: 'Window' object has no attribute 'mainloop'

  cause Often happens if `tb.Window()` is called but the `mainloop()` method is not invoked at the end of the script to start the Tkinter event loop.
  fix Ensure `app.mainloop()` (where `app` is your `tb.Window` instance) is called at the very end of your application's setup code to start the GUI event loop.

Warnings

• breaking ttkbootstrap dropped support for Python 3.9 in version 1.19.0. Applications using Python 3.9 or older will fail to install or run with newer versions.
  Fix: Upgrade your Python environment to 3.10 or newer. The current recommended minimum is Python 3.10.
• deprecated The import path for certain dialog classes, such as `Dialog` (for creating custom dialogs), changed from `ttkbootstrap.dialog` to `ttkbootstrap.dialogs` in version 1.19.1. While `ttkbootstrap.dialogs` now holds pre-built dialogs like `Messagebox`, the base `Dialog` class also moved there.
  Fix: Update import statements from `from ttkbootstrap.dialog import Dialog` to `from ttkbootstrap.dialogs.dialog import Dialog` for custom dialogs, or `from ttkbootstrap.dialogs import Messagebox` for pre-built ones.
• gotcha When using `PhotoImage` objects (e.g., for icons on buttons or labels), ensure you maintain a reference to the image object. If the `PhotoImage` object is garbage collected, the image will disappear from the widget.
  Fix: Assign the `PhotoImage` object to an instance variable of a class or a global variable to prevent it from being garbage collected. Example: `self.icon = PhotoImage(file='icon.png'); button.config(image=self.icon)`.

Install

• pip install ttkbootstrap Install latest version

Imports

• Window

  import ttkbootstrap as tb
  app = tb.Window(themename="flatly")

  The primary entry point for a themed Tkinter application.
• PhotoImage

  from ttkbootstrap import PhotoImage

  Required for displaying images. Often used with `Label` or `Button` widgets.
• Messagebox
  wrong:

  from ttkbootstrap.dialog import Messagebox

  correct:

  from ttkbootstrap.dialogs import Messagebox

  Prior to v1.19.1, some dialogs (like `Dialog` itself) might have been referenced from `ttkbootstrap.dialog` but the correct path for pre-built dialogs is now `ttkbootstrap.dialogs`.

Quickstart

This quickstart creates a simple ttkbootstrap application with a themed window, a label, and a button. The `Window` class automatically sets up a themed Tkinter root window. Experiment with different `themename` values like 'darkly', 'superhero', or 'flatly' for varying aesthetics.

import ttkbootstrap as tb

def main():
    app = tb.Window(themename="cosmo") # Try 'darkly', 'superhero', 'flatly', etc.
    app.title("My ttkbootstrap App")
    app.geometry("400x200")

    label = tb.Label(app, text="Hello from ttkbootstrap!", font=('Helvetica', 16))
    label.pack(pady=30)

    button = tb.Button(app, text="Click Me", command=lambda: label.config(text="Button Clicked!"), bootstyle="primary")
    button.pack(pady=10)

    app.mainloop()

if __name__ == '__main__':
    main()