Skip to main content

Base package for font-based icons in Tkinter/ttkbootstrap with installable icon providers: Bootstrap, 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-4.0.0.tar.gz (90.4 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-4.0.0-py3-none-any.whl (33.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ttkbootstrap_icons-4.0.0.tar.gz
Algorithm Hash digest
SHA256 4d3045e053fa57ce1cc6524d8cd721715595114803cc362616d7cdc8a2a9c416
MD5 d43db3e5305df3da84f22d2588be81d4
BLAKE2b-256 a6ac19312258e408ba8c708256fd948bc78ab7d1d944991adfaf4044d56b7c78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ttkbootstrap_icons-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75ac2a2205be559a348bc6df037976f02e9a0cf4058e3ed037ddf2520dfa8cfd
MD5 dfa76520a0854269f6fa94ab8867b8a7
BLAKE2b-256 b07ef610e3d08fc64c419ff6a0c6d0b168e0fe15ad181f45f51ef37ea3f434b7

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