mirror of https://github.com/zhuzichu520/FluentUI.git synced 2024-11-27 05:38:37 +08:00

FluentUI for QML

Go to file

zhuzihcu bcb862e316 update		2023-05-17 12:54:08 +08:00
.github/workflows	update	2023-05-06 00:08:04 +08:00
3rdparty	update	2023-04-27 09:38:57 +08:00
doc	changed display text and recapture the screenshots	2023-05-15 17:48:09 +08:00
example	update	2023-05-17 12:49:41 +08:00
framelesshelper@4c5ca2e12c	update	2023-05-17 12:54:08 +08:00
scripts	update	2023-04-27 09:38:57 +08:00
src	update	2023-05-17 12:49:41 +08:00
.gitignore	update	2023-04-27 14:30:10 +08:00
CMakeLists.txt	update	2023-05-17 12:49:41 +08:00
example.svg	update	2023-05-16 12:49:20 +08:00
License	Create License	2023-04-01 09:31:18 +08:00
README_zh_CN.md	move the original README to README_zh_CN, new README in Eng.	2023-05-15 16:06:43 +08:00
README.md	Update README.md	2023-05-16 09:47:50 +08:00

README.md

QML FluentUI

A fluent design component library for Qt QML

English | 简体中文

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 to aquire the moudules (Recommanded) or compile them first before using the library.

⚽ Get started

Download the pre-built release. (Please pecify your platform and compilers.)
run example program.

Clone the repository.

git clone https://github.com/zhuzichu520/FluentUI.git

Build

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).

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