# @antv/gui 中文文档

规范地址：https://npmcn.com/package/%40antv/gui/

版本：0\.5\.0
npm 元数据更新时间：2026-09-21T08:46:17.980Z
中文译文更新时间：2026-11-08T05:36:31.269Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40antv/gui
原文对照：https://npmcn.com/package/%40antv/gui/?lang=original
项目主页：https://github.com/antvis/gui#readme
源码仓库：https://github.com/antvis/gui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.7 MB，1271 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：@antv/g ^5\.14\.1
- 首次发布：2019-09-26T06:35:22.677Z
- 最新版本发布：2023-08-29T09:11:39.766Z
- 近 30 天下载量：1886（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 0 个）

## 中文简介

AntV G的UI组件.

## 安装

```sh
npm install @antv/gui
```

也可以使用：`pnpm add @antv/gui`、`yarn add @antv/gui`、`bun add @antv/gui`

## README

# **图形界面**

用户界面组件 [G级](https://github.com/antvis/g)。 。 。 .

[![Build Status](https://github.com/antvis/gui/workflows/build/badge.svg?branch=master)](https://github.com/antvis/gui/actions) [![Coverage Status](https://img.shields.io/coveralls/github/antvis/gui/master.svg)](https://coveralls.io/github/antvis/GUI?branch=master) [![npm Version](https://img.shields.io/npm/v/@antv/gui.svg)](https://www.npmjs.com/package/@antv/gui) [![npm Download](https://img.shields.io/npm/dm/@antv/gui.svg)](https://www.npmjs.com/package/@antv/gui) [![npm License](https://img.shields.io/npm/l/@antv/gui.svg)](https://www.npmjs.com/package/@antv/gui)

## \* 特性

## \* 安装

```bash
$ npm install @antv/gui
```

## 开始

```ts
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();
```

## 组件

-   [API 密码](https://npmcn.com/package/%40antv/gui/docs//api.md)
-   UI 组件
    -   [轴](https://github.com/antvis/GUI/blob/master/docs/api/ui/axis.zh.md)
    -   [图例](https://github.com/antvis/GUI/blob/master/docs/api/ui/legend.zh.md)
    -   [工具提示](https://github.com/antvis/GUI/blob/master/docs/api/ui/tooltip.zh.md)
    -   [幻灯片](https://github.com/antvis/GUI/blob/master/docs/api/ui/slider.zh.md)
    -   [滚动栏](https://github.com/antvis/GUI/blob/master/docs/api/ui/scrollbar.zh.md)
    -   [按钮](https://github.com/antvis/GUI/blob/master/docs/api/ui/button.zh.md)
    -   [复选框](https://github.com/antvis/GUI/blob/master/docs/api/ui/checkbox.zh.md)
    -   [导航](https://github.com/antvis/GUI/blob/master/docs/api/ui/navigator.zh.md)
    -   [面包屑](https://github.com/antvis/GUI/blob/master/docs/api/ui/breadcrumb.zh.md)
    -   [闪光线](https://github.com/antvis/GUI/blob/master/docs/api/ui/sparkline.zh.md)

## 捐款

```bash
$ git clone git@github.com:antvis/gui.git

$ cd gui

$ npm install

$ npm run dev
```

编码后再发送拉出请求.

## 许可证

麻省理工学院@[蚂蚁V](https://github.com/antvis)。 。 。 .

## 常见问题

### @antv/gui 是什么？

AntV G的UI组件\.

### 如何安装 @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 和提交记录判断。