Skip to content

Commit 3b11900

Browse files
authored
Merge pull request #16 from mapbox/cw/add-readmes
add missing READMEs
2 parents ad81af7 + d301c39 commit 3b11900

File tree

4 files changed

+86
-7
lines changed

4 files changed

+86
-7
lines changed

android-location-search/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Add Location Search to an Android app
2+
3+
This is supporting code for the Mapbox [tutorial on adding location search to an Android app](https://docs.mapbox.com/help/tutorials/android-location-search). This demo application helps developers understand how to use [Mapbox Search SDK for Android](https://docs.mapbox.com/android/search) with the [Mapbox Maps SDK for Android](https://docs.mapbox.com/android/maps) in an Android application using Jetpack Compose.
4+
5+
The app demonstrates basic functionality including:
6+
7+
- Rendering a full screen map with Mapbox Standard style using Jetpack Compose
8+
- Implementing location search with autocomplete using Mapbox Search SDK
9+
- Creating a floating search interface with real-time suggestions
10+
- Adding markers to the map for selected search results using PointAnnotation
11+
- Animating the map camera to fly to selected locations with smooth transitions
12+
- Search suggestion handling with proper result selection callbacks
13+
14+
### Requirements
15+
- A [Mapbox Account](https://console.mapbox.com) and Access Token
16+
- Android Studio
17+
18+
#### Add your Access Token
19+
As outlined in the [Install Guide](https://docs.mapbox.com/android/maps/guides/install/) you **must** configure your public token to make requests to Mapbox services. Find the `res/values/mapbox_access_token.xml` file and replace `YOUR_MAPBOX_ACCESS_TOKEN` with your public token. Find your token in the [Mapbox Console](https://console.mapbox.com).
20+
21+
### Key Features
22+
23+
**Location Search**: The app uses Mapbox's Search Engine with SearchBox API to provide real-time search suggestions as users type. The implementation includes proper callback handling for both suggestions and result selection.
24+
25+
**Modern UI**: Built with Jetpack Compose, the app features a floating search interface that overlays the map using Box layout and zIndex for proper layering.
26+
27+
**Map Integration**: Selected search results are displayed as custom markers on the map using PointAnnotation, with MapViewportState handling smooth camera animations to the selected location.
28+
29+
**Comprehensive Implementation**: The code demonstrates proper integration patterns for combining Mapbox Search SDK with Maps SDK in a Compose-based Android application, including state management and UI composition best practices.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Build an Android marker app using GeoJSON data
2+
3+
This is supporting code for the Mapbox [tutorial on building an Android marker app using GeoJSON data](https://docs.mapbox.com/help/tutorials/android-markers-from-geojson/). This demo application helps developers understand how to use [Mapbox Maps SDK for Android](https://docs.mapbox.com/android/maps) in an Android application using Jetpack Compose with external GeoJSON data.
4+
5+
The app demonstrates a common UX pattern for Android mapping applications including:
6+
7+
- Rendering a full screen map with Mapbox Standard style using Jetpack Compose
8+
- Loading and displaying markers from external GeoJSON data
9+
- Adding custom markers for multiple coffee shop locations in Providence
10+
- Implementing tap interactions to show detailed information about each marker
11+
- Using ModalBottomSheet to present additional business information in a slide-in UI panel
12+
- Parsing GeoJSON properties to display location details (name, address, phone number)
13+
14+
### Requirements
15+
- A [Mapbox Account](https://console.mapbox.com) and Access Token
16+
- Android Studio
17+
18+
#### Add your Access Token
19+
As outlined in the [Install Guide](https://docs.mapbox.com/android/maps/guides/install/) you **must** configure your public token to make requests to Mapbox services. Find the `res/values/mapbox_access_token.xml` file and replace `YOUR_MAPBOX_ACCESS_TOKEN` with your public token. Find your token in the [Mapbox Console](https://console.mapbox.com).
20+
21+
### Key Features
22+
23+
**GeoJSON Integration**: The app demonstrates how to load and parse external GeoJSON data containing point features for coffee shop locations, including custom properties for business information.
24+
25+
**Interactive Markers**: Each coffee shop location is displayed as a custom marker on the map. Users can tap markers to reveal additional information about the business.
26+
27+
**Modern UI with ModalBottomSheet**: Built with Jetpack Compose, the app uses Material3's ModalBottomSheet component to create a smooth slide-in interface for displaying detailed location information.
28+

android-markers-from-geojson/README.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

ios-location-search/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Add Location Search to an iOS app
2+
3+
This is supporting code for the Mapbox [tutorial on adding location search to an iOS app](https://docs.mapbox.com/help/tutorials/ios-location-search). This demo application helps developers understand how to use [Mapbox Search SDK for iOS](https://docs.mapbox.com/ios/search) with the [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps) in an iOS application using SwiftUI.
4+
5+
The app demonstrates basic functionality including:
6+
7+
- Rendering a full screen map with Mapbox Standard style
8+
- Implementing location search with autocomplete using Mapbox Search SDK
9+
- Creating a floating search interface with real-time suggestions
10+
- Adding markers to the map for selected search results
11+
- Animating the map camera to fly to selected locations with smooth transitions
12+
- Geographic search biasing with bounding box and proximity parameters
13+
14+
### Requirements
15+
- A [Mapbox Account](https://console.mapbox.com) and Access Token
16+
- Xcode
17+
18+
#### Add your Access Token
19+
As outlined in the [Install Guide](https://docs.mapbox.com/ios/maps/guides/install/) you **must** configure your public token to make requests to Mapbox services. Add your access token to the `Info.plist` file and replace `YOUR_MAPBOX_ACCESS_TOKEN` with your public token. Find your token in the [Mapbox Console](https://console.mapbox.com).
20+
21+
### Key Features
22+
23+
**Location Search**: The app uses Mapbox's PlaceAutocomplete API to provide real-time search suggestions as users type. The search is geographically biased to the Toronto, Canada area for demonstration purposes, but can be easily modified for any region.
24+
25+
**Interactive UI**: Built with SwiftUI, the app features a floating search interface that overlays the map, providing an intuitive user experience for location discovery.
26+
27+
**Map Integration**: Selected search results are displayed as custom markers on the map, with smooth camera animations that fly to the selected location at an appropriate zoom level.
28+
29+
**Comprehensive Comments**: The code includes detailed explanatory comments making it perfect for learning how to integrate Mapbox Search functionality into iOS applications.

0 commit comments

Comments
 (0)