Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zhuzichu520/FluentUI

FluentUI for QML
https://github.com/zhuzichu520/FluentUI

fluent qml qt qtquick ui

Last synced: 3 months ago
JSON representation

FluentUI for QML

Host: GitHub
URL: https://github.com/zhuzichu520/FluentUI
Owner: zhuzichu520
License: mit
Created: 2023-02-24T10:43:48.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-22T08:57:38.000Z (3 months ago)
Last Synced: 2024-10-29T15:21:00.724Z (3 months ago)
Topics: fluent, qml, qt, qtquick, ui
Language: C++
Homepage:
Size: 28.2 MB
Stars: 3,553
Watchers: 34
Forks: 469
Open Issues: 194
Metadata Files:
- Readme: README.md
- License: License

Awesome Lists containing this project

README

        




# QML FluentUI

A Fluent Design component library for Qt QML, You need PySide6 [PySide6-FluentUI-QML](https://github.com/zhuzichu520/PySide6-FluentUI-QML).



![win-badge] ![ubuntu-badge] ![macos-badge] ![release-badge] ![download-badge] ![download-latest]



English | [简体中文](README_zh_CN.md)





[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"



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.



## 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= -DCMAKE_BUILD_TYPE=Release -GNinja 

cmake --build . --config Release --target all --parallel

```

+ Use your IDE (`Qt Creator` or `CLion`) to open the project. (only **CMake** supported).



  



+ 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           |      ![btn](doc/preview/demo_standardbtn.png)       |

|   FluFilledButton   |          Filled button           |    ![filledbtn](doc/preview/demo_filledbtn.png)     |

|    FluTextButton    |           Text button            |      ![textbtn](doc/preview/demo_textbtn.png)       |

|   FluToggleButton   |          Toggle buttons          |    ![togglebtn](doc/preview/demo_toggle_btn.png)    |

|       FluIcon       |           Common icon            |         ![icons](doc/preview/demo_icon.png)         |

|   FluRadioButton    |           radio button           |     ![radiobtn](doc/preview/demo_radiobtn.png)      |

|     FluTextBox      |      Single-line input box       |      ![textbox](doc/preview/demo_textbox.png)       |

| FluMultiLineTextBox |      Multi-lines input area      | ![textarea](doc/preview/demo_multiline_textbox.png) |

|   FluToggleSwitch   |          toggle switch           | ![toggleswitch](doc/preview/demo_toggle_switch.png) |

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

[![Star History Chart](https://api.star-history.com/svg?repos=zhuzichu520/FluentUI&type=Date)](https://star-history.com/#zhuzichu520/FluentUI&Date)

## ⚡ Visitor count

![Visitor count](https://profile-counter.glitch.me/zhuzichu520-FluentUI/count.svg)