Fork me on GitHub

Alex Rupérez

Link: http://j.mp/2rgA8E7
Published: 03 Dec 09:32
I starred felginep/AttributedStringStyle at GitHub.
Focus on the semantics and the visual representation of NSAttributedString separately.
View on GitHub


View README


AttributedStringStyle

Version License Platform

Blog post

You can find the associated blog post here.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

  • iOS 9.0+
  • Swift 4.2

Installation

AttributedStringStyle is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'AttributedStringStyle'

How to use it

Define some abstract style anywhere in your app. For instance.

enum Style {
    case regular
    case highlighted
}

Once your style is defined we have two tools at your disposal:

  • AttributedStringBuilder that is helpful to create attributed string with styles for range of characters
  • AttributedStringStyler that defines which visual attributes to apply for each style

To create your attributed string and focus on the semantic and not the display, use the builder like so:

let content = "A simple string"
let builder = AttributedStringBuilder<Style>(string: content)
builder.setStyle(.regular)
let range = NSString(string: content).range(of: "simple")
builder.addStyle(.highlighted, range: range)
let semanticAttributedString = builder.build()

The attributed string has no visual attributes but semantics ones.

Simple String Semantics

Once your semantic content is defined, you can use the styler to create a new attributed string with visual attributes.

let styler = AttributedStringStyler<Style>()
styler.register(
    attributes: [
        .font: UIFont.systemFont(ofSize: 14),
        .foregroundColor: UIColor.gray
    ],
    forStyle: .regular
)
styler.register(
    attributes: [
        .font: UIFont.boldSystemFont(ofSize: 14),
        .foregroundColor: UIColor.black
    ],
    forStyle: .highlighted
)

let visualAttributedString = semanticAttributedString.styled(with: styler)

This time the result is visual.

Simple String Visual

Author

Pierre Felgines

License

AttributedStringStyle is available under the MIT license. See the LICENSE file for more info.