mirror of
https://github.com/zhuzichu520/FluentUI.git
synced 2024-11-24 03:30:59 +08:00
119 lines
5.3 KiB
Markdown
119 lines
5.3 KiB
Markdown
<div align=center>
|
|
<img width=64 src="doc/preview/fluent_design.svg">
|
|
|
|
# QML FluentUI
|
|
|
|
A Fluent Design component library for Qt QML, You need PySide6 [PySide6-FluentUI-QML](https://github.com/zhuzichu520/PySide6-FluentUI-QML).
|
|
|
|
</div>
|
|
|
|
![win-badge] ![ubuntu-badge] ![macos-badge] ![release-badge] ![download-badge] ![download-latest]
|
|
|
|
<div align=center>
|
|
|
|
English | [简体中文](README_zh_CN.md)
|
|
|
|
<img src="doc/preview/demo_large.png">
|
|
|
|
</div>
|
|
|
|
[win-link]: https://github.com/zhuzichu520/FluentUI/actions?query=workflow%3AWindows "WindowsAction"
|
|
[win-badge]: https://github.com/zhuzichu520/FluentUI/workflows/Windows/badge.svg "Windows"
|
|
[ubuntu-link]: https://github.com/zhuzichu520/FluentUI/actions?query=workflow%3AUbuntu "UbuntuAction"
|
|
[ubuntu-badge]: https://github.com/zhuzichu520/FluentUI/workflows/Ubuntu/badge.svg "Ubuntu"
|
|
[macos-link]: https://github.com/zhuzichu520/FluentUI/actions?query=workflow%3AMacOS "MacOSAction"
|
|
[macos-badge]: https://github.com/zhuzichu520/FluentUI/workflows/MacOS/badge.svg "MacOS"
|
|
[release-link]: https://github.com/zhuzichu520/FluentUI/releases "Release status"
|
|
[release-badge]: https://img.shields.io/github/release/zhuzichu520/FluentUI.svg?style=flat-square "Release status"
|
|
[download-link]: https://github.com/zhuzichu520/FluentUI/releases/latest "Download status"
|
|
[download-badge]: https://img.shields.io/github/downloads/zhuzichu520/FluentUI/total.svg "Download status"
|
|
[download-latest]: https://img.shields.io/github/downloads/zhuzichu520/FluentUI/latest/total.svg "latest status"
|
|
|
|
<p align=center>
|
|
This is a beautiful FluentUI component library based on Qt QML. Currently the main branch supports Qt 6. If you want to use it in Qt 5, checkout the Qt 5 branch.
|
|
</p>
|
|
|
|
## Requirements
|
|
|
|
+ Qt Core, Qt Quick, Qt QML, Qt ShaderTool, Qt 5 Compatibility Module. (**Essential**)
|
|
+ Qt LinguistTool (optional,for translations)
|
|
+ Qt Svg (optional, however essential for Qt 5)
|
|
|
|
Use [Qt Online Installers](https://download.qt.io/archive/online_installers/) to acquire the modules (**Recommended**) or compile them first before using the library.
|
|
|
|
## ⚽ Get started
|
|
|
|
+ Download the [pre-built release](https://github.com/zhuzichu520/FluentUI/releases). (Please specify your platform and compilers.)
|
|
|
|
+ run `example` program.
|
|
|
|
or
|
|
|
|
+ Clone the repository.
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/zhuzichu520/FluentUI.git
|
|
```
|
|
|
|
+ Build
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/zhuzichu520/FluentUI.git
|
|
cd FluentUI
|
|
mkdir build
|
|
cd build
|
|
cmake -DCMAKE_PREFIX_PATH=<YOUR_QT_SDK_DIR_PATH> -DCMAKE_BUILD_TYPE=Release -GNinja <PATH_TO_THE_REPOSITORY>
|
|
cmake --build . --config Release --target all --parallel
|
|
```
|
|
|
|
+ Use your IDE (`Qt Creator` or `CLion`) to open the project. (only **CMake** supported).
|
|
|
|
<div align=center>
|
|
<img src="doc/preview/qt_creator_project.png">
|
|
</div>
|
|
|
|
+ Compile the project. Then try to execute the `example` demo program.
|
|
|
|
+ Great! Now you are ready to write your first QML FluentUI program! Check the documentations for more details.
|
|
|
|
## 📑 Documentations
|
|
|
|
(Work in progress...🚀)
|
|
|
|
## Supported components
|
|
|
|
| Catalog | Detail | Notes / Demos |
|
|
| :-----------------: | :------------------------------: | :-------------------------------------------------: |
|
|
| FluApp | The initial entry of the program | Router supported(SPA) |
|
|
| FluWindow | Frameless Window | *This only works on windows |
|
|
| FluAppBar | Title bar on top of the window | Drag, minimize, maximize and close are supported. |
|
|
| FluText | Common text | |
|
|
| FluButton | Common button |  |
|
|
| FluFilledButton | Filled button |  |
|
|
| FluTextButton | Text button |  |
|
|
| FluToggleButton | Toggle buttons |  |
|
|
| FluIcon | Common icon |  |
|
|
| FluRadioButton | radio button |  |
|
|
| FluTextBox | Single-line input box |  |
|
|
| FluMultiLineTextBox | Multi-lines input area |  |
|
|
| FluToggleSwitch | toggle switch |  |
|
|
|
|
View more [`here`](doc/md/all_components.md)!
|
|
|
|
## Reference
|
|
|
|
+ [**Windows design**: Design guidelines and toolkits of Microsoft.](https://learn.microsoft.com/en-us/windows/apps/design/)
|
|
+ [**Microsoft/WinUI-Gallery**: Microsoft's demo](https://github.com/microsoft/WinUI-Gallery)
|
|
|
|
## License
|
|
|
|
This FluentUI library currently licensed under [MIT License](./License)
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#zhuzichu520/FluentUI&Date)
|
|
|
|
## ⚡ Visitor count
|
|
|
|
|