Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cocoatoucher/styledmarkdown
Generate SwiftUI Text or AttributedString from markdown strings with custom style names.
https://github.com/cocoatoucher/styledmarkdown
attributed attributedstring ios localisation localization macos markdown string style styled swift swiftui text tvos watchos
Last synced: about 1 month ago
JSON representation
Generate SwiftUI Text or AttributedString from markdown strings with custom style names.
- Host: GitHub
- URL: https://github.com/cocoatoucher/styledmarkdown
- Owner: cocoatoucher
- License: mit
- Created: 2022-01-03T22:20:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T16:16:19.000Z (6 months ago)
- Last Synced: 2024-10-15T23:02:37.208Z (2 months ago)
- Topics: attributed, attributedstring, ios, localisation, localization, macos, markdown, string, style, styled, swift, swiftui, text, tvos, watchos
- Language: Swift
- Homepage:
- Size: 796 KB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
iOS 15.0 / macOS 12.0 / tvOS 15.0 / watchOS 8.0
iOS 15 comes with markdown string support. By default, you can style your strings with standard markdown syntax like **`**bold**`** and *`*italic*`*
This is nice, but there is usually a need to specify more complex styling like `font type`, `text color` etc.
---
StyledMarkdown is a mini library that lets you define custom styles in code and use those styles in your localized markdown strings.
- Define your custom styles in code via specifying attributes like custom fonts, text colors, underline styles and more, and name those syles.
- Use those style names in your markdown strings.
- Provide your custom style definitions and markdown strings which are using those custom styles' names to StyledMarkdown. StyledMarkdown can create `SwiftUI` `Text` views or just `AttributedString`s for `UIKit`.
With this approach, you do not have to define a custom `AttributedStringKey` each time you want a custom style in your markdown, as StyledMarkdown handles this part for you.
## Examples
## Sample usage
```swift
let normalStyle = Style { style in
style.font = .subheadline
style.foregroundColor = .red
}
let boldStyle = Style { style in
style.font = Font.italic(.system(size: 20))()
style.foregroundColor = .blue
}
let myStyleGroup = StyleGroup(
base: normalStyle,
[
"bold": boldStyle
]
)
Text(
"Hey ^[buddy](style: 'bold')",
styleGroup: myStyleGroup
)
// or
AttributedString(
localized: "Hey ^[buddy](style: 'bold')",
styleGroup: myStyleGroup
)
```
***The idea of StyleGroup and named Styles comes directly from [`SwiftRichString` library by `Daniele Margutti` on GitHub](https://github.com/malcommac/SwiftRichString). Some of the code from there is also used in this package.***
## Supported modifiers
#### font(*SwiftUI.Font* or *UIFont*)
#### foregroundColor(*SwiftUI.Color* or *UIColor*)
#### backgroundColor(*SwiftUI.Color* or *UIColor*)
#### strikethrough(*SwiftUI.Color* or *UIColor*)
#### strikethroughStyle(*NSUnderlineStyle*)
#### underline(*SwiftUI.Color* or *UIColor*)
#### underlineStyle(*NSUnderlineStyle*)
#### kerning(*CGFloat*)
#### tracking(*CGFloat*)
#### baselineOffset(*CGFloat*)
### Advanced styling
```swift
let rainbow: [Color] = [
.blue, .teal, .red, .gray, .yellow, .orange, .purple
]
let rainbowStyleGroup = StyleGroup(
styleCustom: { source in
var attrString = source
for run in attrString.runs {
let currentRange = run.range
var index = currentRange.lowerBound
var colorCounter: Int = 0
while index < currentRange.upperBound {
let nextIndex = attrString.characters.index(
index,
offsetBy: 1
)
attrString[index ..< nextIndex].foregroundColor = rainbow[colorCounter]
colorCounter += 1
if colorCounter >= rainbow.count {
colorCounter = 0
}
index = nextIndex
}
}
return attrString
}
)
Text(
"Rainbow",
styleGroup: rainbowStyleGroup
)
// or
AttributedString(
localized: "Rainbow",
styleGroup: rainbowStyleGroup
)
```
_Parts of the above code for rainbow styling is taken from WWDC'21 sample app project called Caffe, Copyright © 2021 Apple Inc._
### 🔗 Links
You can add links inside your strings using the custom `link` `AttributedStringKey`:
`^[styled link](link: {url: 'http://www.example.com', style: 'linkStyle'})`
### iOS Automatic grammar agreement
Automatic grammar agreement's `inflect` property works with StyledMarkdown styles.
`^[2 salad](style: 'italic', inflect: true)`
generates
`2 salads` with italic style.
### 🎆 Images (not supported)
iOS currently does not support including custom `Image` attachments within `AttributedString`.