MapboxSearchController

 
public class MapboxSearchController : UIViewController
extension MapboxSearchController: SearchEngineDelegate

Provides built-in location search functionality powered by Mapbox

  • Custom search bar placeholder

    Declaration

    Swift

    public var searchBarPlaceholder: String? { get set }

  • Provider of customer’s favorite records

    Declaration

    Swift

    public var favoritesProvider: FavoritesProvider

  • Provider of recent searches

    Declaration

    Swift

    public var historyProvider: HistoryProvider

  • Actual CategorySearchEngine used for category search requests

    Declaration

    Swift

    public var categorySearchEngine: CategorySearchEngine

  • Actual SearchEngine used for query-based searches

    Declaration

    Swift

    public var searchEngine: SearchEngine { get set }

  • Options used to customize search, nil by default.

    Declaration

    Swift

    public var searchOptions: SearchOptions?

  • Options used to customize category search, nil by default.

    Declaration

    Swift

    public var categorySearchOptions: SearchOptions?

  • Structure to configure MapboxSearchController UI and logic

    Declaration

    Swift

    public var configuration: Configuration { get set }

  • The object that the search controller calls with the result of user actions

    Declaration

    Swift

    public weak var delegate: SearchControllerDelegate?

  • Instantiate MapboxSearchController with explicit accessToken and custom location provider

    Declaration

    Swift

    public required init(accessToken: String, configuration: Configuration = Configuration())

    Parameters

    accessToken

    Mapbox public access token. Checkout init(locationProvider:) to
    configuration

    configuration for search and categorySearch engines.

  • MapboxSearchController initializer with accessToken taken from application Info.plist

    Access token is expected to be at MGLMapboxAccessToken key in application Info.plist. Missing accessToken will trigger fatalError

    Declaration

    Swift

    public required init(configuration: Configuration = Configuration())

    Parameters

    configuration

    configuration for search and categorySearch engines.

  • Make initial UI

    Declaration

    Swift

    public override func viewDidLoad()

  • Restart listening services on screen appearance

    Declaration

    Swift

    public override func viewWillAppear(_ animated: Bool)

  • Pause listening services on screen disappearance

    Declaration

    Swift

    public override func viewDidDisappear(_ animated: Bool)

  • Presentation styles for MapboxSearchController. Non-animated

    See more

    Declaration

    Swift

    enum PresentationStyle

  • Get access to the MapboxPanelController for .panel presentation style

    Declaration

    Swift

    var panelController: MapboxPanelController? { get }

  • Show Mapbox Search Controller inside of target view controller

    Declaration

    Swift

    func present(in rootVC: UIViewController, presentationStyle: PresentationStyle = .panel)

    Parameters

    rootVC

    ViewController to be root of Search Controller
    presentationStyle

    Choose one of the presentation styles. Default is .panel

  • Reset MapboxSearchController state recursively

    Declaration

    Swift

    func resetSearchUI(animated: Bool, collapse: MapboxPanelController.State? = .collapsed)

    Parameters

    animated

    Should changes be animated
    collapse

    Change the collapsing status. Pass nil to not apply status changes. Default: .collapsed

Search Engine Delegate