Search Box
Public beta for Mapbox Search JS
Mapbox Search JS is in public beta. During the public beta phase, frameworks may be subject to potential changes as they stabilize.
Mapbox Search JS offers single-box search, which allows you to search by either place name, address, or category.
MapboxSearchBox
MapboxSearchBox, also available as the element <mapbox-search-box>,
is an element that lets you search for places, addresses, and landmarks using
the Mapbox Search Box API.
It can control a Mapbox GL JS map to zoom to the selected result.
Additionally, MapboxSearchBox implements the IControl
interface.
To use this element, you must have a Mapbox access token.
new MapboxSearchBox()
Example
const search = new MapboxSearchBox();
search.accessToken = '<your access token here>';
map.addControl(search);
<mapbox-search-box
access-token="<your access token here>"
proximity="0,0"
>
</mapbox-search-box>
Instance Members
Map settings
Methods
Map binding
Events
Was this section on MapboxSearchBox helpful?
Was this page helpful?