https://github.com/sgade/swiftui-mapview

MKMapView in SwiftUI
https://github.com/sgade/swiftui-mapview

mkmapview swift swiftui

Last synced: 14 days ago
JSON representation

MKMapView in SwiftUI

• Host: GitHub
• URL: https://github.com/sgade/swiftui-mapview
• Owner: sgade
• License: mit
• Created: 2020-02-20T20:12:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-20T10:47:54.000Z (about 2 years ago)
• Last Synced: 2024-09-16T19:51:02.307Z (about 2 months ago)
• Topics: mkmapview, swift, swiftui
• Language: Swift
• Homepage:
• Size: 2.14 MB
• Stars: 145
• Watchers: 14
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# swiftui-mapview

![Swift Version](https://img.shields.io/badge/Swift-5.1-orange.svg?logo=swift)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsgade%2Fswiftui-mapview%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/sgade/swiftui-mapview)

![Platforms](https://img.shields.io/badge/Platforms-iOS-yellow.svg?logo=apple)

[MKMapView](https://developer.apple.com/documentation/mapkit/mkmapview) in SwiftUI.

**For iOS 14 and later, please use Apple's official [Map](https://developer.apple.com/documentation/mapkit/map) view.**

[![Social Preview](assets/social-preview.png)](assets/screen.png)

(Click the image to see the full screenshot)

## Install

Using Xcode, select `File` -> `Swift Packages` -> `Add Package Dependency` and enter `https://github.com/sgade/swiftui-mapview`.

## Usage

In your view, add the map.

See the [example project](MapViewExample) for how to integrate the map view.

```swift

import SwiftUIMapView

struct ContentView: View {

    var body: some View {

        MapView()

    }

}

```

### General

#### Map type

```swift

MapView(mapType: .standard)

```

### User location

#### Showing the current user location

The current location can be shown on the map. By default, this is `true`.

Note that the application requires permission to access the current user location.

See the documentation on `MapView.showsUserLocation` for more information.

```swift

MapView(showsUserLocation: true)

```

#### Tracking the user's location

```swift

MapView(userTrackingMode: .follow)

```

### Region

#### Setting the visible region center

The binding passed in for `center` defines the visible region. Setting it to `nil` will use the map's default region when loaded.

It is also updated when the visible region changes.

```swift

@State var center: CLLocationCoordinate2D?

MapView(center: self.$center)

```

#### Setting the visible region zoom

The binding passed in for `zoom` defines the visible region span. A default zoom is used if you do not specify any value.

It is also updated when the visible region changes.

```swift

@State var zoom: MKCoordinateSpan

MapView(zoom: self.$zoom)

```

### Annotations

### Adding annotations

Annotations are represented as objects of a custom class that implements the `MapViewAnnotation` protocol.

It might be helpful to sublcass from existing classes like `MKPlacemark`.

```swift

let annotations: [MapViewAnnotation] = ...

MapView(annotation: self.annotations)

```

### Selecting annotations

A list of selected annotations can be passed in via binding.

Selecting an annotations updates the binding, and the other way around.

```swift

@State var selectedAnnotations: [MapViewAnnotation] = []

MapView(selectedAnnotations: self.$selectedAnnotations)

```

## Contributing

See the [contributing guide](CONTRIBUTING.md).

## License

This project is licensed unter the terms of the MIT license. See [LICENSE](./LICENSE) for more information.