mirror of
https://github.com/visgl/react-map-gl.git
synced 2026-01-18 15:54:22 +00:00
116 lines
2.9 KiB
Markdown
116 lines
2.9 KiB
Markdown
# NavigationControl
|
|
|
|
|
|
|
|
This is a React equivalent of Mapbox's [NavigationControl](https://www.mapbox.com/mapbox-gl-js/api/#navigationcontrol),
|
|
which provides zoom buttons and a compass button.
|
|
|
|
```js
|
|
import * as React from 'react';
|
|
import ReactMapGL, {NavigationControl} from 'react-map-gl';
|
|
|
|
const navControlStyle= {
|
|
right: 10,
|
|
top: 10
|
|
};
|
|
|
|
function App() {
|
|
const [viewport, setViewport] = React.useState({
|
|
longitude: -122.45,
|
|
latitude: 37.78,
|
|
zoom: 14
|
|
});
|
|
return (
|
|
<ReactMapGL {...viewport} width="100vw" height="100vh" onViewportChange={setViewport}>
|
|
<NavigationControl style={navControlStyle} />
|
|
</ReactMapGL>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
##### `onViewportChange` (Function)
|
|
|
|
Callback when the user interaction with this control requests a viewport update. If provided, will be called instead of the containing [InteractiveMap](/docs/api-reference/interactive-map.md)'s `onViewportChange`.
|
|
|
|
##### `showCompass` (Boolean)
|
|
|
|
- default: `true`
|
|
|
|
Show or hide the compass button
|
|
|
|
##### `showZoom` (Boolean)
|
|
|
|
- default: `true`
|
|
|
|
Show or hide the zoom buttons
|
|
|
|
##### `zoomInLabel` (String)
|
|
|
|
- default: `Zoom In`
|
|
|
|
Label applied to the zoom in control button.
|
|
|
|
##### `zoomOutLabel` (String)
|
|
|
|
- default: `Zoom Out`
|
|
|
|
Label applied to the zoom out control button.
|
|
|
|
##### `compassLabel` (String)
|
|
|
|
- default: `Reset North`
|
|
|
|
Label applied to the compass control button.
|
|
|
|
##### `className` (String)
|
|
|
|
Assign a custom class name to the container of this control.
|
|
|
|
##### `style` (Object)
|
|
|
|
- default: `{position: 'absolute'}`
|
|
|
|
A [React style](https://reactjs.org/docs/dom-elements.html#style) object applied to this control.
|
|
|
|
##### `captureScroll` (Boolean)
|
|
|
|
- default: `false`
|
|
|
|
Stop propagation of mouse wheel event to the map component. Can be used to stop map from zooming when this component is scrolled.
|
|
|
|
##### `captureDrag` (Boolean)
|
|
|
|
- default: `true`
|
|
|
|
Stop propagation of dragstart event to the map component. Can be used to stop map from panning when this component is dragged.
|
|
|
|
##### `captureClick` (Boolean)
|
|
|
|
- default: `true`
|
|
|
|
Stop propagation of click event to the map component. Can be used to stop map from calling the `onClick` callback when this component is clicked.
|
|
|
|
##### `captureDoubleClick` (Boolean)
|
|
|
|
- default: `true`
|
|
|
|
Stop propagation of dblclick event to the map component. Can be used to stop map from zooming when this component is double clicked.
|
|
|
|
##### `capturePointerMove` (Boolean)
|
|
|
|
- default: `false`
|
|
|
|
Stop propagation of pointermove event to the map component. Can be used to stop map from calling the `onMouseMove` or `onTouchMove` callback when this component is hovered.
|
|
|
|
|
|
## Styling
|
|
|
|
Like its Mapbox counterpart, this control relies on the mapbox-gl stylesheet to work properly. Make sure to add the stylesheet to your page.
|
|
|
|
## Source
|
|
|
|
[navigation-control.js](https://github.com/visgl/react-map-gl/tree/6.1-release/src/components/navigation-control.js)
|
|
|