@graphiql/plugin-code-exporter

中文文档
6.0.0发布于 2026/11/01MITTypeScriptCommonJS构建来源已验证近 30 天下载 9927

此软件包提供了一个集成插件 GraphiQL 代码导出器 输入 GraphiQL 用户界面.

中文使用文档
文档目录3 节
  1. 安装
  2. 使用量
  3. CDN 捆绑

GraphiQL 代码导出插件

此软件包提供了一个集成插件 GraphiQL 代码导出器 输入 GraphiQL 用户界面.

安装

使用您首选的软件包管理器安装插件 :

npm install @graphiql/plugin-code-exporter

确保同时安装所需的同伴依赖性 :

npm install react react-dom graphql

使用量

参见 GraphiQL 代码导出器 详细情况 props 以及如何 创建片段。 。 。 .

示例整合:

import { GraphiQL } from 'graphiql';
import { createTransport } from '@graphiql/toolkit';
import { codeExporterPlugin } from '@graphiql/plugin-code-exporter';
import 'graphiql/style.css';
import '@graphiql/plugin-code-exporter/style.css';

const transport = createTransport({
  url: 'https://countries.trevorblades.com',
});
function getQuery(arg, spaceCount = 2) {
  const spaces = ' '.repeat(spaceCount);
  const { query } = arg.operationDataList[0];
  return spaces + query.replaceAll('\n', '\n' + spaces);
}

const codeExporter = codeExporterPlugin({
  /**
   * Example code for snippets. See https://github.com/OneGraph/graphiql-code-exporter#snippets for details.
   */
  snippets: [
    {
      name: 'Example One',
      language: 'JavaScript',
      codeMirrorMode: 'jsx',
      options: [],
      generate: arg =>
        ['export const query = graphql`', getQuery(arg), '`'].join('\n'),
    },
    {
      name: 'Example Two',
      language: 'JavaScript',
      codeMirrorMode: 'jsx',
      options: [],
      generate: arg =>
        [
          "import { graphql } from 'graphql'",
          '',
          'export const query = graphql`',
          getQuery(arg),
          '`',
        ].join('\n'),
    },
  ],
});
function App() {
  return <GraphiQL transport={transport} plugins={[codeExporter]} />;
}

CDN 捆绑

您也可以通过基于无害环境管理的 CDN 这样的插件 esm.sh (英语)。 。 。 .

见 CDN 实例 一个工作演示.

版本与发布记录

@graphiql/plugin-code-exporter 共发布 285 个版本,首次发布于 2022/10/28;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.0.0latest2026/11/0115 天前
6.0.0-rc.1rc2026/09/301 个月前
6.0.0-rc.02026/09/281 个月前
6.0.0-beta.4beta2026/09/281 个月前
6.0.0-beta.32026/09/281 个月前
6.0.0-beta.22026/09/261 个月前

其他发布通道:canary → 5.1.2-canary-67317292.0,alpha → 5.1.3-alpha.0,beta → 6.0.0-beta.4,rc → 6.0.0-rc.1。

关于 @graphiql/plugin-code-exporter 的常见问题

@graphiql/plugin-code-exporter 是什么?

此软件包提供了一个集成插件 GraphiQL 代码导出器 输入 GraphiQL 用户界面.

如何安装 @graphiql/plugin-code-exporter?

在项目目录运行 npm install @graphiql/plugin-code-exporter,或使用 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.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphiql/plugin-code-exporter 支持 TypeScript 吗?

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

@graphiql/plugin-code-exporter 支持 ESM 还是 CommonJS?

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

@graphiql/plugin-code-exporter 可以商用吗?

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

@graphiql/plugin-code-exporter 的下载量有多少?

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

@graphiql/plugin-code-exporter 还在维护吗?

最新版本 6.0.0 发布于 2026/11/01(15 天前);至今共发布 285 个版本,其中过去 12 个月发布了 17 个;首次发布于 2022/10/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。