Flutter文本转换插件notustohtml的使用

Notus to HTML

将Notus文档格式与HTML相互转换。

概述

此项目是一个通用的Dart包，用于在HTML和Notus文档格式之间进行转换。Notus文档被流行的Zefyr富文本编辑器广泛使用。

Zefyr中使用的Notus格式利用Deltas来表示文档。这些Deltas与其他编辑器不兼容。此转换器中使用的Deltas只能与Notus和Zefyr一起使用。

使用方法

编码HTML

final converter = NotusHtmlCodec();

String html = converter.encode(myNotusDocument.toDelta()); // HTML 输出

解码HTML

final converter = NotusHtmlCodec();

Delta delta = converter.decode(myHtmlString); // Zefyr兼容的Delta
NotusDocument document = NotusDocument.fromDelta(delta); // 准备加载到Zefyr中的Notus文档

示例代码

以下是一个完整的示例代码，展示了如何使用notustohtml插件将Notus文档转换为HTML，并将其解码回Notus文档。

示例代码

import 'package:notus/notus.dart'; // 引入Notus库
import 'package:notustohtml/notustohtml.dart'; // 引入notustohtml插件
import 'package:quill_delta/quill_delta.dart'; // 引入Quill Delta库

void main() {
  // 创建一个Notus文档实例
  final converter = NotusHtmlCodec();

  // 替换为从Zefyr编辑器获取的文档
  final doc = NotusDocument.fromJson(
    [
      {
        "insert": "Hello World!", // 插入纯文本
      },
      {
        "insert": "\n", // 插入换行符
        "attributes": {
          "heading": 1, // 设置标题级别
        },
      },
    ],
  );

  // 将Notus文档转换为HTML
  String html = converter.encode(doc.toDelta());
  print(html); // 打印HTML表示形式

  // 将HTML解码为Delta对象
  Delta delta = converter.decode(html);
  NotusDocument document = NotusDocument.fromDelta(delta); // 将Delta转换为Notus文档

  // 打印解码后的文档内容
  print(document.toJson());
}

输出结果

运行上述代码后，您将看到以下输出：

1. HTML输出：

   <p>Hello World!</p>
   <h1></h1>
   

2. 解码后的Notus文档：

   [
     {
       "insert": "Hello World!"
     },
     {
       "insert": "\n",
       "attributes": {
         "heading": 1
       }
     }
   ]