Skip to content

RinLit-233-shiroko/Rin-UI

Repository files navigation

RinUI Logo

RinUI

A Fluent Design-like UI library for Qt Quick (QML)

English | 中文

Tip

This project is still in development and not ready for production use!

Of course, you are welcome to contribute to this project.

📄 Introduction

RinUI is a UI library similar to Fluent Design for Qt Quick (QML), RinUI will provide high-quality components and practical functions. With simple configuration, you can quickly develop elegant UI interfaces in the Fluent style.

Features

  • Elegant Fluent Design controls (WIP)
  • Dark and light mode, automatic switching
  • Compatible with original QML control names
  • i18n Internationalization
  • Multi-programming language support (WIP)
  • Theme system (WIP)
  • Development documentation, preview now. (WIP)

Screenshots

Screenshot 1

More screenshots...

img.png img_1.png img_2.png img_3.png

The image in the banner comes from Pixiv, PID: 125975786

🪄 Usage

You can install RinUI via pip:

pip install RinUI

Import RinUI in your QML file:

import RinUI

Then you can run the QML file in your project.

import sys
from RinUI import *
from PySide6.QtWidgets import QApplication

if __name__ == '__main__':
    app = QApplication(sys.argv)
    your_app = RinUIWindow("/path/to/your/file.qml")
    sys.exit(app.exec_())

You also can view the demo in the source code, like this:

cd examples
python gallery.py

You also can move the RinUI folder to anywhere in your project's directory.

Note

The documentation is still in progress!! You can view the source code to learn more about the components and themes at the moment.

Now you can learn more about RinUI components and themes in the online documentation.

🙌 Acknowledgements

Resources

Contributors

Contributions are welcome! Please read the contribution guidelines before submitting a pull request.

Thanks to the great people who contributed to this project. Contributors

📜 License

This project is licensed under the MIT License, you can learn more about it in the license file.

Copyright © 2025 RinLit

This is an experimental project by Rin as a newcomer. Welcome to suggest and contribute to this project. ❤️