Swiftpack.co - NuPlay/RichText as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by NuPlay.
NuPlay/RichText v2.0-beta
Easily show RichText(html) in SwiftUI
⭐️ 176
🕓 32 weeks ago
iOS macOS
.package(url: "https://github.com/NuPlay/RichText.git", from: "v2.0-beta")

RichText

Swift: 5.1+ iOS: 13.0+ macOS-10.15+

github

스크린샷 2021-08-28 오전 12 14 09 스크린샷 2021-08-28 오전 12 13 59
LightMode DarkMode

Code

import SwiftUI
import RichText

struct RichText_Test: View {
    @State var  html = ""
    
    var body: some View {
       ScrollView{
            RichText(html: html)
                .lineHeight(170)
                .colorScheme(.auto)
                .imageRadius(12)
                .fontType(.system)
                .foregroundColor(light: Color.primary, dark: Color.primary)
                .linkColor(light: Color.blue, dark: Color.blue)
                .colorPreference(forceColor: .onlyLinks)
                .linkOpenType(.SFSafariView())
                .customCSS("")
                .placeholder {
                    Text("loading")
                }
                .transition(.easeOut)
        }
    }
}

struct RichText_Test_Previews: PreviewProvider {
    static var previews: some View {
        RichText_Test()
    }
}

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding RichText as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/NuPlay/RichText.git", .upToNextMajor(from: "2.0.0"))
]

More

import SwiftUI
import RichText

struct RichText_Test: View {
    @State var  html = ""
    
    let config: Configuration = Configuration(customCSS: String, fontType: FontType, fontColor: ColorSet, lineHeight: CGFloat, colorScheme: ColorScheme, imageRadius: CGFloat, linkOpenType: LinkOpenType, linkColor: ColorSet, isColorsImportant: ColorPreference)
    
    var body: some View {
       ScrollView{
        RichText(html: text, configuration: config, placeholder: AnyView?)
                .lineHeight(170)
                .colorScheme(.auto)
                .imageRadius(12)
                .fontType(.system)
                .foregroundColor(light: Color.primary, dark: Color.primary)
                .linkColor(light: Color.blue, dark: Color.blue)
                .colorPreference(forceColor: .onlyLinks)
                .linkOpenType(.SFSafariView())
                .customCSS("")
                .placeholder {
                    Text("loading")
                }
                .transition(.easeOut)
        }
    }
}

struct RichText_Test_Previews: PreviewProvider {
    static var previews: some View {
        RichText_Test()
    }
}

Custom Font

import SwiftUI
import RichText

struct RichText_Test: View {
    @State private var  html = ""
    
    var body: some View {
       ScrollView{
        RichText(html: html)
        .fontType(.customName("Noto Sans"))
        .customCSS("""
                 @font-face {
                        font-family: 'Noto Sans';
                        src: url("NotoSans-Regular.ttf") format('truetype');
                            }
                """)
        }
    }
}

struct RichText_Test_Previews: PreviewProvider {
    static var previews: some View {
        RichText_Test()
    }
}

Sample Text

Click
import SwiftUI
import RichText

struct RichText_Test: View {
    @State var  html = """
        <h1>Non quam nostram quidem, inquit Pomponius iocans;</h1>
        
        <img style="max-width:100%;" src = "https://user-images.githubusercontent.com/73557895/126889699-a735f993-2d95-4897-ae40-bcb932dc23cd.png">
        

        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quis istum dolorem timet? Sit sane ista voluptas. Quis est tam dissimile homini. Duo Reges: constructio interrete. <i>Quam illa ardentis amores excitaret sui! Cur tandem?</i> </p>

        <dl>
            <dt><dfn>Avaritiamne minuis?</dfn></dt>
            <dd>Placet igitur tibi, Cato, cum res sumpseris non concessas, ex illis efficere, quod velis?</dd>
            <dt><dfn>Immo videri fortasse.</dfn></dt>
            <dd>Quae qui non vident, nihil umquam magnum ac cognitione dignum amaverunt.</dd>
            <dt><dfn>Si longus, levis.</dfn></dt>
            <dd>Ita ne hoc quidem modo paria peccata sunt.</dd>
        </dl>


        <ol>
            <li>Possumusne ergo in vita summum bonum dicere, cum id ne in cena quidem posse videamur?</li>
            <li>Placet igitur tibi, Cato, cum res sumpseris non concessas, ex illis efficere, quod velis?</li>
            <li>Unum nescio, quo modo possit, si luxuriosus sit, finitas cupiditates habere.</li>
        </ol>


        <blockquote cite="http://loripsum.net">
            Aristoteles, Xenocrates, tota illa familia non dabit, quippe qui valitudinem, vires, divitias, gloriam, multa alia bona esse dicant, laudabilia non dicant.
        </blockquote>


        <p>Scrupulum, inquam, abeunti; Conferam tecum, quam cuique verso rem subicias; Audeo dicere, inquit. Maximus dolor, inquit, brevis est. Nos commodius agimus. </p>

        <ul>
            <li>Cur igitur, inquam, res tam dissimiles eodem nomine appellas?</li>
            <li>Omnia peccata paria dicitis.</li>
        </ul>


        <h2>Laboro autem non sine causa;</h2>

        <p>Itaque contra est, ac dicitis; <code>Illa argumenta propria videamus, cur omnia sint paria peccata.</code> </p>

        <pre>Nunc dicam de voluptate, nihil scilicet novi, ea tamen, quae
        te ipsum probaturum esse confidam.

        Sin est etiam corpus, ista explanatio naturae nempe hoc
        effecerit, ut ea, quae ante explanationem tenebamus,
        relinquamus.
        </pre>



        """
    
