Skip to main content

FluentQML

简体中文 | English

基于 PySide6 + QML 的 Fluent Design 组件库,提供 120fps+ 流畅动画体验。

✨ 特性

  • 纯 QML 渲染:无帧率限制,120fps+ 流畅动画
  • Fluent Design:微软 Fluent Design System 组件
  • Python 集成:PySide6 无缝集成,Python 侧管理业务逻辑
  • 配置系统:JSON 持久化 + 原子写入 + QML Property 桥接
  • 响应式状态:细粒度 Store 状态管理,支持 watch / batch 模式
  • 窗口管理:多种窗口布局 + 懒加载 + 云母效果 + 系统托盘
  • 跨平台:Windows、macOS、Linux

📦 安装

pip install fqml

注:PyPI 包名为 fqml(fluentqml 已被占用),但导入名仍是 fluentqml(from fluentqml import ...)。

开发模式安装:

git clone https://github.com/aki-riko/FluentQML.git
cd FluentQML
pip install -e ".[dev]"

🚀 快速开始

from fluentqml import App, Window, WindowType

app = App()
window = app.create_window(WindowType.BAR)
window.setWindowTitle("我的应用")
window.resize(1200, 800)

# 添加导航页面
window.addPage(HomePage, "Home", "首页")
window.addPage(SettingsPage, "Settings", "设置")

window.show()
app.exec()

🏗️ 架构

fluentqml/
├── FluentQML/              # QML 组件(模块名 FluentQML)
│   ├── controls/           # UI 控件
│   ├── _internal/          # 内部窗口实现
│   └── FluentEnums/        # 枚举与常量
└── python/                 # Python 模块
    ├── config/             # 配置管理系统
    ├── core/               # 核心引擎(主题/日志/图标/阴影)
    ├── window/             # 窗口管理(懒加载/云母/托盘)
    ├── state/              # 响应式状态存储
    ├── providers/          # 功能提供者(SVG/二维码/取色器)
    └── models/             # 数据模型(高性能表格)

📐 窗口类型

类型 枚举值 说明
WindowType.BAR 1 紧凑侧边导航(默认)
WindowType.SPLIT 0 展开式侧边导航
WindowType.FILLED 2 填充式分割窗口
from fluentqml import App, Window, WindowType

app = App()

# 紧凑侧边导航(默认)
window = app.create_window(WindowType.BAR)

# 展开式侧边导航
window = app.create_window(WindowType.SPLIT)

🎨 主题系统

切换主题

from fluentqml import setTheme, Theme

setTheme(Theme.LIGHT)   # 浅色
setTheme(Theme.DARK)    # 深色
setTheme(Theme.AUTO)    # 跟随系统

自定义主题色

from fluentqml import setAccentColor, getAccentColor

setAccentColor("#0078d4")
print(getAccentColor())  # "#0078d4"

QML 中使用

import FluentQML as Fluent

// Primary 按钮(style_primary 自动使用全局主题色)
Fluent.Button {
    text: "确定"
    style: Fluent.Enums.button.style_primary
}

// 访问 ThemeManager 属性
Rectangle {
    color: ThemeManager.accentColor
}

说明:ComboBox、Slider 因与 QtQuick.Controls 原生类型同名,未在顶层 FluentQML 模块导出, 需按子模块目录导入后使用,例如 import "../fluentqml/FluentQML/controls/inputs"。

⚙️ 配置系统

配置系统采用五层架构:Validator → SettingEntry → SettingsBase → AppConfig → ConfigManager

  • JSON 持久化:默认存储于 ~/.fluentqml/app.json
  • 原子写入:先写临时文件再替换,防止断电数据丢失
  • QML 桥接:通过 ConfigManager 单例暴露为 QML Property
from fluentqml.python.config import AppConfig, getConfigManager

# 获取配置值
config = getConfigManager()
print(config.lazyLoading)   # True
print(config.dpiScale)      # 0(跟随系统)

# 修改配置(自动保存到 JSON)
config.setDpiScale(150)

自定义配置项

from typing import ClassVar
from fluentqml.python.config import (
    SettingsBase, SettingEntry, EnumEntry,
    Validator,
)


