Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okhanokbay/MapViewPlus
Use any custom view as custom callout view for MKMapView with cool animations. Use any image as annotation view.
https://github.com/okhanokbay/MapViewPlus
animations callout calloutview custom-callout custom-callout-view customcalloutview mapkit mapview mkmapview swift
Last synced: 3 months ago
JSON representation
Use any custom view as custom callout view for MKMapView with cool animations. Use any image as annotation view.
- Host: GitHub
- URL: https://github.com/okhanokbay/MapViewPlus
- Owner: okhanokbay
- License: mit
- Archived: true
- Created: 2018-03-10T11:28:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-07T20:33:13.000Z (almost 5 years ago)
- Last Synced: 2024-08-05T18:07:11.901Z (3 months ago)
- Topics: animations, callout, calloutview, custom-callout, custom-callout-view, customcalloutview, mapkit, mapview, mkmapview, swift
- Language: Swift
- Homepage:
- Size: 28.1 MB
- Stars: 165
- Watchers: 5
- Forks: 21
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - MapViewPlus - Use any custom view as custom callout view of your MKMapView with cool animations. Also, easily use any image as annotation view. (Maps / Other Hardware)
- awesome-swift - MapViewPlus - Use any custom view as custom callout view for MKMapView with cool animations. Use any image as annotation view. (Libs / Maps)
- awesome-ios-star - MapViewPlus - Use any custom view as custom callout view of your MKMapView with cool animations. Also, easily use any image as annotation view. (Maps / Other Hardware)
- awesome-swift - MapViewPlus - Use any custom view as custom callout view for MKMapView with cool animations. Use any image as annotation view. ` 📝 2 years ago ` (Maps [🔝](#readme))
README
# MapViewPlus
[](https://developer.apple.com/swift/)
[](http://cocoapods.org/pods/MapViewPlus)
[](http://cocoapods.org/pods/MapViewPlus)
[](http://cocoapods.org/pods/MapViewPlus)
## About
MapViewPlus gives you the missing methods of MapKit which are: ```imageForAnnotation``` and ```calloutViewForAnnotationView``` delegate methods.
- Return any UIImage from ```imageForAnnotation``` (image shouldn't have paddings)
- Create any UIView to use as your custom callout view and return it from ```calloutViewForAnnotationView```
- MapViewPlus will:
1) Add an anchor view to bottom of your callout view
2) Combine callout view with the anchor view and add shadow to both of them
3) Add a cool animation to ```CalloutAndAnchorView```
4) Make it user interaction enabled (this may be easy but tricky sometimes)
5) Scrolls map view to show the callout view completely after tapping the annotation view
5) Even give a ready-to-use template for callout view
6) [Forward all of the delegate methods](#forwarding-delegate-methods) of ```MKMapView``` to your subclass of ```MapViewPlus``` (except ```mapView:viewForAnnotation:```)
## Requirements
- Swift 5.0
- iOS 10.0+
## Installation
MapViewPlus is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'MapViewPlus'
```
If you don't use CocoaPods, you can drag and drop all the classes and use it in your project.
## How to use
**1) If you are using Interface Builder, set your map view's class and module as MapViewPlus:**
**2) Setup your Callout View Model:**
```swift
import UIKit
import MapViewPlus
// CalloutViewModel is a protocol of MapVieWPlus. Currently, it has no requirements to its conformant classes.
class YourCalloutViewModel: CalloutViewModel {
var title: String
var image: UIImage
init(title: String, image: UIImage) {
self.title = title
self.image = image
}
}
```
**3) Setup your CalloutView:**
- Create any view in an xib file (or programmatically):
- Wire your view to your callout view class:
```swift
import UIKit
import MapViewPlus
// CalloutViewPlus is a protocol of MapViewPlus.
// Currently, it has just one requirement -> func configureCallout(_ viewModel: CalloutViewModel)
class YourCalloutView: UIView, CalloutViewPlus {
@IBOutlet weak var label: UILabel!
@IBOutlet weak var imageView: UIImageView!
func configureCallout(_ viewModel: CalloutViewModel) {
let viewModel = viewModel as! YourCalloutViewModel
label.text = viewModel.title
imageView.image = viewModel.image
}
}
```
**4) Setup your Annotations in your View Controller:**
```swift
import UIKit
import CoreLocation
import MapViewPlus
class YourViewController: UIViewController {
@IBOutlet weak var mapView: MapViewPlus!
override func viewDidLoad() {
super.viewDidLoad()
//Required
mapView.delegate = self
let viewModel = YourCalloutViewModel(title: "Cafe", image: UIImage(named: "cafe.png")!)
let annotation = AnnotationPlus(viewModel: viewModel,
coordinate: CLLocationCoordinate2DMake(50.11, 8.68))
var annotations: [AnnotationPlus] = []
annotations.append(annotation)
mapView.setup(withAnnotations: annotations)
}
}
```
**5) Return the image for Annotation and the View for Callout**
```swift
extension YourViewController: MapViewPlusDelegate {
func mapView(_ mapView: MapViewPlus, imageFor annotation: AnnotationPlus) -> UIImage {
return UIImage(named: "your_annotation_image.png")!
}
func mapView(_ mapView: MapViewPlus, calloutViewFor annotationView: AnnotationViewPlus) -> CalloutViewPlus{
let calloutView = Bundle.main.loadNibNamed("YourCalloutView", owner: nil, options: nil)!.first as! YourCalloutView
return calloutView
}
}
```
This is it. You are all set and ready to go now.
## Customization (Optional)
MapViewPlus is highly customizable:
### CalloutViewCustomizerDelegate
- Change the center of the callout view related to anchor view and callout view:
```swift
func mapView(_ mapView: MapViewPlus, centerForCalloutViewOf annotationView: AnnotationViewPlus) -> CalloutViewPlusCenter
```
- Change the bounds for callout view without changing the frames in Interface Builder. If you don't use this delegate method, then your callout view's frame will stay the same as the Interface Builder file. You can also use this to change frame dynamically according to the data in callout view!
```swift
func mapView(_ mapView: MapViewPlus, boundsForCalloutViewOf annotationView: AnnotationViewPlus) -> CalloutViewPlusBound
```
- Change the inset of anchor view related to callout view. Anchor view will go under the callout view as amount the value you returned from this method. Defaults to 0.
```swift
func mapView(_ mapView: MapViewPlus, insetFor calloutView: CalloutViewPlus) -> CGFloat
```
- Change the animation type for **showing** the callout view. Defaults to ```.fromBottom``` and available types are, ```.fromTop```, ```.fromBottom```, ```.fromLeft```, ```.fromRight```
```swift
func mapView(_ mapView: MapViewPlus, animationTypeForShowingCalloutViewOf annotationView: AnnotationViewPlus) -> CalloutViewShowingAnimationType
```
- Change the animation type for **hiding** the callout view. Defaults to ```.toBottom``` and available types are, ```.toTop```, ```.toBottom```, ```.toLeft```, ```.toRight```
```swift
func mapView(_ mapView: MapViewPlus, animationTypeForHidingCalloutViewOf annoationView: AnnotationViewPlus) -> CalloutViewHidingAnimationType
```
### AnchorViewCustomizerDelegate
- Change the height for anchor. Anchor view **will always draw a equilateral triangle** by taking the value you supplied as the triangle's height. You can change the height and the anchor view will calculate the necessary size for you:
```swift
func mapView(_ mapView: MapViewPlus, heightForAnchorOf calloutView: CalloutViewPlus) -> CGFloat
```
- Change the background color of anchor view. This is very important. You can supply any color you want for the anchor view. Generally you would like to make this color as same as the background color of your callout view. Just change it like:
```swift
func mapView(_ mapView: MapViewPlus, fillColorForAnchorOf calloutView: CalloutViewPlus) -> UIColor
```
## Notes
### DefaultCalloutView
- MapViewPlus supplies you a ready-to-go template for callout view. You can see the usage example of it in the example project.
- It allows you to specify the source of the image. It has three options:
1) ```.downloadable(imageURL: URL, placeholder: UIImage?)```
- Downloads the image with the help of Kingfisher framework
2) ```.fromBundle(image: UIImage)```
3) ```.none```
### Forwarding Delegate Methods
```MapViewPlus``` uses methods from ```MKMapViewDelegate```, but not all of them. It forwards all of the delegate methods except ```mapView:viewForAnnotation:```. This method is used internally and won't be redirected to your subclass.
Normally, ```MapViewPlus``` will abstract you from ```MapKit``` when you don't want to use the other methods of ```MKMapViewDelegate```. But when you want to use the other methods from ```MKMapViewDelegate```, you can easily do that without any extra efforts. Just write them down and they will get called by ```MapViewPlusDelegate```. Please see how ```mapView(_:regionDidChangeAnimated:)``` method is being called in ```DefaultCalloutViewController.swift``` (in the example project) even if you don't conform to ```MKMapViewDelegate```. If in the future, some new methods are added to ```MKMapViewDelegate```, they will be automagically forwarded to you by ```MapViewPlusDelegate``` without a new version of the framework. There is no wrapping occuring in the background.
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Screenshots
## License
MapViewPlus is available under the MIT license. See the LICENSE file for more info.