跳到主要内容

TypeScript 支持

从 v2.0 起,DHTMLX RichText 内置了 TypeScript 类型定义,无需额外配置。

注意

Snippet Tool 中体验编辑器。

TypeScript 的优势

在 DHTMLX RichText 中使用 TypeScript 可带来:

  • 类型安全 — 编译器在构建阶段即可捕获配置属性和方法参数的错误用法
  • 自动补全 — IDE 在输入时会提示合法的属性名、方法签名及值类型
  • 自文档化 API — 配置对象和方法上的类型注解同时充当内联文档

在 TypeScript 中初始化 RichText

以下示例展示了如何在 TypeScript 中初始化 RichText,并借助内置类型定义获得自动补全支持:

import { Richtext } from "@dhx/richtext";

const editor = new Richtext("#root", {
menubar: true,
layoutMode: "document"
});

参考 API 类型

有关每个配置属性的 TypeScript 签名,请参阅 属性概览。有关方法签名,请参阅 方法概览