# @atlaskit/editor-plugin-code-block 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/editor-plugin-code-block/

版本：32\.0\.15
npm 元数据更新时间：2026-11-07T01:22:38.851Z
中文译文更新时间：2026-11-07T02:44:28.541Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/editor-plugin-code-block
原文对照：https://npmcn.com/package/%40atlaskit/editor-plugin-code-block/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-mirror

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

- 包体积（解压后）：686 kB，195 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：29 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-intl ^5\.25\.1 \|\| ^6\.0\.0 \|\| ^7\.0\.0，@atlaskit/editor-common ^134\.9\.0
- 首次发布：2023-11-07T10:38:41.476Z
- 最新版本发布：2026-11-07T01:22:38.661Z
- 近 30 天下载量：34885（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：521（近 12 个月 327 个）

## 中文简介

@ atlaskit/ 编辑- 核心的代码块插件

## 安装

```sh
npm install @atlaskit/editor-plugin-code-block
```

也可以使用：`pnpm add @atlaskit/editor-plugin-code-block`、`yarn add @atlaskit/editor-plugin-code-block`、`bun add @atlaskit/editor-plugin-code-block`

## README

# 编辑器插件代码块

@ atlaskit/ editor- core 的代码块插件

**说明:** 这一构成部分是为阿特拉斯系统内部开发而设计的. 外部捐助者将能够使用这一构成部分,但无法提交问题.

## 概览

代码块插件扩展了Atlassian编辑器,具有丰富的代码编辑功能. 它为代码块节点提供了语言选择和类似IDE的键盘快捷键,以获得更好的代码编辑体验.

## 主要特点

-   **语言选择** - 支持多种编程语言
-   **IDE 键盘快捷键** - 自动关闭括号和引文,智能缩进
-   **行号** - 显示行号并跟踪行站位置
-   **文字环绕** - 支持在代码块中进行文字包装
-   **工具栏支持** - 有语言选择器和其他动作的浮动工具栏
-   **快速插入** - 使用快速插入菜单插入代码块 `/` 或者说 ` ``` `

## 安装

* * *

-   **安装** - 说吧 _线条添加 @ atlaskit/ editor- plugin- code- block_
-   **无** - 说吧 [@atlaskit/editor-plugin-code-block (中文(简体) )](https://www.npmjs.com/package/@atlaskit/editor-plugin-code-block)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-code-block)
-   **套装** - 说吧 [unpkg.com (英语)](https://unpkg.com/@atlaskit/editor-plugin-code-block/dist/)

## 使用量

* * *

**仅内部使用**

@atlaskit/editor-plugin-code-block是供@atlaskit/editor-core内部使用,并作为您产品中编辑器的插件依赖.

不支持直接使用此组件.

请看 [Atlaskit - 编辑器插件代码块](https://atlaskit.atlassian.com/packages/editor/editor-plugin-code-block) 用于此软件包的文档和示例.

### 插件配置

插件接受以下配置选项: `CodeBlockPluginOptions`数字 :

-   `allowCopyToClipboard`: 启用/ 禁用复制到剪贴板按钮( 布尔)
-   `overrideLanguageName`: 自定义语言显示名称的函数
-   `useLongPressSelection`: 启用移动上长压选择( 布尔)
-   `allowCompositionInputOverride`: 允许移动( 布尔) 上的成分输入覆盖

### 插件动作

插件提供了以下动作:

-   `insertCodeBlock(inputMethod)`: 在当前选中插入一个代码块, 并带有分析跟踪

## 支助

* * *

对于内部阿特拉斯人, 访问懒惰的通道 [\# 帮助编辑器 #](https://atlassian.slack.com/archives/CFG3PSQ9E) 支助或访问 [去/编辑-帮助](https://go/editor-help) 以提交错误.

## 许可证

* * *

请看 [阿特拉斯前端 - 许可证](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) 获取更多的许可证信息.

## 常见问题

### @atlaskit/editor-plugin-code-block 是什么？

@ atlaskit/ 编辑- 核心的代码块插件

### 如何安装 @atlaskit/editor-plugin-code-block？

在项目目录运行 npm install @atlaskit/editor-plugin-code-block，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.2\.0）、react-intl（^5\.25\.1 \|\| ^6\.0\.0 \|\| ^7\.0\.0）、@atlaskit/editor-common（^134\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlaskit/editor-plugin-code-block 支持 TypeScript 吗？

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

### @atlaskit/editor-plugin-code-block 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atlaskit/editor-plugin-code-block 可以商用吗？

@atlaskit/editor-plugin-code-block 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @atlaskit/editor-plugin-code-block 的下载量有多少？

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

### @atlaskit/editor-plugin-code-block 还在维护吗？

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