README-zh_CN.md

「 Antilla 」 基于 Qml 的现代 UI

Qt Qml 的 Ant 设计组件库

如果你需要 Qt5 实现 Antilla for Qt5

English | 中文

🌈 陈列室预览

✨ 特性

• 📦 一套开箱即用的优质 Qml 组件.
• 🎨 强大的主题定制系统.
• 💻 基于Qml，完全跨平台.
• 🔧 高度灵活的基于委托的组件定制.

🌐 在线 wiki

• Antilla 在线 wiki (AI)

🗂️ 预编译包

预编译了两个平台的 Windows / Linux 程序包和二进制库包.

前往 Release 中下载.

🔨 如何构建

• 克隆

git clone --recursive https://github.com/davidhsing/qt-antilla.git

• 更新

git submodule update --remote --recursive

• 构建

# 初始化 MSVC BuildTools
"C:\Program Files (x86)\Microsoft Visual Studio\18\BuildTools\VC\Auxiliary\Build\vcvarsall.bat" x64

Debug 构建

cmake -S . -B build/make/Debug -G "Ninja" -DCMAKE_BUILD_TYPE=Debug -DBUILD_ANTILLA_DEFAULT_LOCATION=OFF -DINSTALL_ANTILLA_DEFAULT_LOCATION=OFF -DBUILD_ANTILLA_STATIC_LIBS=OFF
cmake --build build/make/Debug --target all --parallel --config Debug
# cmake --install build/make/Debug

Release 构建

cmake -S . -B build/make/Release -G "Ninja" -DCMAKE_BUILD_TYPE=Release -DBUILD_ANTILLA_DEFAULT_LOCATION=OFF -DINSTALL_ANTILLA_DEFAULT_LOCATION=OFF -DBUILD_ANTILLA_STATIC_LIBS=OFF
cmake --build build/make/Release --target all --parallel --config Release
# cmake --install build/make/Release

说明

• The BUILD_ANTILLA_DEFAULT_LOCATION, INSTALL_ANTILLA_DEFAULT_LOCATION, BUILD_ANTILLA_STATIC_LIBS param is Antilla's own definition.

Important

默认情况下，BUILD_ANTILLA_DEFAULT_LOCATION=ON:

• headers 将构建在 [QtDir]/[QtVersion]/[Kit]/include/Antilla 目录中。
• *.dll/*.so 将构建在 [QtDir]/[QtVersion]/[Kit]/bin 目录中。
• *.lib 将构建在 [QtDir]/[QtVersion]/[Kit]/lib 目录中。
• plugin 将构建在 [QtDir]/[QtVersion]/[Kit]/qml/Antilla 目录中。
• qml 将构建在 [QtDir]/[QtVersion]/[Kit]/qml/Antilla 目录中.
• AntillaBasic[d].dll 将构建在 [QtDir]/[QtVersion]/[Kit]/bin 目录中.

• 安装

cmake --install --prefix <install_dir>

安装目录结构

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

• 使用
  • 链接 <install_dir>/lib.
  • 包含 <install_dir>/include.
  • 复制 <install_dir>/bin/AntillaBasic.[dll/so] 到 [QtDir]/[QtVersion]/[Kit]/bin.
  • 复制 <install_dir>/imports/Antilla 到 [QtDir]/[QtVersion]/[Kit]/qml.

📦 上手

• 创建 QtQuick 应用 QtVersion >= 6.7
• 添加下面的 cmake 命令到您的项目 CMakeLists.txt 中

 target_include_directories(<your_target> PRIVATE Antilla/include)
 target_link_directories(<your_target> PRIVATE Antilla/lib)
 target_link_libraries(<your_target> PRIVATE AntillaBasic)

• 添加下面的代码到您的 main.cpp 中

 #include "antapp.h"

 int main(int argc, char *argv[])
 {
     ...
     /*! 设置 OpenGL, 可选 */
     QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGL);
     QQuickWindow::setDefaultAlphaBuffer(true);
     ...
     QGuiApplication app(argc, argv);
     QQmlApplicationEngine engine;
     AntApp::initialize(&engine);
     ...
 }

• 添加下面的代码到您的 .qml 中

 import Antilla.Basic
 AntWindow { 
   ...
 }

好了，你现在可以愉快的开始使用 Antilla 了。

🚩 参考

• Ant-d 组件: https://ant-design.antgroup.com/components/overview-cn
• Ant 设计: https://ant-design.antgroup.com/docs/spec/introduce-cn

💓 许可证

使用 MIT LICENSE

🌇 环境

Windows 11 / Ubuntu 24.04.2, Qt Version >= 6.7

🎉 Star 历史