react-map-gl/docs/api-reference/use-control.md

useControl

The useControl hook is used to create React wrappers for custom map controls.

import MapboxDraw from '@mapbox/mapbox-gl-draw';
import {Map, useControl} from 'react-map-gl';

function DrawControl(props: DrawControlProps) {
  useControl(() => new MapboxDraw(props), {
    position: props.position
  });

  return null;
}

function App() {
  return (
    <Map
      initialViewState={{
        longitude: -122.4,
        latitude: 37.8,
        zoom: 14
      }}
      mapStyle="mapbox://styles/mapbox/satellite-v9"
    >
      <DrawControl
        position="top-left"
        displayControlsDefault={false}
        controls={{
          polygon: true,
          trash: true
        }}
      />
    </Map>
  );
}

See a full example here.

Signature

useControl(onCreate: () => IControl, options?: {
  position?: ControlPosition;
  onAdd?: (map: MapboxMap) => void;
  onRemove?: (map: MapboxMap) => void;
}): IControl

The hook creates an IControl instance, adds it to the map when it's available, and removes it upon unmount.

Parameters:

• onCreate (Function) - called to create an instance of the control.
• options (object)
  • position ('top-left' | 'top-right' | 'bottom-left' | 'bottom-right') - control position relative to the map
  • onAdd (Function) - called after the control is added to a map
  • onRemove (Function) - called before the control is removed from a map

Returns:

The control instance.