# @graphiql/plugin-code-exporter 中文文档

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

版本：6\.0\.0
npm 元数据更新时间：2026-11-01T14:33:50.641Z
中文译文更新时间：2026-11-17T01:45:32.918Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：10.9 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18 \|\| ^19，graphql ^16\.11\.0 \|\| ^17\.0\.0，react-dom ^18 \|\| ^19，@graphiql/react ^1\.0\.0
- 首次发布：2022-10-28T15:35:36.775Z
- 最新版本发布：2026-11-01T14:33:50.292Z
- 近 30 天下载量：9927（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：285（近 12 个月 17 个）

## 中文简介

此软件包提供了一个集成插件 [GraphiQL 代码导出器](https://github.com/OneGraph/graphiql-code-exporter) 输入 GraphiQL 用户界面.

## 安装

```sh
npm install @graphiql/plugin-code-exporter
```

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

## README

# GraphiQL 代码导出插件

此软件包提供了一个集成插件 [GraphiQL 代码导出器](https://github.com/OneGraph/graphiql-code-exporter) 输入 GraphiQL 用户界面.

## 安装

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

```sh
npm install @graphiql/plugin-code-exporter
```

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

```sh
npm install react react-dom graphql
```

## 使用量

参见 [GraphiQL 代码导出器](https://github.com/OneGraph/graphiql-code-exporter) 详细情况 `props` 以及如何 [创建片段](https://github.com/OneGraph/graphiql-code-exporter#snippets)。 。 。 .

示例整合:

```jsx
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 (英语)](https://esm.sh/)。 。 。 .

见 [CDN 实例](https://npmcn.com/package/%40graphiql/plugin-code-exporter/example/index.html) 一个工作演示.

## 常见问题

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

