Skip to main content

NavigationControl

React component that wraps maplibre-gl's NavigationControl class.

import * as React from 'react';
import {Map, NavigationControl} from 'react-map-gl/maplibre';
import 'maplibre-gl/dist/maplibre-gl.css';

function App() {
  return <Map
    initialViewState={{
      longitude: -100,
      latitude: 40,
      zoom: 3.5
    }}
    mapStyle="https://demotiles.maplibre.org/style.json"
  >
    <NavigationControl />
  </Map>;
}

Properties​

Reactive Properties​

style: CSSProperties​

CSS style override that applies to the control's container.

Other Properties​

The properties in this section are not reactive. They are only used when the component first mounts.

Any options supported by the NavigationControl class, such as

  • showCompass
  • showZoom
  • visualizePitch

Plus the following:

position: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'​

Default: 'top-right'

Placement of the control relative to the map.

Source​

navigation-control.ts