@graphiql/plugin-query-builder

中文文档
1.0.1发布于 2026/11/02MITTypeScriptCommonJS构建来源已验证近 30 天下载 5.8万

A first-party visual query builder plugin for GraphiQL.

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. Known limitations
  4. License

@graphiql/plugin-query-builder

A first-party visual query builder plugin for GraphiQL. Build GraphQL queries by clicking through your schema instead of writing them by hand.

Pick fields from the schema and the operation in the editor stays in sync, both ways. It covers a schema tree with checkboxes, argument inputs (scalars, enums, lists, and input objects, including lists of input objects), promoting scalar arguments to variables, creating named fragments from a selection, and union/interface type-condition selectors. See #734 for the original feature request.

Install

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

Usage

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} />;
}

Known limitations

  • Aliases. The tree addresses fields by their schema name, so a hand-written document that aliases the same field twice (a: hero b: hero) matches the first occurrence. Editing acts on that one; full alias-aware editing is not supported yet.
  • Explicit null. The builder has no control for an explicit null argument, and treats an empty input as "remove this argument". A hand-written arg: null is therefore not preserved across an edit.

License

MIT

版本与发布记录

@graphiql/plugin-query-builder 共发布 12 个版本,首次发布于 2026/08/30;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.1latest2026/11/0214 天前
1.0.02026/11/0115 天前
1.0.0-rc.3rc2026/10/131 个月前
1.0.0-rc.22026/10/121 个月前
1.0.0-rc.12026/09/301 个月前
1.0.0-rc.02026/09/281 个月前

其他发布通道:beta → 1.0.0-beta.4,rc → 1.0.0-rc.3。

关于 @graphiql/plugin-query-builder 的常见问题

@graphiql/plugin-query-builder 是什么?

A first-party visual query builder plugin for 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 和提交记录判断。