https://github.com/tunous/joinedtext

A SwiftUI library for combining multiple Text views.
https://github.com/tunous/joinedtext

swiftui

Last synced: about 1 month ago
JSON representation

A SwiftUI library for combining multiple Text views.

• Host: GitHub
• URL: https://github.com/tunous/joinedtext
• Owner: Tunous
• License: mit
• Archived: true
• Created: 2020-08-28T19:07:36.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-21T10:19:34.000Z (about 3 years ago)
• Last Synced: 2024-09-24T21:41:18.122Z (about 1 month ago)
• Topics: swiftui
• Language: Swift
• Homepage:
• Size: 35.2 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JoinedText

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FTunous%2FJoinedText%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/Tunous/JoinedText)

![Build / Test](https://github.com/Tunous/JoinedText/workflows/Build%20/%20Test/badge.svg)

# Deprecation

**DEPRECATED:** This library was created while result builders (previously known as function builders) were not yet officially a part of Swift language. Now you can use **[TextBuilder](https://github.com/davdroman/TextBuilder)** library by [David Roman](https://github.com/davdroman) instead which provides the same basic functionallity and more using the latest Swift API.

___

A **SwiftUI** view for combining multiple `Text` views into a single `Text` instance.

```swift

Text {

    Text("This text can be")

    if isTrue {

        Text("bold,")

            .fontWeight(.bold)

        Text("monospaced")

            .font(.system(.body, design: .monospaced))

        Text("or")

    }

    Text("styled")

        .font(.system(.caption))

    Text("however")

        .italic()

    Text("you")

        .font(Font.title.smallCaps())

    Text("want and")

    Text("everything")

        .foregroundColor(.green)

        .underline()

    Text("will be combined 😃.")

}

```

![Preview](./Art/Preview.png)

# Description

Similarly to how you can build regular view hierarchies, this library provides you with an additional initializer for `Text` view, that you can use to build complex sentences with varying styles. Inside of text definition block, you can use common code instructions such as `if`, `if else`, `switch` and similar statements to build complex multi style sentences.

## Usage

### Basics

You can use `Text(_ content:)` initializer to build your sentence from multiple `Text` views provided in passed closure.

```swift

Text {

    Text("Example")

    Text("sentence").bold()

}

```

**Output:**

> Example **sentence**

### String separator

By default all `Text`s declared inside of content block will be separated by a space character. You can change this behavior by providing your own separator text.

```swift

Text(separator: "-") {

    Text("joined")

    Text("with")

    Text("dashes")

}

```

**Output:**

> joined-with-dashes

### Advanced separator

For even more control, like additional styling, pass in `Text` instance as a separator.

```swift

Text(separator: Text(" ! ").bold()) {

    Text("bold")

    Text("exclamation")

    Text("mark")

}

```

**Output:**

> bold **!** exclamation **!** mark

### Control flow

Inside of text definition blocks you can use control flow statements such as `if`, `switch` or `if let` to build your combined `Text`.

```swift

Text {

   Text("Hello,")

   if let name = yourName {

       Text(name).bold()

   } else {

       Text("what is your name?")

   }

}

```

**Output:**

> Hello, **Łukasz**