QtShadcn

Modern styling and theming framework for Qt/PySide and PyQt applications, inspired by shadcn/ui.

QtShadcn loads a local XML theme file containing <light> and <dark> palettes, resolves the design tokens, renders a QSS stylesheet via Jinja2, and applies it to your QApplication in one call.

---

Features

• Light & dark palettes — single XML file, both modes
• Auto mode — follows the OS theme via darkdetect
• Binding neutral — works with PySide6, PyQt6, PySide2, or PyQt5 via qtpy
• Custom fonts — drop font files in the package resources/fonts/ directory
• Disk cache — theme is re-rendered only when the source file changes
• App-provided Qt runtime — install the Qt binding your app already uses
• Themed icons — SVG check icons generated and cached at runtime

---

Requirements

• Python >= 3.11
• One of: PySide6, PyQt6, PySide2, or PyQt5 (provided by your application environment)

---

Installation

# Install QtShadcn from PyPI
pip install qtshadcn

# Or with uv
uv add qtshadcn

QtShadcn does not bundle a Qt binding. Install the binding your application already uses and optionally set QT_API to select one when multiple bindings are present:

# PySide6 (recommended)
pip install PySide6
export QT_API=pyside6

# Or PyQt6
pip install PyQt6
export QT_API=pyqt6

# Or PySide2
pip install PySide2
export QT_API=pyside2

# Or PyQt5
pip install PyQt5
export QT_API=pyqt5

---

Quick Start

import sys
from qtpy import QtWidgets
from qtshadcn import setTheme, setThemeMode, getTheme

app = QtWidgets.QApplication(sys.argv)

setThemeMode("auto", save=False)  # "auto" | "light" | "dark"
setTheme("path/to/my_theme.xml", save=False)
tokens = getTheme()
print(tokens.primary)  # resolved hex color

label = QtWidgets.QLabel("Hello, QtShadcn!")
label.show()
sys.exit(app.exec())

---

Widget Gallery

Explore the supported widgets by running the gallery:

make gallery

The gallery includes a sidebar navigator, a light/dark toggle, and pages for every currently styled widget.

---

Supported Styled Widgets

QtShadcn currently ships QSS for:

• QWidget — base background, foreground, and typography classes
• QLabel — typography and disabled state
• QPushButton — variants, sizes, and disabled states
• QToolButton — compact icon/action variants
• QCheckBox — toggle controls with themed check icons and disabled states
• QRadioButton — radio controls with themed checked icons
• QLineEdit — input states including focus, disabled, and invalid
• QTextEdit — textarea states including focus, disabled, and invalid
• QComboBox and QFontComboBox — dropdowns, popups, and invalid states
• QProgressBar — determinate, thin, and disabled states
• QSlider — horizontal, vertical, tick, and disabled states
• QGroupBox and QFrame — layout containers

See the roadmap for what is planned next.

---

Theme File Format

A QtShadcn theme is a plain XML file with two palette sections:

<theme>
  <light>
    <background>#ffffff</background>
    <foreground>#020617</foreground>
    <primary>#0f172a</primary>
    <primary_foreground>#f8fafc</primary_foreground>
    <secondary>#f1f5f9</secondary>
    <secondary_foreground>#0f172a</secondary_foreground>
    <accent>#f1f5f9</accent>
    <accent_foreground>#0f172a</accent_foreground>
    <muted>#f1f5f9</muted>
    <muted_foreground>#64748b</muted_foreground>
    <destructive>#ef4444</destructive>
    <destructive_foreground>#f8fafc</destructive_foreground>
    <border>#e2e8f0</border>
    <input>#e2e8f0</input>
    <ring>#0f172a</ring>
    <radius>8px</radius>
    <font_family>Open Sans</font_family>
    <spacing>4px</spacing>
    <card>#ffffff</card>
    <card_foreground>#020617</card_foreground>
    <popover>#ffffff</popover>
    <popover_foreground>#020617</popover_foreground>
  </light>
  <dark>
    <!-- same tokens, dark values -->
  </dark>
</theme>

Unknown tokens are silently ignored so you can extend the format freely.

---

API Reference

QtShadcn exposes a small, composable public API directly from the package root:

from qtshadcn import (
    qsettings,
    ThemeMode,
    setThemeMode,
    toggleThemeMode,
    themeMode,
    isDarkTheme,
    setTheme,
    getTheme,
    setStyleSheet,
    getStyleSheet,
    SystemThemeWatcher,
)

setThemeMode(mode, *, save=True)

Set the active theme mode ("auto", "light", or "dark") and re-render the stylesheet.

toggleThemeMode(*, save=True)

Cycle the theme mode: auto → light → dark → auto.

themeMode() -> ThemeMode

Return the current ThemeMode.

isDarkTheme() -> bool

Return whether the resolved active palette is dark.

setTheme(source, *, custom_tokens=None, save=True)

Load a QtShadcn .xml or .json theme, apply optional token overrides, and re-render the stylesheet.

getTheme() -> ShadcnThemeTokens

Return the resolved tokens for the active mode.

setStyleSheet(source, *, save=True)

Set an additional stylesheet (inline QSS/Jinja string or .qss/.jinja file path) layered on top of the base QSS.

getStyleSheet() -> str

Return the current additional stylesheet content.

ShadcnThemeTokens

Immutable Pydantic model with one field per design token (background, primary, border, radius, font_family, ...). Every token is required in both XML palettes; missing tokens raise ThemeParseError.

---

Documentation

• Docs site: https://qtshadcn.readthedocs.io/
• Widget gallery: examples/gallery/main.py (run make gallery)

---

Contributing

Contributions are welcome. See CONTRIBUTING.md for setup instructions, coding conventions, and architecture rules.

---

License

MIT