Metadata-Version: 2.4
Name: ttkbootstrap-icons
Version: 3.1.1
Summary: 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.
Author-email: Israel Dryer <israel.dryer@gmail.com>
Project-URL: Homepage, https://github.com/israel-dryer/ttkbootstrap-icons
Keywords: tkinter,ttk,bootstrap,gui,desktop,python3,ui,widgets,theming,cross-platform,modern,responsive,python-gui,icon
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pillow>=9.1.0

﻿# ttkbootstrap-icons

[![PyPI](https://img.shields.io/pypi/v/ttkbootstrap-icons.svg)](https://pypi.org/project/ttkbootstrap-icons/)
[![Python Versions](https://img.shields.io/pypi/pyversions/ttkbootstrap-icons.svg)](https://pypi.org/project/ttkbootstrap-icons/)
[![Downloads](https://static.pepy.tech/badge/ttkbootstrap-icons)](https://pepy.tech/project/ttkbootstrap-icons)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](../../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

```bash
pip install ttkbootstrap-icons
```

---

## Quick start

```python
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):

```python
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](https://israel-dryer.github.io/ttkbootstrap-icons/stateful-icons/) 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.

```bash
ttkbootstrap-icons
# or
python -m ttkbootstrap_icons.browser
```

---

## Links

- Documentation: https://israel-dryer.github.io/ttkbootstrap-icons/
- Repository: https://github.com/israel-dryer/ttkbootstrap-icons

