Introduce MapInitOptions.mapStyle (#7512)

GitOrigin-RevId: b5f374e78e77cd37d5c0b4df118c491fdffc9998

Author: persidskiy

CHANGELOG.md

@@ -6,6 +6,19 @@ Mapbox welcomes participation and contributions from everyone.
 
 * Introduced `ScaleBarViewOptions.units` property supporting metric, imperial, and nautical units, replacing the boolean `useMetricUnits` property.
 * Fix crash in `OrnamentsManager` when setting attribution color.
+* Introduce `MapInitOptions.mapStyle` property. Use it to initialize map with a custom style.
+```swift
+// Before
+let options = MapInitOptions(styleURI: .standardSatellite)
+let mapView = MapView(frame: view.bounds, mapInitOptions: options)
+mapView.mapboxMap.setStyleImportConfigProperties(for: "basemap", configs: ["lightPreset": "dusk"])
+
+// After:
+let options = MapInitOptions(mapStyle: .standardSatellite(lightPreset: .dusk))
+let mapView = MapView(frame: view.bounds, mapInitOptions: options)
+```
+
+
 ## 11.16.0 - 21 October, 2025
 
 ## 11.16.0-rc.2 - 14 October, 2025

Sources/Examples/All Examples/DebugMapExample.swift

@@ -412,7 +412,7 @@ struct StyleJson: Codable {
 struct Metadata: Codable {
     let origin: String?
     let compatibility: Compatibility?
-    
+
     enum CodingKeys: String, CodingKey {
         case origin = "mapbox:origin"
         case compatibility = "mapbox:compatibility"
@@ -424,4 +424,3 @@ struct Compatibility: Codable {
     let android: String?
     let js: String?
 }
-

Sources/Examples/SwiftUI Examples/Util/ViewExtensions.swift

@@ -58,7 +58,6 @@ extension Color {
     }
 }
 
-
 extension View {
     func simpleAlert(message: Binding<String?>, title: String = "Alert") -> some View {
         return alert(item: message) { item in

Sources/Examples/UseCases/PinPoweredMap/Models/FavoritesManager.swift

@@ -3,7 +3,7 @@ import MapboxMaps
 
 class FavoritesManager: ObservableObject {
     @Published var favoriteIds: Set<String> = []
-    
+
     func isFavorite(_ mapboxId: String) -> Bool {
         return favoriteIds.contains(mapboxId)
     }
@@ -22,15 +22,15 @@ class FavoritesManager: ObservableObject {
 
         toggleFavorite(for: mapboxId)
     }
-    
+
     func toggleFavorite(for mapboxId: String) {
         if favoriteIds.contains(mapboxId) {
             favoriteIds.remove(mapboxId)
         } else {
             favoriteIds.insert(mapboxId)
         }
     }
-        
+
     var allFavoriteIds: [String] {
         return Array(favoriteIds)
     }

Sources/MapboxMaps/Foundation/MapInitOptions.swift

@@ -19,10 +19,13 @@ public final class MapInitOptions: NSObject {
     public let mapOptions: MapOptions
 
     /// Style URI for initializing the map. Defaults to Mapbox Standard.
-    public let styleURI: StyleURI?
+    public var styleURI: StyleURI? { mapStyle?.data.asURI }
 
     /// String representation of JSON style spec. Has precedence over ``styleURI``.
-    public let styleJSON: String?
+    public var styleJSON: String? { mapStyle?.data.asJson }
+
+    /// Map style for map initialization.
+    public let mapStyle: MapStyle?
 
     /// Camera options for initializing the map. CameraOptions default to 0.0 for each value.
     public let cameraOptions: CameraOptions?
@@ -45,17 +48,42 @@ public final class MapInitOptions: NSObject {
     ///         can be `nil`.
     ///   - styleJSON: Style JSON in String representation. Has precedence over ``styleURI``.
     ///   - antialiasingSampleCount: Sample count to control multisample anti-aliasing (MSAA) option for rendering.
-    public init(
+    convenience public init(
         mapOptions: MapOptions = MapOptions(),
         cameraOptions: CameraOptions? = nil,
         styleURI: StyleURI? = .standard,
         styleJSON: String? = nil,
         antialiasingSampleCount: Int = 1
     ) {
-        self.mapOptions      = mapOptions
-        self.cameraOptions   = cameraOptions
-        self.styleURI        = styleURI
-        self.styleJSON       = styleJSON
+        let mapStyle: MapStyle? = if let styleJSON {
+            MapStyle(json: styleJSON)
+        } else if let styleURI {
+            MapStyle(uri: styleURI)
+        } else {
+            nil
+        }
+        self.init(mapStyle: mapStyle,
+                  mapOptions: mapOptions,
+                  cameraOptions: cameraOptions,
+                  antialiasingSampleCount: antialiasingSampleCount)
+    }
+
+    /// Creates new map init options.
+    ///
+    /// - Parameters:
+    ///   - mapStyle:  Map style to load, defaults to Mapbox Standard style.
+    ///   - mapOptions: Map rendering options.
+    ///   - cameraOptions:  Camera options overriding the default camera that has been specified in the style.
+    ///   - antialiasingSampleCount: Sample count to control multisample anti-aliasing (MSAA) option for rendering.
+    public init(
+        mapStyle: MapStyle?,
+        mapOptions: MapOptions = MapOptions(),
+        cameraOptions: CameraOptions? = nil,
+        antialiasingSampleCount: Int = 1
+    ) {
+        self.mapOptions = mapOptions
+        self.cameraOptions = cameraOptions
+        self.mapStyle = mapStyle
         self.antialiasingSampleCount = antialiasingSampleCount
     }
 
@@ -106,13 +134,17 @@ extension MapInitOptions {
                 scaleFactor: mapOptions.__scaleFactor)
 
             // Use the overriding style URI if provided (currently from IB)
-            let resolvedStyleURI = overridingStyleURI.map { StyleURI(url: $0) } ?? styleURI
+            let resolvedStyle = if let overridingStyleURI,
+                                   let uri = StyleURI(url: overridingStyleURI) {
+                MapStyle(uri: uri)
+            } else {
+                mapStyle
+            }
 
             return MapInitOptions(
+                mapStyle: resolvedStyle,
                 mapOptions: resolvedMapOptions,
-                cameraOptions: cameraOptions,
-                styleURI: resolvedStyleURI,
-                styleJSON: styleJSON)
+                cameraOptions: cameraOptions)
         } else {
             return self
         }

Sources/MapboxMaps/Foundation/MapView.swift

@@ -330,10 +330,8 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
             object: nil
         )
 
-        if let initialStyleJSON = resolvedMapInitOptions.styleJSON {
-            mapboxMap.mapStyle = MapStyle(json: initialStyleJSON)
-        } else if let initialStyleURI = resolvedMapInitOptions.styleURI {
-            mapboxMap.mapStyle = MapStyle(uri: initialStyleURI)
+        if let mapStyle = resolvedMapInitOptions.mapStyle {
+            mapboxMap.mapStyle = mapStyle
         }
 
         if let cameraOptions = resolvedMapInitOptions.cameraOptions {

Sources/MapboxMaps/Style/MapStyle.swift

@@ -60,6 +60,18 @@ public struct MapStyle: Equatable, Sendable {
     enum Data: Equatable, Sendable {
         case uri(StyleURI)
         case json(String)
+        var asJson: String? {
+            switch self {
+            case .json(let json): json
+            case .uri: nil
+            }
+        }
+        var asURI: StyleURI? {
+            switch self {
+            case .json: nil
+            case .uri(let uri): uri
+            }
+        }
     }
     var data: Data
     var configuration: JSONObject?

Sources/MapboxMaps/SwiftUI/Map.swift

@@ -97,7 +97,8 @@ public struct Map: UIViewControllerRepresentable {
     public func makeCoordinator() -> Coordinator {
         let urlOpener = ClosureURLOpener()
         sendTelemetry(\.swiftUI)
-        let mapView = MapView(frame: .zero, urlOpener: urlOpener)
+        let initOptions = MapInitOptions(mapStyle: mapDependencies.mapStyle)
+        let mapView = MapView(frame: .zero, mapInitOptions: initOptions, urlOpener: urlOpener)
         let viewController = MapViewController(mapView: mapView)
 
         let mapContentDependencies = MapContentDependencies(

Tests/MapboxMapsTests/Foundation/MapInitOptionsTests.swift

@@ -29,4 +29,27 @@ class MapInitOptionsTests: XCTestCase {
 
         XCTAssert(set.count == 1)
     }
+
+    func testStyleURI() {
+        var me = MapInitOptions(styleURI: .standardSatellite)
+        XCTAssertEqual(me.styleURI, .standardSatellite)
+        XCTAssertEqual(me.mapStyle, MapStyle.standardSatellite)
+
+        me = MapInitOptions(mapStyle: .streets)
+        XCTAssertEqual(me.styleURI, .streets)
+        XCTAssertEqual(me.mapStyle, MapStyle.streets)
+    }
+
+    func testStyleJSON() {
+        let json = "{}"
+        var me = MapInitOptions(styleJSON: json)
+        XCTAssertEqual(me.styleURI, nil)
+        XCTAssertEqual(me.styleJSON, json)
+        XCTAssertEqual(me.mapStyle, MapStyle(json: json))
+
+        me = MapInitOptions(mapStyle: MapStyle(json: json))
+        XCTAssertEqual(me.styleURI, nil)
+        XCTAssertEqual(me.styleJSON, json)
+        XCTAssertEqual(me.mapStyle, MapStyle(json: json))
+    }
 }

Tests/MapboxMapsTests/Foundation/MapViewTests.swift

@@ -441,6 +441,13 @@ final class MapViewTestsWithScene: XCTestCase {
         super.tearDown()
     }
 
+    func testMapStyleInInitOptions() throws {
+        XCTAssertEqual(mapView.mapboxMap.mapStyle, .standard)
+        let mapStyle = MapStyle.outdoors
+        var aView = MapView(frame: .zero, mapInitOptions: MapInitOptions(mapStyle: mapStyle))
+        XCTAssertEqual(aView.mapboxMap.mapStyle, mapStyle)
+    }
+
     func testDisplayLinkResumedWhenSceneDidActivate() throws {
         guard #available(iOS 13.0, *) else {
             throw XCTSkip("Test requires iOS 13 or higher.")