    var body: some View {
        ScrollView{
           RichText(html: html)
                .lineHeight(170)
                .colorScheme(.auto)
                .imageRadius(12)
                .fontType(.system)
                .foregroundColor(light: Color.primary, dark: Color.primary)
                .linkColor(light: Color.blue, dark: Color.blue)
                .colorPreference(forceColor: .onlyLinks)
                .customCSS("")
                .linkOpenType(.SFSafariView())
                .placeholder {
                    Text("loading")
                }
                .transition(.easeOut)
        }
    }
}

struct RichText_Test_Previews: PreviewProvider {
    static var previews: some View {
        RichText_Test()
    }
}
    

If use for macOS

macOS Guide - This library uses WebView to display HTML.
  • If it is not displayed normally, please allow "Outgoing Connections (Client)" permission.

How To Use

Variable explanation

  • html : which you want to show (String type)

Modifier

Modifier Default
.foregroundColor(light: Color, dark: Color) (light: "000000", dark: "F2F2F2")
.imageRadius(_ imageRadius: CGFloat) 0
.customCSS(_ customCSS: String) ""
.lineHeight(_ lineHeight: CGFloat) 170
.colorScheme(_ colorScheme: ColorScheme) .auto
.fontType(_ fontType: FontType) .system
.linkColor(_ linkColor: ColorSet) ColorSet(light: "#007AFF", dark: "#0A84FF", isImportant: true)
.linkOpenType(_ linkOpenType: LinkOpenType) .Safari
.placeholder<T>(@ViewBuilder content: () -> T) nil
.colorPreference(forceColor: ColorPreference) .onlyLinks
.transition(_ transition: Animation?) .none
  • foregroundColor (default: (light: "000000", dark: "F2F2F2")) : Color of Text
  • imageRadius (default: 0) : Radius of image corner
  • customCSS(default: ""): You can add CSS if you want
  • lineHeight (default: 170) : Height of each line
  • colorScheme(default: .auto) : light or dark mode (it changes text color)
  • fontType(default: .system): Font type in RichText view
  • linkColor (default: ColorSet(light: "#007AFF", dark: "#0A84FF")) : linkColor (Color or UIColor)
  • linkOpenType (default: .Safari) : When the user clicks the link contained in html, Way to take action
  • placeholder (default: nil) : What to display until Richtext views are completely drawn (View type)
  • transition(default: .none) : Transition between PlaceHolder and Content
  • colorPreference(default: .onlyLinks) : css '!important', It ignores the color in variable 'html'

Known Issues

If you are trying to display very large content, it may not be displayed.

Planned (Future work):

A variety of options. If you need any options, leave them in the issues or discussion.

GitHub

link
Stars: 176
Last commit: 4 weeks ago
Advertisement: IndiePitcher.com - Cold Email Software for Startups

Release Notes

V.2.3.1
5 weeks ago

:star: What's Changed

✨ [Feature]: Add custom type to LinkOpenType by @vidalhara in https://github.com/NuPlay/RichText/pull/42

public enum LinkOpenType {
   #if canImport(UIKit)
   case SFSafariView(configuration: SFSafariViewController.Configuration = .init(), isReaderActivated: Bool? = nil, isAnimated: Bool = true)
   #endif
   case Safari
   case custom((URL) -> Void)
   case none
}

🐛 [Fix] Always call decisionHandler on webview navigationAction by @filip-zielinski in https://github.com/NuPlay/RichText/pull/43

👍 New Contributors

Full Changelog: https://github.com/NuPlay/RichText/compare/2.3.0...2.3.1

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics