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.1.2.tar.gz (275.1 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.1.2-py3-none-any.whl (219.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ttkbootstrap_icons-3.1.2.tar.gz
  • Upload date:
  • Size: 275.1 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.1.2.tar.gz
Algorithm Hash digest
SHA256 6e9d7345039fc4b4351a777b402408f9304f9f998390a53d9ff20331608ed7da
MD5 19e52e9c6eaf154d7b34dc7d2bee04b7
BLAKE2b-256 58233e8d624428195d0fd594459b99c1520bb650947e5ed898e44e9a73002901

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ttkbootstrap_icons-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5b24bf2489e8cb36b7caef1a1bd4357e7fba236bc6347e2fb6a264af0964544a
MD5 4e044231288d271c541f1920a4d45136
BLAKE2b-256 44d831b61874c5582a5277be8dd766c776e89cc49f559432932917b52d2a8a06

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