# @covalent/highlight 中文文档

规范地址：https://npmcn.com/package/%40covalent/highlight/

版本：11\.23\.0
npm 元数据更新时间：2026-10-02T15:29:43.231Z
中文译文更新时间：2026-11-10T20:55:51.430Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：104 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/cdk 20\.x\.x，highlight\.js ^11\.9\.0，@angular/core 20\.x\.x，@angular/common 20\.x\.x，@angular/material 20\.x\.x，@angular/platform-browser 20\.x\.x
- 首次发布：2016-07-12T23:23:00.657Z
- 最新版本发布：2026-10-02T15:29:43.026Z
- 近 30 天下载量：10250（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：440（近 12 个月 74 个）

## 中文简介

Teradata UI 平台高亮模块

## 安装

```sh
npm install @covalent/highlight
```

也可以使用：`pnpm add @covalent/highlight`、`yarn add @covalent/highlight`、`bun add @covalent/highlight`

## README

## TdText编辑器 组件: td-文本编辑器

`<td-text-editor>` 元素生成一个简单的标记下调编辑器.

## API 总结

#### 投入

-   值 ?: 字符串
    -   编辑器中文本的值
-   选项? : 对象
    -   在此列出的有效配置对象 : [https://github.com/Ionaru/easy-markdown-editor#configulation (英语)](https://github.com/Ionaru/easy-markdown-editor#configuration)

#### 属性

-   是 PreviewActive 吗 : 函数 ()
    -   是预览活动。 返回布尔
-   是SideBySideActive吗?:函数()
    -   是侧面活动。 返回布尔
-   是 Fullscreen 动作吗 ?: 函数( )
    -   全屏活动。 返回布尔
-   清除AutosavedValue?: 函数()
    -   清除自动保存的值。 返回无效
-   到文本区?: 函数( )
    -   返回初始文本区域。 返回无效
-   简单MDE?: 函数( )
    -   用于基础的简单MDE对象的获取函数。 返回轻松的MDE

## 安装

此组件可以被安装为npm包.

```bash
npm install @covalent/text-editor
```

## 设置

导入 **共价文本编辑器模块** 在您的 NGMudule 中:

```typescript
import { CovalentTextEditorModule } from '@covalent/text-editor';
@NgModule({
  imports: [
    CovalentTextEditorModule,
    ...
  ],
  ...
})
export class MyModule {}
```

### 使用量

```html
<td-text-editor [value]="Some Text" [options]="options"></td-text-editor>
```

```typescript
class MyComponent {
  options: any = {
    lineWrapping: true,
    toolbar: false,
    ...
  };
}
```

## 常见问题

### @covalent/highlight 是什么？

Teradata UI 平台高亮模块

### 如何安装 @covalent/highlight？

在项目目录运行 npm install @covalent/highlight，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/cdk（20\.x\.x）、highlight\.js（^11\.9\.0）、@angular/core（20\.x\.x）、@angular/common（20\.x\.x）、@angular/material（20\.x\.x）、@angular/platform-browser（20\.x\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @covalent/highlight 支持 TypeScript 吗？

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

### @covalent/highlight 支持 ESM 还是 CommonJS？

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

### @covalent/highlight 可以商用吗？

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

### @covalent/highlight 的下载量有多少？

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

### @covalent/highlight 还在维护吗？

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