API Documentation

ttkbootstrap is a wrapper on tkinter. Any widget or function not defined specifically in this library can be found in other references.

🌈 colorutils module

This module contains various helper methods for manipulating colors.

💬 dialogs module

This module contains various base dialog base classes (ending in "Dialog") that can be used to create custom dialogs for the end user. These base classes serve as the basis for the pre-defined static helper methods in the Messagebox, and Querybox container classes, which include many pre-defined message and query dialog configurations.

❯ ColorChooserDialog
❯ ColorDropperDialog
❯ Dialog
❯ FontDialog
❯ MessageBox
❯ MessageDialog
❯ QueryBox
❯ QueryDialog

😉 icons module

This module contains classes that provide emojis or image icons for your application. They can be used in text as Emoji or in the PhotoImage class as Icon.

❯ Emoji
❯ Icon

🈚 localization module

The module includes methods and classes for localizing the text in gui widgets. Your help is needed to add to the msg files used to translate the text!

📜 scrolled module

This module contains various scrolled widgets such as ScrolledText and ScrolledFrame.

❯ ScrolledFrame
❯ ScrolledText

🎨 style module

This module contains the classes that make up the ttkbootstrap theme and style engine. Depending on how you use ttkbootstrap, you may never need to use any of these classes directly, but then again, you may, so the docs are here for your reference.

❯ Style
❯ Colors
❯ ThemeDefinition
❯ StyleBuilderTk
❯ StyleBuilderTTK
❯ Bootstyle

🪟 tableview module

❯ Tableview
❯ TableColumn
❯ TableRow

🛎️ toast module

This module has a class called ToastNotification which provides a semi-transparent popup window for temporary alerts or messages.

This module contains a class of the same name that provides a semi-transparent tooltip popup window that shows text when the mouse is hovering over the widget and closes when the mouse is no longer hovering over the widget.

☑️ widgets module

This module contains the custom ttkbootstrap widgets linked below.

❯ DateEntry
❯ Floodgauge
❯ Meter

🗔 window module

This module contains a class of the same name that wraps the tkinter.Tk and Style classes to provide a more convenient api for initial application startup. This also applies to the Toplevel class.

❯ Window
❯ Toplevel

⚙️ utility module

This module includes various utility functions that may or may not be useful to the end user. Click the header to read more.

❓other references

This api reference does not include classes, methods, and functions inherited from tkinter. To learn more about how to use tkinter, you can consult any of the resources listed below:

❯ docs.python.org
❯ tkdocs
❯ pythontutorial.net
❯ anzeljg
❯ tcl/tk