Commit `1873fef702`

1873fef70216e46ea03a1e72575fd83dd8b40cf2

parent: 77bb69d3d0

Unsigned

cmc <hello@cleberg.net> · 2026-08-31 18:32 UTC

Take TODO/DONE colors from the caller

The renderer hardcoded green for DONE and orange for TODO, which match no
embedding app's palette — everything else it draws is semantic and inherits
the app's appearance. OrgKeywordStyle carries the two colors and defaults
to semantic, so the package invents no hues of its own.

OrgRenderOptions stays Foundation-only, so this lives in OrgSwiftUI.

Layout: unified · split

ARCHITECTURE.md +6

   OrgInlineStyler.swift               [OrgObject] → styled AttributedString
   OrgBlockView.swift, OrgListView.swift, OrgTableView.swift
   OrgCodeStyler.swift                 the app's syntax highlighter, as a protocol
+  OrgKeywordStyle.swift               the app's colors for TODO/DONE
 ```
 `OrgRenderer.renderToHTML` is a thin façade over `OrgParser.parse` + `OrgHTMLTreeRenderer`.
 `CodeHighlighter` — returning `AttributedString` where the other returns HTML. Keeping it a
 protocol is what lets the package stay dependency-free.
+Color follows the same principle. Everything the renderer draws uses a semantic color, so it
+inherits the embedding app's appearance; the one place org carries status rather than prose —
+`TODO`/`DONE` — is configurable through `OrgKeywordStyle` and defaults to semantic too. A
+package that picks concrete hues puts colors on screen that match nothing around them.
 One behaviour deliberately differs from HTML. An image source that will not resolve to an
 **absolute** URL degrades to its alt text: HTML may emit a relative `src` for a document base
 URL to resolve, and a view has no base, so a relative source is unloadable.

README.md +8

	@@ -89,6 +89,14 @@ struct Highlighter: OrgCodeStyler {
89	OrgView(orgSource, options: options, styler: Highlighter())	89	OrgView(orgSource, options: options, styler: Highlighter())
90	```	90	```
91		91
		92	Org's `TODO`/`DONE` keywords default to semantic colors, because a package
		93	cannot know your palette. Pass your own:
		94
		95	```swift
		96	OrgView(orgSource, options: options,
		97	keywords: OrgKeywordStyle(todo: .gbOK, done: .gbDone))
		98	```
		99
92	### Title and heading level	100	### Title and heading level
93		101
94	Two presentation knobs, both defaulting to how Hutch rendered:	102	Two presentation knobs, both defaulting to how Hutch rendered:

Sources/OrgSwiftUI/OrgKeywordStyle.swift added +23

@@ -0,0 +1,23 @@
	1	import SwiftUI
	2
	3	/// Colors for the part of a heading that is status rather than prose: org's `TODO` and
	4	/// `DONE` keywords.
	5	///
	6	/// The defaults are deliberately semantic rather than literal. A package cannot know the
	7	/// palette of the app embedding it, and picking concrete hues — green for done, orange for
	8	/// todo — puts colors on screen that belong to no design system and match nothing around
	9	/// them. Apps pass their own.
	10	public struct OrgKeywordStyle: Sendable {
	11	public var todo: Color
	12	public var done: Color
	13
	14	public init(todo: Color = .secondary, done: Color = .secondary) {
	15	self.todo = todo
	16	self.done = done
	17	}
	18
	19	/// The keyword's color, or nil for a keyword that is neither.
	20	func color(for keyword: String) -> Color {
	21	keyword == "DONE" ? done : todo
	22	}
	23	}

Sources/OrgSwiftUI/OrgLayoutBuilder.swift +2 −1

 struct OrgLayoutBuilder {
     var options: OrgRenderOptions
     var styler: OrgCodeStyler
+    var keywords: OrgKeywordStyle
     private var inline: OrgInlineStyler { OrgInlineStyler(options: options) }
     private var resolver: OrgURLResolver { OrgURLResolver(options: options) }
             var title = AttributedString()
             if let todo = heading.todo {
                 var keyword = AttributedString(todo + " ")
-                keyword.foregroundColor = todo == "DONE" ? .green : .orange
+                keyword.foregroundColor = keywords.color(for: todo)
                 title += keyword
             }
             if let priority = heading.priority {

Sources/OrgSwiftUI/OrgView.swift +5 −2

     private let source: String
     private let options: OrgRenderOptions
     private let styler: OrgCodeStyler
+    private let keywords: OrgKeywordStyle
     @Environment(\.colorScheme) private var colorScheme
     @State private var layout = OrgLayout()
     public init(
         _ source: String,
         options: OrgRenderOptions = .init(),
-        styler: OrgCodeStyler = PlainOrgCodeStyler()
+        styler: OrgCodeStyler = PlainOrgCodeStyler(),
+        keywords: OrgKeywordStyle = .init()
     ) {
         self.source = source
         self.options = options
         self.styler = styler
+        self.keywords = keywords
     }
     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)
+            layout = OrgLayoutBuilder(options: options, styler: styler, keywords: keywords)
                 .layout(OrgParser.parse(source))
         }
     }

Tests/OrgSwiftUITests/OrgLayoutTests.swift +29 −2

	@@ -14,9 +14,11 @@ struct OrgLayoutTests {
14	private func layout(	14	private func layout(
15	_ source: String,	15	_ source: String,
16	options: OrgRenderOptions = .init(),	16	options: OrgRenderOptions = .init(),
17	styler: OrgCodeStyler = PlainOrgCodeStyler()	17	styler: OrgCodeStyler = PlainOrgCodeStyler(),
		18	keywords: OrgKeywordStyle = .init()
18	) -> OrgLayout {	19	) -> OrgLayout {
19	OrgLayoutBuilder(options: options, styler: styler).layout(OrgParser.parse(source))	20	OrgLayoutBuilder(options: options, styler: styler, keywords: keywords)
		21	.layout(OrgParser.parse(source))
20	}	22	}
21		23
22	private func plain(_ string: AttributedString) -> String { String(string.characters) }	24	private func plain(_ string: AttributedString) -> String { String(string.characters) }
	@@ -179,6 +181,31 @@ struct OrgLayoutTests {
179	#expect(layout("#+begin_export latex\n\\emph{hi}\n#+end_export").blocks.isEmpty)	181	#expect(layout("#+begin_export latex\n\\emph{hi}\n#+end_export").blocks.isEmpty)
180	}	182	}
181		183
		184	/// Keyword colors come from the caller. The package defaults to semantic colors rather
		185	/// than inventing hues that match no app's palette.
		186	@Test
		187	func todoKeywordsTakeTheirColorFromTheCaller() {
		188	let style = OrgKeywordStyle(todo: .pink, done: .brown)
		189
		190	guard case .heading(let todo, _) = layout("* TODO Ship it", keywords: style)
		191	.blocks.first else {
		192	Issue.record("expected a heading"); return
		193	}
		194	#expect(todo.runs.contains { $0.foregroundColor == .pink })
		195
		196	guard case .heading(let done, _) = layout("* DONE Shipped", keywords: style)
		197	.blocks.first else {
		198	Issue.record("expected a heading"); return
		199	}
		200	#expect(done.runs.contains { $0.foregroundColor == .brown })
		201
		202	// The default invents nothing.
		203	guard case .heading(let plain, _) = layout("* TODO Ship it").blocks.first else {
		204	Issue.record("expected a heading"); return
		205	}
		206	#expect(plain.runs.allSatisfy { $0.foregroundColor != .green && $0.foregroundColor != .orange })
		207	}
		208
182	/// Every run carries a font, not only the emphasised ones. A plain heading run with no	209	/// Every run carries a font, not only the emphasised ones. A plain heading run with no
183	/// font would inherit the surrounding view's and render at body size.	210	/// font would inherit the surrounding view's and render at body size.
184	@Test	211	@Test

Commit 1873fef702

Commit `1873fef702`