/SDWebImageMapKitPlugin

A SDWebImage plugin to support MapKit integration

Primary LanguageObjective-CMIT LicenseMIT

SDWebImageMapKitPlugin

CI Status Version License Platform Carthage compatible SwiftPM compatible codecov

What's for

SDWebImageMapKitPlugin is a plugin for SDWebImage framework, which provide the MapKit integration and category.

SDWebImage previously have a subspec to hold these integration code, however, since this is not the core feature of SDWebImage, due to the project maintain issue, we move the MapKit integration into a standalone framework.

Requirements

  • iOS 8+
  • macOS 10.10+
  • tvOS 9.2+
  • Xcode 11+

Installation

CocoaPods

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

pod 'SDWebImageMapKitPlugin'

Carthage

SDWebImageMapKitPlugin is available through Carthage.

github "SDWebImage/SDWebImageMapKitPlugin"

Swift Package Manager (Xcode 11+)

SDWebImageMapKitPlugin is available through Swift Package Manager.

let package = Package(
    dependencies: [
        .package(url: "https://github.com/SDWebImage/SDWebImageMapKitPlugin.git", from: "0.1")
    ]
)

Usage

  • Objective-C
MKAnnotationView *annotationView;
NSURL *imageURL;
[annotationView sd_setImageWithURL:imageURL];
  • Swift
let annotationView: MKAnnotationView
let imageURL: URL
annotationView.sd_setImage(with: imageURL)

Demo

If you have some issue about usage, SDWebImageMapKitPlugin provide a demo for iOS && macOS platform. To run the demo, clone the repo and run the following command.

cd Example/
pod install
open SDWebImageMapKitPlugin.xcworkspace

After the Xcode project was opened, click Run to build and run the demo.

Screenshot

The annotation pin icon is from icons8.com

Author

DreamPiggy

License

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