# @domternal/angular 中文文档

规范地址：https://npmcn.com/package/%40domternal/angular/

版本：1\.8\.1
npm 元数据更新时间：2026-11-08T11:30:07.934Z
中文译文更新时间：2026-11-16T05:42:11.433Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40domternal/angular
原文对照：https://npmcn.com/package/%40domternal/angular/?lang=original
项目主页：https://domternal.dev/
源码仓库：https://github.com/domternal/domternal

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

- 包体积（解压后）：385 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- peer 依赖：@angular/core \>=17\.1\.0，@angular/forms \>=17\.1\.0，@domternal/core \>=1\.8\.0 \<2\.0\.0，@angular/platform-browser \>=17\.1\.0
- 首次发布：2026-03-21T22:03:38.639Z
- 最新版本发布：2026-11-08T11:30:07.740Z
- 近 30 天下载量：1957（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 47 个）

## 中文简介

用于 Domternal 丰富文本编辑器的 MIT 许可角组件

## 安装

```sh
npm install @domternal/angular
```

也可以使用：`pnpm add @domternal/angular`、`yarn add @domternal/angular`、`bun add @domternal/angular`

## README

# @ domternal/ angular (英语)

[![Version](https://img.shields.io/npm/v/@domternal/angular.svg)](https://www.npmjs.com/package/@domternal/angular) [![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/domternal/domternal/blob/main/LICENSE)

用于 [永远](https://domternal.dev/) 丰富的文本编辑器 . 独立编辑器与反应形式和 `ngModel` 结束 `ControlValueAccessor`。工具栏、选择菜单、插入菜单和拾取器组件 使用信号和 OnPush 更改检测.

## 安装

在角应用程序中:

```bash
pnpm add @domternal/angular @domternal/core @domternal/theme
```

目前的建筑以Angular 21.2.20编译. 我们推荐匹配 `@angular/core`, (中文(简体) ), `@angular/forms`,以及 `@angular/platform-browser` 软件包 版本或稍后。 应用程序应使用相同的或较新的编译器,如上所述 内 [角库兼容性](https://angular.dev/tools/libraries/creating-libraries#ensuring-library-version-compatibility)。 。 。 . 名单中仍然宣称范围更广 `>=17.1.0` 对等区域; 这不是一个保证 与更古老的Angular释放相兼容.

要求数 `@domternal/core >=1.8.0 <2.0.0`。对所有安装的1.8.1版本使用 Domternal Free 软件包. 软件包宣布节点.js 22 或以后用于工具; 也跟随 您的角化版本的 [节点js要求](https://angular.dev/reference/versions)。 。 。 .

在您的全局样式表中装入主题, 例如 `styles.scss`数字 :

```scss
@use '@domternal/theme/scss';
```

## 快开始

此独立组件将文档绑入窗体控件并添加工具栏:

```ts
import { Component, signal } from '@angular/core';
import { FormControl, ReactiveFormsModule } from '@angular/forms';
import {
  DomternalEditorComponent,
  DomternalToolbarComponent,
} from '@domternal/angular';
import { StarterKit, type Editor } from '@domternal/core';

@Component({
  selector: 'app-text-editor',
  standalone: true,
  imports: [ReactiveFormsModule, DomternalEditorComponent, DomternalToolbarComponent],
  template: `
    @if (editor(); as ed) {
      <domternal-toolbar [editor]="ed" />
    }
    <domternal-editor
      [extensions]="extensions"
      [formControl]="content"
      (editorCreated)="editor.set($event)"
    />
  `,
})
export class TextEditorComponent {
  readonly editor = signal<Editor | null>(null);
  readonly extensions = [StarterKit];
  readonly content = new FormControl('<p>Hello from Angular!</p>', { nonNullable: true });
}
```

编辑拥有其生命周期; `editorCreated` 为命令提供示例 和兄弟UI组件。 工具栏将控制您的扩展 贡献。 订阅窗体控件 `valueChanges` 以保存内容.

## 形式和配置

-   形式值默认为HTML. 使用 `outputFormat="json"` 包含 JSON 内容 用于结构化文档的值。 通话 `disable()` 或者说 `enable()` 表格上的表格 控制更新可编辑性,一个已禁用的控件启动编辑器 只读。 这个 `editable` 输入和控件按变化的顺序决定.
-   没有表单,通过 HTML 或 JSON `[content]`手柄 `(contentUpdated)`, (中文(简体) ), 读取 `event.editor.getHTML()` 或者说 `getJSON()`。该部分还揭露 `htmlContent`, (中文(简体) ), `jsonContent`, (中文(简体) ), `isEmpty`, (中文(简体) ), `isFocused`,以及 `isEditable` 信号.
-   包装包括 `Document`, (中文(简体) ), `Paragraph`, (中文(简体) ), `Text`, (中文(简体) ), `BaseKeymap`,以及 `History`。 。 。 . 对于另一个撤消管理器, 设置 `[history]="false"` 并省略历史 延长,包括 [启动器 阿杰的历史](https://domternal.dev/v1/extensions/history/#disabling-the-built-in-history)。 。 。 .
-   `preset="notion"` 在创建时读取。 这个 `i18n` 输入更新 UI 翻译 当替换时,不重创建编辑器或更改其形式值.
-   `(contentError)` 报告无效的初始内容. `(contentDiagnostic)` 报告 标准值;初次报告到达之前 `editorCreated`。见 [内容诊断](https://domternal.dev/v1/guides/editor-api/#content-diagnostics)。 。 。 .
-   自定义 `icons` 输入包含原始 SVG 。 供应可信,开发者授权的常数.

这个 [角向导](https://domternal.dev/v1/guides/angular/) 包括投入、产出、, 形式行为,以及工具栏、泡泡菜单、浮动菜单、取血器和 名词取色器组件.

## 办公室粘贴和自定义列表标签

登记册 [`PasteCleanup`](https://npmcn.com/package/%40domternal/extension-paste-cleanup/README.md) 在你的编辑 `extensions` 以规范支持的 Word 和 Google Docs 剪贴板 HTML 。 没错 无法由包装器启用 。 在1.5.0时, `formattingForPaste` 允许您的应用程序 选择每个粘贴的保存或适应,而不创建编辑器. 为您添加相应的格式化、 表格和图像扩展名 想要保留。 使用 [`ListLabels`](https://npmcn.com/package/%40domternal/core/README.md#optional-list-labels) 页:1 支持自定义标记,每个协作作者都有相同的计划.

## 进一步阅读

-   [角向导和组件参考](https://domternal.dev/v1/guides/angular/)
-   [编辑器命令和内容 API](https://domternal.dev/v1/guides/editor-api/)
-   [他们](https://domternal.dev/v1/guides/theming/) 财务报告和审定财务报表 [本地化为 `i18n`](https://domternal.dev/v1/guides/i18n/#angular)
-   [可选剪贴板 HTML 清理](https://domternal.dev/v1/extensions/paste-cleanup/)

## 常见问题

### @domternal/angular 是什么？

用于 Domternal 丰富文本编辑器的 MIT 许可角组件

### 如何安装 @domternal/angular？

在项目目录运行 npm install @domternal/angular，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/core（\>=17\.1\.0）、@angular/forms（\>=17\.1\.0）、@domternal/core（\>=1\.8\.0 \<2\.0\.0）、@angular/platform-browser（\>=17\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @domternal/angular 支持 TypeScript 吗？

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

### @domternal/angular 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @domternal/angular 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @domternal/angular 可以商用吗？

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

### @domternal/angular 的下载量有多少？

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

### @domternal/angular 还在维护吗？

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

