Swift Package Index



  • The latest stable release is 0.0.1. Released about 2 months ago.
  • The last commit to main was about 2 months ago.

Swift Version Compatibility

  • 0.0.1 and main
    5.3
    5.2
    5.1
    5.0
    4.2
Full build results

Platform Compatibility

  • 0.0.1 and main
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS
Full build results

SequenceBuilder

SequenceBuilder is a general purpose Function Builder / Result Builder for Swift. It allows you to build arbitrary heterogenous sequences without loosing information about the underlying types.

SequenceBuilder might be helpful for you if you have ever encountered the error message Protocol 'X' can only be used as a generic constraint because it has Self or associated type requirements. It can be used for any kind of heterogenous sequence, but it is especially useful for building custom container views in SwiftUI.

You can use @SequenceBuilder like the @ViewBuilder-attribute in SwiftUI. As a result, you don't just get one view, but a sequence of individual views without resorting to AnyView. SequenceBuilder has the same limitation as ViewBuilder in that it currently only support 10 Elements without nesting.

For a simple example, this view wraps its child views in an enumeration similar to an ordered HTML list (Full example).

import SequenceBuilder
import SwiftUI

struct EnumerationView<Content: Sequence>: View where Content.Element: View {

    let content: Content

    init(@SequenceBuilder builder: () -> Content) {
        self.content = builder()
    }

    var body: some View {
        VStack(alignment: .leading, spacing: 8) {
            ForEach(sequence: content) { (index, content) in
                HStack(alignment: .top) {
                    Text("\(index + 1). ")
                    content
                }
            }
        }
    }
}

// Usage: 
// EnumerationView {
//    Text("Some text")
//    ...
// }

The elements of the heterogeneous sequence don't have to be views. For a more intricate example, where the SequenceBuilder is used to build a table out of columns, see TableView.swift in the examples folder.

What kind of sorcery is this?

You might ask yourself at this point how this is implemented and I encourage you to check out the source. It is very small.

The elements of the sequence are of type Either:

public enum Either<Left, Right> {
    case left(Left)
    case right(Right)
}

For every additional element in the sequence, another Either is nested inside the other ones. E.g.:

  • the sequence Text, Image becomes [Either<Text, Image>]
  • the sequence Text, Image, Text becomes [Either<Text, Either<Image, Text>>]
  • the sequence Text, Image, Text, Button becomes [Either<Text, Either<Image, Either<Text, Button>>>]
  • and so on ...

This growth of types is similar to the kind you get in SwiftUI. It seems to work fine, but it is probably not suitable for very large collections.

If you just want a collection of views, yout don't have to care about this implementation detail, because Either conforms to View if Left and Right also conform to View.
But if you want to use your own protocols with or without associated types, then you have to extend Either yourself like in the TableView.swift example.

Installation

Swift Package Manager

In Xcode, select menu File > Swift Packages > Add Package Dependency... and enter the repository URL.

Repository: "https://github.com/andtie/SequenceBuilder"