Apply mica background (if supported) and immersive dark mode to Windows 11 Win32 apps made with python, such as Tkinter or PyQt/PySide apps
Project description
Win32mica: A simple module to add the Mica effect and enable immersive dark mode on Python UI Windows
The aim of this project is to apply the Mica effect and enable immersive dark mode on python applications made with Python, like Tkinter, PyQt/PySide, WxPython, Kivy, etc.
This will work on any windows version, including the new released dev builds where the mica API is public.
View this project on PyPi View this project on GitHub
Installation:
python -m pip install win32mica
Requirements:
- Windows 11
- A window set to not have a transparent background and to have extended composition enabled* (It might work with other settings, but nothing is guaranteed.)
- The HWND (identifier) of that window. More info: what is a hwnd?
- OPTIONAL: The window must have semi-transparent widgets/controls in order to recreate the transparency effect on the controls.
- OPTIONAL: Know if Windows has dark or light mode enabled. This can be checked with the
darkdetect
module
Usage:
#####################################################################
# #
# Those examples are oversimplified, please see the examples folder #
# for detailed usage with each UI library. #
# #
#####################################################################
hwnd = qtwindow.winId().__int__() # On a PyQt/PySide window
hwnd = tkwindow.frame() # On a tkinter window
# You'll need to adjust this to your program
from win32mica import MICAMODE, ApplyMica
mode = MICAMODE.DARK # Dark mode mica effect
mode = MICAMODE.LIGHT # Light mode mica effect
# Choose one of them following your app color scheme
import darkdetect # You can pass the darkdetect return value directly, since the ColorMode accepts bool values (True -> dark, False -> light)
mode = darkdetect.isDark()
win32mica.ApplyMica(hwnd, mode)
# Will return 0x32 if the system does not support Mica textures (Windows 10 or less). Immersive dark mode will still be applied (if selected theme is MICAMODE.DARK)
# Will return 0x00 if mica is applied successfully
# If DwmSetWindowAttribute fails, the output code will be returned
You can check out the examples folder for detailed use in Tk and PySide/PyQt.
Result:
Those are PySide2 windows with custom widgets.
Troubleshooting:
For more information about possible errors/mistakes, make sure to add the following before using win32mica:
# Add these lines at the very start of your script
import win32mica
win32mica.debugging = True
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.