⚠️此项目已弃用 (2023-04-18)⚠️

很遗憾，我们未能找到外部贡献者。欢迎随意 fork 这个项目。如果有 fork 流行起来，请在我们的上给我们留言，我们可以考虑在本 README 中添加一个指向新项目的链接。

RichTextView

iOS 文本视图 (UIView)，可以正确显示 LaTeX、HTML、Markdown 和 YouTube/Vimeo 链接

安装

使用 Cocoapods

只需将以下内容添加到您的 Podfile

pod 'RichTextView'

并在您的仓库中运行 pod install。

使用 Carthage

只需将以下内容添加到您的 Cartfile

github "tophat/RichTextView"

并在您的仓库中运行 carthage update --platform iOS。

用法

您可以通过首先导入项目来实例化一个 RichTextView

import RichTextView

初始化 RichTextView

let richTextView = RichTextView(
    input: "Test",
    latexParser: LatexParser(),
    font: UIFont.systemFont(ofSize: UIFont.systemFontSize),
    textColor: UIColor.black,
    isSelectable: true,
    isEditable: false,
    latexTextBaselineOffset: 0,
    interactiveTextColor: UIColor.blue,
    textViewDelegate: nil,
    frame: CGRect.zero,
    completion: nil
)

您也可以按如下方式更新现有的 RichTextView

richTextView.update(
    input: "Test",
    latexParser: LatexParser(),
    font: UIFont.systemFont(ofSize: UIFont.systemFontSize),
    textColor: UIColor.black,
    latexTextBaselineOffset: 0,
    interactiveTextColor: UIColor.blue,
    completion: nil
)

参数定义如下

input - 您要渲染的字符串
latexParser - 如果您想以自定义方式处理 LaTeX 解析，您可以传递您自己的符合 LatexParserProtocol 协议的类。目前我们默认使用 iosMath Pod 来处理 LaTeX 解析
font - 要渲染的文本的字体
texColor - 要渲染的文本的颜色
isSelectable - 一个属性，用于确定 RichTextView 是否可选中
isEditable - 一个属性，用于确定 RichTextView 是否可编辑
latexTextBaselineOffset - 属性化文本附件的基线偏移量，该附件表示任何需要渲染的 LaTeX 文本
interactiveTextColor - 任何交互式元素/自定义链接的文本颜色（请参阅 Formatting the input 中的 交互式元素）
textViewDelegate - 一个 RichTextViewDelegate - 符合 UITextViewDelegate 协议，并且在点击交互式元素/自定义链接时也有处理
frame - 一个 CGRect，表示 RichTextView 的框架
completion - 一个完成块，用于处理可能返回的任何错误。即使存在错误，输入仍然会渲染，但它可能看起来与预期不同。

格式化输入

为了使 RichTextView 能够处理可能遇到的各种用例，输入字符串需要按如下方式格式化

LaTeX：将您要渲染为 LaTeX 的任何文本放在 [math] 和 [/math] 标签之间。示例：[math]x^n[/math]
代码：将您要渲染为代码的任何文本放在 [code] 和 [/code] 标签之间。示例：[code]print('Hello World')[/code]
HTML/Markdown：无需格式化
YouTube 视频：将 YouTube 视频的 ID 放在 YouTube 标签中，如下所示：youtube[dQw4w9WgXcQ]。任何视频的 YouTube ID 都可以通过查看视频的 URL（示例：https://www.youtube.com/watch?v=dQw4w9WgXcQ）并获取 v= URL 参数后面的值来找到。在这种情况下，YouTube 视频的 ID 是 dQw4w9WgXcQ
Vimeo 视频：将 Vimeo 视频的 ID 放在 Vimeo 标签中，如下所示：vimeo[100708006]。任何视频的 Vimeo ID 都可以通过查看视频的 URL（示例：https://vimeo.com/100708006）并获取第一个 / 后面的值来找到。在这种情况下，Vimeo 视频的 ID 是 100708006
交互式元素：如果您想添加在点击时具有自定义处理的文本，请将文本放在 [interactive-element id=<id>] 和 [/interactive-element] 标签之间。这样做后，当用户点击此文本时，它将使用代表交互式元素的文本 ID (<id>) 调用 RichTextViewDelegate 的 didTapCustomLink 函数，因此请务必连接到 RichTextViewDelegate 以捕获此内容。