Skip to main content

Font-based icons for Tkinter/ttkbootstrap with a built-in Bootstrap set and installable providers: Font Awesome, Material, Ionicons, Remix, Fluent, Simple, Weather, Lucide, Eva & more.

Project description

ttkbootstrap-icons

PyPI Python Versions Downloads License

Font-based icons for Tkinter and ttkbootstrap, with a built-in Bootstrap Icons set and optional provider packages (Font Awesome, Material, Remix, Fluent, Simple, Weather, Lucide, Eva, Typicons, and more). Includes a lightweight Icon Browser to search and copy names.


Highlights

  • Built-in Bootstrap Icons provider
  • Install-and-use provider packages (auto-discovered)
  • Simple Python API for size, color, and style
  • Fast Icon Browser to preview and copy names
  • Pure-Python rendering with Pillow

Documentation

Full documentation, provider list, API reference, and usage guides:

https://israel-dryer.github.io/ttkbootstrap-icons/

Install

pip install ttkbootstrap-icons

Quick start

import tkinter as tk
from ttkbootstrap_icons import BootstrapIcon

root = tk.Tk()
icon = BootstrapIcon("house", size=24, color="#0d6efd", style="fill")
tk.Label(root, image=icon.image, text=" Home", compound="left").pack(padx=10, pady=10)
root.mainloop()

Stateful Icons (v3.1.0+)

Icons can automatically change appearance based on widget states (hover, pressed, disabled, selected):

import ttkbootstrap as tb
from ttkbootstrap_icons import BootstrapIcon

app = tb.Window()
icon = BootstrapIcon("mic-mute-fill", size=64)
toggle = tb.Checkbutton(app, compound="image", bootstyle="toolbutton")
toggle.pack(padx=20, pady=20)

# Icon automatically switches to mic-fill when selected
icon.map(toggle, statespec=[("selected", {"name": "mic-fill"})])

app.mainloop()

See the Stateful Icons documentation for automatic color mapping, custom state specifications, and advanced examples.


Icon Browser

Search and preview icons across all installed providers, then copy names for use in code.

ttkbootstrap-icons
# or
python -m ttkbootstrap_icons.browser

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ttkbootstrap_icons-3.3.0.tar.gz (275.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ttkbootstrap_icons-3.3.0-py3-none-any.whl (220.0 kB view details)

Uploaded Python 3

File details

Details for the file ttkbootstrap_icons-3.3.0.tar.gz.

File metadata

  • Download URL: ttkbootstrap_icons-3.3.0.tar.gz
  • Upload date:
  • Size: 275.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for ttkbootstrap_icons-3.3.0.tar.gz
Algorithm Hash digest
SHA256 b316b0a664ba38dd6be23af26aaa77c680242a68369414f82a9c11017bf81dde
MD5 5a8a550a326394918bdff6a102835345
BLAKE2b-256 ca575fbbdbe7776d322895b2696262bcabf3f5f869949c9f31a149fc93117b6a

See more details on using hashes here.

File details

Details for the file ttkbootstrap_icons-3.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ttkbootstrap_icons-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 31d6c6bb6b634ba70efce1e3da721f702128ca102f66be0acf7e2e645fdcf335
MD5 8e6173a87f042b47969ab871d3002509
BLAKE2b-256 4390ee916102d8e64641ebc2fa0d26d581a769a3f6bdd60cf65fedf6ee8383eb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page