STTextView

具有行号和更多功能的高性能 macOS 和 iOS 文本视图。(NSTextView/UITextView 重新实现)

本项目的目标是利用 TextKit 2 框架构建 NSTextView/UITextView 替代的可重用组件。由于许多充分理由。

该组件主要是为满足 Swift Studio 作为源代码编辑器的需求而开发的。

TextKit 2 在 WWDC 2021 期间被宣布为 TextKit 1 的替代品，用于文本布局等功能。苹果宣布专门用于文本编辑的视图组件 NSTextView 将采用 TextKit 2，并提供与 TextKit 1 相当的支持。当我开始深入了解 NSTextView + TextKit 2 时，我意识到截至今天（2022 年 2 月），NSTextView 和 TextKit 2 类都还未完全发挥作用。在此过程中，我向苹果报告了几个错误报告，并请求 DTS（支持票据）。最终，我被某些特定的错误阻碍，这促使我开始了这个项目。

✨ 特性

macOS 文本系统集成
高性能文本编辑
标尺视图中的行号
支持标尺标记
颜色和字体的自定义
开启和关闭换行
调整行高
在文本视图中高亮/选择范围
多光标编辑
搜索/替换文本
拼写和语法检查
听写
显示不可见字符
可自定义的自动完成支持
长内容的平滑滚动
LTR（从左到右）/ RTL（从右到左）布局
撤销/重做
插件
锚定注释（通过插件）
源代码语法高亮（通过插件）

🤝 支持与赞助

项目的财务可持续性得益于我们 GitHub 赞助者的持续贡献

🗓️ 路线图

STTextView 已经非常适合作为文本编辑器组件使用。然而，在发布 v1.0 版本之前，它仍需要一些改进

建议或投票支持新功能：功能请求

已知问题

文本拖动（部分实现）

🚀 入门

STTextView 通过 Swift Package Manager 分发。通过在 Package.swift 清单中添加依赖项或通过 Xcode 项目设置中的"Package Dependencies"将其安装到项目中

let package = Package(
    dependencies: [
        .package(url: "https://github.com/krzyzanowskim/STTextView", from: "0.9.6")
    ]
)

演示应用

演示应用 TextEdit 和 TextEdit.SwiftUI 让你可以探索该库。

插件

STTextView 组件中的插件提供了超出简单文本显示之外的额外功能和定制选项。它们通过添加语法高亮、字数统计等功能来增强文本视图的核心能力。这些插件在保持模块化和适应性软件结构的同时，扩展了 STTextView 的实用性。

Plugin-Neon：使用 TreeSitter 和 Neon 进行源代码语法高亮。
Plugin-TextFormation：使用 TextFormation 进行输入完成。
Plugin-Annotations：锚定注释（例如内联错误消息）插件。
Plugin-Template：准备构建新插件的虚拟插件模板仓库。
... 添加更多插件

使用方法

SwiftUI

TextView 是一个包装 STTextView 的 SwiftUI 视图。

支持富文本（属性字符串）
比 SwiftUI.TextEdit 更快（https://twitter.com/krzyzanowskim/status/1677628085217243137）

import STTextViewSwiftUI

struct ContentView: View {

    @State private var text = AttributedString("Hello World!")
    @State private var selection: NSRange?

    var body: some View {
        TextView(
            text: $text,
            selection: $selection,
            options: [.wrapLines, .highlightSelectedLine],
            plugins: [plugin1(), plugin2()]
        )
        .textViewFont(.preferredFont(forTextStyle: .body))
    }
}

创建 TextView

STTextView 是 NSView 的子类，可以像其他视图一样初始化。它的 API 与 NSTextView 类似。

import STTextView

let textView = STTextView()
view.addSubView(textView)

（macOS）添加到滚动视图

let textView = STTextView()
let scrollView = NSScrollView()
scrollView.documentView = textView

let scrollView = STTextView.scrollableTextView()
let textView = scrollView.documentView as! STTextView

自定义

文本视图可以通过多种方式进行自定义。

let paragraph = NSParagraphStyle.default.mutableCopy() as! NSMutableParagraphStyle
// 将行高设置为 110%
paragraph.lineHeightMultiple = 1.1
paragraph.defaultTabInterval = 28

// 默认段落样式
textView.typingAttributes[.paragraphStyle] = paragraph

// 设置默认字体
textView.font = NSFont.monospacedSystemFont(ofSize: 14, weight: .regular)

// 设置默认文本颜色
textView.textColor = .textColor

// 设置文本值
textView.text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ornare lobortis sem a vulputate."
textView.addAttributes([.foregroundColor: NSColor.red], range: NSRange(location: 10, length: 5))

// 将行包裹/不包裹到编辑器宽度 textView.isHorizontallyResizable = true

// 高亮选中的行 textView.highlightSelectedLine = true


使用专门的 `STLineNumberRulerView`（`NSRulerView` 的专门子类）添加行号

```swift
let textView = STTextView()
let scrollView = NSScrollView()
scrollView.documentView = textView

// 行号
textView.showLineNumbers = true
textView.gutterView?.drawSeparator = true

(macOS) 在视图内启用可选的搜索和替换查找界面，通常是在滚动视图中。

textView.isIncrementalSearchingEnabled = true
textView.textFinder.incrementalSearchingShouldDimContentView = true

🐛 TextKit 2 错误报告列表

以下是我迄今为止向 Apple 报告的与 NSTextView 和 TextKit 框架相关的 TextKit 2 问题和错误列表：

FB9856587: TextKit2 最后一行出现意外的额外行片段
FB9925766: NSTextSelectionNavigation.deletionRanges 只在单词末尾有效
FB9925647: NSTextLayoutManager.replaceContents(in range: with attributedString:) 已有文档但不是公共 API 的一部分
FB9907261: NSTextElementProvider.replaceContents(in:with:) 未按文档所述替换内容
FB9692714: 渲染属性无法正确绘制
FB9886911: NSTextView 无法正确布局和显示长行（这个问题很棘手，因为它会导致视图在文本属性更新时"跳动"）
FB9713415: NSTextView drawInsertionPoint(in:color:turnedOn) 从未被调用
FB9971054: NSLayoutManager.enumerateCaretOffsetsInLineFragment 忽略起始位置
FB9971054: 使用 TextKit2 设置时 NSTextView 在选择时断言
FB9743449, FB10019859: NSTextContentStorage.textElements(for:) 不返回元素，而 enumerateTextElements 返回元素
FB11898356: textSelections(interactingAt:inContainerAt:anchors:modifiers:selecting:bounds:) 对某些位置产生错误的选择
FB12726775: NSTextParagraph.paragraphContentRange 的文档不正确
FB13272586: NSTextContainer.size 的默认值与文档不符
FB13290979: NSTextContainer.lineFragmentPadding 不影响 usageBoundsForTextContainer 矩形的片段末端
FB13291926: NSTextLayoutManager.usageBoundsForTextContainer 观察器从未被触发
FB13789916: NSTextInputClient.setMarkedText 为中文键盘提供错误的选择范围
FB14700414: NSTextList 自 macOS 14 起不再工作（回归）