TextBuilder
Introduction
Text composition in SwiftUI can often be cumbersome, especially when there's logic affecting its format and content.
TextBuilder leverages the power of Swift Result Builders to solve this problem. TextBuilder mimics SwiftUI's ViewBuilder to make for a familiar experience at the point of use.
Usage
TextBuilder offers 3 ready-made builders out of the box, depending on which text separator you need.
Unspaced Text
@BasicTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
Spaced Text
@SpacedTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
Multiline Text
@MultilineTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
Pro Tip
✨
TextBuilder accepts String types directly as if they were plain Text, and also provides a String.text computed var to remove unwanted code noise when Text is explicitly needed.
@MultilineTextBuilder
var loremIpsum: Text {
"Lorem".text.underline().foregroundColor(.blue)
"ipsum dolor"
"sit".text.bold()
"amet, consectetur"
}
Other Separators
There are two options to customize the separator used to compose your Text.
First, you can use Text.init(separator:content:):
var loremIpsum: Text {
Text(separator: " 🍆 ") {
"Lorem".text.underline().foregroundColor(.blue)
"ipsum dolor"
"sit".text.bold()
"amet, consectetur"
}
}
But if you prefer to keep using a result builder, you can:
struct EggplantSeparator: TextBuilderSeparator {
static var separator: String { " 🍆 " }
}
@TextBuilder<EggplantSeparator>
var loremIpsum: Text {
"Lorem".text.underline().foregroundColor(.blue)
"ipsum dolor"
"sit".text.bold()
"amet, consectetur"
}
Try it out!
TextBuilder supports Arena to effortlessly take it for a spin in a playground before you decide to add it to your codebase.
Simply install Arena and run arena davdroman/TextBuilder@branch:master --platform macos in your terminal.
1.1k Jan 8, 2023
438 Dec 9, 2022
9 Dec 24, 2022
16 Nov 8, 2022
3 Sep 16, 2021
2 Sep 22, 2021
346 Oct 8, 2022
3.7k Dec 31, 2022
110 Mar 10, 2021
2.9k Dec 27, 2022
8.8k Jan 4, 2023
5 Jan 28, 2022
19 Dec 7, 2022
26 Dec 20, 2022
13 Oct 22, 2022
1.2k Jan 1, 2023
1.8k Dec 24, 2022
1.9k Dec 29, 2022