Commit `d143408780`

d14340878015b48d12c9abcfa5341700050ae68c

parent: 58fdc6e3a9

Verified · cmc

cmc <hello@cleberg.net> · 2026-09-30 03:05 UTC

Add a textTransform hook to OrgView

OrgView(_:options:styler:keywords:textTransform:) runs the closure on each
styled run of prose (paragraphs, headings, list terms, table cells, verse,
captions, footnotes), never on a code block. Code and verbatim runs keep the
.code intent and links keep .link, so a caller can skip them. Lets an app add
its own links, e.g. issue references, without re-implementing the layout.

Ref krz/gitbay-ios

Layout: unified · split

README.md +10

	@@ -108,6 +108,16 @@ OrgView(orgSource, options: options,
108	keywords: OrgKeywordStyle(todo: .gbOK, done: .gbDone))	108	keywords: OrgKeywordStyle(todo: .gbOK, done: .gbDone))
109	```	109	```
110		110
		111	To add links or styling of your own to prose, pass a `textTransform`. It gets each
		112	styled run of prose, never a code block; code and verbatim runs carry the `.code`
		113	inline presentation intent and links carry `.link`:
		114
		115	```swift
		116	OrgView(orgSource, options: options, textTransform: { text in
		117	// e.g. link issue references outside code and existing links
		118	})
		119	```
		120
111	### Title and heading level	121	### Title and heading level
112		122
113	Two presentation knobs, both defaulting to how Hutch rendered:	123	Two presentation knobs, both defaulting to how Hutch rendered:

Sources/OrgSwiftUI/OrgLayoutBuilder.swift +4 −1

     var options: OrgRenderOptions
     var styler: OrgCodeStyler
     var keywords: OrgKeywordStyle
+    var textTransform: ((inout AttributedString) -> Void)? = nil
     private var inline: OrgInlineStyler { OrgInlineStyler(options: options) }
     private var resolver: OrgURLResolver { OrgURLResolver(options: options) }
         _ objects: [OrgObject], _ notes: inout OrgFootnotes,
         style: Font.TextStyle = .body, bold: Bool = false
     ) -> AttributedString {
-        inline.attributed(objects, &notes, style: style, bold: bold)
+        var string = inline.attributed(objects, &notes, style: style, bold: bold)
+        textTransform?(&string)
+        return string
     }
     /// One element to zero or more blocks. Zero for a footnote definition (it moves to the

Sources/OrgSwiftUI/OrgView.swift +11 −2

     private let options: OrgRenderOptions
     private let styler: OrgCodeStyler
     private let keywords: OrgKeywordStyle
+    private let textTransform: ((inout AttributedString) -> Void)?
     @Environment(\.colorScheme) private var colorScheme
     @State private var layout = OrgLayout()
+    /// - Parameter textTransform: runs on each run of prose after styling: paragraphs,
+    ///   headings, list terms, table cells, verse, captions and footnotes, never a code
+    ///   block. Code and verbatim runs carry the `.code` inline presentation intent and
+    ///   links carry `.link`, so a transform can leave them alone. It is not part of the
+    ///   layout key; changing it alone does not re-render.
     public init(
         _ source: String,
         options: OrgRenderOptions = .init(),
         styler: OrgCodeStyler = PlainOrgCodeStyler(),
-        keywords: OrgKeywordStyle = .init()
+        keywords: OrgKeywordStyle = .init(),
+        textTransform: ((inout AttributedString) -> Void)? = nil
     ) {
         self.source = source
         self.options = options
         self.styler = styler
         self.keywords = keywords
+        self.textTransform = textTransform
     }
     public var body: some View {
         .frame(maxWidth: .infinity, alignment: .leading)
         .textSelection(.enabled)
         .task(id: LayoutKey(source: source, colorScheme: colorScheme)) {
-            layout = OrgLayoutBuilder(options: options, styler: styler, keywords: keywords)
+            layout = OrgLayoutBuilder(options: options, styler: styler, keywords: keywords,
+                                      textTransform: textTransform)
                 .layout(OrgParser.parse(source))
         }
     }

Tests/OrgSwiftUITests/OrgLayoutTests.swift +33

	@@ -343,4 +343,37 @@ struct OrgBadgeRowTests {
343	func anUnresolvableSourceIsNotABadgeRow() {	343	func anUnresolvableSourceIsNotABadgeRow() {
344	#expect(badges("[[https://example.com][file:badge.png]]") == nil)	344	#expect(badges("[[https://example.com][file:badge.png]]") == nil)
345	}	345	}
		346
		347	/// The transform sees each run of prose after styling, with code and links still marked,
		348	/// and never sees a code block.
		349	@Test
		350	func textTransformRunsOnProseOnly() {
		351	var seen: [String] = []
		352	let blocks = OrgLayoutBuilder(
		353	options: .init(), styler: PlainOrgCodeStyler(), keywords: .init(),
		354	textTransform: { text in
		355	seen.append(String(text.characters))
		356	for run in text.runs where run.inlinePresentationIntent?.contains(.code) == true {
		357	text[run.range].foregroundColor = .red
		358	}
		359	}
		360	).layout(OrgParser.parse("""
		361	* Title
		362
		363	Some =x= here.
		364
		365	\| cell \|
		366
		367	#+begin_src sh
		368	echo hi
		369	#+end_src
		370	""")).blocks
		371
		372	#expect(seen == ["Title", "Some x here.", "cell"])
		373	guard case .paragraph(let text) = blocks[1] else {
		374	Issue.record("expected a paragraph")
		375	return
		376	}
		377	#expect(text.runs.contains { $0.foregroundColor == .red && String(text[$0.range].characters) == "x" })
		378	}
346	}	379	}

Commit d143408780

Commit `d143408780`