FontAwesome icons in PyQt and PySide applications
Project description
QtAwesome
Copyright © 2015–2020 Spyder Project Contributors
Description
QtAwesome enables iconic fonts such as Font Awesome and Elusive Icons in PyQt and PySide applications.
It started as a Python port of the QtAwesome C++ library by Rick Blommers.
Installation
Using conda:
conda install qtawesome
or using pip (only if you don't have conda installed):
pip install qtawesome
Usage
Supported Fonts
QtAwesome identifies icons by their prefix and their icon name, separated by a period (.) character.
The following prefixes are currently available to use:
-
-
FA 5.9.0 features 1,534 free icons in different styles:
fa5prefix has 151 icons in the "regular" style.fa5sprefix has 935 icons in the "solid" style.fa5bprefix has 413 icons of various brands.
-
fais the legacy FA 4.7 version with its 675 icons but all of them (and more!) are part of FA 5.x so you should probably use the newer version above.
-
-
eiprefix holds Elusive Icons 2.0 with its 304 icons. -
mdiprefix holds Material Design Icons 5.4.55 with its 5555 icons.
Examples
import qtawesome as qta
- Use Font Awesome, Elusive Icons or Material Design Icons.
# Get FontAwesome 5.x icons by name in various styles:
fa5_icon = qta.icon('fa5.flag')
fa5_button = QtWidgets.QPushButton(fa5_icon, 'Font Awesome! (regular)')
fa5s_icon = qta.icon('fa5s.flag')
fa5s_button = QtWidgets.QPushButton(fa5s_icon, 'Font Awesome! (solid)')
fa5b_icon = qta.icon('fa5b.github')
fa5b_button = QtWidgets.QPushButton(fa5b_icon, 'Font Awesome! (brands)')
# or Elusive Icons:
asl_icon = qta.icon('ei.asl')
elusive_button = QtWidgets.QPushButton(asl_icon, 'Elusive Icons!')
# or Material Design Icons:
apn_icon = qta.icon('mdi.access-point-network')
mdi_button = QtWidgets.QPushButton(apn_icon, 'Material Design Icons!')
- Apply some styling
# Styling icons
styling_icon = qta.icon('fa5s.music',
active='fa5s.balance-scale',
color='blue',
color_active='orange')
music_button = QtWidgets.QPushButton(styling_icon, 'Styling')
- Stack multiple icons
# Stacking icons
camera_ban = qta.icon('fa5s.camera', 'fa5s.ban',
options=[{'scale_factor': 0.5,
'active': 'fa5s.balance-scale'},
{'color': 'red'}])
stack_button = QtWidgets.QPushButton(camera_ban, 'Stack')
stack_button.setIconSize(QtCore.QSize(32, 32))
- Animations
# Spining icons
spin_button = QtWidgets.QPushButton(' Spinning icon')
spin_icon = qta.icon('fa5s.spinner', color='red',
animation=qta.Spin(spin_button))
spin_button.setIcon(spin_icon)
- Display Icon as a widget
# Spining icon widget
spin_widget = qta.IconWidget()
spin_icon = qta.icon('mdi.loading', color='red',
animation=qta.Spin(spin_widget))
spin_widget.setIcon(spin_icon)
# Simple icon widget
simple_widget = qta.IconWidget('mdi.web', color='blue')
- Screenshot
Other features
- QtAwesome comes bundled with Font Awesome, Elusive Icons and Material Design
Icons but it can also be used with other iconic fonts. The
load_fontfunction allows to load other fonts dynamically. - QtAwesome relies on the QtPy project as a compatibility layer on the top ot PyQt or PySide.
Icon Browser
QtAwesome ships with a browser that displays all the available icons. You can use this to search for an icon that suits your requirements and then copy the name that should be used to create that icon!
Once installed, run qta-browser from a shell to start the browser.
License
MIT License. Copyright 2015 - The Spyder development team. See the LICENSE file for details.
The Font Awesome, Elusive Icons and Material Design Icons fonts are licensed under the SIL Open Font License.
Sponsors
Spyder and its subprojects are funded thanks to the generous support of
and the donations we have received from our users around the world through Open Collective:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for QtAwesome-1.0.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 970447822cd1f2e36fc8a1a3a8ff239e682516de9ed5f6f960413e83f0e997ed |
|
| MD5 | b38611f9a38158c7341a5749d31ec6cb |
|
| BLAKE2b-256 | 32eea14f4b5635a85ccaf24593b6b4dd2c6fdecc9c10d87c94d63676e2601104 |
