「 HuskarUI 」 Modern UI for Qml

Ant Design component library for Qt Qml

If you need Qt5 impl HuskarUI for Qt5

English | 中文

🌈 Gallery Preview

✨ Features

• 📦 A set of high-quality Qml components out of the box.
• 🎨 Powerful theme customization system.
• 💻 Based on Qml, completely cross platform.
• 🔧 Highly flexible delegate based component customization.

🗺️ Roadmap

The development plan can be found here: Component Roadmap.

Anyone can discuss through issues, QQ groups, or WeChat groups, and ultimately meaningful components/functions will be added to the development plan.

🌐 Online wiki

• HuskarUI Online wiki (AI)

📺 Online Demo

• BiliBili

🗂️ Precompiled package

Precompiled packages and binary libraries for two platforms, Windows / Linux, have been created.

Please visit Release to download.

🔨 How to Build

• Clone

git clone --recursive https://github.com/mengps/HuskarUI.git

• Build

cd HuskarUI
cmake -S . -B build
cmake --build build --config Release --target all --parallel

• Build with MinGW

cmake -S . -B build -G "Ninja"
or
cmake -S . -B build -G "MinGW Makefiles"

Important

By default, BUILD_HUSKARUI_IN_DEFAULT_LOCATION=ON , the plugin will be built in the [QtDir]/[QtVersion]/[Kit]/qml/HuskarUI directory.

• Install

cmake --install --prefix <install_dir>

The installation directory structure

──<install_dir>
    ├─include
    │   *.h
    ├─bin
    │   *.dll
    ├─lib
    │   *.lib/so
    └─imports
        └─HuskarUI/Basic

• Usage
  • Link the <install_dir>/lib.
  • Include the <install_dir>/include.
  • Copy the <install_dir>/bin/HuskarUIBasic.[dll/so] to [QtDir]/[QtVersion]/[Kit]/bin.
  • Copy the <install_dir>/imports/HuskarUI to [QtDir]/[QtVersion]/[Kit]/qml.

📦 Get started

• Create QtQuick application QtVersion >= 6.7
• Add the following cmake command to your project CMakeLists.txt

 target_include_directories(<your_target> PRIVATE HuskarUI/include)
 target_link_directories(<your_target> PRIVATE HuskarUI/lib)
 target_link_libraries(<your_target> PRIVATE HuskarUIBasic)

• Add the following code to your main.cpp

 #include "huspp.h"

 int main(int argc, char *argv[])
 {
     ...
     /*! Set OpenGL, optional */
     QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGL);
     QQuickWindow::setDefaultAlphaBuffer(true);
     ...
     QGuiApplication app(argc, argv);
     QQmlApplicationEngine engine;
     HusApp::initialize(&engine);
     ...
 }

• Add the following code to your .qml

 import HuskarUI.Basic
 HusWindow { 
   ...
 }

Alright, you can now enjoy using HuskarUI.

🚩 Reference

• Ant-d Components: https://ant-design.antgroup.com/components/overview
• Ant Design: https://ant-design.antgroup.com/docs/spec/introduce

💓 LICENSE

Use MIT LICENSE

🌇 Environment

Windows 11 / Ubuntu 24.04.2, Qt Version >= 6.7

🎉 Star History