Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddiekaiger/swiftyattributes
A Swifty API for attributed strings
https://github.com/eddiekaiger/swiftyattributes
carthage cocoa cocoapods ios macos nsattributedstring swift swifty-api tvos watchos
Last synced: 1 day ago
JSON representation
A Swifty API for attributed strings
- Host: GitHub
- URL: https://github.com/eddiekaiger/swiftyattributes
- Owner: eddiekaiger
- License: mit
- Created: 2015-11-15T11:08:38.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T00:06:00.000Z (about 1 year ago)
- Last Synced: 2024-10-29T17:50:16.366Z (3 months ago)
- Topics: carthage, cocoa, cocoapods, ios, macos, nsattributedstring, swift, swifty-api, tvos, watchos
- Language: Swift
- Homepage:
- Size: 248 KB
- Stars: 1,635
- Watchers: 18
- Forks: 83
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftyAttributes
#### *A Swifty API for attributed strings.*
[](https://github.com/Carthage/Carthage)
[](https://img.shields.io/cocoapods/v/SwiftyAttributes.svg)
[](http://cocoapods.org/pods/SwiftyAttributes)
[](https://travis-ci.org/eddiekaiger/SwiftyAttributes.svg?branch=master)
[](http://codecov.io/github/eddiekaiger/SwiftyAttributes/coverage.svg?branch=master)
---
With **SwiftyAttributes**, you can create attributed strings like so:
````swift
let fancyString = "Hello World!".withTextColor(.blue).withUnderlineStyle(.styleSingle)
````
Alternatively, use the `Attribute` enum:
````swift
let fancyString = "Hello World!".withAttributes([
.backgroundColor(.magenta),
.strokeColor(.orange),
.strokeWidth(1),
.baselineOffset(5.2)
])
````
You can also easily combine attributed strings using a plus sign:
````swift
let fancyString = "Hello".withFont(.systemFont(ofSize: 12)) + " World!".withFont(.systemFont(ofSize: 18))
````
**SwiftyAttributes** has support for *every* attribute available in Cocoa and Cocoa Touch.
# Requirements
* iOS 8.0+, macOS 10.11+, watchOS 2.0+, tvOS 9.0+
* Swift 4.2+
* Xcode 10.0+
# Installation
### Swift Package Manager
```swift
dependencies: [
.package(url: "https://github.com/eddiekaiger/SwiftyAttributes.git", from: "5.3.0")
]
```
### With CocoaPods
`pod 'SwiftyAttributes'`
### With Carthage
`github "eddiekaiger/SwiftyAttributes"`
# Usage
Initializing attributed strings in `SwiftyAttributes` can be done several ways:
- Using the `with[Attribute]` extensions:
````swift
"Hello World".withUnderlineColor(.red).withUnderlineStyle(.styleDouble)
````
- Using the `Attribute` enum extensions:
````swift
"Hello World".withAttributes([.underlineColor(.red), .underlineStyle(.styleDouble)])
````
- Using the `Attribute` enum in an initializer:
````swift
NSAttributedString(string: "Hello World", swiftyAttributes: [.kern(5), .backgroundColor(.gray)])
````
You can retrieve the attribute at a specific location using the built-in `NSAttributedString.Key` enum:
````swift
let attr: Attribute? = myAttributedString.swiftyAttribute(.shadow, at: 5)
````
Several API methods are provided to use these new enums as well as Swift's `Range` type instead of `NSRange`. Some of the method signatures include:
````swift
extension NSMutableAttributedString {
func addAttributes(_ attributes: [Attribute], range: Range)
func addAttributes(_ attributes: [Attribute], range: NSRange)
func setAttributes(_ attributes: [Attribute], range: Range)
func setAttributes(_ attributes: [Attribute], range: NSRange)
func replaceCharacters(in range: Range, with str: String)
func replaceCharacters(in range: Range, with attrString: NSAttributedString)
func deleteCharacters(in range: Range)
func removeAttribute(_ name: NSAttributedStringKey, range: Range)
}
extension NSAttributedString {
convenience init(string str: String, swiftyAttributes: [Attribute])
func withAttributes(_ attributes: [Attribute]) -> NSMutableAttributedString
func withAttribute(_ attribute: Attribute) -> NSMutableAttributedString
func attributedSubstring(from range: Range) -> NSAttributedString
func swiftyAttribute(_ attrName: NSAttributedStringKey, at location: Int, effectiveRange range: NSRangePointer? = nil) -> Attribute?
func swiftyAttributes(in range: Range, options: NSAttributedString.EnumerationOptions = []) -> [([Attribute], Range)]
func enumerateSwiftyAttributes(in enumerationRange: Range, options: NSAttributedString.EnumerationOptions = [], using block: (_ attrs: [Attribute], _ range: Range, _ stop: UnsafeMutablePointer) -> Void)
func enumerateSwiftyAttribute(_ attrName: NSAttributedStringKey, in enumerationRange: Range, options: NSAttributedString.EnumerationOptions = [], using block: (_ value: Any?, _ range: Range, _ stop: UnsafeMutablePointer) -> Void)
}
extension String {
var attributedString: NSMutableAttributedString
func withAttributes(_ attributes: [Attribute]) -> NSMutableAttributedString
func withAttribute(_ attribute: Attribute) -> NSMutableAttributedString
}
// ... and more!
````
# Support
For questions, support, and suggestions, please open up an issue.
# License
**SwiftyAttributes** is available under the MIT license. See the LICENSE file for more info.