Skip to content

Latest commit

 

History

History
162 lines (104 loc) · 4.91 KB

README.md

File metadata and controls

162 lines (104 loc) · 4.91 KB
Raw

PyQtDarkTheme

PyQtDarkTheme applies a flat dark theme to QtWidgets application. There's a light theme too. Color balanced from the dark theme for easy viewing in daylight.

Check out the complete documentation.

Project status PyPI Latest Release Python Versions Qt Versions License

Tests pre-commit.ci status codecov Documentation Status

Features

  • A flat dark and light theme
  • Support PySide and PyQt
  • Sync with OS's theme and accent (Mac, Windows, Linux)
  • Resolve the style differences between Qt versions
  • Provide dark/light theme QPalette
  • Override Qt old standard icons

Themes

Dark Theme

widget_gallery_dark_theme

Light Theme

widget_gallery_light_them

Requirements

  • Python 3.7+
  • Qt 5.15+
  • PySide6, PyQt6, PyQt5 or PySide2

Installation Method

  • Last released version

    pip install pyqtdarktheme

  • Latest development version

    pip install git+https://github.com/5yutan5/PyQtDarkTheme.git@main

Usage

import sys

from PySide6.QtWidgets import QApplication, QMainWindow, QPushButton

import qdarktheme

app = QApplication(sys.argv)
# Apply the complete dark theme to your Qt App.
qdarktheme.setup_theme()

main_win = QMainWindow()
push_button = QPushButton("PyQtDarkTheme!!")
main_win.setCentralWidget(push_button)

main_win.show()

app.exec()

Further information can be found in our docs:

Enable HiDPI

# enable_hi_dpi() must be called before the instantiation of QApplication.
qdarktheme.enable_hi_dpi()
app = QApplication(sys.argv)
qdarktheme.setup_theme()

For Qt6 bindings, HiDPI “just works” without using this function.

Light theme

qdarktheme.setup_theme("light")

Sync with OS's theme and accent

qdarktheme.setup_theme("auto")

sync with os theme

On macOS, qdarktheme also syncs with accent colors. sync with os accent

Customizing colors

You can customize the theme color.

# Customize accent color.
qdarktheme.setup_theme(custom_colors={"primary": "#D0BCFF"})

For a list of all customizable colors, see the Theme Color Reference:

Sharp frame

You can change the corner style.

# Default is "rounded".
stylesheet = qdarktheme.setup_theme(corner_shape="sharp")

QPalette and stylesheet

You can also only load QPalette and stylesheet. qdarktheme.setup_theme uses the following functions internally.

palette = qdarktheme.load_palette(theme="dark")
stylesheet = qdarktheme.load_stylesheet(theme="dark")

Example

To check all Qt widgets, run:

python -m qdarktheme.widget_gallery

License

The svg files for the PyQtDarkTheme are derived Material design icons(Apache License Version 2.0). Qt stylesheets are originally fork of QDarkStyleSheet(MIT License). Other files are covered by PyQtDarkTheme's MIT license. The accent detector(qdarktheme/_os_appearance/_accent/_mac_detect) is inspired by darkdetect(3-clause BSD License).

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. You can get started by reading this:

Change log

See Releases.