An easier way to compose attributed strings

Damien

Last update: Dec 31, 2022

Related tags

Text TextAttributes

Overview

TextAttributes makes it easy to compose attributed strings.

let attrs = TextAttributes()
    .font(name: "HelveticaNeue", size: 16)
    .foregroundColor(white: 0.2, alpha: 1)
    .lineHeightMultiple(1.5)

NSAttributedString(string: "The quick brown fox jumps over the lazy dog", attributes: attrs)

Features • Usage • Demo • References • Installation • License

Features

Strongly typed properties
Chainable setter methods
A direct access to the NSParagraphStyle properties
Better autocompletion

Usage

Get or set the TextAttributes properties:

attrs.font = UIFont(name: "HelveticaNeue", size: 16)
attrs.backgroundColor = .white

See all the properties

Method chaining:

The TextAttributes methods return Self to allow method chaining:

attrs
    .lineHeightMultiple(1.5)
    .underlineStyle(.styleSingle)

See all the methods

The methods are also constructors:

The following are equivalent:

attrs
    .font(name: "HelveticaNeue", size: 16)
    .foregroundColor(white: 0.2, alpha: 1)

let font  = UIFont(name: "HelveticaNeue", size: 16)
let color = UIColor(white: 0.2, alpha: 1)

attrs
    .font(font)
    .foregroundColor(color)

Access the underlying dictionary:

attrs.dictionary // Returns the attributes dictionary of type [NSAttributedString.Key: Any]

Third-party libraries:

muukii/TextAttributesUtil Quickly create NSAttributedString with TextAttributes

Demo

Live updates with Injection for Xcode

References

Attributes dictionary

Dictionary Key	`TextAttributes` Property	`TextAttributes` Method
`NSFontAttributeName`	`font`	`font(name:size:)`
		`font(_:)`
`NSParagraphStyleAttributeName`	`paragraphStyle`	`paragraphStyle(_:)`
`NSForegroundColorAttributeName`	`foregroundColor`	`foregroundColor(_:)`
		`foregroundColor(white:alpha:)`
		`foregroundColor(hue:saturation:brightness:alpha:)`
		`foregroundColor(red:green:blue:alpha:)`
		`foregroundColor(patternImage:)`
`NSBackgroundColorAttributeName`	`backgroundColor`	`backgroundColor(_:)`
		`backgroundColor(white:alpha:)`
		`backgroundColor(hue:saturation:brightness:alpha:)`
		`backgroundColor(red:green:blue:alpha:)`
		`backgroundColor(patternImage:)`
`NSLigatureAttributeName`	`ligature`	`ligature(_:)`
`NSKernAttributeName`	`kern`	`kern(_:)`
`NSStrikethroughStyleAttributeName`	`strikethroughStyle`	`strikethroughStyle(_:)`
`NSStrikethroughColorAttributeName`	`strikethroughColor`	`strikethroughColor(_:)`
		`strikethroughColor(white:alpha:)`
		`strikethroughColor(hue:saturation:brightness:alpha:)`
		`strikethroughColor(red:green:blue:alpha:)`
		`strikethroughColor(patternImage:)`
`NSUnderlineStyleAttributeName`	`underlineStyle`	`underlineStyle(_:)`
`NSUnderlineColorAttributeName`	`underlineColor`	`underlineColor(_:)`
		`underlineColor(white:alpha:)`
		`underlineColor(hue:saturation:brightness:alpha:)`
		`underlineColor(red:green:blue:alpha:)`
		`underlineColor(patternImage:)`
`NSStrokeWidthAttributeName`	`strokeWidth`	`strokeWidth(_:)`
`NSStrokeColorAttributeName`	`strokeColor`	`strokeColor(_:)`
		`strokeColor(white:alpha:)`
		`strokeColor(hue:saturation:brightness:alpha:)`
		`strokeColor(red:green:blue:alpha:)`
		`strokeColor(patternImage:)`
`NSShadowAttributeName`	`shadow`	`shadow(_:)`
		`shadow(color:offset:blurRadius:)`
`NSTextEffectAttributeName`	`textEffect`	`textEffect(_:)`
`NSAttachmentAttributeName`	`attachment`	`attachment(_:)`
`NSLinkAttributeName`	`link`	`link(_:)`
		`link(string:)`
		`link(string:relativeToURL:)`
`NSBaselineOffsetAttributeName`	`baselineOffset`	`baselineOffset(_:)`
`NSObliquenessAttributeName`	`obliqueness`	`obliqueness(_:)`
`NSExpansionAttributeName`	`expansion`	`expansion(_:)`
`NSVerticalGlyphFormAttributeName`	`verticalGlyphForm`	`verticalGlyphForm(_:)`

Paragraph style

`NSMutableParagraphStyle` Property	`TextAttributes` Property	`TextAttributes` Method
`alignment`	`alignment`	`alignment(_:)`
`firstLineHeadIndent`	`firstLineHeadIndent`	`firstLineHeadIndent(_:)`
`headIndent`	`headIndent`	`headIndent(_:)`
`tailIndent`	`tailIndent`	`tailIndent(_:)`
`lineBreakMode`	`lineBreakMode`	`lineBreakMode(_:)`
`maximumLineHeight`	`maximumLineHeight`	`maximumLineHeight(_:)`
`lineSpacing`	`lineSpacing`	`lineSpacing(_:)`
`paragraphSpacing`	`paragraphSpacing`	`paragraphSpacing(_:)`
`paragraphSpacingBefore`	`paragraphSpacingBefore`	`paragraphSpacingBefore(_:)`
`baseWritingDirection`	`baseWritingDirection`	`baseWritingDirection(_:)`
`lineHeightMultiple`	`lineHeightMultiple`	`lineHeightMultiple(_:)`

