SwiftRichString

You can install SwiftRichString using CocoaPods, Swift Package Manager, or Carthage.

### CocoaPods
```ruby
pod 'SwiftRichString'

Swift Package Manager

dependencies: [
    .package(url: "https://github.com/malcommac/SwiftRichString.git", from: "3.5.0")
]

Carthage

github "malcommac/SwiftRichString"

SwiftRichString requires the following minimum versions:

• Swift 5.1+
• iOS 8.0+
• macOS 11.0+
• watchOS 2.0+
• tvOS 11.0+

SwiftRichString can parse and render XML-tagged strings into NSAttributedString instances. To do this:

1. Define a base Style for the entire string.
2. Define specific Style objects for each tag (e.g., <b>, <i>).
3. Create a StyleXML instance containing the base style and a dictionary mapping tag names to their respective styles.
4. Apply the StyleXML to the source string using .set(style:).

SwiftRichString extends UILabel, UITextView, and UITextField with three additional properties that can be used in Interface Builder:

1. styleName: String: Set this in IB to use a globally registered style name. The text already set in the control will be rendered using this style.
2. style: StyleProtocol: Allows you to set a specific style instance to render the control's text.
3. styledText: String: Use this property instead of attributedText to set new text that is automatically rendered using the currently assigned style.

Supported style types:

• Style: Applies attributes to the entire text.
• StyleXML: Applies a base attribute and applies specific attributes when XML/HTML tags are encountered.
• StyleRegEx: Applies a base attribute and applies attributes only to matches of a specified pattern.

SwiftRichString supports attaching images to attributed strings via direct AttributedString initialization or through XML tags.

Direct Initialization

• Local: AttributedString(image:bounds:)
• Remote: AttributedString(imageURL:)

XML Tags

• <img named="resourceName" rect="x,y,w,h"/> for local assets.
• <img url="http://..."/> for remote URLs.

Lazy Loading

Provide a custom imageProvider closure to StyleXML to intercept image requests and return custom images manually.

You can manually apply styles to UILabel, UITextView, or UITextField in code using the following patterns:

Using the .set() method on a String: Convert a standard string to an attributed string by applying a style.

Using the .style and .styledText properties: Assign a style instance directly to the control and then update the text via styledText.

// manually set an attributed string
self.label?.attributedText = (self.label?.text ?? "").set(myStyle)

// manually set the style via instance
self.label?.style = myStyle
self.label?.styledText = "Updated text"

When using the styleName property set in Interface Builder, you should update the content of the control using the styledText property to ensure the style is applied to the new content.

// use `styleName` set value to update a text with the style
self.label?.styledText = "Another text to render" // text is rendered using specified `styleName` value.

You can create a new style that inherits all properties from an existing style and then override or add specific attributes using the byAdding() method.

let initialStyle = Style {
	$0.font = SystemFonts.Helvetica_Light.font(size: 15)
	$0.alignment = right
}

// subStyle inherits initialStyle but overrides alignment and adds a color
let subStyle = initialStyle.byAdding {
	$0.alignment = center
	$0.color = UIColor.red
}

Use the Style class to encapsulate text attributes like font, color, and alignment. It uses a builder pattern where you provide a closure to configure properties. You can use UIColor, HEX strings, or SystemFonts for typography.

let style = Style {
	$0.font = SystemFonts.AmericanTypewriter.font(size: 25)
	$0.color = "#0433FF" // HEX string supported
	$0.underline = (.patternDot, UIColor.red)
	$0.alignment = .center
}
let attributedText = "Hello World!".set(style: style)