# HuskarUI

**Repository Path**: MenPenS/HuskarUI

## Basic Information

- **Project Name**: HuskarUI
- **Description**: * 此仓库为 Github 镜像仓库 - 「 HuskarUI」 基于 Qml 的 Ant-d UI 套件
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/mengps/HuskarUI
- **GVP Project**: No

## Statistics

- **Stars**: 38
- **Forks**: 20
- **Created**: 2024-12-08
- **Last Updated**: 2025-12-11

## Categories & Tags

**Categories**: desktop-ui

**Tags**: Qt, Qml, Controls, Cpp, UI

## README

<div align=center>
<img width=64 src="resources/huskarui_icon.svg">

# 「 HuskarUI 」 Modern UI for Qml 

Ant Design component library for Qt Qml

If you need Python impl [HuskarUI for PySide6](https://github.com/mengps/PyHuskarUI)

If you need Qt5 impl [HuskarUI for Qt5](https://github.com/mengps/HuskarUI_Qt5)

</div>

<div align=center>

![win-badge] ![linux-badge] ![macos-badge] ![android-badge]

[![Issues][issues-open-image]][issues-open-url] [![Issues][issues-close-image]][issues-close-url] [![Release][release-image]][release-url]

[![QQGroup][qqgroup-image]][qqgroup-url]

English | [中文](./README-zh_CN.md)

</div>

[win-badge]: https://img.shields.io/badge/Windows-passing-brightgreen?style=flat-square
[linux-badge]: https://img.shields.io/badge/Linux-passing-brightgreen?style=flat-square
[macos-badge]: https://img.shields.io/badge/MacOS-passing-brightgreen?style=flat-square
[android-badge]: https://img.shields.io/badge/Android-passing-brightgreen?style=flat-square

[issues-open-image]: https://img.shields.io/github/issues/mengps/HuskarUI?label=Issue&style=flat-square
[issues-open-url]: https://github.com/mengps/HuskarUI/issues
[issues-close-image]: https://img.shields.io/github/issues-closed/mengps/HuskarUI?color=brightgreen&label=Issue&style=flat-square
[issues-close-url]: https://github.com/mengps/HuskarUI/issues?q=is%3Aissue%20state%3Aclosed

[release-image]: https://img.shields.io/github/v/release/mengps/HuskarUI?label=Release&style=flat-square
[release-url]: https://github.com/mengps/HuskarUI/releases

[qqgroup-image]: https://img.shields.io/badge/QQGroup-490328047-f74658?style=flat-square
[qqgroup-url]: https://qm.qq.com/q/cMNHn2tWeY

<div align=center>

## 🌈 Gallery Preview

<img width=800 height=500 src="preview/light.png">
<img width=800 height=500 src="preview/dark.png">
<img width=800 height=500 src="preview/doc.png">

</div>

## ✨ 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](https://github.com/mengps/HuskarUI/discussions/5).

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)](https://deepwiki.com/mengps/HuskarUI)

## 📺 Online Demo

  - [BiliBili](https://www.bilibili.com/video/BV1jodhYhE8a/?spm_id_from=333.1387.homepage.video_card.click)

## 🗂️ Precompiled package

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

Please visit [Release](https://github.com/mengps/HuskarUI/releases) to download.

## 🔨 How to Build

- Clone
```auto
git clone --recursive https://github.com/mengps/HuskarUI.git
```
- Build & Install
  - Windows - Visual Studio
  ```sh
  cd HuskarUI
  cmake -DCMAKE_PREFIX_PATH=<QT_DIR> -G "Visual Studio <version>" -B build -S . 
  cmake --build build --config Release --target ALL_BUILD INSTALL --parallel
  ```
  - All - Ninja
  ```sh
  cd HuskarUI
  cmake -DCMAKE_PREFIX_PATH=<QT_DIR> -G "Ninja" -B build -S . 
  cmake --build build --config Release --target all install --parallel
  ```

> [!IMPORTANT]
> By default, `INSTALL_HUSKARUI_IN_DEFAULT_LOCATION=ON`:
> - the `headers` will be install in the `[QtDir]/[QtVersion]/[Kit]/include/HuskarUI` directory.
> - the `*.dll` will be install in the `[QtDir]/[QtVersion]/[Kit]/bin` directory.
> - the `*.lib/*.so/*.dylib` will be install in the `[QtDir]/[QtVersion]/[Kit]/lib` directory.
> - the `qmlplugin` will be install in the `[QtDir]/[QtVersion]/[Kit]/qml` directory.
> 
> If you want to change the installation directory, please modify the `INSTALL_HUSKARUI_IN_DEFAULT_LOCATION` to `OFF` and set the `HUSKARUI_INSTALL_DIRECTORY` in the cmake.
> ```sh
> cmake -DCMAKE_PREFIX_PATH=<QT_DIR> \
>   -DINSTALL_HUSKARUI_IN_DEFAULT_LOCATION=OFF \
>   -DHUSKARUI_INSTALL_DIRECTORY=<install_dir> \
>   -G "Ninja" -B build -S .
> ```

The installation directory structure
```auto
──<install_dir>
    ├─include
    │   └─HuskarUI/*.h
    ├─bin
    │   *.dll
    ├─lib
    │   *.lib/*.so/*.dylib
    │   └─cmake/*.cmake
    └─qml
        └─HuskarUI/Basic
```
- Usage
  - Using cmake
    Add the following cmake command to your project `CMakeLists.txt`
    ```cmake
    find_package(HuskarUI REQUIRED)
    target_link_libraries(<your_target> HuskarUI::Basic)
    ```
  - Directly using the library
    - Link the `<install_dir>/lib`.
    - Include the `<install_dir>/include`.
    - [Optional] Copy the `<install_dir>/bin/HuskarUIBasic.[dll]` to `[QtDir]/[QtVersion]/[Kit]/bin`.
    - [Optional] Copy the `<install_dir>/lib/HuskarUIBasic.[so/dylib]` to `[QtDir]/[QtVersion]/[Kit]/bin`.
    - Copy the `<install_dir>/qml/HuskarUI` to `[QtDir]/[QtVersion]/[Kit]/qml`.

## 📦 Get started 

 - Create QtQuick application `QtVersion >= 6.7`
 - Add the following code to your `main.cpp`
 ```cpp
  #include "HuskarUI/husapp.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`
 ```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

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