Awesome
<p align="center"> <img width="15%" align="center" src="https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/logo.png" alt="logo"> </p> <h1 align="center"> PyQt-Frameless-Window </h1> <p align="center"> A cross-platform frameless window based on PyQt5 </p> <p align="center"> <a style="text-decoration:none"> <img src="https://img.shields.io/badge/Platform-Win32%20|%20Linux%20|%20macOS-blue?color=#4ec820" alt="Platform Win32 | Linux | macOS"/> </a> <a style="text-decoration:none"> <img src="https://static.pepy.tech/personalized-badge/pyqt5-frameless-window?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads" alt="Download"/> </a> <a style="text-decoration:none"> <img src="https://img.shields.io/badge/License-GPLv3-blue?color=#4ec820" alt="GPLv3"/> </a> </p>Features
- Moving
- Stretching
- Window shadow
- Window animation
- Win11 snap layout
- Win10 acrylic blur
- Win11 mica blur
- Win7 Aero blur
- MacOS blur
Install
To install use pip:
pip install PyQt5-Frameless-Window
Or clone the repo:
git clone https://github.com/zhiyiYo/PyQt-Frameless-Window.git
python setup.py install
Requirements
Platform | Requirement |
---|---|
Win32 | pywin32 |
Linux | xcffib |
MacOS | pyobjc |
Usage
To use the frameless window, you only need to inherit FramelessWindow
or FramelessMainWindow
. Here is a minimal example:
import sys
from PyQt5.QtWidgets import QApplication
from qframelesswindow import FramelessWindow
class Window(FramelessWindow):
def __init__(self, parent=None):
super().__init__(parent=parent)
self.setWindowTitle("PyQt-Frameless-Window")
self.titleBar.raise_()
if __name__ == '__main__':
app = QApplication(sys.argv)
demo = Window()
demo.show()
sys.exit(app.exec_())
For more complex requirements, see demo.py and main_window.py.
Examples
- Normal frameless window
- Acrylic frameless window
Document
Want to know more about PyQt-Frameless-Window? Please read the help document 👈
Notes
-
FramelessWindow
provides a default custom title bar. If you don't like it, just rewrite it as demo.py does. -
Moving the acrylic window on Win10 may get stuck. At present, there is no good solution. Maybe you can disable the acrylic effect when moving the window, but I haven't done this in the source code.
-
Snap layout is not enabled by default. See #56 to learn how to enable it.
-
If you encounter this problem on Windows:
ImportError: DLL load failed while importing win32api
see my answer on stackoverflow or my blog for the solution.
-
If you are using PySide2, PySide6 or PyQt6, you can download the code in PySide2, PySide6 or PyQt6 branch.
Support
If this project helps you a lot and you want to support the development and maintenance of this project, feel free to sponsor me via 爱发电 or ko-fi. Your support is highly appreciated 🥰
See Also
Here are some projects that use PyQt-Frameless-Window:
- zhiyiYo/Groove: A cross-platform music player based on PyQt5
- zhiyiYo/Alpha-Gobang-Zero: A gobang robot based on reinforcement learning
- zhiyiYo/PyQt-Fluent-Widgets: A fluent design widgets library based on Qt
- zhiyiYo/QMaterialWidgets: A material design widgets library based on Qt
Reference
- wangwenx190/framelesshelper: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS
- libxcb: Basic Graphics Programming With The XCB Library
License
PyQt-Frameless-Window is licensed under GPLv3.
Copyright © 2021 by zhiyiYo.