FaviconFinder

FaviconFinder is a small, pure Swift library designed for iOS and macOS applications that allows you to detect favicons used by a website.

Why not just download the file that exists at https://site.com/favicon.ico? There are multiple places that a developer can place there favicon, not just at the root directory with the specific filename of fav.ico. FaviconFinder handles the dirty work for you and iterates through the numerous locations that the favicon could be located at, and simply delivers the image to you in a closure, once the image is found.

FaviconFinder will:

Detect the favicon in the root directory of the URL provided
Will automatically check if the favicon is located within the root URL if the subdomain failed (Will check https://site.com/favicon.ico if https://subdomain.site.com/favicon.ico fails)
Detect and parse the HTML at the URL for the declaration of the favicon
Is able to read the favicon URL, even if it's a relative URL to the subdomain that you're querying
Allow you to prioritise which format of favicon you would like served

To do:

Detect and parse web application manifest JSON files
Detect and parse web application Microsoft browser configuration XML

Usage

FaviconFinder uses simple syntax to allow you to easily download the favicon you need, and get on with your project. Just insert this code into your project:

FaviconFinder(url: url).downloadFavicon { result in
    switch result {
    case .success(let favicon):
        print("URL of Favicon: \(favicon.url)")
        DispatchQueue.main.async {
            self.imageView.image = favicon.image
        }

    case .failure(let error):
        print("Error: \(error)")
    }
}

However if you're the type to want to have some fine-tuned control over what sort of favicon's we're after, you can do so. Just insert this code into your project:

FaviconFinder(url: url, preferredType: .html, preferences: [
    .html: FaviconType.appleTouchIcon.rawValue,
    .ico: "favicon.ico"
]).downloadFavicon { result in
    switch result {
    case .success(let favicon):
        print("URL of Favicon: \(favicon.url)")
        DispatchQueue.main.async {
            self.imageView.image = favicon.image
        }

    case .failure(let error):
        print("Error: \(error)")
    }
}

This allows you to control:

What type of download type FaviconFinder will use first
When iterating through each download type, what sub-type to look for. For the HTML download type, this allows you to prioritise different "rel" types. For the file .ico type, this allows you to choose the filename.

Example Project

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

FaviconFinder supports iOS 10.0 and above & macOS 10.10 and above.

Installation

Cocoapods

FaviconFinder is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'FaviconFinder', '3.1.0'

Carthage

FaviconFinder is also available through Carthage. To install it, simply add the following line to your Cartfile:

github "will-lumley/FaviconFinder" == 3.1.0

Swift Package Manager

FaviconFinder is also available through Swift Package Manager. To install it, simply add the dependency to your Package.Swift file:

...
dependencies: [
    .package(url: "https://github.com/will-lumley/FaviconFinder.git", from: "3.1.0"),
],
targets: [
    .target( name: "YourTarget", dependencies: ["FaviconFinder"]),
]
...

Author

William Lumley, will@lumley.io

License

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

schradeyannik/FaviconFinder