https://github.com/maptiler/maptiler-sdk-swift
Complete mobile mapping experience with Swift
https://github.com/maptiler/maptiler-sdk-swift
Last synced: 3 months ago
JSON representation
Complete mobile mapping experience with Swift
- Host: GitHub
- URL: https://github.com/maptiler/maptiler-sdk-swift
- Owner: maptiler
- License: bsd-3-clause
- Created: 2025-01-23T15:47:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-25T17:31:58.000Z (4 months ago)
- Last Synced: 2026-02-25T18:15:56.616Z (4 months ago)
- Language: Swift
- Homepage: https://www.maptiler.com
- Size: 5.2 MB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MapTiler SDK Swift
[](https://swiftpackageindex.com/maptiler/maptiler-sdk-swift)
[](https://swiftpackageindex.com/maptiler/maptiler-sdk-swift)
The MapTiler SDK Swift is a native SDK written in Swift, designed to work with the well-established MapTiler Cloud service, which provides all the data required to fuel a complete mobile mapping experience: vector tiles, geojson, map interaction, custom styles, data visualization and more.
## Features
- [x] Map interaction
- [x] Pre-made map styles
- [x] VectorTile and GeoJSON sources
- [x] Fill, Line and Symbol layers
- [x] Custom Annotation Views
- [x] Location tracking
- [x] Globe and 3D Terrain
- [x] UIKit and SwiftUI support
## Basic Usage
Make sure to set your MapTiler Cloud API key first. (i.e. in AppDelegate):
```swift
Task {
await MTConfig.shared.setAPIKey("YOUR_API_KEY")
}
```
### UIKit
```swift
import MapTilerSDK
let coordinates = CLLocationCoordinate2D(latitude: 47.137765, longitude: 8.581651)
let options = MTMapOptions(center: coordinates, zoom: 2.0, bearing: 1.0, pitch: 20.0)
var mapView = MTMapView(frame: view.frame, options: options, referenceStyle: .streets)
mapView.delegate = self
view.addSubview(mapView)
```
If you are using auto layout, you can call the helper function for anchors pinning. This ensures correct orientation updates.
```swift
mapView.pinToSuperviewEdges()
```
### SwiftUI
```swift
import MapTilerSDK
@State private var mapView = MTMapView(options: MTMapOptions(zoom: 2.0))
var body: some View {
MTMapViewContainer(map: mapView) {}
.referenceStyle(.streets)
}
```
For detailed functionality overview refer to the API Reference documentation or build local docs in Xcode: Product -> Build Documentation.
## Sources and Layers
Sources and layers can be added to the map view style object as soon as map is initialized. Setting the style after adding layers resets them to default, so make sure style is finished loading first.
### UIKit
```swift
guard let style = mapView.style else {
return
}
if let contoursTilesURL = URL(string: "https://api.maptiler.com/tiles/contours-v2/tiles.json?key=YOUR_API_KEY") {
let contoursDataSource = MTVectorTileSource(identifier: "contoursSource", url: contoursTilesURL)
style.addSource(contoursDataSource)
let contoursLayer = MTLineLayer(identifier: "contoursLayer", sourceIdentifier: contoursDataSource.identifier, sourceLayer: "contour_ft")
contoursLayer.color = .brown
contoursLayer.width = 2.0
style.addLayer(contoursLayer)
}
```
### SwiftUI
```swift
@State private var mapView = MTMapView(options: MTMapOptions(zoom: 2.0))
var body: some View {
MTMapViewContainer(map: mapView) {
MTVectorTileSource(identifier: "countoursSource", url: URL(string: "https://api.maptiler.com/tiles/contours-v2/tiles.json?key=YOUR_API_KEY"))
MTLineLayer(identifier: "contoursLayer", sourceIdentifier: "countoursSource", sourceLayer: "contour_ft")
.color(.brown)
.width(2.0)
}
}
```
## Markers and Popups
Markers and popups (Text, Custom Annotation) can be used for highlighting points of interest on the map.
### UIKit
```swift
let coordinates = CLLocationCoordinate2D(latitude: 47.137765, longitude: 8.581651)
let popup = MTTextPopup(coordinates: coordinates, text: "MapTiler", offset: 20.0)
let marker = MTMarker(coordinates: coordinates, popup: popup)
marker.draggable = true
mapView.addMarker(marker)
```
### SwiftUI
```swift
@State private var mapView = MTMapView(options: MTMapOptions(zoom: 2.0))
let coordinates = CLLocationCoordinate2D(latitude: 47.137765, longitude: 8.581651)
var body: some View {
MTMapViewContainer(map: mapView) {
let popup = MTTextPopup(coordinates: coordinates, text: "MapTiler", offset: 20.0)
MTMarker(coordinates: coordinates, draggable: true, popup: popup)
}
}
```
Alternatively add content on custom actions:
```swift
@State private var mapView = MTMapView(options: MTMapOptions(zoom: 2.0))
let coordinates = CLLocationCoordinate2D(latitude: 47.137765, longitude: 8.581651)
var body: some View {
MTMapViewContainer(map: mapView) {
}
.didInitialize {
let marker = MTMarker(coordinates: coordinates)
Task {
await mapView.addMarker(marker)
}
}
Button("Add Popup") {
Task {
let popup = MTTextPopup(coordinates: coordinates, text: "MapTiler", offset: 20.0)
await mapView.addTextPopup(popup)
}
}
}
```
For additional examples refer to the Examples directory.
## Custom Annotations
In addition to `MTMarker` and `MTTextPopup`, you can use `MTCustomAnnotationView` class to make your own annotations and add them to the map. You can subclass to create custom UI it or use it as is for simple designs.
```swift
let customSize = CGSize(width: 200.0, height: 80.0)
let coordinates = CLLocationCoordinate2D(latitude: 47.137765, longitude: 8.581651)
let offset = MTPoint(x: 0, y: -80)
let myCustomView = MTCustomAnnotationView(size: customSize, coordinates: coordinates, offset: offset)
myCustomView.backgroundColor = .blue
myCustomView.addTo(mapView)
```
# Installation
MapTiler Swift SDK is a Swift Package and can be added as dependency through **Swift Package Manager**.
- File -> Add Package Dependencies
- Add https://github.com/maptiler/maptiler-sdk-swift.git
# License
MapTiler SDK Swift is released under the BSD 3-Clause license. See LICENSE for details.