FluentUI/README.md

4.1 KiB

QML FluentUI

A fluent design component library for Qt QML

win-badge ubuntu-badge macos-badge release-badge download-badge download-latest

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.

or

  • Clone the repository.
git clone https://github.com/zhuzichu520/FluentUI.git
  • 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
FluFilledButton Filled button filledbtn
FluTextButton Text button textbtn
FluToggleButton Toggle buttons togglebtn
FluIcon Common icon icons
FluRadioButton radio button radiobtn
FluTextBox Single-line input box textbox
FluMultiLineTextBox Multi-lines input area textarea
FluToggleSwitch toggle switch toggleswitch

View more here!

Reference

License

This FluentUI library currently licensed under MIT License

Visitor count