tkfeather 1.0.0

Feather icons for tkinter

tkfeather

tkinter support for feather icons

Latest Changes

Current version: 1.0.0-rc1

• Initial release

Usage

Import

from tkfeather import Feather

Initialization:

Feather(name: str, size: int [optional])

Args

• name: str - The name of the Feather icon
• size: int [optional] - The size of the icon image in pixels, square (default: 24)

Note: Sizes smaller than 24px are allowed but aren't recommended as the icon will become blurred

The minimum allowed size is 1, and the maximum allowed size is 1024

Properties

• Feather.icon - an ImageTk.PhotoImage object for the given Feather icon

Class Methods

• Feather.icons_available() returns a list with the names of all available Feather Icons

Exceptions

• Passing a size value outside the range of 1 to 1024 will raise a ValueError
• Trying to use an icon that doesn't exist will raise a FileNotFoundError

Example

You must maintain a reference to the Feather instance in a variable in order to keep the image from being garbage-collected:

# this works
feather = Feather('home')
label = tk.Label(parent, image=feather.icon)
label.pack()

If you don't maintain a reference to the image, it won't appear!

# this doesn't work - the label will have no image
label = tk.Label(parent, image=Feather('home').icon)
label.pack()

Installation

pip install tkfeather

Packaged Dependencies

• PNG Icons
• Pillow >= 9.2.0

Acknowledgements

Based on Feather Icons originally created by Cole Bemis

• https://feathericons.com
• https://github.com/feathericons/feather

Under MIT License