GUI
✨ Features
📦 Installation
$ npm install @antv/gui
🔨 Getting Started
import { Canvas } from '@antv/g';
import { Renderer } from '@antv/g-canvas';
import { Button } from '@antv/gui';
// create a canvas
const canvas = new Canvas({
container: 'container',
width: 600,
height: 600,
renderer: new Renderer(),
});
// create a button
const button = new Button({
/* ... */
});
canvas.appendChild(button);
// render it
canvas.render();
📎 Components
📮 Contribution
$ git clone [email protected]:antvis/gui.git
$ cd gui
$ npm install
$ npm run dev
Then send a pull request after coding.
📄 License
MIT@AntV.
关于 @antv/gui 的常见问题
@antv/gui 是什么？
UI components for AntV G.
如何安装 @antv/gui？
在项目目录运行 npm install @antv/gui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antv/g（^5.14.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@antv/gui 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@antv/gui 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。
@antv/gui 可以商用吗？
@antv/gui 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@antv/gui 的下载量有多少？
根据 npm 官方下载统计，@antv/gui 在 2026/10/06 – 2026/11/04 这 30 天内被下载 1,886 次，日均约 63 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@antv/gui 还在维护吗？
最新版本 0.5.0 发布于 2023/08/29（3 年前）；至今共发布 129 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/09/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。
