How to display a custom map on a web with Leaflet

This example demonstrates how to display a custom map from MapTiler on a web page using Leaflet JS.

To create your first custom map, check out the How to create a custom map tutorial.

NPM module
Basic JavaScript

Copy the following code, paste it into your favorite text editor, and save it as a .html file.

Install the npm package.
Include the CSS file.

If you have a bundler that can handle CSS, you can import the CSS or include it with a <link> in the head of the document via the CDN
Include the following code in your JavaScript file (Example: main.js).

Replace YOUR_MAPTILER_API_KEY_HERE with your own API key. Make sure to protect the key before publishing your map app!
The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.

Replace the tileLayer URL with your custom map style. Check the Publish the map section to get the URL of your custom style.


     L.tileLayer(`https://api.maptiler.com/maps/YOUR_CUSTOM_MAP_ID/{z}/{x}/{y}.png?key=${key}`,{
   tileSize: 512,
   zoomOffset: -1,
   minZoom: 1,
   attribution: "\u003ca href=\"https://www.maptiler.com/copyright/\" target=\"_blank\"\u003e\u0026copy; MapTiler\u003c/a\u003e \u003ca href=\"https://www.openstreetmap.org/copyright\" target=\"_blank\"\u003e\u0026copy; OpenStreetMap contributors\u003c/a\u003e",
   crossOrigin: true
 }).addTo(map);

View complete source code