FaviconFinder

https://github.com/will-lumley/faviconfinder
Admin
FaviconFinder is a pure Swift library for iOS, macOS, and Linux that automatically detects and...
Tokens:1,537
Snippets:10
Trust Score:7.5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing FaviconFinder with Swift Package Manager

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This snippet demonstrates how to add FaviconFinder as a dependency to a Swift project using Swift Package Manager. It specifies the repository URL and the minimum version, and then links the library to a target within the Package.swift file.

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

--------------------------------

### Accepting Header/Hero Images with FaviconFinder in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This snippet demonstrates how to configure FaviconFinder to also consider header or hero images when searching for favicons. By setting the `acceptHeaderImage` parameter to `true` in the configuration, FaviconFinder expands its search to include these larger images. The example then proceeds to fetch, download, and select the largest available image, which could be a header/hero image.

```Swift
let favicon = try await FaviconFinder(
    url: url,
    configuration: .init(acceptHeaderImage: true)
)
    .fetchFaviconURLs()
    .download()
    .largest()
```

--------------------------------

### Downloading Largest Favicon After Size-Based Selection in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

Building upon size-based URL selection, this example shows how to download the actual image of the largest favicon identified. After calling `.largest()` on the fetched favicon URLs, the `.download()` method is chained to retrieve the image data. This approach ensures that only the desired favicon image is downloaded, further optimizing resource usage and performance.

```Swift
let largestFavicon = try await FaviconFinder(url: url)
    .fetchFaviconURLs()
    .largest()
    .download()

self.imageView.image = largestFavicon.image
```

--------------------------------

### Fetching Authenticated Favicons with Custom HTTP Headers in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This example illustrates how to configure FaviconFinder to include custom HTTP headers for accessing favicons behind an authentication layer. It defines a dictionary of headers, including an 'Authorization' bearer token and a 'Cookie' for session management, which are then passed via the `httpHeaders` property in the configuration. These headers are sent with all HTTP requests made by FaviconFinder, enabling access to protected resources.

```Swift
let headers = [
    "Authorization": "Bearer your_token_here",
    "Cookie": "session_id=your_session_id_here"
]

let favicon = try await FaviconFinder(
    url: url,
    configuration: .init(
        httpHeaders: headers
    )
)
    .fetchFaviconURLs()
    .download()
    .largest()

self.imageView.image = favicon.image
```

--------------------------------

### Enabling Meta-Refresh Redirect Detection in FaviconFinder (Swift)

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This example shows how to enable meta-refresh redirect detection in FaviconFinder's configuration. By setting `checkForMetaRefreshRedirect` to `true`, FaviconFinder will scan the HTML for meta-refresh tags and follow the redirects, ensuring correct favicon retrieval even on sites using this less common redirection method. Note that this feature is off by default due to potential performance implications.

```Swift
    let favicon = try await FaviconFinder(
        url: url,
        configuration: .init(
            preferredSource: .html,
            preferences: [
                .html: FaviconFormatType.appleTouchIcon.rawValue,
                .ico: "favicon.ico",
                .webApplicationManifestFile: FaviconFormatType.launcherIcon4x.rawValue
            ],
            checkForMetaRefreshRedirect: true
        )
    )
        .fetchFaviconURLs()
        .download()
        .largest()

    self.imageView.image = favicon.image
```

--------------------------------

### Creating a New Feature Branch (Git)

Source: https://github.com/will-lumley/faviconfinder/blob/main/CONTRIBUTING.md

This snippet demonstrates how to create and switch to a new Git branch for developing a new feature. It's a prerequisite step before making changes and submitting a pull request, ensuring work is isolated from the main branch.

```bash
git checkout -b feature/my-new-feature
```

--------------------------------

### Using Pre-Fetched HTML with FaviconFinder in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This snippet demonstrates how to initialize FaviconFinder with a pre-fetched HTML document using the `prefetchedHTML` configuration property. It utilizes SwiftSoup to parse an HTML string into a `Document` object, which is then passed to FaviconFinder to avoid redundant HTML downloads. The code fetches favicon URLs, downloads the largest one, and displays it in an image view.

```Swift
import SwiftSoup

// Assuming you have already fetched and parsed the HTML
let htmlString = "<html><head>...</head></html>"
let document = try SwiftSoup.parse(htmlString)

let favicon = try await FaviconFinder(
    url: url,
    configuration: .init(prefetchedHTML: document)
)
    .fetchFaviconURLs()
    .download()
    .largest()

self.imageView.image = favicon.image
```

--------------------------------

### Configuring FaviconFinder for Preferential Downloading (Swift)

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This snippet demonstrates how to configure FaviconFinder to prioritize specific favicon sources and types. It sets HTML as the preferred source, with a preference for `appleTouchIcon` from HTML, `favicon.ico` for ICO files, and `launcherIcon4x` for web application manifest files. If the preferred type isn't found, FaviconFinder will automatically try other available methods.

```Swift
    let favicon = try await FaviconFinder(
        url: url,
        configuration: .init(
            preferredSource: .html,
            preferences: [
                .html: FaviconFormatType.appleTouchIcon.rawValue,
                .ico: "favicon.ico",
                .webApplicationManifestFile: FaviconFormatType.launcherIcon4x.rawValue
            ]
        )
    )
        .fetchFaviconURLs()
        .download()
        .largest()

    self.imageView.image = favicon.image
```

--------------------------------

### Downloading and Displaying the Largest Favicon in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This Swift code snippet demonstrates how to use the FaviconFinder library to asynchronously fetch, download, and select the largest available favicon for a given URL. It initializes FaviconFinder with a URL, then chains calls to fetchFaviconURLs() to find all favicon declarations, download() to retrieve the image data, and largest() to select the highest resolution favicon. Finally, the retrieved favicon.image is assigned to a self.imageView.image property, typically for display in a UI element. This snippet requires 'url' to be a valid URL object and 'self.imageView' to be an existing UIImageView or similar image view component. On Linux, 'largest()' might not be effective due to lack of native image support.

```swift
    let favicon = try await FaviconFinder(url: url)
        .fetchFaviconURLs()
        .download()
        .largest()

    self.imageView.image = favicon.image
```

--------------------------------

### Sorting Favicon URLs by Size Without Downloading in Swift

Source: https://github.com/will-lumley/faviconfinder/blob/main/README.md

This snippet demonstrates how to identify the largest or smallest favicon URL based on size metadata without downloading the actual images. By calling `.largest()` or `.smallest()` after `fetchFaviconURLs()`, FaviconFinder returns the `FaviconURL` object corresponding to the desired size. This optimizes performance by avoiding unnecessary image downloads, relying on the `sizeTag` metadata.

```Swift
let faviconURL = try await FaviconFinder(url: url)
    .fetchFaviconURLs()
    .largest()  // or .smallest()

print("Largest Favicon URL: \(faviconURL.source)")
```
Tokens:
Raw