Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eaceto/wkwebview_warmup

A library that speeds up the loading of Web Pages when using WKWebView
https://github.com/eaceto/wkwebview_warmup

ios macos uiwebview webview webview-library wkwebview

Last synced: 12 days ago
JSON representation

A library that speeds up the loading of Web Pages when using WKWebView

Host: GitHub
URL: https://github.com/eaceto/wkwebview_warmup
Owner: eaceto
License: mit
Created: 2022-04-27T11:43:48.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-01-30T16:14:55.000Z (almost 2 years ago)
Last Synced: 2024-04-29T14:00:53.780Z (6 months ago)
Topics: ios, macos, uiwebview, webview, webview-library, wkwebview
Language: Swift
Homepage:
Size: 354 KB
Stars: 6
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # WKWebView WarmUp

![Swift](https://img.shields.io/badge/Swift-5.3_5.4_5.5_5.6-yellowgreen?style=flat-square)

![Platforms](https://img.shields.io/badge/Platforms-macOS_iOS-yellowgreen?label=Platforms&style=flat-square)

![Swifth Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)

![Cocoapods](https://img.shields.io/cocoapods/v/WKWebView_WarmUp?label=Cocoapods&style=flat-square)

[![Swift CI](https://github.com/eaceto/WKWebView_WarmUp/actions/workflows/swift-ci.yml/badge.svg)](https://github.com/eaceto/WKWebView_WarmUp/actions/workflows/swift-ci.yml)

[![Swift Docs](https://github.com/eaceto/WKWebView_WarmUp/actions/workflows/swift-docs.yml/badge.svg?branch=main)](https://github.com/eaceto/WKWebView_WarmUp/actions/workflows/swift-docs.yml)

[![Latest release](https://img.shields.io/badge/Latest_release-1.1.0-blue.svg)](https://github.com/eaceto/WKWebView/releases/1.1.0)

A library that speeds up the loading of Web Pages when using WKWebView.

## Table of Contents

1. References

    * [GitHub Page](https://eaceto.github.io/WKWebView_WarmUp/)

    * [Code Documentation](./code/jazzy/index.html)

    * [Coverage Report](./coverage/index.html)

    * [Lint report](./code/swiftlint/index.html)

    * [Code Analysis](https://app.snyk.io/org/eaceto/project/9749d95d-30cd-4e89-af98-b57bdc22d8c7)

2. [Requirements](#requirements)

3. [Installation](#installation)

    * [Cocoapods](#cocoapods)

    * [Swift Package Manager](#swift-package-manager)

4. [Usage](#usage)

5. [Notes](#notes)

6. [Author](#author)

### Requirements

| Platform | Minimun Swift Version | Installation | Status |

| --- | --- | --- | --- |

| iOS 9.0+ | 5.3 | [Cocoapods](#cocoapods), [Swift Package Manager](#swift-package-manager) | Fully Tested |

| macOS 10.12+ | 5.3 | [Cocoapods](#cocoapods), [Swift Package Manager](#swift-package-manager) | Fully Tested |

### Installation

#### Cocoapods

````ruby

pod 'WKWebView_WarmUp', '~> '

````

#### Swift Package Manager

````swift

// Inside Package definition

dependencies: [

    .package(url: "https://github.com/eaceto/WKWebView_WarmUp.git", .upToNextMajor(from: ""))

]

// Inside Target definition

dependencies: [

    "WKWebView_WarmUp"

]

````

### Usage

note: **warmUp** should always be called in the **Main Thread**.

When you want to speed up the loading of a WebView, perform the following request with the required URL / URLRequest to load. 

````swift

let url = URL(string: "https://duckduckgo.com")!

WKWebViewHeater.shared.warmUp(with: url)

````

This call should be done as soon as possible, and before your app makes all the critical calls, so the calls performed by the **WKWebViewHeater**.

Then, when you want to retrieve the warmed-up WebView, just call

````swift

let webView = WKWebViewHeater.shared.dequeue(with: url)!

````

#### Lifespan

Warmed-up WebView may have a lifespan. In case the end of life of a WebView happens when it's inside the pool (not yet dequeued), the pool will reload it by calling the **warmUp** method over the WebView automatically.

````swift

let url = URL(string: "https://duckduckgo.com")!

WKWebViewHeater.shared.warmUp(with: url, lifespan: 30.0)  //WebView will be automatically reloaded every 30 seconds.

````

### Notes

**Remember that** this WebView's size is Zero! In order to added to your ViewController, use AutoLayout as follows:

````swift

// Declare a variable that holds the WebView

private lazy var webView: WKWebView = {

    let webView: WKWebView!

    webView = WKWebViewHeater.shared.dequeue(url: urlString)

    

    // Set other properties of the WebView

    webView.configuration.allowsInlineMediaPlayback = true

    

    webView.translatesAutoresizingMaskIntoConstraints = false

    webView.scrollView.alwaysBounceHorizontal = false

    return webView

}()

override func viewDidLoad() {

    super.viewDidLoad()

    // Add the WebView

    view.addSubview(webView)

    // Set WebView's delegate and props

    webView.navigationDelegate = self

    

    // User AutoLayout to set its constraints

    let webViewConstraints = [

        webView.topAnchor.constraint(equalTo: view.topAnchor),

        webView.leftAnchor.constraint(equalTo: view.leftAnchor),

        webView.bottomAnchor.constraint(equalTo: view.bottomAnchor),

        webView.rightAnchor.constraint(equalTo: view.rightAnchor)

    ]

    NSLayoutConstraint.activate(webViewConstraints)

}

````

### Author

© 2020 Ezequiel (Kimi) Aceto

This project is distributed under [**MIT** License](LICENSE).