Skip to content

A webViewController implemented by WKWebView with a progress bar in the navigation bar

License

Notifications You must be signed in to change notification settings

kf99916/ProgressWebViewController

Repository files navigation

ProgressWebViewController

A WebViewController implemented by WKWebView with a progress bar in the navigation bar. The WebViewController is safari-like web browser.

CocoaPods GitHub stars GitHub forks CocoaPods Compatible Platform GitHub license

ProgressWebViewController ProgressWebViewController

Features

  • ✅ Progress bar in navigation bar
  • ✅ Bypass SSL according to the assigned hosts.( i.e., you can access the self-signed certificate websites with ProgressWebViewController)
  • ✅ Customize bar button items
  • ✅ Assign cookies to the web view
  • ✅ Browse the local html files
  • ✅ Support large titles for navigation bars in iOS 11
  • ✅ Support custom headers
  • ✅ Support custom user agent
  • ✅ Open the special urls including the app store, tel, mailto, sms, and _blank with other apps
  • ✅ Support the pull-to-refresh
  • ✅ Support the push navigation way

Requirements

  • iOS 13.0+

Installation

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 ProgressWebViewController as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/kf99916/ProgressWebViewController.git")
]

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate ProgressWebViewController into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'ProgressWebViewController'

Usage

Import

import ProgressWebViewController

Integration

ProgressWebViewController

A view controller with WKWebView and a progress bar in the navigation bar

var url: URL? the url to request
var tintColor: UIColor? the tint color for the progress bar, navigation bar, and tool bar
var delegate: ProgressWebViewControllerDelegate? the delegate for ProgressWebViewController
var scrollViewDelegate: ProgressWebViewControllerScrollViewDelegate? the delegate for scroll view var bypassedSSLHosts: [String]? the bypassed SSL hosts. The hosts must also be disabled in the App Transport Security.
var cookies: [HTTPCookie]? the assigned cookies
var headers: [String: String]? the custom headers
var userAgent: String? the custom user agent
var urlsHandledByApp: [String: Any] configure the urls handled by other apps (default [ "hosts": ["itunes.apple.com"], "schemes": ["tel", "mailto", "sms"], "_blank": true ])
var websiteTitleInNavigationBar = true show the website title in the navigation bar
var doneBarButtonItemPosition: NavigationBarPosition the position for the done bar button item. the done barbutton item is added automatically if the view controller is presented.(default .left)
var leftNavigaionBarItemTypes: [BarButtonItemType] configure the bar button items in the left navigation bar (default [])
var rightNavigaionBarItemTypes: [BarButtonItemType] configure the bar button items in the right navigation bar (default [])
var toolbarItemTypes: [BarButtonItemType] configure the bar button items in the toolbar of navigation controller (default [.back, .forward, .reload, .activity])
var navigationWay: [NavigationWay] configure the navigation way for clicking links (default .browser)
var pullToRefresh: Bool enable/disable the pull-to-refresh (default false)

Subclassing

You should set up the webview in loadView() and set up others in viewDidLoad()

class MyWebViewController: ProgressWebViewController {
    override open func loadView() {
        super.loadView()

        // set up webview, including cookies, headers, user agent, and so on.
    }

    override func viewDidLoad() {
        super.viewDidLoad()

        // Do any additional setup after loading the view.
    }

    // Other methods
}

ProgressWebViewControllerDelegate

The delegate for ProgressWebViwController

optional func progressWebViewController(_ controller: ProgressWebViewController, canDismiss url: URL) -> Bool
optional func progressWebViewController(_ controller: ProgressWebViewController, didStart url: URL)
optional func progressWebViewController(_ controller: ProgressWebViewController, didFinish url: URL)
optional func progressWebViewController(_ controller: ProgressWebViewController, didFail url: URL, withError error: Error)
optional func progressWebViewController(_ controller: ProgressWebViewController, decidePolicy url: URL) -> Bool optional func initPushedProgressWebViewController(url: URL) -> ProgressWebViewController

ProgressWebViewControllerScrollViewDelegate

The delegate for scroll view

optional func scrollViewDidScroll(_ scrollView: UIScrollView)

BarButtonItemType

The enum for bar button item

enum BarButtonItemType {
    case back
    case forward
    case reload
    case stop
    case activity
    case done
    case flexibleSpace
}

NavigationBarPosition

The enum for position of bar button item in the navigation bar

enum NavigationBarPosition {
    case none
    case left
    case right
}

NavigationWay

The enum for navigation way

enum NavigationWay {
    case browser
    case push
}

Apps using ProgressWebViewController

If you are using ProgressWebViewController in your app and want to be listed here, simply create a pull request.

I am always curious who is using my projects :)

Hikingbook - by Zheng-Xiang Ke

Hikingbook

Demo

ProgressWebViewControllerDemo is a simple demo app which browse the Apple website with ProgressWebViewController.

Author

Zheng-Xiang Ke, kf99916@gmail.com

License

ProgressWebViewController is available under the MIT license. See the LICENSE file for more info.