Mapbox Search SDK for iOS

Overview
Documentation
Requirements
Main features
Getting Started
Contributing
Code of Conduct
Versioning

Overview

The Mapbox Search SDK is a developer toolkit to add location search on mobile devices. With the same speed and scale of the Mapbox Search API, the SDK is built specifically for on-demand and local search use cases, like ride-share, food delivery, and store finders apps. Whether your users are trying to find a place among the vast amount of data on a global map, or to find the exact location of a venue a few miles down the road, the Search SDK provides location search for countries all over the globe, in many different languages.

Previously, implementing search into your application required custom tuning with every API request to set a language, location biasing, and result types. There was no pre-built UI and no option for a user to see their search history, or save favorites.

The Mapbox Search SDK allows you to drop pre-tuned search into your application, removing the complexity of API configuration, while still giving you control to customize. It ships with an optional UI framework, or you can build a completely custom implementation with your own UI elements by using the core library. The Search SDK is pre-configured for autocomplete, local search biasing, and includes new features like category search, search history, and search favorites.

Documentation

You can find more documentation at docs.mapbox.com:

Requirements

iOS 12.0 and newer
Xcode 15.0 and newer
Swift 5.9 and newer
Objective-C is not supported
macOS/tvOS/watchOS platforms currently are not supported

Main features

Easy-to-use pre-tuned search options to integrate search into your app quickly.
- Local search for a specific address or POI
Pre-configured and customizable category search for popular categories like cafes, ATMs, hotels, and gas stations.
On-device user search history
On-device favorites
Import/export customer data with your own protocols
Provide you own persistent providers for customer data like History or Favorites

Getting Started

You can install MapboxSearch and/or MapboxSearchUI packages with Swift Package Manager, Cocoapods, or Carthage. Swift Package Manage is our preferred distribution system.

Swift Package Manager

Add the MapboxSearch dependency to your Package.swift or use the Xcode > Project settings > Package Dependencies tab.

dependencies: [
    .package(url: "https://github.com/mapbox/mapbox-search-ios.git")
]

Cocoapods

Set up .netrc file for sdk registry access
1. Create .netrc file in user home directory ($HOME/.netrc, e.g. /Users/victorprivalov/.netrc)
2. File content:
```
machine api.mapbox.com
login mapbox
password sk.ey_Your_Access_Token_With_Read_permission
```

MapboxSearch

To integrate latest pre-release version of MapboxSearch into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'MapboxSearch', ">= 2.6.0-rc.1", "< 3.0"

MapboxSearchUI

To integrate latest pre-release version of MapboxSearchUI into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'MapboxSearchUI', ">= 2.6.0-rc.1", "< 3.0"

Carthage

Set up .netrc file for sdk registry access
1. Create .netrc file in user home directory ($HOME/.netrc, e.g. /Users/victorprivalov/.netrc)
2. File content:
```
machine api.mapbox.com
login mapbox
password sk.ey_Your_Access_Token_With_Read_permission
```
Follow the Carthage Quick Start and specificy the MapboxSearch dependency in your Cartfile:

github "Mapbox/mapbox-search-ios" ~> 2.6.0-rc.1

Contributing

We welcome feedback and code contributions!

If you found a bug or want to request a feature open a github issue. Please use the appropriate issue template.

Development

The SDK requires Carthage which you can install using Homebrew.

Check that Homebrew is installed by running brew -v. If you don't have Homebrew, install before proceeding.
Update Homebrew data to install latest tools versions including Carthage (v0.38 or newer)
- brew update && brew bundle install
Set up .netrc file for sdk registry access
1. Create .netrc file in user home directory ($HOME/.netrc, e.g. /Users/victorprivalov/.netrc)
2. File content:
```
machine api.mapbox.com
login mapbox
password sk.ey_Your_Access_Token_With_Read_permission
```
Set up commit hooks with ./scripts/install_git_hooks
Build dependencies: make dependencies
Mapbox APIs require a Mapbox account and access token. Get an access token from the Mapbox account page. To run a Demo you can provide a token in different ways:
1. Create a new file named mapbox or .mapbox in your home directory with content of your access token. We also support .mapbox file in the repository root folder. MapboxSearchDemoApplication will automatically handle this key and insert it in corresponding place.
2. Open the Workspace, choose MapboxSearchDemoApplication project and select "Info" tab for "MapboxSearchDemoApplication" target. Here you may set your accessToken for MBXAccessToken key in "Custom iOS Target Properties" section.
Alternatively, you could provide your accessToken as a parameter to SearchEngine.init and other initializers that accept an accessToken parameter. Use this approach to deliver your key dynamically and implement a key rotation schedule.

Code of Conduct

Our Standards

Examples of behavior that contributes to creating a positive environment include:

Using welcoming and inclusive language.
Being respectful of differing viewpoints and experiences.
Gracefully accepting constructive criticism.
Focusing on what is best for the community.
Showing empathy towards other community members.

We recommend reading this blog post from Github on writing great PRs..

Versioning

We use SemVer for versioning. For the versions available, see the tags on repository.

mapbox / mapbox-search-ios

readme