Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rosberry/texstyle

Format iOS attributed strings easily
https://github.com/rosberry/texstyle

Last synced: 9 days ago
JSON representation

Format iOS attributed strings easily

Awesome Lists containing this project

README 

        


    Stylin






    

      

    

    

        Swift Version

    

    

        Carthage Compatible

    

    

        codecov

    




Texstyle allows you to format attributed strings easily.



## Features



- Applying attributes with strong typing and autocompletion

- Cache for attributes

- Substyles

- Convenient extensions for `String` and `UIButton`



## Requirements



- iOS 9.0+ / tvOS 9.0+

- Xcode 10.0+



## Usage



Here is a basic example of Texstyle using:



```swift

let text = Text(value: "Hello, World 🌍", style: .title1)

text.add(.heading1, for: "World")

titleLabel.attributedText = text.attributed

```



The result:



![Example1](https://raw.githubusercontent.com/rosberry/texstyle/master/.github/example1.png)



Let's start with text styles. There is a `TextStyle` class for configuring different style parameters like font, color, kerning etc. We prefer to use `TextStyle` extension for app specific styles:



```swift

extension TextStyle {



    static let title1: TextStyle = {

        let style = TextStyle()

        style.font = .systemFont(ofSize: 32, weight: .regular)

        return style

    }()

        

    static let heading1: TextStyle = {

        let style = TextStyle()

        style.font = .systemFont(ofSize: 28, weight: .semibold)

        style.color = .purple

        return style

    }()

}

```



It allows you to reuse the styles across the app.



Next, create a `Text` instance. It contains string value and style:



```swift

let text = Text(value: "Hello, World 🌍", style: .title1)

```



Text also supports independent styles for each `UIControl.State`. For example, if you want to use a different style for button highlight state, you should initialize text like:



```swift

let text = Text(value: " Sign in with Apple", styles: [.normal: .heading1,

                                                         .highlighted: .heading2])

```



To create an attributed string, just use:



```swift

//By default for normal state

text.attributed



//For needed state

text.attributed(for: .highlighted)

```



All attributed strings are cached by default. It's useful in reusable elements like `UICollectionViewCell` or `UITableViewCell`.



There are custom operators for texts and strings:



```swift

let text1 = Text(value: "Ros", style: .title1)

let text2 = text1 + "ber"

let text3 = Text(value: "ry", style: .title1)

let text4 = text2 + text3

text4.value // "Rosberry"

```



There are convenience APIs for text creation and applying:



```swift

//String to text

"Settings".text(with: .heading1)



//UIButton

button.setText(text)

```



Check [TexstyleExample](xcode://clone?repo=https%3A%2F%2Fgithub.com%2Frosberry%2Ftexstyle) project for more examples.



![Example2](https://raw.githubusercontent.com/rosberry/texstyle/master/.github/example2.png)



## Cache



TextStyle and Text classes have internal cache to prevent extra calculation. TextStyle caches attributes and invalidates it on any attribute change. Text has cached attributed strings for states. For example, if you use texts in collection view cells and want to update some labels in it after reuse, texts return cached strings. Please note that texts won't invalidate cached strings if you update textstyle attributes.



## Installation



### Depo



[Depo](https://github.com/rosberry/depo) is a universal dependency manager that combines Carthage, SPM and CocoaPods and provides common user interface to all of them.



To install `Texstyle` via Carthage using Depo you need to add this to your `Depofile`:

```yaml

carts:

  - kind: github

    identifier: rosberry/Texstyle

```



  To install Texstyle via CocoaPods

  Add this to your Depofile:



  ```yaml

  pods:

    - name: Texstyle

  ```



### CocoaPods



[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Alamofire into your Xcode project using CocoaPods, specify it in your `Podfile`:



```ruby

pod 'Texstyle', '~> 0.0'

```



### Carthage



[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate Alamofire into your Xcode project using Carthage, specify it in your `Cartfile`:



```ogdl

github "Rosberry/Texstyle" ~> 5.0

```



## Documentation



Read the [docs](https://rosberry.github.io/texstyle). Generated with [jazzy](https://github.com/realm/jazzy). Hosted by [GitHub Pages](https://pages.github.com).



## About






This project is owned and maintained by [Rosberry](http://rosberry.com). We build mobile apps for users worldwide 🌏.



Check out our [open source projects](https://github.com/rosberry), read [our blog](https://medium.com/@Rosberry) or give us a high-five on 🐦 [@rosberryapps](http://twitter.com/RosberryApps).



## License



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