Swiftpack.co - Package - will-lumley/FaviconFinder

FaviconFinder: Simple Favicon Finding

FaviconFinder

CI Status Version Carthage Compatible SPM Compatible Swift 5.0 Platform License Twitter

FaviconFinder is a tiny, 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/fav.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.

Favicon will:

  • ☑ Detect the favicon in the root directory
  • ☑ Will automatically check if the favicon is located within the root URL if the subdomain failed (Will check https://site.com/fav.ico if https://subdomain.site.com/fav.ico fails)
  • ☑ Detect and parse the HTML at the URL for the declaration of the favicon

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 { (image, url, error) in
    // 'image' will be the image object holding the favicon (UIImage or NSImage depending on your platform)
    // 'url' will be the URL location of the favicon
    // 'error' will be the error that occured if we failed to get the favicon
}

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', '~> 2.1.1'

Carthage

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

github "will-lumley/FaviconFinder" == 2.1.1

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: "2.1.1"),
],
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.

Github

link
Stars: 2

Dependencies

Used By

Total: 0