Installation

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate TextAttributes into your Xcode project using Carthage, specify it in your Cartfile:

github "delba/TextAttributes"

Cocoapods

CocoaPods is a dependency manager for Cocoa projects.

You can install it with the following command:

$ gem install cocoapods

To integrate TextAttributes into your Xcode project using CocoaPods, specify it in your Podfile:

use_frameworks!

pod 'TextAttributes'

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Comments

Add string, mutableString methods
I wrote an extension of TextAttributes to enable creating NSAttributedStrings directly, like this:

let attributedString = TextAttributes() .font(name: "HelveticaNeue", size: 16) .foregroundColor(white: 0.2, alpha: 1) .lineHeightMultiple(1.5) .string("The quick brown fox jumps over the lazy dog")

It will be even more easier to create attributed strings. How do you think?
opened by muukii 10
Implements Swift 4 support

This PR fixes issue https://github.com/delba/TextAttributes/issues/27 by implementing Swift 4.2 support to the project. It has migrated all the source code and all project targets (iOS, MacOS, watch and tvOS) to Swift 4.2. This PR requires Xcode 10 with Swift 4.2 to build successfully.

There is no change in the API surface and all tests are passing. Please review and merge.

@delba : If you could add the label hacktoberfest to this PR and the above issue, this would qualify for the Hacktoberfest contest and give some credits.

opened by annjose 8
Update code and project for Swift 4

Using xCode 9 beta 3. Was not able to run the tests for some reason, so they are not updated unfortunately. Something to do with the simulators on my machine.

opened by ejmartin504 8

Problem Clone()

let attribute1 = TextAttributes().font(UIFont(name: "AvenirNext", size: 12))

let attribute2 = attribute1.clone()

attribute2.font  // => UIFont(name: "HelveticaNeue", size: 12) 😥
attribute2.dictionary[NSFontAttributeName] // => UIFont(name: "AvenirNext", size: 12)

I think that there is better to change StoredProperty to ComputedProperty. How do you think?

opened by muukii 6

TextAttribtues reset paragraphStyle configured by InterfaceBuilder/Storyboard.

Hi.

When migrate my project to TextAttributes I noticed problem and wrote patch for it that is TextAttributes reset paragraphStyle configured by storyboard even if not changed paragraphStyle parameter.

// `@IBOutlet weak var label: UILabel!` is configured to center alignment via storyboard.

// Native: label is aligned to Center.
let attributedString = NSMutableAttributedString(string: "text")
attributedString.addAttribute(NSBaselineOffsetAttributeName, value: 8, range: NSRange(location: 0, length: 4))
label.attributedText = attributedString

// TextAttributes: label is aligned to Left.
let attributedString = NSMutableAttributedString(string: "text")
let attrs = TextAttributes().baselineOffset(8)
attributedString.addAttributes(attrs)
label.attributedText = attributedString

Is this bug or feature?

My workaround patch is this, but this patch break current TextAttributes behavior. https://github.com/r-plus/TextAttributes/commit/680cf0786d0137c1e5bc114aa7d4ff845ecf84dc

P.S. I preferred current simply architecture. We should add .alignment(.Center) chain explicitly.

opened by r-plus 4

Range

Hey there,

How would I make this work with ranges? Let's say my string is "Hello World". How would I change only the first 5 characters to be red coloured?

Thanks

opened by jyounus 2

ambiguous use of 'init(string:)

On Xcode 7.3 I get this error, "ambiguous use of 'init(string:)", I tried to force the namespace Foundation but it's still ambiguous

var s = Foundation.NSMutableAttributedString(string: text)
                    ^
Foundation.NSMutableAttributedString:14:12: note: found this candidate
    public init(string str: String)
           ^
TextAttributes.NSAttributedString:19:24: note: found this candidate
    public convenience init(string: String, attributes: TextAttributes.TextAttributes? = default)

opened by vhosune 2

Support for tvOS, watchOS?
I would like support for tvOS and watchOS in Podfile. Are there anything blocking support for them?

s.tvos.deployment_target = '9.0' s.wachos.deployment_target = '2.0'
opened by muukii 2
Use underlineStyle(.single) cause crash app

App Error *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[__SwiftValue _getValue:forType:]: unrecognized selector sent to instance 0x2807a3420' Similar https://stackoverflow.com/questions/46092027/setting-nsunderlinestyle-causes-unrecogognized-selector-exception Env: Xcode 11.2

opened by daoan1412 1
Swift 3.0 Update

I'm not an expect in Swift 3.0 updating, but this works for me when I point my Swift 3 project to my repo.

Cool library, I haven't dug into it yet but looking forward to it.

-MikeSand

opened by mikesanderson 1
Remove default value in initilizer

These convenience initializers conflict existing initializers like this because of the default value in the extension.

I guess the compiler doesn't recognize which one to use. I think it's not good to affect existing APIs. If you have an idea to this problem, let me know it.

Thanks in advance.

opened by pixyzehn 1