@cori-risi/cori.data.api / GeocoderControl

GeocoderControl()

GeocoderControl(props): null

This is a Geocoder search component that can be added to any react-map-gl Map component.

import mapboxgl from 'mapbox-gl';
import Map, { Source, Layer } from 'react-map-gl';

import { GeocoderControl } from "@cori-risi/cori.data.api";

import "mapbox-gl/dist/mapbox-gl.css";

mapboxgl.accessToken = import.meta.env.VITE_MAPBOX_ACCESS_TOKEN;

// ...

<Map mapboxAccessToken={MAPBOX_TOKEN}
     {...} >
   <Source {...} >
       <Layer {...} /> :
   </Source>
   <GeocoderControl mapboxAccessToken={MAPBOX_TOKEN} position="top-left" />
</Map>

Parameters

props

props.mapboxAccessToken: string

Mapbox API token

props.marker?: boolean | Omit<MarkerProps, "longitude" | "latitude">

true or false to place marker on result once selected (default: false)

props.position: ControlPosition

CSS class to position control in “top-left”, “top-right”, “bottom-left” or “bottom-right” of the map pane

Returns

null

Defined in

@cori-risi/components/GeocoderControl.tsx:47