https://github.com/zats/Tribute

Programmatic creation of NSAttributedString doesn't have to be a pain
https://github.com/zats/Tribute

Last synced: 6 days ago
JSON representation

Programmatic creation of NSAttributedString doesn't have to be a pain

• Host: GitHub
• URL: https://github.com/zats/Tribute
• Owner: zats
• License: mit
• Created: 2015-12-06T21:14:58.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-02-18T15:22:59.000Z (almost 3 years ago)
• Last Synced: 2024-08-15T19:08:04.780Z (4 months ago)
• Language: Swift
• Homepage:
• Size: 2.38 MB
• Stars: 63
• Watchers: 5
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ios-star - Tribute - Programmatic creation of NSAttributedString doesn't have to be a pain. (Text / Other Testing)
• awesome-ios - Tribute - Programmatic creation of NSAttributedString doesn't have to be a pain. (Text / Other Testing)

README

        
# Tribute [![Build Status](https://travis-ci.org/zats/Tribute.svg?branch=master)](https://travis-ci.org/zats/Tribute)

```swift

let string = NSMutableAttributedString().add("Hello ") {

    $0.font = .systemFontOfSize(20)

    $0.color = .redColor()

    $0.underline = .StyleSingle

}.add("world ") {

    $0.stroke = .Filled(width: 2)

    $0.strokeColor = .orangeColor()

}.add("of Swift "){

    $0.font = .systemFontOfSize(12)

    $0.underline = nil

    $0.URL = NSURL(string: "http://swift.org")!

}.add(UIImage(named: "swift")!)

```

![](https://raw.githubusercontent.com/zats/Tribute/master/docs/attributed-string.png)

Not bad comparing to

```swift

let string2 = NSMutableAttributedString()

string2.appendAttributedString(NSAttributedString(string: "Hello ", attributes: [

    NSFontAttributeName: UIFont.systemFontOfSize(20),

    NSUnderlineStyleAttributeName: NSUnderlineStyle.StyleSingle.rawValue,

    NSForegroundColorAttributeName: UIColor.redColor()

]))

string2.appendAttributedString(NSAttributedString(string: "world ", attributes: [

    NSFontAttributeName: UIFont.systemFontOfSize(20),

    NSUnderlineStyleAttributeName: NSUnderlineStyle.StyleSingle.rawValue,

    NSForegroundColorAttributeName: UIColor.redColor(),

    NSStrokeColorAttributeName: UIColor.orangeColor(),

    NSStrokeWidthAttributeName: -2

]))

string2.appendAttributedString(NSAttributedString(string: "of Swift ", attributes: [

    NSFontAttributeName: UIFont.systemFontOfSize(12),

    NSForegroundColorAttributeName: UIColor.redColor(),

    NSStrokeColorAttributeName: UIColor.orangeColor(),

    NSStrokeWidthAttributeName: -2

]))

let attachment = NSTextAttachment()

attachment.image = UIImage(named: "swift")

string2.appendAttributedString(NSAttributedString(attachment: attachment))

```

# Design Goals

1. Word processor logic: appending a string should inherit last attributes.

1. Allow for easy customization of common properties, including toggle bold or change the font size.

1. Flatten paragraph style and attributes, no more 5 lines of code if all you wanted is to change text alignment.

1. Replace weird attributes with more reasonable versions (for example [`Attribute.Stroke`](https://github.com/zats/Tribute/blob/master/Tribute/Tribute.swift#L24-L27) vs [NSStrokeWidthAttributeName](https://developer.apple.com/library/mac/qa/qa1531/_index.html)).

1. Minimal overhead: produce only required attributes.

1. Have an attributed string ready to use every time you leave the configuration block.

1. Replace string constants with strongly typed enums where possible.

# Notes

## Playground

Playgrounds do not always render `NSAttributesString` correctly (font variations and attachments are few of the problematic I noticed). 

**Workaround**: Use a `UILabel` as a live view instead: `XCPlaygroundPage.currentPage.liveView = label`.

## Font variations

Not all fonts have both italic and bold variations

**Workaround**: Use `obliqueness` property as a poor man italic, and `expansion` as a bold respectively.

## Closure with one statement

When the configuration closure includes only one statement, compiler gets confused

**Workaround**: Specify closure type explicitly like so

```swift 

string.add("text") { (inout a: Attributes) in

    a.color = .redColor()

}

```

If you know a better way, please open a PR, I'd love to learn from it!

# Roadmap

- [ ] Objective-C compatibility

- [ ] Moar attributes (PRs are welcome)

*This is just a tribute*