# @graphiql/plugin-query-builder 中文文档

规范地址：https://npmcn.com/package/%40graphiql/plugin-query-builder/

版本：1\.0\.1
npm 元数据更新时间：2026-11-02T02:59:33.231Z
中文译文更新时间：2026-11-16T22:49:40.180Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40graphiql/plugin-query-builder
原文对照：https://npmcn.com/package/%40graphiql/plugin-query-builder/?lang=original
项目主页：https://github.com/graphql/graphiql/tree/master/packages/graphiql-plugin-query-builder#readme
源码仓库：https://github.com/graphql/graphiql

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

- 包体积（解压后）：447 kB，81 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18 \|\| ^19，graphql ^16\.11\.0 \|\| ^17\.0\.0，react-dom ^18 \|\| ^19，@graphiql/react ^1\.0\.1
- 首次发布：2026-08-29T16:06:12.974Z
- 最新版本发布：2026-11-02T02:59:32.903Z
- 近 30 天下载量：57541（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

GraphiQL 的一站式视觉查询构建器插件.

## 安装

```sh
npm install @graphiql/plugin-query-builder
```

也可以使用：`pnpm add @graphiql/plugin-query-builder`、`yarn add @graphiql/plugin-query-builder`、`bun add @graphiql/plugin-query-builder`

## README

# `@graphiql/plugin-query-builder`

GraphiQL 的一站式视觉查询构建器插件. 通过点击您的计划而不是手写来构建 GraphQL 查询 .

从计划中选择字段,编辑器中的操作保持同步,两种方式都保持同步. 它覆盖了包含复选框,参数输入(scalars, enums, lists, 和输入对象, 包括输入对象列表)的 schema树, 将scalar 参数推广到变量, 从选择中创建出命名的片段, 以及联盟/ 界面类型选择器. 见 [734号](https://github.com/graphql/graphiql/issues/734) 用于原始特性请求.

## 安装

```bash
npm install @graphiql/plugin-query-builder
# or
yarn add @graphiql/plugin-query-builder
```

## 使用量

```tsx
import { GraphiQL } from 'graphiql';
import { QUERY_BUILDER_PLUGIN } from '@graphiql/plugin-query-builder';
import '@graphiql/plugin-query-builder/style.css';

function App() {
  return <GraphiQL plugins={[QUERY_BUILDER_PLUGIN]} fetcher={fetcher} />;
}
```

## 已知的限制

-   **异相类相.** 树用它们的图案名称处理字段,所以一个手写文档,两次去名同一个字段(`a: hero b: hero`)与第一次发生相匹配。 编辑行为与此有关;完全别名的编辑尚未获得支持.
-   **明确 `null`。 。 。 .** 建造者无法控制一个明确的 `null` 参数,并将空输入视为“删除此参数”。 手写 `arg: null` 因此,在编辑过程中没有保留.

## 许可证

麻省理工学院

## 常见问题

### @graphiql/plugin-query-builder 是什么？

GraphiQL 的一站式视觉查询构建器插件\.

### 如何安装 @graphiql/plugin-query-builder？

在项目目录运行 npm install @graphiql/plugin-query-builder，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18 \|\| ^19）、graphql（^16\.11\.0 \|\| ^17\.0\.0）、react-dom（^18 \|\| ^19）、@graphiql/react（^1\.0\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @graphiql/plugin-query-builder 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @graphiql/plugin-query-builder 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @graphiql/plugin-query-builder 可以商用吗？

@graphiql/plugin-query-builder 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @graphiql/plugin-query-builder 的下载量有多少？

根据 npm 官方下载统计，@graphiql/plugin-query-builder 在 2026/10/17 – 2026/11/15 这 30 天内被下载 57,541 次，日均约 1,918 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @graphiql/plugin-query-builder 还在维护吗？

最新版本 1\.0\.1 发布于 2026/11/02（14 天前）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/08/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