class MyAppConfig(SettingsBase):
    auto_save: ClassVar[SettingEntry] = SettingEntry(
        group="Editor", name="AutoSave",
        default=True, validator=Validator.boolean(),
    )
    font_size: ClassVar[EnumEntry] = EnumEntry(
        group="Editor", name="FontSize",
        default=14,
        validator=Validator.choice([12, 14, 16, 18, 20, 24]),
    )

📊 状态管理

Store 提供响应式状态存储,支持细粒度 watch 和批量更新:

from fluentqml import Store

class AppStore(Store):
    def __init__(self):
        super().__init__("app")
        self.define("user", None)
        self.define("count", 0)

store = AppStore()

# 监听变化
store.watch("count", lambda new, old: print(f"{old} → {new}"))

# 设置值
store.set("count", 1)     # 输出: 0 → 1

# 批量更新(合并通知)
with store.batch():
    store.set("count", 10)
    store.set("user", "Alice")
# 退出 with 时统一通知

# 字典语法
store["count"] = 20
print(store["count"])      # 20

🔔 系统托盘

from fluentqml import SystemTrayIcon, Icon

tray = SystemTrayIcon(icon="AppIcon.png", toolTip="我的应用")
tray.addAction(text="显示", icon="Visibility", triggered=window.show)
tray.addSeparator()
tray.addAction(text="退出", icon="Power", triggered=app.quit)
tray.show()

🧩 UI 组件

控件

Button · Card · CheckBox · ToggleSwitch · LineEdit · ComboBox · Slider · ProgressBar · SpinBox · TableView · ListView · TreeView

导航

NavigationBar · NavigationView · Pivot · Breadcrumb · Windows

特效

Shadow · ShadowedRectangle · ColorOverlay · GaussianBlur

完整组件清单见各 controls/ 子目录的 qmldir。ComboBox、Slider 等与 QtQuick 原生同名的组件需经子模块目录导入。

🧪 测试

python -m pytest tests/ -v

📄 License

FluentQML is licensed under the MIT License.

Copyright © 2026 aki-riko.

🙏 Credits

Metadata

Release files for fqml 0.2.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fqml 0.2.13
File Size Uploaded Provenance
fqml-0.2.13.tar.gz 1.8 MB With provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for fqml 0.2.13
File Interpreter ABI Platform
fqml-0.2.13-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details
fqml-0.2.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details
fqml-0.2.13-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details

Total release size: 14.4 MB

Release files / fqml-0.2.13.tar.gz

Download URL fqml-0.2.13.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
11e5d3736fdb21af0e455dff9be89b840f240012396ba4811800af1ba64739a0
BLAKE2b-256 checksum
How to use checksums
73f6abbd6bb6a5af694d2ba575787c5b26a4a61fdbf8140249fe93334b2b8c90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.

Transparency log

Release files / fqml-0.2.13-cp39-abi3-win_amd64.whl

Download URL fqml-0.2.13-cp39-abi3-win_amd64.whl
Size 4.1 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
4efd28ba2924661e2c29bb511e4f961605595bb5d4b98894cf09f76b516885e9
BLAKE2b-256 checksum
How to use checksums
050ae4db34614cbaa5d1d470d35be0eadf68cd4bc1a667d88f1f0a95c7c594f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.

Transparency log

Release files / fqml-0.2.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL fqml-0.2.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 4.3 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
0faba70116009e8a5c1045c970b34226bcddcc3b3fc0983f5c0822630811d6d7
BLAKE2b-256 checksum
How to use checksums
2f1320669b3ae3e0f5b14b28a843f835e5a8ffb45ca792258e023d5bfe89d93d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.

Transparency log

Release files / fqml-0.2.13-cp39-abi3-macosx_11_0_arm64.whl

Download URL fqml-0.2.13-cp39-abi3-macosx_11_0_arm64.whl
Size 4.2 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
27cff560886d8853bf9992b3be8456219d5004342ac63375e1c3125ef94f95ae
BLAKE2b-256 checksum
How to use checksums
44af9e02c76ca0ce6a58f318285e9e2dd96535f1fded278aa927d14776e50958
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.

Transparency log

Security for fqml 0.2.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 4 files in this release have been uploaded with provenance metadata.

Select from 4 files

Attestation for fqml-0.2.13.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page