# @atlaskit/editor-presets 中文文档

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

版本：24\.3\.5
npm 元数据更新时间：2026-11-07T01:22:39.642Z
中文译文更新时间：2026-11-07T03:14:11.603Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：297 kB，257 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：100 个
- 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
- 首次发布：2026-04-09T22:56:16.683Z
- 最新版本发布：2026-11-07T01:22:39.434Z
- 近 30 天下载量：6203（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：246（近 12 个月 246 个）

## 中文简介

公共编辑器为Atlassian编辑器预设,包含聚合物和其他产品的基本配置

## 安装

```sh
npm install @atlaskit/editor-presets
```

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

## README

# @atlaskit/编辑 - presets

公共编辑器为Atlassian编辑器预设,包含Conculation和其他产品的基础配置.

## 概览

这个软件包为Atlassian编辑器提供了标准化的,开源的,并易于消耗的预设. 它能够快速原型化、实验和融入外部环境.

## 可用预设

### 组合完整页面基础预设

这个 `confluenceFullPagePresetBase` 包含 Copulation 全页编辑器使用的所有公共插件和配置.

```typescript
import { confluenceFullPagePresetBase } from '@atlaskit/editor-presets';

const preset = confluenceFullPagePresetBase({
  intl,
  providers,
  enabledOptionalPlugins,
  pluginOptions,
});
```

## 使用量

### 基本设置

```typescript
import React from 'react';
import { ComposableEditor } from '@atlaskit/editor-core/composable-editor';
import { confluenceFullPagePresetBase } from '@atlaskit/editor-presets';
import { useIntl } from 'react-intl';

function MyEditor() {
  const intl = useIntl();
  
  const preset = confluenceFullPagePresetBase({
    intl,
    providers: {
      // Provide necessary services
    },
    enabledOptionalPlugins: {
      // Configure optional features
    },
    pluginOptions: {
      // Plugin-specific options
    },
  });

  return <ComposableEditor preset={preset} />;
}
```

### 扩展预设

您可以用额外的插件来扩展基础预设 :

```typescript
import { confluenceFullPagePresetBase } from '@atlaskit/editor-presets';
import { myCustomPlugin } from './my-custom-plugin';

const customPreset = confluenceFullPagePresetBase(options)
  .add([myCustomPlugin, myCustomPluginOptions]);
```

## 插件选项

预设中包含的每个插件都可以通过 `pluginOptions` 对象。 可选选项参考单个插件文档 .

## API 密码

### `confluenceFullPagePresetBase(options: ConfluenceFullPageBasePresetOptions): EditorPresetBuilder`

创建一个带有所有公共插件的库名 Conclusive Full Page 编辑器 .

**参数:**

-   `intl: IntlShape` - 国际化的反作用干预
-   `providers: Providers` - 所需服务提供者
-   `enabledOptionalPlugins: EnabledOptionalPlugins` - 可选插件的配置
-   `pluginOptions: AllPluginOptions` - 插件特定配置选项

**回返情况:** `EditorPresetBuilder` - 可用额外插件扩展的预设构建器

## 建筑

公共预设只包含 `@atlaskit/editor-plugin-*` 软件包。 私有或产品专用的插件应当被添加到单独的预设包中(例如, `editor-presets-confluence` (c) 与具体效应有关的特性.

## 捐款

当在此预设中添加新的公共插件时, 确保 :

1.  此插件来自 `@atlaskit/editor-plugin-*` 或类似的公共软件包
2.  添加插件选项到 `pluginOptions` 类型
3.  插件顺序得到维护( 有些插件有依赖性)
4.  测试更新以反映新插件

## 许可证

Apache 许可证 2.0

## 常见问题

### @atlaskit/editor-presets 是什么？

公共编辑器为Atlassian编辑器预设,包含聚合物和其他产品的基本配置

### 如何安装 @atlaskit/editor-presets？

在项目目录运行 npm install @atlaskit/editor-presets，或使用 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-presets 支持 TypeScript 吗？

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

### @atlaskit/editor-presets 支持 ESM 还是 CommonJS？

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

### @atlaskit/editor-presets 可以商用吗？

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

### @atlaskit/editor-presets 的下载量有多少？

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

### @atlaskit/editor-presets 还在维护吗？

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

