dreymonde/telegraphkit

Usage

1. Create a post on telegra.ph. There is no need to create an account or configure anything. Tap "PUBLISH" and copy the link.

1. Add TelegraphKit to your project (see "Installation" section below)

1. Somewhere in your project:

import TelegraphKit

let url = URL(string: "<your-telegraph-url>")!
let telegraphVC = TelegraphViewController(url: url)
let nvc = UINavigationController(rootViewController: telegraphVC)
self.present(nvc, animated: true)

Guide

TelegraphKit is built on top of WKWebView that adds a few extra features specifically for telegra.ph articles:

• Dark Mode support (Telegraph web-version only supports light mode)
• Native fonts: TelegraphKit substitutes Telegra.ph fonts for Apple system ones in order to achieve that "native look and feel" (this can be configured)
• Customization: select between system and telegra.ph font styles, hide the author & date section, disable text selection & more.
• Layout improvements: TelegraphKit makes slight adjustments to the layout of the page to make it look best inside iOS apps

| Default telegra.ph look | TelegraphKit version | | --- | --- | | [default] | [default] |

Creating TelegraphViewController

let telegraphVC = TelegraphViewController(url: URL(string: "https://telegra.ph/This-is-TelegraphKit-02-03")!)
// or
let telegraphVC = TelegraphViewController(postID: "This-is-TelegraphKit-02-03")

Customizing the appearance

You can configure the appearance of your TelegraphViewController by using TelegraphViewController.Appearance struct:

let telegraphVC = TelegraphViewController(postID: "<your-post-id>", appearance: .appleSystem)

TelegraphKit provides you with two presets:

TelegraphViewController.Appearance
--->.appleSystem // (default)
--->.telegraph

--->.defaultAppearance // (equals .appleSystem by default)

You can fine-tune the appearance by creating it directly:

TelegraphViewController.Appearance(
    fontStyle: TelegraphViewController.Appearance.FontStyle, // .appleSystem or .telegraph
    hideAuthor: Bool,
    darkModeSupport: Bool, // true by default
    disableImageInteraction: Bool, // true by default
    disableSelection: Bool // false by default
)

To change the default appearance globally, you can modify TelegraphViewController.Appearance.defaultAppearance:

// Somewhere in AppDelegate.swift or similar:
TelegraphViewController.Appearance.defaultAppearance = .telegraph

SwiftUI

Since version 0.1.0, TelegraphKit provides a TelegraphView for SwiftUI

TelegraphView(
    postID: "<YOUR-POST-ID>",
    appearance: .appleSystem // optional
)

To automatically add "Done" button at the top right of the screen, use .dismissable():

TelegraphView(
    postID: "<YOUR-POST-ID>",
    appearance: .appleSystem // optional
)
.dismissable() // will show "Done"

.dismissable(doneButtonTitle: "Cancel") // optional: customize done button title

Full usage example:

struct ExampleView: View {
    @State var showWebPage: Bool
    
    var body: some View {
        ZStack {
            Button("Open Telegraph") {
                showWebPage = true
            }
        }
        .sheet(isPresented: $showWebPage) {
            TelegraphView(
                postID: "<YOUR-POST-ID>",
                appearance: .appleSystem // optional
            )
            .dismissable()
        }
    }
}

Installation

Swift Package Manager

1. Click File → Swift Packages → Add Package Dependency.
2. Enter http://github.com/dreymonde/TelegraphKit.git.

Package Metadata

Repository: dreymonde/telegraphkit

Default branch: main

README: README.md