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.
TextBuilder offers 3 ready-made builders out of the box, depending on which text separator you need.
@BasicTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
@SpacedTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
@MultilineTextBuilder
var loremIpsum: Text {
Text("Lorem").underline().foregroundColor(.blue)
Text("ipsum dolor")
Text("sit").bold()
Text("amet, consectetur")
}
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"
}
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"
}
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:main --platform macos
in your terminal.
Alternatively, a standalone demo Xcode Playground is also provided in this package.