当前位置：首页 > news >正文

HighlightedTextEditor完全指南：打造SwiftUI动态文本高亮编辑器的终极方案

news 2026/7/5 16:01:28

HighlightedTextEditor完全指南：打造SwiftUI动态文本高亮编辑器的终极方案

【免费下载链接】HighlightedTextEditorA SwiftUI view for dynamically highlighting user input项目地址: https://gitcode.com/gh_mirrors/hi/HighlightedTextEditor

HighlightedTextEditor是一款专为SwiftUI打造的动态文本高亮编辑器，它能帮助开发者轻松实现文本输入过程中的实时语法高亮效果。无论是构建代码编辑器、富文本处理器还是自定义输入框，这款工具都能提供简单而强大的解决方案。

为什么选择HighlightedTextEditor？

在SwiftUI开发中，原生TextField和TextEditor组件功能相对基础，难以满足复杂的文本格式化需求。HighlightedTextEditor通过以下特性解决了这一痛点：

实时动态高亮：输入文本时立即应用高亮规则，提供即时视觉反馈
跨平台支持：同时支持iOS和macOS系统，实现一致的用户体验
高度可定制：通过灵活的规则系统，轻松定义自己的高亮模式
SwiftUI原生集成：采用NSViewRepresentable和UIViewRepresentable实现，完美融入SwiftUI视图体系

图1：macOS平台上的Markdown语法高亮效果展示

快速开始：安装与基本配置

安装方法

HighlightedTextEditor提供多种安装方式，选择最适合你项目的方式：

CocoaPods：

pod 'HighlightedTextEditor'

Swift Package Manager：在Xcode中通过仓库URL添加依赖：

https://gitcode.com/gh_mirrors/hi/HighlightedTextEditor

基本使用示例

使用HighlightedTextEditor非常简单，只需几行代码即可实现一个基础的高亮编辑器：

import HighlightedTextEditor struct ContentView: View { @State private var text = "" // 定义高亮规则 let highlightRules: [HighlightRule] = [ HighlightRule(pattern: "https?://\\S+", attributes: [.foregroundColor: Color.blue]) ] var body: some View { HighlightedTextEditor( text: $text, highlightRules: highlightRules ) .padding() } }

这段代码创建了一个能够自动识别并高亮URL的文本编辑器。

图2：URL自动高亮效果展示，链接被自动识别并显示为蓝色

核心功能详解

预设高亮规则

HighlightedTextEditor提供了多种预设的高亮规则，方便开发者快速集成常见的文本格式化需求：

Markdown预设：支持标题、粗体、斜体等Markdown语法高亮
```
let markdownRules = MarkdownHighlightRules().rules
```
URL预设：自动识别并高亮网址链接
```
let urlRules = URLHighlightRules().rules
```

这些预设规则位于项目的Sources/HighlightedTextEditor/Presets/目录下，你可以直接使用或作为自定义规则的基础。

图3：Markdown语法高亮效果，支持多种格式的文本样式

自定义高亮规则

除了使用预设规则，你还可以创建完全自定义的高亮规则。每个HighlightRule由正则表达式模式和文本属性组成：

let customRules: [HighlightRule] = [ // 高亮邮箱地址 HighlightRule( pattern: "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,64}", attributes: [ .foregroundColor: Color.green, .font: UIFont.systemFont(ofSize: 16, weight: .medium) ] ), // 高亮关键词 HighlightRule( pattern: "\\b(Swift|SwiftUI|iOS|macOS)\\b", attributes: [ .foregroundColor: Color.orange, .font: UIFont.boldSystemFont(ofSize: 16) ] ) ]

文本属性定制

HighlightedTextEditor支持丰富的文本属性定制，包括字体、颜色、字重等：

let attributes: [NSAttributedString.Key: Any] = [ .font: NSFont.systemFont(ofSize: 14, weight: .medium), .foregroundColor: NSColor.systemBlue, .backgroundColor: NSColor.systemYellow.withAlphaComponent(0.2), .underlineStyle: NSUnderlineStyle.single.rawValue ]

图4：自定义字体样式效果展示

高级用法与事件处理

事件回调

HighlightedTextEditor提供了多种事件回调，方便你处理文本变化和用户交互：

HighlightedTextEditor(text: $text, highlightRules: rules) .onEditingChanged { print("编辑开始") } .onCommit { print("编辑提交") } .onTextChange { newText in print("文本变化: \(newText)") } .onSelectionChange { ranges in print("选择范围变化: \(ranges)") }

这些回调方法定义在Sources/HighlightedTextEditor/HighlightedTextEditor.AppKit.swift和对应的UIKit文件中。

跨平台适配

HighlightedTextEditor通过条件编译实现了iOS和macOS的原生支持：

iOS: HighlightedTextEditor.UIKit.swift
macOS: HighlightedTextEditor.AppKit.swift

在使用时无需额外处理平台差异，组件会自动适配当前运行的系统。

实战案例：构建Markdown编辑器

下面是一个完整的Markdown编辑器示例，展示了如何结合预设规则和自定义功能：

struct MarkdownEditorView: View { @State private var markdownText = "# 开始编辑Markdown\n\n这是**粗体**文本，这是*斜体*文本。\n\n[访问链接](https://example.com)" var body: some View { VStack { Text("Markdown编辑器") .font(.title) HighlightedTextEditor( text: $markdownText, highlightRules: MarkdownHighlightRules().rules ) .padding() .frame(minHeight: 300) Text("预览") .font(.headline) Text(markdownText) .frame(maxWidth: .infinity, alignment: .leading) .padding() .background(Color(.systemBackground)) } .padding() } }

这个示例创建了一个简单但功能完整的Markdown编辑器，左侧输入，右侧实时预览。

常见问题与解决方案

性能优化

对于大型文档，建议限制单次处理的文本长度或使用节流机制：

// 简单的节流实现 .onTextChange { newText in DispatchQueue.main.asyncAfter(deadline: .now() + 0.3) { if self.text == newText { // 处理文本变化 } } }

复杂正则表达式

复杂的正则表达式可能会影响性能，建议：

优化正则表达式，避免贪婪匹配
拆分复杂规则为多个简单规则
对长文本进行分段处理

自定义视图外观

如果需要完全自定义编辑器外观，可以使用introspect方法访问底层视图：

HighlightedTextEditor(text: $text, highlightRules: rules) .introspect { internals in // 自定义NSTextView或UITextView #if os(macOS) internals.textView.backgroundColor = .darkGray internals.textView.textColor = .white #else internals.textView.backgroundColor = .darkGray internals.textView.textColor = .white #endif }