Add distance formatter field to MapboxSearchUI.Configuration

CHANGELOG.md

@@ -8,6 +8,7 @@ Guide: https://keepachangelog.com/en/1.0.0/
 
 <!-- Add changes for active work here -->
 
+- [SearchUI] Add `distanceFormatter` field to Configuration to support changing the search suggestions distance format. Nil values will use the default behavior.
 - [Core] Remove Swifter library dependency from MapboxSearch target (only used in Test targets)
 - [Core] Change AbstractSearchEngine.init `supportSBS: Bool = false` parameter to `apiType: ApiType = .SBS`. This changes the default API engine for discover/category and other API requests to SBS. Add ApiType enum to represent non-Autofill and non-PlaceAutocomplete SearchEngine API types.
 

Examples/SearchExamples/SimpleUISearchViewController.swift

@@ -1,12 +1,19 @@
 import MapboxMaps
 import MapboxSearch
 import MapboxSearchUI
+import MapKit
 import UIKit
 
 class SimpleUISearchViewController: MapsViewController {
     lazy var searchController: MapboxSearchController = {
         let locationProvider = PointLocationProvider(coordinate: .sanFrancisco)
-        var configuration = Configuration(locationProvider: locationProvider)
+        let formatter = MKDistanceFormatter()
+        // formatter.units = .metric
+        formatter.unitStyle = .abbreviated
+        var configuration = Configuration(
+            locationProvider: locationProvider,
+            distanceFormatter: formatter
+        )
 
         return MapboxSearchController(configuration: configuration)
     }()

Sources/Demo/PlaceAutocompleteDetailsViewController.swift

@@ -101,7 +101,7 @@ extension PlaceAutocompleteResultViewController {
 }
 
 extension PlaceAutocomplete.Result {
-    static let measurumentFormatter: MeasurementFormatter = {
+    static let measurementFormatter: MeasurementFormatter = {
         let formatter = MeasurementFormatter()
         formatter.unitOptions = [.naturalScale]
         formatter.numberFormatter.roundingMode = .halfUp
@@ -137,7 +137,7 @@ extension PlaceAutocomplete.Result {
             components.append(
                 (
                     name: "Estimated time",
-                    value: PlaceAutocomplete.Result.measurumentFormatter.string(from: estimatedTime)
+                    value: PlaceAutocomplete.Result.measurementFormatter.string(from: estimatedTime)
                 )
             )
         }

Sources/Demo/PlaceAutocompleteMainViewController.swift

@@ -79,7 +79,7 @@ extension PlaceAutocompleteMainViewController: UITableViewDataSource, UITableVie
             description += "\n\(PlaceAutocomplete.Result.distanceFormatter.string(fromDistance: distance))"
         }
         if let estimatedTime = suggestion.estimatedTime {
-            description += "\n\(PlaceAutocomplete.Result.measurumentFormatter.string(from: estimatedTime))"
+            description += "\n\(PlaceAutocomplete.Result.measurementFormatter.string(from: estimatedTime))"
         }
 
         tableViewCell.detailTextLabel?.text = description

Sources/MapboxSearchUI/Configuration.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MapKit
 import UIKit
 
 /// General structure to configure MapboxSearchController UI and logic
@@ -16,12 +17,14 @@ public struct Configuration {
         categoryDataProvider: CategoryDataProvider = DefaultCategoryDataProvider(),
         locationProvider: LocationProvider? = DefaultLocationProvider(),
         hideCategorySlots: Bool = false,
-        style: Style = .default
+        style: Style = .default,
+        distanceFormatter: MKDistanceFormatter? = nil
     ) {
         self.allowsFeedbackUI = allowsFeedbackUI
         self.categoryDataProvider = categoryDataProvider
         self.locationProvider = locationProvider
         self.hideCategorySlots = hideCategorySlots
+        self.distanceFormatter = distanceFormatter
     }
 
     /// Allow to show feedback related UI
@@ -44,4 +47,9 @@ public struct Configuration {
     /// Style to be used for Search UI elements.
     /// It's possible to change style on the fly. Non-animatable.
     public var style = Style()
+
+    /// Override the default ``MKDistanceFormatter`` behavior used by ``SearchSuggestionCell`` to display search
+    /// results in a specific unit system. A nil value will use the ``MKDistanceFormatter`` system behavior to infer
+    /// the unit system based on the device locale.
+    public var distanceFormatter: MKDistanceFormatter?
 }

Sources/MapboxSearchUI/SearchSuggestionCell.swift

@@ -95,7 +95,12 @@ class SearchSuggestionCell: UITableViewCell {
         ) == .orderedSame
         populateSuggestionButton.isHidden = resultNameSameAsQuery
 
-        if let distanceString = suggestion.distance.map(SearchSuggestionCell.distanceFormatter.string) {
+        if let distanceFormatter = configuration.distanceFormatter,
+           let distanceString = suggestion.distance.map(distanceFormatter.string)
+        {
+            distanceLabel.text = distanceString
+            distanceLabel.isHidden = false
+        } else if let distanceString = suggestion.distance.map(SearchSuggestionCell.distanceFormatter.string) {
             distanceLabel.text = distanceString
             distanceLabel.isHidden = false
         } else {