Restrict map panning to an area | Mapbox GL JS

This example prevents a map from being panned to a different location.

It uses maxBounds to set maximum geographical bounds, and pan and zoom operations are constrained within those bounds.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Restrict map panning to an area</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
<link href="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.3.0/mapbox-gl.js"></script>
<style>
body { margin: 0; padding: 0; }
#map { position: absolute; top: 0; bottom: 0; width: 100%; }
</style>
</head>
<body>
<div id="map"></div>
<script>
	// TO MAKE THE MAP APPEAR YOU MUST
	// ADD YOUR ACCESS TOKEN FROM
	// https://account.mapbox.com
	mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';
    // Set bounds to San Francisco, California.
    const bounds = [
        [-122.66336, 37.492987], // Southwest coordinates
        [-122.250481, 37.871651] // Northeast coordinates
    ];

    const map = new mapboxgl.Map({
        container: 'map', // container ID
        // Choose from Mapbox's core styles, or make your own style with Mapbox Studio
        style: 'mapbox://styles/mapbox/streets-v12', // style URL
        center: [-122.433247, 37.742646], // starting position
        zoom: 12, // starting zoom
        maxBounds: bounds // Set the map's geographical boundaries.
    });
</script>

</body>
</html>

Was this example helpful?